actions.h

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