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