Rewrite of list library. Now has seperate header and list_entry

[privoxy.git] / list.h

diff --git a/list.h b/list.h
index b803251..1c66c4a 100644 (file)
--- a/list.h
+++ b/list.h
@@ -1,6 +1,6 @@
 #ifndef LIST_H_INCLUDED
 #define LIST_H_INCLUDED
-#define LIST_H_VERSION "$Id: list.h,v 1.5 2001/07/29 18:43:08 jongfoster Exp $"
+#define LIST_H_VERSION "$Id: list.h,v 1.6 2001/08/05 16:06:20 jongfoster Exp $"
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/list.h,v $
@@ -36,6 +36,13 @@
  *
  * Revisions   :
  *    $Log: list.h,v $
+ *    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.
@@ -78,26 +85,50 @@ extern "C" {
 #endif
 
 
-extern void enlist(struct list *h, const char *s);
-extern void enlist_unique(struct list *header, const char *str, int n);
-extern void enlist_unique_header(struct list *header, const char *name, const char *value);
-extern void enlist_first(struct list *header, const char *str);
+/*
+ * struct list
+ *
+ * A linked list class.
+ */
+
+extern void init_list    (struct list *the_list);
+extern void destroy_list (struct list *the_list);
+
+extern int  list_is_valid(const struct list *the_list);
+
+extern int  enlist                 (struct list *the_list, const char *str);
+extern int  enlist_unique          (struct list *the_list, const char *str, int num_significant_chars);
+extern int  enlist_unique_header   (struct list *the_list, const char *name, const char *value);
+extern int  enlist_first           (struct list *the_list, const char *str);
+extern int  list_append_list_unique(struct list *dest,     const struct list *src);
+extern int  list_duplicate         (struct list *dest,     const struct list *src);
 
-extern int   list_remove_item(struct list *header, const char *str);
+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);
 
-extern void  list_append_list_unique(struct list *dest, const struct list *src);
-extern void  list_append_list_unique(struct list *dest, const struct list *src);
-extern int   list_remove_list(struct list *header, const struct list *to_remove);
+extern int  list_is_empty(const struct list *the_list);
+
+extern char * list_to_text(const struct list *the_list);
+
+
+/*
+ * struct map
+ *
+ * A class which maps names to values.
+ *
+ * Note: You must allocate this through new_map() and free it
+ * through free_map().
+ */
 
-extern void  list_duplicate(struct list *dest, const struct list *src);
+extern struct map * new_map  (void);
+extern void         free_map (struct map * the_map);
 
-extern void  destroy_list(struct list *h);
-extern char *list_to_text(struct list *h);
+extern int          map      (struct map * the_map,
+                              const char * name, int name_needs_copying,
+                              const char * value, int value_needs_copying);
+extern const char * lookup   (const struct map * the_map, const char * name);
 
-extern struct map *new_map(void);
-extern void free_map(struct map *list);
-extern void map(struct map* map, const char *name, int nc, const char *value, int vc);
-extern const char *lookup(const struct map *list, const char *name);
 
 /* Revision control strings from this header and associated .c file */
 extern const char list_rcs[];