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