8dd1835610d58d385d6bcf440997a0c1990baa95
[privoxy.git] / src / list.h
1 #ifndef LIST_H_INCLUDED
2 #define LIST_H_INCLUDED
3 #define LIST_H_VERSION "$Id: list.h,v 1.12 2002/03/26 22:29:55 swa Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/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  2002/03/26 22:29:55  swa
40  *    we have a new homepage!
41  *
42  *    Revision 1.11  2002/03/24 13:25:43  swa
43  *    name change related issues
44  *
45  *    Revision 1.10  2002/03/07 03:46:17  oes
46  *    Fixed compiler warnings
47  *
48  *    Revision 1.9  2001/10/23 21:21:03  jongfoster
49  *    New error handling - error codes are now jb_errs, not ints.
50  *    Changed the way map() handles out-of-memory, to dramatically
51  *    reduce the amount of error-checking clutter needed.
52  *
53  *    Revision 1.8  2001/09/16 17:30:24  jongfoster
54  *    Fixing a compiler warning.
55  *
56  *    Revision 1.7  2001/09/16 13:20:29  jongfoster
57  *    Rewrite of list library.  Now has seperate header and list_entry
58  *    structures.  Also added a large sprinking of assert()s to the list
59  *    code.
60  *
61  *    Revision 1.6  2001/08/05 16:06:20  jongfoster
62  *    Modifiying "struct map" so that there are now separate header and
63  *    "map_entry" structures.  This means that functions which modify a
64  *    map no longer need to return a pointer to the modified map.
65  *    Also, it no longer reverses the order of the entries (which may be
66  *    important with some advanced template substitutions).
67  *
68  *    Revision 1.5  2001/07/29 18:43:08  jongfoster
69  *    Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
70  *    ANSI C rules.
71  *
72  *    Revision 1.4  2001/06/29 13:30:37  oes
73  *    - Introduced enlist_unique_header()
74  *    - Removed logentry from cancelled commit
75  *
76  *    Revision 1.3  2001/06/03 11:03:48  oes
77  *    introduced functions for new list type "map": map(), lookup(),
78  *    free_map(), and extended enlist_unique
79  *
80  *    Revision 1.2  2001/06/01 18:49:17  jongfoster
81  *    Replaced "list_share" with "list" - the tiny memory gain was not
82  *    worth the extra complexity.
83  *
84  *    Revision 1.1  2001/05/31 21:11:53  jongfoster
85  *    - Moved linked list support to new "list.c" file.
86  *      Structure definitions are still in project.h,
87  *      function prototypes are now in "list.h".
88  *    - Added support for "struct list_share", which is identical
89  *      to "struct list" except it saves memory by not duplicating
90  *      the strings.  Obviously, this only works if there is some
91  *      other way of managing the memory used by the strings.
92  *      (These list_share lists are used for lists which last
93  *      for only 1 request, and where all the list entries are
94  *      just coming directly from entries in the actionsfile.)
95  *      Note that you still need to destroy list_share lists
96  *      properly to free the nodes - it's only the strings
97  *      which are shared.
98  *
99  *
100  *********************************************************************/
101 \f
102
103 #include "project.h"
104
105 #ifdef __cplusplus
106 extern "C" {
107 #endif
108
109
110 /*
111  * struct list
112  *
113  * A linked list class.
114  */
115
116 extern void init_list    (struct list *the_list);
117 extern void destroy_list (struct list *the_list);
118
119 extern jb_err enlist                 (struct list *the_list, const char *str);
120 extern jb_err enlist_unique          (struct list *the_list, const char *str, size_t num_significant_chars);
121 extern jb_err enlist_unique_header   (struct list *the_list, const char *name, const char *value);
122 extern jb_err enlist_first           (struct list *the_list, const char *str);
123 extern jb_err list_append_list_unique(struct list *dest,     const struct list *src);
124 extern jb_err list_duplicate         (struct list *dest,     const struct list *src);
125
126 extern int    list_remove_item(struct list *the_list, const char *str);
127 extern int    list_remove_list(struct list *dest,     const struct list *src);
128 extern void   list_remove_all (struct list *the_list);
129
130 extern int    list_is_empty(const struct list *the_list);
131
132 extern char * list_to_text(const struct list *the_list);
133
134
135 /*
136  * struct map
137  *
138  * A class which maps names to values.
139  *
140  * Note: You must allocate this through new_map() and free it
141  * through free_map().
142  */
143
144 extern struct map * new_map  (void);
145 extern void         free_map (struct map * the_map);
146
147 extern int          map      (struct map * the_map,
148                               const char * name, int name_needs_copying,
149                               const char * value, int value_needs_copying);
150 extern const char * lookup   (const struct map * the_map, const char * name);
151
152
153 /* Revision control strings from this header and associated .c file */
154 extern const char list_rcs[];
155 extern const char list_h_rcs[];
156
157 #ifdef __cplusplus
158 } /* extern "C" */
159 #endif
160
161 #endif /* ndef LIST_H_INCLUDED */
162
163 /*
164   Local Variables:
165   tab-width: 3
166   end:
167 */