X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=list.h;h=fb51dc393341c002bb690a6707b4952171feb68b;hp=5a6ea13a6c99a699a48ea51f95bfb718f8a7eff5;hb=bcfa184923d2c9e046d641795a1dd8f8595304d1;hpb=31a3c127af9bc2bdea9d0b00526bdb5d03553fb7 diff --git a/list.h b/list.h index 5a6ea13a..fb51dc39 100644 --- a/list.h +++ b/list.h @@ -1,16 +1,16 @@ -#ifndef _LIST_H -#define _LIST_H -#define LIST_H_VERSION "$Id: list.h,v NOT CHECKED IN YET $" +#ifndef LIST_H_INCLUDED +#define LIST_H_INCLUDED +#define LIST_H_VERSION "$Id: list.h,v 1.14 2006/07/18 14:48:46 david__schmidt Exp $" /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/list.c,v $ + * File : $Source: /cvsroot/ijbswa/current/list.h,v $ * * Purpose : Declares functions to handle lists. * Functions declared include: * `destroy_list', `enlist' and `list_to_text' * - * Copyright : Written by and Copyright (C) 2001 the SourceForge - * IJBSWA team. http://ijbswa.sourceforge.net + * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge + * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written * by and Copyright (C) 1997 Anonymous Coders and @@ -35,7 +35,75 @@ * Temple Place - Suite 330, Boston, MA 02111-1307, USA. * * Revisions : - * $Log: list.c,v $ + * $Log: list.h,v $ + * Revision 1.14 2006/07/18 14:48:46 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.12.2.1 2002/11/28 18:14:54 oes + * Added unmap function that removes all items with a given + * name from a map. + * + * Revision 1.12 2002/03/26 22:29:55 swa + * we have a new homepage! + * + * Revision 1.11 2002/03/24 13:25:43 swa + * name change related issues + * + * Revision 1.10 2002/03/07 03:46:17 oes + * Fixed compiler warnings + * + * Revision 1.9 2001/10/23 21:21:03 jongfoster + * New error handling - error codes are now jb_errs, not ints. + * Changed the way map() handles out-of-memory, to dramatically + * reduce the amount of error-checking clutter needed. + * + * Revision 1.8 2001/09/16 17:30:24 jongfoster + * Fixing a compiler warning. + * + * Revision 1.7 2001/09/16 13:20:29 jongfoster + * Rewrite of list library. Now has seperate header and list_entry + * structures. Also added a large sprinking of assert()s to the list + * code. + * + * Revision 1.6 2001/08/05 16:06:20 jongfoster + * Modifiying "struct map" so that there are now separate header and + * "map_entry" structures. This means that functions which modify a + * map no longer need to return a pointer to the modified map. + * Also, it no longer reverses the order of the entries (which may be + * important with some advanced template substitutions). + * + * Revision 1.5 2001/07/29 18:43:08 jongfoster + * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to + * ANSI C rules. + * + * Revision 1.4 2001/06/29 13:30:37 oes + * - Introduced enlist_unique_header() + * - Removed logentry from cancelled commit + * + * Revision 1.3 2001/06/03 11:03:48 oes + * introduced functions for new list type "map": map(), lookup(), + * free_map(), and extended enlist_unique + * + * Revision 1.2 2001/06/01 18:49:17 jongfoster + * Replaced "list_share" with "list" - the tiny memory gain was not + * worth the extra complexity. + * + * Revision 1.1 2001/05/31 21:11:53 jongfoster + * - Moved linked list support to new "list.c" file. + * Structure definitions are still in project.h, + * function prototypes are now in "list.h". + * - Added support for "struct list_share", which is identical + * to "struct list" except it saves memory by not duplicating + * the strings. Obviously, this only works if there is some + * other way of managing the memory used by the strings. + * (These list_share lists are used for lists which last + * for only 1 request, and where all the list entries are + * just coming directly from entries in the actionsfile.) + * Note that you still need to destroy list_share lists + * properly to free the nodes - it's only the strings + * which are shared. + * * *********************************************************************/ @@ -47,25 +115,51 @@ extern "C" { #endif -extern void enlist(struct list *h, const char *s); -extern void destroy_list(struct list *h); -extern char *list_to_text(struct list *h); +/* + * struct list + * + * A linked list class. + */ + +extern void init_list (struct list *the_list); +extern void destroy_list (struct list *the_list); + +extern jb_err enlist (struct list *the_list, const char *str); +extern jb_err enlist_unique (struct list *the_list, const char *str, size_t num_significant_chars); +extern jb_err enlist_unique_header (struct list *the_list, const char *name, const char *value); +extern jb_err enlist_first (struct list *the_list, const char *str); +extern jb_err list_append_list_unique(struct list *dest, const struct list *src); +extern jb_err list_duplicate (struct list *dest, const struct list *src); + +extern int list_remove_item(struct list *the_list, const char *str); +extern int list_remove_list(struct list *dest, const struct list *src); +extern void list_remove_all (struct list *the_list); -void enlist_unique(struct list *header, const char *str); +extern int list_is_empty(const struct list *the_list); + +extern char * list_to_text(const struct list *the_list); + +extern int list_contains_item(const struct list *the_list, const char *str); + +/* + * struct map + * + * A class which maps names to values. + * + * Note: You must allocate this through new_map() and free it + * through free_map(). + */ -int list_remove_item(struct list *header, const char *str); -int list_remove_list(struct list *header, const struct list *to_remove); +extern struct map * new_map (void); +extern void free_map (struct map * the_map); -void list_duplicate(struct list *dest, const struct list *src); -void list_append_list_unique(struct list *dest, const struct list *src); +extern jb_err map (struct map * the_map, + const char * name, int name_needs_copying, + const char * value, int value_needs_copying); +extern jb_err unmap (struct map *the_map, + const char *name); +extern const char * lookup (const struct map * the_map, const char * name); -void destroy_list_share(struct list_share *h); -void enlist_share(struct list_share *header, const char *str); -void enlist_unique_share(struct list_share *header, const char *str); -int list_remove_item_share(struct list_share *header, const char *str); -int list_remove_list_share(struct list_share *dest, const struct list *src); -void list_duplicate_share(struct list_share *dest, const struct list *src); -void list_append_list_unique_share(struct list_share *dest, const struct list *src); /* Revision control strings from this header and associated .c file */ extern const char list_rcs[]; @@ -75,7 +169,7 @@ extern const char list_h_rcs[]; } /* extern "C" */ #endif -#endif /* ndef _LIST_H */ +#endif /* ndef LIST_H_INCLUDED */ /* Local Variables: