Andrew's git - gitweb.git/blob

   1#ifndef STRING_LIST_H
   2#define STRING_LIST_H
   3
   4struct string_list_item {
   5        char *string;
   6        void *util;
   7};
   8struct string_list {
   9        struct string_list_item *items;
  10        unsigned int nr, alloc;
  11        unsigned int strdup_strings:1;
  12};
  13
  14#define STRING_LIST_INIT_NODUP { NULL, 0, 0, 0 }
  15#define STRING_LIST_INIT_DUP   { NULL, 0, 0, 1 }
  16
  17void print_string_list(const struct string_list *p, const char *text);
  18void string_list_clear(struct string_list *list, int free_util);
  19
  20/* Use this function to call a custom clear function on each util pointer */
  21/* The string associated with the util pointer is passed as the second argument */
  22typedef void (*string_list_clear_func_t)(void *p, const char *str);
  23void string_list_clear_func(struct string_list *list, string_list_clear_func_t clearfunc);
  24
  25/* Use this function or the macro below to iterate over each item */
  26typedef int (*string_list_each_func_t)(struct string_list_item *, void *);
  27int for_each_string_list(struct string_list *list,
  28                         string_list_each_func_t, void *cb_data);
  29#define for_each_string_list_item(item,list) \
  30        for (item = (list)->items; item < (list)->items + (list)->nr; ++item)
  31
  32/*
  33 * Apply want to each item in list, retaining only the ones for which
  34 * the function returns true.  If free_util is true, call free() on
  35 * the util members of any items that have to be deleted.  Preserve
  36 * the order of the items that are retained.
  37 */
  38void filter_string_list(struct string_list *list, int free_util,
  39                        string_list_each_func_t want, void *cb_data);
  40
  41/*
  42 * Remove any empty strings from the list.  If free_util is true, call
  43 * free() on the util members of any items that have to be deleted.
  44 * Preserve the order of the items that are retained.
  45 */
  46void string_list_remove_empty_items(struct string_list *list, int free_util);
  47
  48/* Use these functions only on sorted lists: */
  49int string_list_has_string(const struct string_list *list, const char *string);
  50int string_list_find_insert_index(const struct string_list *list, const char *string,
  51                                  int negative_existing_index);
  52struct string_list_item *string_list_insert(struct string_list *list, const char *string);
  53struct string_list_item *string_list_insert_at_index(struct string_list *list,
  54                                                     int insert_at, const char *string);
  55struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
  56
  57/*
  58 * Remove all but the first of consecutive entries with the same
  59 * string value.  If free_util is true, call free() on the util
  60 * members of any items that have to be deleted.
  61 */
  62void string_list_remove_duplicates(struct string_list *sorted_list, int free_util);
  63
  64
  65/* Use these functions only on unsorted lists: */
  66
  67/*
  68 * Add string to the end of list.  If list->strdup_string is set, then
  69 * string is copied; otherwise the new string_list_entry refers to the
  70 * input string.
  71 */
  72struct string_list_item *string_list_append(struct string_list *list, const char *string);
  73
  74/*
  75 * Like string_list_append(), except string is never copied.  When
  76 * list->strdup_strings is set, this function can be used to hand
  77 * ownership of a malloc()ed string to list without making an extra
  78 * copy.
  79 */
  80struct string_list_item *string_list_append_nodup(struct string_list *list, char *string);
  81
  82void sort_string_list(struct string_list *list);
  83int unsorted_string_list_has_string(struct string_list *list, const char *string);
  84struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
  85                                                     const char *string);
  86
  87void unsorted_string_list_delete_item(struct string_list *list, int i, int free_util);
  88
  89/*
  90 * Split string into substrings on character delim and append the
  91 * substrings to list.  The input string is not modified.
  92 * list->strdup_strings must be set, as new memory needs to be
  93 * allocated to hold the substrings.  If maxsplit is non-negative,
  94 * then split at most maxsplit times.  Return the number of substrings
  95 * appended to list.
  96 *
  97 * Examples:
  98 *   string_list_split(l, "foo:bar:baz", ':', -1) -> ["foo", "bar", "baz"]
  99 *   string_list_split(l, "foo:bar:baz", ':', 0) -> ["foo:bar:baz"]
 100 *   string_list_split(l, "foo:bar:baz", ':', 1) -> ["foo", "bar:baz"]
 101 *   string_list_split(l, "foo:bar:", ':', -1) -> ["foo", "bar", ""]
 102 *   string_list_split(l, "", ':', -1) -> [""]
 103 *   string_list_split(l, ":", ':', -1) -> ["", ""]
 104 */
 105int string_list_split(struct string_list *list, const char *string,
 106                      int delim, int maxsplit);
 107
 108/*
 109 * Like string_list_split(), except that string is split in-place: the
 110 * delimiter characters in string are overwritten with NULs, and the
 111 * new string_list_items point into string (which therefore must not
 112 * be modified or freed while the string_list is in use).
 113 * list->strdup_strings must *not* be set.
 114 */
 115int string_list_split_in_place(struct string_list *list, char *string,
 116                               int delim, int maxsplit);
 117#endif /* STRING_LIST_H */