1 #ifndef ACTIONS_H_INCLUDED
2 #define ACTIONS_H_INCLUDED
3 #define ACTIONS_H_VERSION "$Id: actions.h,v 1.8 2002/03/24 13:25:43 swa Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/actions.h,v $
8 * Purpose : Declares functions to work with actions files
9 * Functions declared include: FIXME
11 * Copyright : Written by and Copyright (C) 2001 the SourceForge
12 * Privoxy team. http://www.privoxy.org/
14 * Based on the Internet Junkbuster originally written
15 * by and Copyright (C) 1997 Anonymous Coders and
16 * Junkbusters Corporation. http://www.junkbusters.com
18 * This program is free software; you can redistribute it
19 * and/or modify it under the terms of the GNU General
20 * Public License as published by the Free Software
21 * Foundation; either version 2 of the License, or (at
22 * your option) any later version.
24 * This program is distributed in the hope that it will
25 * be useful, but WITHOUT ANY WARRANTY; without even the
26 * implied warranty of MERCHANTABILITY or FITNESS FOR A
27 * PARTICULAR PURPOSE. See the GNU General Public
28 * License for more details.
30 * The GNU General Public License should be included with
31 * this file. If not, you can view it at
32 * http://www.gnu.org/copyleft/gpl.html
33 * or write to the Free Software Foundation, Inc., 59
34 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
38 * Revision 1.8 2002/03/24 13:25:43 swa
39 * name change related issues
41 * Revision 1.7 2002/03/16 23:54:06 jongfoster
42 * Adding graceful termination feature, to help look for memory leaks.
43 * If you enable this (which, by design, has to be done by hand
44 * editing config.h) and then go to http://i.j.b/die, then the program
45 * will exit cleanly after the *next* request. It should free all the
46 * memory that was used.
48 * Revision 1.6 2001/10/23 21:30:30 jongfoster
49 * Adding error-checking to selected functions.
51 * Revision 1.5 2001/10/14 21:58:22 jongfoster
52 * Adding support for the CGI-based editor:
53 * - Exported get_actions()
54 * - Added new function free_alias_list()
55 * - Added support for {{settings}} and {{description}} blocks
56 * in the actions file. They are currently ignored.
57 * - Added restriction to only one {{alias}} block which must appear
58 * first in the file, to simplify the editor's rewriting rules.
59 * - Note that load_actions_file() is no longer used by the CGI-based
60 * editor, but some of the other routines in this file are.
62 * Revision 1.4 2001/09/16 15:47:37 jongfoster
63 * First version of CGI-based edit interface. This is very much a
64 * work-in-progress, and you can't actually use it to edit anything
65 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
68 * Revision 1.3 2001/09/14 00:17:32 jongfoster
69 * Tidying up memory allocation. New function init_action().
71 * Revision 1.2 2001/07/29 19:01:11 jongfoster
72 * Changed _FILENAME_H to FILENAME_H_INCLUDED.
73 * Added forward declarations for needed structures.
75 * Revision 1.1 2001/05/31 21:16:46 jongfoster
76 * Moved functions to process the action list into this new file.
79 *********************************************************************/
88 struct current_action_spec;
93 /* This structure is used to hold user-defined aliases */
97 struct action_spec action[1];
98 struct action_alias * next;
102 extern jb_err get_actions (char *line,
103 struct action_alias * alias_list,
104 struct action_spec *cur_action);
105 extern void free_alias_list(struct action_alias *alias_list);
107 extern void init_action(struct action_spec *dest);
108 extern void free_action(struct action_spec *src);
109 extern jb_err merge_actions (struct action_spec *dest,
110 const struct action_spec *src);
111 extern jb_err copy_action (struct action_spec *dest,
112 const struct action_spec *src);
113 extern char * actions_to_text (struct action_spec *action);
114 #ifdef FEATURE_CGI_EDIT_ACTIONS
115 extern char * actions_to_html (struct action_spec *action);
116 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
118 extern void init_current_action (struct current_action_spec *dest);
119 extern void free_current_action (struct current_action_spec *src);
120 extern jb_err merge_current_action (struct current_action_spec *dest,
121 const struct action_spec *src);
122 extern char * current_action_to_text(struct current_action_spec *action);
124 extern jb_err get_action_token(char **line, char **name, char **value);
125 extern void unload_actions_file(void *file_data);
126 extern int load_actions_file(struct client_state *csp);
128 #ifdef FEATURE_GRACEFUL_TERMINATION
129 void unload_current_actions_file(void);
133 /* Revision control strings from this header and associated .c file */
134 extern const char actions_rcs[];
135 extern const char actions_h_rcs[];
141 #endif /* ndef ACTIONS_H_INCLUDED */