Merge branch 'jn/gitweb-system-config'
[git] / string-list.h
1 #ifndef STRING_LIST_H
2 #define STRING_LIST_H
3
4 struct string_list_item {
5         char *string;
6         void *util;
7 };
8 struct 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
17 void print_string_list(const struct string_list *p, const char *text);
18 void 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 */
22 typedef void (*string_list_clear_func_t)(void *p, const char *str);
23 void 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 */
26 typedef int (*string_list_each_func_t)(struct string_list_item *, void *);
27 int 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 /* Use these functions only on sorted lists: */
33 int string_list_has_string(const struct string_list *list, const char *string);
34 int string_list_find_insert_index(const struct string_list *list, const char *string,
35                                   int negative_existing_index);
36 struct string_list_item *string_list_insert(struct string_list *list, const char *string);
37 struct string_list_item *string_list_insert_at_index(struct string_list *list,
38                                                      int insert_at, const char *string);
39 struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
40
41 /* Use these functions only on unsorted lists: */
42 struct string_list_item *string_list_append(struct string_list *list, const char *string);
43 void sort_string_list(struct string_list *list);
44 int unsorted_string_list_has_string(struct string_list *list, const char *string);
45 struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
46                                                      const char *string);
47 #endif /* STRING_LIST_H */