blob: 63b69c8d75ee33120a65a23598ddf93e84831bdd [file] [log] [blame]
Thiago Farina0afcb5f2010-01-08 17:45:08 -05001#ifndef STRING_LIST_H
2#define STRING_LIST_H
Johannes Schindelinc455c872008-07-21 19:03:49 +01003
4struct string_list_item {
5 char *string;
6 void *util;
7};
8struct string_list
9{
10 struct string_list_item *items;
11 unsigned int nr, alloc;
12 unsigned int strdup_strings:1;
13};
14
15void print_string_list(const char *text, const struct string_list *p);
16void string_list_clear(struct string_list *list, int free_util);
17
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010018/* Use this function to call a custom clear function on each util pointer */
19/* The string associated with the util pointer is passed as the second argument */
20typedef void (*string_list_clear_func_t)(void *p, const char *str);
21void string_list_clear_func(struct string_list *list, string_list_clear_func_t clearfunc);
22
Jay Soffianc6f5a7a2009-02-25 03:32:18 -050023/* Use this function to iterate over each item */
24typedef int (*string_list_each_func_t)(struct string_list_item *, void *);
25int for_each_string_list(string_list_each_func_t,
26 struct string_list *list, void *cb_data);
27
Johannes Schindelinc455c872008-07-21 19:03:49 +010028/* Use these functions only on sorted lists: */
29int string_list_has_string(const struct string_list *list, const char *string);
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010030int string_list_find_insert_index(const struct string_list *list, const char *string,
31 int negative_existing_index);
Johannes Schindelinc455c872008-07-21 19:03:49 +010032struct string_list_item *string_list_insert(const char *string, struct string_list *list);
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010033struct string_list_item *string_list_insert_at_index(int insert_at,
34 const char *string, struct string_list *list);
Johannes Schindelinc455c872008-07-21 19:03:49 +010035struct string_list_item *string_list_lookup(const char *string, struct string_list *list);
36
37/* Use these functions only on unsorted lists: */
38struct string_list_item *string_list_append(const char *string, struct string_list *list);
39void sort_string_list(struct string_list *list);
40int unsorted_string_list_has_string(struct string_list *list, const char *string);
Stephen Boyde2421482010-03-24 00:16:02 -070041struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
42 const char *string);
Thiago Farina0afcb5f2010-01-08 17:45:08 -050043#endif /* STRING_LIST_H */