prune_remote(): iterate using for_each_string_list_item()
[git/git.git] / string-list.h
CommitLineData
0afcb5f7
TF
1#ifndef STRING_LIST_H
2#define STRING_LIST_H
c455c87c
JS
3
4struct string_list_item {
5 char *string;
6 void *util;
7};
8dd5afc9
JH
8
9typedef int (*compare_strings_fn)(const char *, const char *);
10
9cba13ca 11struct string_list {
c455c87c
JS
12 struct string_list_item *items;
13 unsigned int nr, alloc;
14 unsigned int strdup_strings:1;
8dd5afc9 15 compare_strings_fn cmp; /* NULL uses strcmp() */
c455c87c
JS
16};
17
acb3d222
TA
18#define STRING_LIST_INIT_NODUP { NULL, 0, 0, 0, NULL }
19#define STRING_LIST_INIT_DUP { NULL, 0, 0, 1, NULL }
183113a5 20
3ed3f5fe
TA
21void string_list_init(struct string_list *list, int strdup_strings);
22
cb944f6b 23void print_string_list(const struct string_list *p, const char *text);
c455c87c
JS
24void string_list_clear(struct string_list *list, int free_util);
25
cfa1ee6b
MSO
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 */
28typedef void (*string_list_clear_func_t)(void *p, const char *str);
29void string_list_clear_func(struct string_list *list, string_list_clear_func_t clearfunc);
30
8d31635c 31/* Use this function or the macro below to iterate over each item */
c6f5a7a9 32typedef int (*string_list_each_func_t)(struct string_list_item *, void *);
b684e977
JP
33int for_each_string_list(struct string_list *list,
34 string_list_each_func_t, void *cb_data);
8d31635c
AR
35#define for_each_string_list_item(item,list) \
36 for (item = (list)->items; item < (list)->items + (list)->nr; ++item)
c6f5a7a9 37
eb5f0c7a
MH
38/*
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.
43 */
44void filter_string_list(struct string_list *list, int free_util,
45 string_list_each_func_t want, void *cb_data);
46
6bb2a137
MH
47/*
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.
51 */
52void string_list_remove_empty_items(struct string_list *list, int free_util);
53
c455c87c
JS
54/* Use these functions only on sorted lists: */
55int string_list_has_string(const struct string_list *list, const char *string);
cfa1ee6b
MSO
56int string_list_find_insert_index(const struct string_list *list, const char *string,
57 int negative_existing_index);
78a395d3 58struct string_list_item *string_list_insert(struct string_list *list, const char *string);
aadceea6
JP
59struct string_list_item *string_list_insert_at_index(struct string_list *list,
60 int insert_at, const char *string);
e8c8b713 61struct string_list_item *string_list_lookup(struct string_list *list, const char *string);
c455c87c 62
31d5451e
MH
63/*
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.
67 */
68void string_list_remove_duplicates(struct string_list *sorted_list, int free_util);
69
e448fed8 70
c455c87c 71/* Use these functions only on unsorted lists: */
e448fed8
MH
72
73/*
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.
77 */
1d2f80fa 78struct string_list_item *string_list_append(struct string_list *list, const char *string);
e448fed8
MH
79
80/*
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.
85 */
86struct string_list_item *string_list_append_nodup(struct string_list *list, char *string);
87
c455c87c
JS
88void sort_string_list(struct string_list *list);
89int unsorted_string_list_has_string(struct string_list *list, const char *string);
e2421480
SB
90struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
91 const char *string);
e448fed8 92
86d4b528 93void unsorted_string_list_delete_item(struct string_list *list, int i, int free_util);
ff919f96
MH
94
95/*
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.
102 *
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) -> ["", ""]
110 */
111int string_list_split(struct string_list *list, const char *string,
112 int delim, int maxsplit);
113
114/*
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.
120 */
121int string_list_split_in_place(struct string_list *list, char *string,
122 int delim, int maxsplit);
0afcb5f7 123#endif /* STRING_LIST_H */