1 #ifndef LIST_H_INCLUDED
2 #define LIST_H_INCLUDED
3 #define LIST_H_VERSION "$Id: list.h,v 1.9 2001/10/23 21:21:03 jongfoster Exp $"
4 /*********************************************************************
6 * File : $Source: /cvsroot/ijbswa/current/list.h,v $
8 * Purpose : Declares functions to handle lists.
9 * Functions declared include:
10 * `destroy_list', `enlist' and `list_to_text'
12 * Copyright : Written by and Copyright (C) 2001 the SourceForge
13 * IJBSWA team. http://ijbswa.sourceforge.net
15 * Based on the Internet Junkbuster originally written
16 * by and Copyright (C) 1997 Anonymous Coders and
17 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
39 * Revision 1.9 2001/10/23 21:21:03 jongfoster
40 * New error handling - error codes are now jb_errs, not ints.
41 * Changed the way map() handles out-of-memory, to dramatically
42 * reduce the amount of error-checking clutter needed.
44 * Revision 1.8 2001/09/16 17:30:24 jongfoster
45 * Fixing a compiler warning.
47 * Revision 1.7 2001/09/16 13:20:29 jongfoster
48 * Rewrite of list library. Now has seperate header and list_entry
49 * structures. Also added a large sprinking of assert()s to the list
52 * Revision 1.6 2001/08/05 16:06:20 jongfoster
53 * Modifiying "struct map" so that there are now separate header and
54 * "map_entry" structures. This means that functions which modify a
55 * map no longer need to return a pointer to the modified map.
56 * Also, it no longer reverses the order of the entries (which may be
57 * important with some advanced template substitutions).
59 * Revision 1.5 2001/07/29 18:43:08 jongfoster
60 * Changing #ifdef _FILENAME_H to FILENAME_H_INCLUDED, to conform to
63 * Revision 1.4 2001/06/29 13:30:37 oes
64 * - Introduced enlist_unique_header()
65 * - Removed logentry from cancelled commit
67 * Revision 1.3 2001/06/03 11:03:48 oes
68 * introduced functions for new list type "map": map(), lookup(),
69 * free_map(), and extended enlist_unique
71 * Revision 1.2 2001/06/01 18:49:17 jongfoster
72 * Replaced "list_share" with "list" - the tiny memory gain was not
73 * worth the extra complexity.
75 * Revision 1.1 2001/05/31 21:11:53 jongfoster
76 * - Moved linked list support to new "list.c" file.
77 * Structure definitions are still in project.h,
78 * function prototypes are now in "list.h".
79 * - Added support for "struct list_share", which is identical
80 * to "struct list" except it saves memory by not duplicating
81 * the strings. Obviously, this only works if there is some
82 * other way of managing the memory used by the strings.
83 * (These list_share lists are used for lists which last
84 * for only 1 request, and where all the list entries are
85 * just coming directly from entries in the actionsfile.)
86 * Note that you still need to destroy list_share lists
87 * properly to free the nodes - it's only the strings
91 *********************************************************************/
104 * A linked list class.
107 extern void init_list (struct list *the_list);
108 extern void destroy_list (struct list *the_list);
110 extern jb_err enlist (struct list *the_list, const char *str);
111 extern jb_err enlist_unique (struct list *the_list, const char *str, size_t num_significant_chars);
112 extern jb_err enlist_unique_header (struct list *the_list, const char *name, const char *value);
113 extern jb_err enlist_first (struct list *the_list, const char *str);
114 extern jb_err list_append_list_unique(struct list *dest, const struct list *src);
115 extern jb_err list_duplicate (struct list *dest, const struct list *src);
117 extern int list_remove_item(struct list *the_list, const char *str);
118 extern int list_remove_list(struct list *dest, const struct list *src);
119 extern void list_remove_all (struct list *the_list);
121 extern int list_is_empty(const struct list *the_list);
123 extern char * list_to_text(const struct list *the_list);
129 * A class which maps names to values.
131 * Note: You must allocate this through new_map() and free it
132 * through free_map().
135 extern struct map * new_map (void);
136 extern void free_map (struct map * the_map);
138 extern int map (struct map * the_map,
139 const char * name, int name_needs_copying,
140 const char * value, int value_needs_copying);
141 extern const char * lookup (const struct map * the_map, const char * name);
144 /* Revision control strings from this header and associated .c file */
145 extern const char list_rcs[];
146 extern const char list_h_rcs[];
152 #endif /* ndef LIST_H_INCLUDED */