Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
[privoxy.git] / list.h
1 #ifndef LIST_H_INCLUDED
2 #define LIST_H_INCLUDED
3 #define LIST_H_VERSION "$Id: list.h,v 1.12.2.1 2002/11/28 18:14:54 oes Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/Attic/list.h,v $
7  *
8  * Purpose     :  Declares functions to handle lists.
9  *                Functions declared include:
10  *                   `destroy_list', `enlist' and `list_to_text'
11  *
12  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
13  *                Privoxy team. http://www.privoxy.org/
14  *
15  *                Based on the Internet Junkbuster originally written
16  *                by and Copyright (C) 1997 Anonymous Coders and 
17  *                Junkbusters Corporation.  http://www.junkbusters.com
18  *
19  *                This program is free software; you can redistribute it 
20  *                and/or modify it under the terms of the GNU General
21  *                Public License as published by the Free Software
22  *                Foundation; either version 2 of the License, or (at
23  *                your option) any later version.
24  *
25  *                This program is distributed in the hope that it will
26  *                be useful, but WITHOUT ANY WARRANTY; without even the
27  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
28  *                PARTICULAR PURPOSE.  See the GNU General Public
29  *                License for more details.
30  *
31  *                The GNU General Public License should be included with
32  *                this file.  If not, you can view it at
33  *                http://www.gnu.org/copyleft/gpl.html
34  *                or write to the Free Software Foundation, Inc., 59
35  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
36  *
37  * Revisions   :
38  *    $Log: list.h,v $
39  *    Revision 1.12.2.1  2002/11/28 18:14:54  oes
40  *    Added unmap function that removes all items with a given
41  *    name from a map.
42  *
43  *    Revision 1.12  2002/03/26 22:29:55  swa
44  *    we have a new homepage!
45  *
46  *    Revision 1.11  2002/03/24 13:25:43  swa
47  *    name change related issues
48  *
49  *    Revision 1.10  2002/03/07 03:46:17  oes
50  *    Fixed compiler warnings
51  *
52  *    Revision 1.9  2001/10/23 21:21:03  jongfoster
53  *    New error handling - error codes are now jb_errs, not ints.
54  *    Changed the way map() handles out-of-memory, to dramatically
55  *    reduce the amount of error-checking clutter needed.
56  *
57  *    Revision 1.8  2001/09/16 17:30:24  jongfoster
58  *    Fixing a compiler warning.
59  *
60  *    Revision 1.7  2001/09/16 13:20:29  jongfoster
61  *    Rewrite of list library.  Now has seperate header and list_entry
62  *    structures.  Also added a large sprinking of assert()s to the list
63  *    code.
64  *
65  *    Revision 1.6  2001/08/05 16:06:20  jongfoster
66  *    Modifiying "struct map" so that there are now separate header and
67  *    "map_entry" structures.  This means that functions which modify a
68  *    map no longer need to return a pointer to the modified map.
69  *    Also, it no longer reverses the order of the entries (which may be
70  *    important with some advanced template substitutions).
71  *
72  *    Revision 1.5  2001/07/29 18:43:08  jongfoster
73  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
74  *    ANSI C rules.
75  *
76  *    Revision 1.4  2001/06/29 13:30:37  oes
77  *    - Introduced enlist_unique_header()
78  *    - Removed logentry from cancelled commit
79  *
80  *    Revision 1.3  2001/06/03 11:03:48  oes
81  *    introduced functions for new list type "map": map(), lookup(),
82  *    free_map(), and extended enlist_unique
83  *
84  *    Revision 1.2  2001/06/01 18:49:17  jongfoster
85  *    Replaced "list_share" with "list" - the tiny memory gain was not
86  *    worth the extra complexity.
87  *
88  *    Revision 1.1  2001/05/31 21:11:53  jongfoster
89  *    - Moved linked list support to new "list.c" file.
90  *      Structure definitions are still in project.h,
91  *      function prototypes are now in "list.h".
92  *    - Added support for "struct list_share", which is identical
93  *      to "struct list" except it saves memory by not duplicating
94  *      the strings.  Obviously, this only works if there is some
95  *      other way of managing the memory used by the strings.
96  *      (These list_share lists are used for lists which last
97  *      for only 1 request, and where all the list entries are
98  *      just coming directly from entries in the actionsfile.)
99  *      Note that you still need to destroy list_share lists
100  *      properly to free the nodes - it's only the strings
101  *      which are shared.
102  *
103  *
104  *********************************************************************/
105 \f
106
107 #include "project.h"
108
109 #ifdef __cplusplus
110 extern "C" {
111 #endif
112
113
114 /*
115  * struct list
116  *
117  * A linked list class.
118  */
119
120 extern void init_list    (struct list *the_list);
121 extern void destroy_list (struct list *the_list);
122
123 extern jb_err enlist                 (struct list *the_list, const char *str);
124 extern jb_err enlist_unique          (struct list *the_list, const char *str, size_t num_significant_chars);
125 extern jb_err enlist_unique_header   (struct list *the_list, const char *name, const char *value);
126 extern jb_err enlist_first           (struct list *the_list, const char *str);
127 extern jb_err list_append_list_unique(struct list *dest,     const struct list *src);
128 extern jb_err list_duplicate         (struct list *dest,     const struct list *src);
129
130 extern int    list_remove_item(struct list *the_list, const char *str);
131 extern int    list_remove_list(struct list *dest,     const struct list *src);
132 extern void   list_remove_all (struct list *the_list);
133
134 extern int    list_is_empty(const struct list *the_list);
135
136 extern char * list_to_text(const struct list *the_list);
137
138
139 /*
140  * struct map
141  *
142  * A class which maps names to values.
143  *
144  * Note: You must allocate this through new_map() and free it
145  * through free_map().
146  */
147
148 extern struct map * new_map  (void);
149 extern void         free_map (struct map * the_map);
150
151 extern jb_err       map      (struct map * the_map,
152                               const char * name, int name_needs_copying,
153                               const char * value, int value_needs_copying);
154 extern jb_err       unmap    (struct map *the_map,
155                               const char *name);
156 extern const char * lookup   (const struct map * the_map, const char * name);
157
158
159 /* Revision control strings from this header and associated .c file */
160 extern const char list_rcs[];
161 extern const char list_h_rcs[];
162
163 #ifdef __cplusplus
164 } /* extern "C" */
165 #endif
166
167 #endif /* ndef LIST_H_INCLUDED */
168
169 /*
170   Local Variables:
171   tab-width: 3
172   end:
173 */