4 struct string_list_item
{
9 struct string_list_item
*items
;
10 unsigned int nr
, alloc
;
11 unsigned int strdup_strings
:1;
14 #define STRING_LIST_INIT_NODUP { NULL, 0, 0, 0 }
15 #define STRING_LIST_INIT_DUP { NULL, 0, 0, 1 }
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
);
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
);
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)
33 * Apply want to each item in list, retaining only the ones for which
34 * the function returns true. If free_util is true, call free() on
35 * the util members of any items that have to be deleted. Preserve
36 * the order of the items that are retained.
38 void filter_string_list(struct string_list
*list
, int free_util
,
39 string_list_each_func_t want
, void *cb_data
);
42 * Remove any empty strings from the list. If free_util is true, call
43 * free() on the util members of any items that have to be deleted.
44 * Preserve the order of the items that are retained.
46 void string_list_remove_empty_items(struct string_list
*list
, int free_util
);
49 * Return the longest string in prefixes that is a prefix (in the
50 * sense of prefixcmp()) of string, or NULL if no such prefix exists.
51 * This function does not require the string_list to be sorted (it
52 * does a linear search).
54 char *string_list_longest_prefix(const struct string_list
*prefixes
, const char *string
);
57 /* Use these functions only on sorted lists: */
58 int string_list_has_string(const struct string_list
*list
, const char *string
);
59 int string_list_find_insert_index(const struct string_list
*list
, const char *string
,
60 int negative_existing_index
);
61 struct string_list_item
*string_list_insert(struct string_list
*list
, const char *string
);
62 struct string_list_item
*string_list_insert_at_index(struct string_list
*list
,
63 int insert_at
, const char *string
);
64 struct string_list_item
*string_list_lookup(struct string_list
*list
, const char *string
);
67 * Remove all but the first of consecutive entries with the same
68 * string value. If free_util is true, call free() on the util
69 * members of any items that have to be deleted.
71 void string_list_remove_duplicates(struct string_list
*sorted_list
, int free_util
);
74 /* Use these functions only on unsorted lists: */
77 * Add string to the end of list. If list->strdup_string is set, then
78 * string is copied; otherwise the new string_list_entry refers to the
81 struct string_list_item
*string_list_append(struct string_list
*list
, const char *string
);
84 * Like string_list_append(), except string is never copied. When
85 * list->strdup_strings is set, this function can be used to hand
86 * ownership of a malloc()ed string to list without making an extra
89 struct string_list_item
*string_list_append_nodup(struct string_list
*list
, char *string
);
91 void sort_string_list(struct string_list
*list
);
92 int unsorted_string_list_has_string(struct string_list
*list
, const char *string
);
93 struct string_list_item
*unsorted_string_list_lookup(struct string_list
*list
,
96 void unsorted_string_list_delete_item(struct string_list
*list
, int i
, int free_util
);
99 * Split string into substrings on character delim and append the
100 * substrings to list. The input string is not modified.
101 * list->strdup_strings must be set, as new memory needs to be
102 * allocated to hold the substrings. If maxsplit is non-negative,
103 * then split at most maxsplit times. Return the number of substrings
107 * string_list_split(l, "foo:bar:baz", ':', -1) -> ["foo", "bar", "baz"]
108 * string_list_split(l, "foo:bar:baz", ':', 0) -> ["foo:bar:baz"]
109 * string_list_split(l, "foo:bar:baz", ':', 1) -> ["foo", "bar:baz"]
110 * string_list_split(l, "foo:bar:", ':', -1) -> ["foo", "bar", ""]
111 * string_list_split(l, "", ':', -1) -> [""]
112 * string_list_split(l, ":", ':', -1) -> ["", ""]
114 int string_list_split(struct string_list
*list
, const char *string
,
115 int delim
, int maxsplit
);
118 * Like string_list_split(), except that string is split in-place: the
119 * delimiter characters in string are overwritten with NULs, and the
120 * new string_list_items point into string (which therefore must not
121 * be modified or freed while the string_list is in use).
122 * list->strdup_strings must *not* be set.
124 int string_list_split_in_place(struct string_list
*list
, char *string
,
125 int delim
, int maxsplit
);
126 #endif /* STRING_LIST_H */