Andrew's git / gitweb.git / string-list.h
?
string-list.hon commit string_list: add function string_list_append_nodup() (e448fed)
   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/* Use these functions only on sorted lists: */
  34int string_list_has_string(const struct string_list *list, const char *string);
  35int string_list_find_insert_index(const struct string_list *list, const char *string,
  36                                  int negative_existing_index);
  37struct string_list_item *string_list_insert(struct string_list *list, const char *string);
  38struct string_list_item *string_list_insert_at_index(struct string_list *list,
  39                                                     int insert_at, const char *string);
  40struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
  41
  42
  43/* Use these functions only on unsorted lists: */
  44
  45/*
  46 * Add string to the end of list.  If list->strdup_string is set, then
  47 * string is copied; otherwise the new string_list_entry refers to the
  48 * input string.
  49 */
  50struct string_list_item *string_list_append(struct string_list *list, const char *string);
  51
  52/*
  53 * Like string_list_append(), except string is never copied.  When
  54 * list->strdup_strings is set, this function can be used to hand
  55 * ownership of a malloc()ed string to list without making an extra
  56 * copy.
  57 */
  58struct string_list_item *string_list_append_nodup(struct string_list *list, char *string);
  59
  60void sort_string_list(struct string_list *list);
  61int unsorted_string_list_has_string(struct string_list *list, const char *string);
  62struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
  63                                                     const char *string);
  64
  65void unsorted_string_list_delete_item(struct string_list *list, int i, int free_util);
  66#endif /* STRING_LIST_H */