1 #ifndef ACTIONS_H_INCLUDED
2 #define ACTIONS_H_INCLUDED
3 #define ACTIONS_H_VERSION "$Id: actions.h,v 1.6 2001/10/23 21:30:30 jongfoster 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 * IJBSWA team. http://ijbswa.sourceforge.net
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.6 2001/10/23 21:30:30 jongfoster
39 * Adding error-checking to selected functions.
41 * Revision 1.5 2001/10/14 21:58:22 jongfoster
42 * Adding support for the CGI-based editor:
43 * - Exported get_actions()
44 * - Added new function free_alias_list()
45 * - Added support for {{settings}} and {{description}} blocks
46 * in the actions file. They are currently ignored.
47 * - Added restriction to only one {{alias}} block which must appear
48 * first in the file, to simplify the editor's rewriting rules.
49 * - Note that load_actions_file() is no longer used by the CGI-based
50 * editor, but some of the other routines in this file are.
52 * Revision 1.4 2001/09/16 15:47:37 jongfoster
53 * First version of CGI-based edit interface. This is very much a
54 * work-in-progress, and you can't actually use it to edit anything
55 * yet. You must #define FEATURE_CGI_EDIT_ACTIONS for these changes
58 * Revision 1.3 2001/09/14 00:17:32 jongfoster
59 * Tidying up memory allocation. New function init_action().
61 * Revision 1.2 2001/07/29 19:01:11 jongfoster
62 * Changed _FILENAME_H to FILENAME_H_INCLUDED.
63 * Added forward declarations for needed structures.
65 * Revision 1.1 2001/05/31 21:16:46 jongfoster
66 * Moved functions to process the action list into this new file.
69 *********************************************************************/
78 struct current_action_spec;
83 /* This structure is used to hold user-defined aliases */
87 struct action_spec action[1];
88 struct action_alias * next;
92 extern jb_err get_actions (char *line,
93 struct action_alias * alias_list,
94 struct action_spec *cur_action);
95 extern void free_alias_list(struct action_alias *alias_list);
97 extern void init_action(struct action_spec *dest);
98 extern void free_action(struct action_spec *src);
99 extern jb_err merge_actions (struct action_spec *dest,
100 const struct action_spec *src);
101 extern jb_err copy_action (struct action_spec *dest,
102 const struct action_spec *src);
103 extern char * actions_to_text (struct action_spec *action);
104 #ifdef FEATURE_CGI_EDIT_ACTIONS
105 extern char * actions_to_html (struct action_spec *action);
106 #endif /* def FEATURE_CGI_EDIT_ACTIONS */
108 extern void init_current_action (struct current_action_spec *dest);
109 extern void free_current_action (struct current_action_spec *src);
110 extern jb_err merge_current_action (struct current_action_spec *dest,
111 const struct action_spec *src);
112 extern char * current_action_to_text(struct current_action_spec *action);
114 extern jb_err get_action_token(char **line, char **name, char **value);
115 extern void unload_actions_file(void *file_data);
116 extern int load_actions_file(struct client_state *csp);
118 #ifdef FEATURE_GRACEFUL_TERMINATION
119 void unload_current_actions_file(void);
123 /* Revision control strings from this header and associated .c file */
124 extern const char actions_rcs[];
125 extern const char actions_h_rcs[];
131 #endif /* ndef ACTIONS_H_INCLUDED */