Documentation/describe: improve one-line summary
[git.git] / string-list.h
blob494eb5d95de0e5e8d69705f7a6f4fe2efcb232ad
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);
58 struct string_list_item *string_list_insert(struct string_list *list, const char *string);
59 struct string_list_item *string_list_insert_at_index(struct string_list *list,
60 int insert_at, const char *string);
61 struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
64 * Remove all but the first of consecutive entries with the same
65 * string value. If free_util is true, call free() on the util
66 * members of any items that have to be deleted.
68 void string_list_remove_duplicates(struct string_list *sorted_list, int free_util);
71 /* Use these functions only on unsorted lists: */
74 * Add string to the end of list. If list->strdup_string is set, then
75 * string is copied; otherwise the new string_list_entry refers to the
76 * input string.
78 struct string_list_item *string_list_append(struct string_list *list, const char *string);
81 * Like string_list_append(), except string is never copied. When
82 * list->strdup_strings is set, this function can be used to hand
83 * ownership of a malloc()ed string to list without making an extra
84 * copy.
86 struct string_list_item *string_list_append_nodup(struct string_list *list, char *string);
88 void sort_string_list(struct string_list *list);
89 int unsorted_string_list_has_string(struct string_list *list, const char *string);
90 struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
91 const char *string);
93 void unsorted_string_list_delete_item(struct string_list *list, int i, int free_util);
96 * Split string into substrings on character delim and append the
97 * substrings to list. The input string is not modified.
98 * list->strdup_strings must be set, as new memory needs to be
99 * allocated to hold the substrings. If maxsplit is non-negative,
100 * then split at most maxsplit times. Return the number of substrings
101 * appended to list.
103 * Examples:
104 * string_list_split(l, "foo:bar:baz", ':', -1) -> ["foo", "bar", "baz"]
105 * string_list_split(l, "foo:bar:baz", ':', 0) -> ["foo:bar:baz"]
106 * string_list_split(l, "foo:bar:baz", ':', 1) -> ["foo", "bar:baz"]
107 * string_list_split(l, "foo:bar:", ':', -1) -> ["foo", "bar", ""]
108 * string_list_split(l, "", ':', -1) -> [""]
109 * string_list_split(l, ":", ':', -1) -> ["", ""]
111 int string_list_split(struct string_list *list, const char *string,
112 int delim, int maxsplit);
115 * Like string_list_split(), except that string is split in-place: the
116 * delimiter characters in string are overwritten with NULs, and the
117 * new string_list_items point into string (which therefore must not
118 * be modified or freed while the string_list is in use).
119 * list->strdup_strings must *not* be set.
121 int string_list_split_in_place(struct string_list *list, char *string,
122 int delim, int maxsplit);
123 #endif /* STRING_LIST_H */