Merge tag 'v2.14.1'
[git/raj.git] / string-list.h
blob29bfb7ae45931686e14c91b1a47a703e7b32fe52
1 #ifndef STRING_LIST_H
2 #define STRING_LIST_H
4 struct string_list_item {
5 char *string;
6 void *util;
7 };
9 typedef int (*compare_strings_fn)(const char *, const char *);
11 struct 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() */
18 #define STRING_LIST_INIT_NODUP { NULL, 0, 0, 0, NULL }
19 #define STRING_LIST_INIT_DUP { NULL, 0, 0, 1, NULL }
21 void string_list_init(struct string_list *list, int strdup_strings);
23 void print_string_list(const struct string_list *p, const char *text);
24 void string_list_clear(struct string_list *list, int free_util);
26 /* Use this function to call a custom clear function on each util pointer */
27 /* The string associated with the util pointer is passed as the second argument */
28 typedef void (*string_list_clear_func_t)(void *p, const char *str);
29 void string_list_clear_func(struct string_list *list, string_list_clear_func_t clearfunc);
31 /* Use this function or the macro below to iterate over each item */
32 typedef int (*string_list_each_func_t)(struct string_list_item *, void *);
33 int for_each_string_list(struct string_list *list,
34 string_list_each_func_t, void *cb_data);
35 #define for_each_string_list_item(item,list) \
36 for (item = (list)->items; item < (list)->items + (list)->nr; ++item)
39 * Apply want to each item in list, retaining only the ones for which
40 * the function returns true. If free_util is true, call free() on
41 * the util members of any items that have to be deleted. Preserve
42 * the order of the items that are retained.
44 void filter_string_list(struct string_list *list, int free_util,
45 string_list_each_func_t want, void *cb_data);
48 * Remove any empty strings from the list. If free_util is true, call
49 * free() on the util members of any items that have to be deleted.
50 * Preserve the order of the items that are retained.
52 void string_list_remove_empty_items(struct string_list *list, int free_util);
54 /* Use these functions only on sorted lists: */
55 int string_list_has_string(const struct string_list *list, const char *string);
56 int string_list_find_insert_index(const struct string_list *list, const char *string,
57 int negative_existing_index);
59 * Inserts the given string into the sorted list.
60 * If the string already exists, the list is not altered.
61 * Returns the string_list_item, the string is part of.
63 struct string_list_item *string_list_insert(struct string_list *list, const char *string);
66 * Removes the given string from the sorted list.
67 * If the string doesn't exist, the list is not altered.
69 extern void string_list_remove(struct string_list *list, const char *string,
70 int free_util);
73 * Checks if the given string is part of a sorted list. If it is part of the list,
74 * return the coresponding string_list_item, NULL otherwise.
76 struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
79 * Remove all but the first of consecutive entries with the same
80 * string value. If free_util is true, call free() on the util
81 * members of any items that have to be deleted.
83 void string_list_remove_duplicates(struct string_list *sorted_list, int free_util);
86 /* Use these functions only on unsorted lists: */
89 * Add string to the end of list. If list->strdup_string is set, then
90 * string is copied; otherwise the new string_list_entry refers to the
91 * input string.
93 struct string_list_item *string_list_append(struct string_list *list, const char *string);
96 * Like string_list_append(), except string is never copied. When
97 * list->strdup_strings is set, this function can be used to hand
98 * ownership of a malloc()ed string to list without making an extra
99 * copy.
101 struct string_list_item *string_list_append_nodup(struct string_list *list, char *string);
103 void string_list_sort(struct string_list *list);
104 int unsorted_string_list_has_string(struct string_list *list, const char *string);
105 struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
106 const char *string);
108 void unsorted_string_list_delete_item(struct string_list *list, int i, int free_util);
111 * Split string into substrings on character delim and append the
112 * substrings to list. The input string is not modified.
113 * list->strdup_strings must be set, as new memory needs to be
114 * allocated to hold the substrings. If maxsplit is non-negative,
115 * then split at most maxsplit times. Return the number of substrings
116 * appended to list.
118 * Examples:
119 * string_list_split(l, "foo:bar:baz", ':', -1) -> ["foo", "bar", "baz"]
120 * string_list_split(l, "foo:bar:baz", ':', 0) -> ["foo:bar:baz"]
121 * string_list_split(l, "foo:bar:baz", ':', 1) -> ["foo", "bar:baz"]
122 * string_list_split(l, "foo:bar:", ':', -1) -> ["foo", "bar", ""]
123 * string_list_split(l, "", ':', -1) -> [""]
124 * string_list_split(l, ":", ':', -1) -> ["", ""]
126 int string_list_split(struct string_list *list, const char *string,
127 int delim, int maxsplit);
130 * Like string_list_split(), except that string is split in-place: the
131 * delimiter characters in string are overwritten with NULs, and the
132 * new string_list_items point into string (which therefore must not
133 * be modified or freed while the string_list is in use).
134 * list->strdup_strings must *not* be set.
136 int string_list_split_in_place(struct string_list *list, char *string,
137 int delim, int maxsplit);
138 #endif /* STRING_LIST_H */