blob: 0684cb73bfd27846182479a4e192d682a44f201a [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};
Jonathan Nieder9cba13c2011-03-16 02:08:34 -05008struct string_list {
Johannes Schindelinc455c872008-07-21 19:03:49 +01009 struct string_list_item *items;
10 unsigned int nr, alloc;
11 unsigned int strdup_strings:1;
12};
13
Thiago Farina183113a2010-07-04 16:46:19 -030014#define STRING_LIST_INIT_NODUP { NULL, 0, 0, 0 }
15#define STRING_LIST_INIT_DUP { NULL, 0, 0, 1 }
16
Julian Phillipscb944f62010-06-26 00:41:33 +010017void print_string_list(const struct string_list *p, const char *text);
Johannes Schindelinc455c872008-07-21 19:03:49 +010018void string_list_clear(struct string_list *list, int free_util);
19
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010020/* 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
Alex Riesen8d316352010-07-03 14:40:04 +020025/* Use this function or the macro below to iterate over each item */
Jay Soffianc6f5a7a2009-02-25 03:32:18 -050026typedef int (*string_list_each_func_t)(struct string_list_item *, void *);
Julian Phillipsb684e972010-06-26 00:41:34 +010027int for_each_string_list(struct string_list *list,
28 string_list_each_func_t, void *cb_data);
Alex Riesen8d316352010-07-03 14:40:04 +020029#define for_each_string_list_item(item,list) \
30 for (item = (list)->items; item < (list)->items + (list)->nr; ++item)
Jay Soffianc6f5a7a2009-02-25 03:32:18 -050031
Johannes Schindelinc455c872008-07-21 19:03:49 +010032/* Use these functions only on sorted lists: */
33int string_list_has_string(const struct string_list *list, const char *string);
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010034int string_list_find_insert_index(const struct string_list *list, const char *string,
35 int negative_existing_index);
Julian Phillips78a395d2010-06-26 00:41:35 +010036struct string_list_item *string_list_insert(struct string_list *list, const char *string);
Julian Phillipsaadceea2010-06-26 00:41:36 +010037struct string_list_item *string_list_insert_at_index(struct string_list *list,
38 int insert_at, const char *string);
Julian Phillipse8c8b712010-06-26 00:41:37 +010039struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
Johannes Schindelinc455c872008-07-21 19:03:49 +010040
41/* Use these functions only on unsorted lists: */
Julian Phillips1d2f80f2010-06-26 00:41:38 +010042struct string_list_item *string_list_append(struct string_list *list, const char *string);
Johannes Schindelinc455c872008-07-21 19:03:49 +010043void sort_string_list(struct string_list *list);
44int unsorted_string_list_has_string(struct string_list *list, const char *string);
Stephen Boyde2421482010-03-24 00:16:02 -070045struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
46 const char *string);
Johannes Sixt86d4b522011-08-11 23:20:00 -060047void unsorted_string_list_delete_item(struct string_list *list, int i, int free_util);
Thiago Farina0afcb5f2010-01-08 17:45:08 -050048#endif /* STRING_LIST_H */