-const char list_rcs[] = "$Id: list.c,v 1.9 2001/09/16 13:20:29 jongfoster Exp $";
+const char list_rcs[] = "$Id: list.c,v 1.11 2001/10/23 21:21:03 jongfoster Exp $";
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/list.c,v $
* IJBSWA team. http://ijbswa.sourceforge.net
*
* Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
+ * by and Copyright (C) 1997 Anonymous Coders and
* Junkbusters Corporation. http://www.junkbusters.com
*
- * This program is free software; you can redistribute it
+ * This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at
*
* Revisions :
* $Log: list.c,v $
+ * Revision 1.11 2001/10/23 21:21:03 jongfoster
+ * New error handling - error codes are now jb_errs, not ints.
+ * Changed the way map() handles out-of-memory, to dramatically
+ * reduce the amount of error-checking clutter needed.
+ *
+ * Revision 1.10 2001/09/16 17:30:24 jongfoster
+ * Fixing a compiler warning.
+ *
* Revision 1.9 2001/09/16 13:20:29 jongfoster
* Rewrite of list library. Now has seperate header and list_entry
* structures. Also added a large sprinking of assert()s to the list
#endif
#include <string.h>
-#ifndef _WIN32
+#if !defined(_WIN32) && !defined(__OS2__)
#include <unistd.h>
#endif
* then pass it to this function.
* (Implementation note: Rather than calling this
* function, you can also just memset the memory to
- * zero, e.g. if you have a larger structure you
- * want to initialize quickly. However, that isn't
+ * zero, e.g. if you have a larger structure you
+ * want to initialize quickly. However, that isn't
* really good design.)
*
* Parameters :
* calling list_init().
*
* (Implementation note: You *can* reuse the_list
- * without calling list_init(), but please don't.
+ * without calling list_init(), but please don't.
* If you want to remove all entries from a list
- * and still have a usable list, then use
+ * and still have a usable list, then use
* list_remove_all().)
*
* Parameters :
for (cur_entry = the_list->first; cur_entry ; cur_entry = next_entry)
{
next_entry = cur_entry->next;
- freez((char *)cur_entry->str);
+ freez(cur_entry->str);
free(cur_entry);
}
* Description : Check that a string list is valid. The intended
* usage is "assert(list_is_valid(the_list))".
* Currently this checks that "the_list->last"
- * is correct, and that the list dosn't contain
+ * is correct, and that the list dosn't contain
* circular references. It is likely to crash if
* it's passed complete garbage.
*
if (cur_entry->str)
{
/*
- * Just check that this string can be accessed - i.e. it's a valid
+ * Just check that this string can be accessed - i.e. it's a valid
* pointer.
*/
strlen(cur_entry->str);
* 1 : the_list = pointer to list
* 2 : str = string to add to the list (maybe NULL)
*
- * Returns : 0 on success, nonzero on out-of-memory error. On
- * error, the_list will be unchanged.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ * On error, the_list will be unchanged.
*
*********************************************************************/
-int enlist(struct list *the_list, const char *str)
+jb_err enlist(struct list *the_list, const char *str)
{
struct list_entry *cur;
if (NULL == (cur = (struct list_entry *)zalloc(sizeof(*cur))))
{
- return 1;
+ return JB_ERR_MEMORY;
}
if (str)
if (NULL == (cur->str = strdup(str)))
{
free(cur);
- return 1;
+ return JB_ERR_MEMORY;
}
}
/* else { cur->str = NULL; } - implied by zalloc */
}
assert(list_is_valid(the_list));
- return 0;
+ return JB_ERR_OK;
}
* 1 : the_list = pointer to list
* 2 : str = string to add to the list (maybe NULL)
*
- * Returns : 0 on success, nonzero on out-of-memory error. On
- * error, the_list will be unchanged.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ * On error, the_list will be unchanged.
*
*********************************************************************/
-int enlist_first(struct list *the_list, const char *str)
+jb_err enlist_first(struct list *the_list, const char *str)
{
struct list_entry *cur;
if (NULL == (cur = (struct list_entry *)zalloc(sizeof(*cur))))
{
- return 1;
+ return JB_ERR_MEMORY;
}
if (str)
if (NULL == (cur->str = strdup(str)))
{
free(cur);
- return 1;
+ return JB_ERR_MEMORY;
}
}
/* else { cur->str = NULL; } - implied by zalloc */
-
+
cur->next = the_list->first;
the_list->first = cur;
}
assert(list_is_valid(the_list));
- return 0;
+ return JB_ERR_OK;
}
* Description : Append a string into a specified string list,
* if & only if it's not there already.
* If the num_significant_chars argument is nonzero,
- * only compare up to the nth character.
+ * only compare up to the nth character.
*
* Parameters :
* 1 : the_list = pointer to list
* 3 : num_significant_chars = number of chars to use
* for uniqueness test, or 0 to require an exact match.
*
- * Returns : 0 on success, nonzero on out-of-memory error. On
- * error, the_list will be unchanged. "Success"
- * does not indicate whether or not the item was
- * already in the list.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ * On error, the_list will be unchanged.
+ * "Success" does not indicate whether or not the
+ * item was already in the list.
*
*********************************************************************/
-int enlist_unique(struct list *the_list, const char *str,
- int num_significant_chars)
+jb_err enlist_unique(struct list *the_list, const char *str,
+ int num_significant_chars)
{
struct list_entry *cur_entry;
&& (0 == strncmp(str, cur_entry->str, num_significant_chars)))
{
/* Already there */
- return 0;
+ return JB_ERR_OK;
}
}
}
if ( (cur_entry->str != NULL) && (0 == strcmp(str, cur_entry->str)))
{
/* Already there */
- return 0;
+ return JB_ERR_OK;
}
}
}
* 2 : name = HTTP header name (e.g. "Content-type")
* 3 : value = HTTP header value (e.g. "text/html")
*
- * Returns : 0 on success, nonzero on out-of-memory error. On
- * error, the_list will be unchanged. "Success"
- * does not indicate whether or not the header was
- * already in the list.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ * On error, the_list will be unchanged.
+ * "Success" does not indicate whether or not the
+ * header was already in the list.
*
*********************************************************************/
-int enlist_unique_header(struct list *the_list, const char *name, const char *value)
+jb_err enlist_unique_header(struct list *the_list, const char *name,
+ const char *value)
{
int length;
- int result;
+ jb_err result;
char *str;
assert(the_list);
length = strlen(name) + 2;
if (NULL == (str = (char *)malloc(length + strlen(value) + 1)))
{
- return 1;
+ return JB_ERR_MEMORY;
}
strcpy(str, name);
str[length - 2] = ':';
* Description : Remove all entries from a list. On return, the_list
* is a valid, empty list. Note that this is similar
* to destroy_list(), but the difference is that this
- * function guarantees that the list structure is still
+ * function guarantees that the list structure is still
* valid after the call.
*
* Parameters :
for (cur_entry = the_list->first; cur_entry ; cur_entry = next_entry)
{
next_entry = cur_entry->next;
- freez((char *)cur_entry->str);
+ freez(cur_entry->str);
free(cur_entry);
}
if ((ret = (char *)malloc(size + 1)) == NULL)
{
- return(NULL);
+ return NULL;
}
ret[size] = '\0';
}
*s++ = '\r'; *s++ = '\n';
- return(ret);
+ return ret;
}
* All existing entries will be removed.
* 1 : src = pointer to source list for copy.
*
- * Returns : 0 on success, nonzero on error. On error, dest
- * will be empty.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
+ * On error, dest will be empty.
*
*********************************************************************/
-int list_duplicate(struct list *dest, const struct list *src)
+jb_err list_duplicate(struct list *dest, const struct list *src)
{
struct list_entry * cur_src;
struct list_entry * cur_dest;
assert(list_is_valid(src));
assert(list_is_valid(dest));
- return 1;
+ return JB_ERR_MEMORY;
}
if (cur_src->str)
assert(list_is_valid(src));
assert(list_is_valid(dest));
- return 1;
+ return JB_ERR_MEMORY;
}
}
/* else { cur_dest->str = NULL; } - implied by zalloc */
assert(list_is_valid(src));
assert(list_is_valid(dest));
- return 1;
+ return JB_ERR_MEMORY;
}
if (cur_src->str)
{
assert(list_is_valid(src));
assert(list_is_valid(dest));
- return 1;
+ return JB_ERR_MEMORY;
}
}
/* else { cur_dest->str = NULL; } - implied by zalloc */
assert(list_is_valid(src));
assert(list_is_valid(dest));
- return 0;
+ return JB_ERR_OK;
}
* 1 : dest = pointer to destination list for merge.
* 2 : src = pointer to source for merge.
*
- * Returns : 0 on success, nonzero on out-of-memory error.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
* On error, some (but not all) of src might have
* been copied into dest.
*
*********************************************************************/
-int list_append_list_unique(struct list *dest, const struct list *src)
+jb_err list_append_list_unique(struct list *dest, const struct list *src)
{
struct list_entry * cur;
assert(list_is_valid(src));
assert(list_is_valid(dest));
- return 1;
+ return JB_ERR_MEMORY;
}
}
}
assert(list_is_valid(src));
assert(list_is_valid(dest));
- return 0;
+ return JB_ERR_OK;
}
{
assert(the_list);
assert(list_is_valid(the_list));
-
+
return (the_list->first == NULL);
}
return;
}
- for (cur_entry = the_map->first; cur_entry != NULL; cur_entry = next_entry)
+ for (cur_entry = the_map->first; cur_entry != NULL; cur_entry = next_entry)
{
- freez((char *)cur_entry->name);
- freez((char *)cur_entry->value);
+ freez(cur_entry->name);
+ freez(cur_entry->value);
next_entry = cur_entry->next;
free(cur_entry);
* later, set the copy flags for constants or
* strings that will be independantly free()d.
*
+ * Note2: This function allows NULL parameters - it
+ * returns JB_ERR_MEMORY in that case.
+ *
+ * Note3: If this function returns JB_ERR_MEMORY,
+ * it will free(name) unless you specify
+ * name_needs_copying, and similarly it will
+ * free(value) unless you specify
+ * value_needs_copying.
+ *
+ * Due to Note2 and Note3 above, the following code
+ * is legal, and will never crash or leak memory even
+ * if the system runs out of memory:
+ *
+ * err = map(mymap, "xyz", 1, html_encode(somestring), 0);
+ *
+ * err will be set to JB_ERR_MEMORY if either call runs
+ * out-of-memory. Without these features, you would
+ * need to check the return value of html_encode in the
+ * above example for NULL, which (at least) doubles the
+ * amount of error-checking code needed.
+ *
* Parameters :
* 1 : the_map = map to add to
* 2 : name = name to add
* 4 : value = value to add
* 5 : value_needs_copying = flag set if a copy of value should be used
*
- * Returns : 0 on success, nonzero on out-of-memory error.
+ * Returns : JB_ERR_OK on success
+ * JB_ERR_MEMORY on out-of-memory error.
*
*********************************************************************/
-int map(struct map *the_map,
- const char *name, int name_needs_copying,
- const char *value, int value_needs_copying)
+jb_err map(struct map *the_map,
+ const char *name, int name_needs_copying,
+ const char *value, int value_needs_copying)
{
struct map_entry *new_entry;
assert(the_map);
- assert(name);
- assert(value);
- if (NULL == (new_entry = zalloc(sizeof(*new_entry))))
+ if ( (NULL == value)
+ || (NULL == name)
+ || (NULL == (new_entry = zalloc(sizeof(*new_entry)))) )
{
- return 1;
+ if ((name != NULL) && (!name_needs_copying))
+ {
+ free((char *)name);
+ }
+ if ((value != NULL) && (!value_needs_copying))
+ {
+ free((char *)value);
+ }
+ return JB_ERR_MEMORY;
}
if (name_needs_copying)
if (NULL == (name = strdup(name)))
{
free(new_entry);
- return 1;
+ if (!value_needs_copying)
+ {
+ free((char *)value);
+ }
+ return JB_ERR_MEMORY;
}
}
{
if (NULL == (value = strdup(value)))
{
- if (name_needs_copying)
- {
- free((char *)name);
- }
+ free((char *)name);
free(new_entry);
- return 1;
+ return JB_ERR_MEMORY;
}
}
the_map->last = new_entry;
}
- return 0;
+ return JB_ERR_OK;
}
projects / privoxy.git / blobdiff