98c3724c2d9a404115b1d55aa33d0f73a2e4b0f4
[privoxy.git] / actions.h
1 #ifndef ACTIONS_H_INCLUDED
2 #define ACTIONS_H_INCLUDED
3 #define ACTIONS_H_VERSION "$Id: actions.h,v 1.7 2002/03/16 23:54:06 jongfoster Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/actions.h,v $
7  *
8  * Purpose     :  Declares functions to work with actions files
9  *                Functions declared include: FIXME
10  *
11  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
12  *                Privoxy team.  http://ijbswa.sourceforge.net
13  *
14  *                Based on the Internet Junkbuster originally written
15  *                by and Copyright (C) 1997 Anonymous Coders and 
16  *                Junkbusters Corporation.  http://www.junkbusters.com
17  *
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.
23  *
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.
29  *
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.
35  *
36  * Revisions   :
37  *    $Log: actions.h,v $
38  *    Revision 1.7  2002/03/16 23:54:06  jongfoster
39  *    Adding graceful termination feature, to help look for memory leaks.
40  *    If you enable this (which, by design, has to be done by hand
41  *    editing config.h) and then go to http://i.j.b/die, then the program
42  *    will exit cleanly after the *next* request.  It should free all the
43  *    memory that was used.
44  *
45  *    Revision 1.6  2001/10/23 21:30:30  jongfoster
46  *    Adding error-checking to selected functions.
47  *
48  *    Revision 1.5  2001/10/14 21:58:22  jongfoster
49  *    Adding support for the CGI-based editor:
50  *    - Exported get_actions()
51  *    - Added new function free_alias_list()
52  *    - Added support for {{settings}} and {{description}} blocks
53  *      in the actions file.  They are currently ignored.
54  *    - Added restriction to only one {{alias}} block which must appear
55  *      first in the file, to simplify the editor's rewriting rules.
56  *    - Note that load_actions_file() is no longer used by the CGI-based
57  *      editor, but some of the other routines in this file are.
58  *
59  *    Revision 1.4  2001/09/16 15:47:37  jongfoster
60  *    First version of CGI-based edit interface.  This is very much a
61  *    work-in-progress, and you can't actually use it to edit anything
62  *    yet.  You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
63  *    to have any effect.
64  *
65  *    Revision 1.3  2001/09/14 00:17:32  jongfoster
66  *    Tidying up memory allocation. New function init_action().
67  *
68  *    Revision 1.2  2001/07/29 19:01:11  jongfoster
69  *    Changed _FILENAME_H to FILENAME_H_INCLUDED.
70  *    Added forward declarations for needed structures.
71  *
72  *    Revision 1.1  2001/05/31 21:16:46  jongfoster
73  *    Moved functions to process the action list into this new file.
74  *
75  *
76  *********************************************************************/
77 \f
78
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82
83
84 struct action_spec;
85 struct current_action_spec;
86 struct client_state;
87
88
89
90 /* This structure is used to hold user-defined aliases */
91 struct action_alias
92 {
93    const char * name;
94    struct action_spec action[1];
95    struct action_alias * next;
96 };
97
98
99 extern jb_err get_actions (char *line, 
100                            struct action_alias * alias_list,
101                            struct action_spec *cur_action);
102 extern void free_alias_list(struct action_alias *alias_list);
103
104 extern void init_action(struct action_spec *dest);
105 extern void free_action(struct action_spec *src);
106 extern jb_err merge_actions (struct action_spec *dest, 
107                              const struct action_spec *src);
108 extern jb_err copy_action (struct action_spec *dest, 
109                            const struct action_spec *src);
110 extern char * actions_to_text     (struct action_spec *action);
111 #ifdef FEATURE_CGI_EDIT_ACTIONS
112 extern char * actions_to_html     (struct action_spec *action);
113 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
114
115 extern void init_current_action     (struct current_action_spec *dest);
116 extern void free_current_action     (struct current_action_spec *src);
117 extern jb_err merge_current_action  (struct current_action_spec *dest, 
118                                      const struct action_spec *src);
119 extern char * current_action_to_text(struct current_action_spec *action);
120
121 extern jb_err get_action_token(char **line, char **name, char **value);
122 extern void unload_actions_file(void *file_data);
123 extern int load_actions_file(struct client_state *csp);
124
125 #ifdef FEATURE_GRACEFUL_TERMINATION
126 void unload_current_actions_file(void);
127 #endif
128
129
130 /* Revision control strings from this header and associated .c file */
131 extern const char actions_rcs[];
132 extern const char actions_h_rcs[];
133
134 #ifdef __cplusplus
135 } /* extern "C" */
136 #endif
137
138 #endif /* ndef ACTIONS_H_INCLUDED */
139
140 /*
141   Local Variables:
142   tab-width: 3
143   end:
144 */
145