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