Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals  

actions.h File Reference

Declares functions to work with actions files Functions declared include: FIXME. More...

Go to the source code of this file.

Data Structures

struct  action_alias
 This structure is used to hold user-defined aliases. More...


Defines

#define ACTIONS_H_VERSION   "$Id: actions.h,v 2.1 2002/06/04 17:55:24 jongfoster Exp $"

Functions

jb_err get_actions (char *line, struct action_alias *alias_list, struct action_spec *cur_action)
void free_alias_list (struct action_alias *alias_list)
void init_action (struct action_spec *dest)
void free_action (struct action_spec *src)
jb_err merge_actions (struct action_spec *dest, const struct action_spec *src)
jb_err copy_action (struct action_spec *dest, const struct action_spec *src)
char * actions_to_text (struct action_spec *action)
char * actions_to_html (struct client_state *csp, struct action_spec *action)
void init_current_action (struct current_action_spec *dest)
void free_current_action (struct current_action_spec *src)
jb_err merge_current_action (struct current_action_spec *dest, const struct action_spec *src)
char * current_action_to_html (struct client_state *csp, struct current_action_spec *action)
jb_err get_action_token (char **line, char **name, char **value)
void unload_actions_file (void *file_data)
int load_actions_file (struct client_state *csp)

Variables

const char actions_rcs []
const char actions_h_rcs []

Detailed Description

Declares functions to work with actions files Functions declared include: FIXME.

Log:
actions.h,v
Revision 2.1 2002/06/04 17:55:24 jongfoster Adding comments

Revision 2.0 2002/06/04 14:34:21 jongfoster Moving source files to src/

Revision 1.12 2002/05/06 07:56:50 oes Made actions_to_html independent of FEATURE_CGI_EDIT_ACTIONS

Revision 1.11 2002/04/30 11:14:52 oes Made csp the first parameter in *action_to_html

Revision 1.10 2002/04/26 12:53:33 oes

Revision 1.9 2002/03/26 22:29:54 swa we have a new homepage!

Revision 1.8 2002/03/24 13:25:43 swa name change related issues

Revision 1.7 2002/03/16 23:54:06 jongfoster Adding graceful termination feature, to help look for memory leaks. If you enable this (which, by design, has to be done by hand editing config.h) and then go to http://i.j.b/die, then the program will exit cleanly after the *next* request. It should free all the memory that was used.

Revision 1.6 2001/10/23 21:30:30 jongfoster Adding error-checking to selected functions.

Revision 1.5 2001/10/14 21:58:22 jongfoster Adding support for the CGI-based editor:

Revision 1.4 2001/09/16 15:47:37 jongfoster First version of CGI-based edit interface. This is very much a work-in-progress, and you can't actually use it to edit anything yet. You must define FEATURE_CGI_EDIT_ACTIONS for these changes to have any effect.

Revision 1.3 2001/09/14 00:17:32 jongfoster Tidying up memory allocation. New function init_action().

Revision 1.2 2001/07/29 19:01:11 jongfoster Changed _FILENAME_H to FILENAME_H_INCLUDED. Added forward declarations for needed structures.

Revision 1.1 2001/05/31 21:16:46 jongfoster Moved functions to process the action list into this new file.

Function Documentation

char* actions_to_html (  struct client_state *    csp,
struct action_spec *    action
) 
 

Converts a actionsfile entry from numeric form ("mask" and "add") to a
-seperated HTML string in which each action is linked to its chapter in the user manual.

Parameters:
csp  Client state (for config)
action  Action spec to be converted
Returns:
A string. Caller must free it. NULL on out-of-memory error.

char* actions_to_text (  struct action_spec *    action ) 
 

Converts a actionsfile entry from the internal structurt into a text line.

The output is split into one line for each action with line continuation.

Parameters:
action  The action to format.
Returns:
A string. Caller must free it. NULL on out-of-memory error.

jb_err copy_action (  struct action_spec *    dest,
const struct action_spec *    src
) 
 

Copy an action_specs.

Similar to "dest = src".

Parameters:
dest  Destination of copy.
src  Source for copy.
Returns:
N/A

char* current_action_to_html (  struct client_state *    csp,
struct current_action_spec *    action
) 
 

Converts a curren action spec to a
seperated HTML text in which each action is linked to its chapter in the user manual.

Parameters:
csp  Client state (for config)
action  Current action spec to be converted
Returns:
A string. Caller must free it. NULL on out-of-memory error.

void free_action (  struct action_spec *    src ) 
 

Destroy an action_spec.

Frees memory used by it, except for the memory used by the struct action_spec itself.

Parameters:
src  Source to free.
Returns:
N/A

void free_alias_list (  struct action_alias *    alias_list ) 
 

Free memory used by a list of aliases.

Parameters:
alias_list  Linked list to free.
Returns:
N/A

void free_current_action (  struct current_action_spec *    src ) 
 

Free memory used by a current_action_spec.

Does not free the current_action_spec itself.

Parameters:
src  Source to free.
Returns:
N/A

jb_err get_action_token (  char **    line,
char **    name,
char **    value
) 
 

Parses a line for the first action.

Modifies it's input array, doesn't allocate memory. e.g. given: *line=" +abc{def} -ghi "

Returns *line=" -ghi " *name="+abc" *value="def"

Parameters:
line  [in] The line containing the action. [out] Start of next action on line, or NULL if we reached the end of line before we found an action.
name  [out] Start of action name, null terminated. NULL on EOL
value  [out] Start of action value, null terminated. NULL if none or EOL.
Returns:
JB_ERR_OK => Ok JB_ERR_PARSE => Mismatched {} (line was trashed anyway)

jb_err get_actions (  char *    line,
struct action_alias *    alias_list,
struct action_spec *    cur_action
) 
 

Parses a list of actions.

Parameters:
line  The string containing the actions. Will be written to by this function.
alias_list  Custom alias list, or NULL for none.
cur_action  Where to store the action. Caller allocates memory.
Returns:
JB_ERR_OK => Ok JB_ERR_PARSE => Parse error (line was trashed anyway) nonzero => Out of memory (line was trashed anyway)

void init_action (  struct action_spec *    dest ) 
 

Zero out an action.

Parameters:
dest  An uninitialized action_spec.
Returns:
N/A

void init_current_action (  struct current_action_spec *    dest ) 
 

Zero out an action.

Parameters:
dest  An uninitialized current_action_spec.
Returns:
N/A

jb_err merge_actions (  struct action_spec *    dest,
const struct action_spec *    src
) 
 

Merge two actions together.

Similar to "dest += src".

Parameters:
dest  Actions to modify.
src  Action to add.
Returns:
JB_ERR_OK or JB_ERR_MEMORY

jb_err merge_current_action (  struct current_action_spec *    dest,
const struct action_spec *    src
) 
 

Merge two actions together.

Similar to "dest += src". Differences between this and merge_actions() is that this one doesn't allocate memory for strings (so "src" better be in memory for at least as long as "dest" is, and you'd better free "dest" using "free_current_action"). Also, there is no mask or remove lists in dest. (If we're applying it to a URL, we don't need them)

Parameters:
dest  Current actions, to modify.
src  Action to add. Returns 0 : no error !=0 : error, probably JB_ERR_MEMORY.

void unload_actions_file (  void *    file_data ) 
 

Unloads an actions module.

Parameters:
file_data  the data structure associated with the actions file.
Returns:
N/A

Variable Documentation

const char actions_h_rcs[]
 

Version information about actions.h.

const char actions_rcs[]
 

Version information about actions.c.

Generated on Tue Jun 4 18:54:48 2002 for Privoxy 3.1.1 by doxygen1.2.15