blob: a917955fbd8d18956ae593b5fa190042e13db644 [file] [log] [blame]
Johannes Schindelinc455c872008-07-21 19:03:49 +01001#include "cache.h"
2#include "string-list.h"
3
Tanay Abhra3ed3f5f2014-07-18 02:18:59 -07004void string_list_init(struct string_list *list, int strdup_strings)
5{
6 memset(list, 0, sizeof(*list));
7 list->strdup_strings = strdup_strings;
8}
9
Johannes Schindelinc455c872008-07-21 19:03:49 +010010/* if there is no exact match, point to the index where the entry could be
11 * inserted */
12static int get_entry_index(const struct string_list *list, const char *string,
13 int *exact_match)
14{
15 int left = -1, right = list->nr;
Junio C Hamano8dd5afc2013-01-07 12:24:55 -080016 compare_strings_fn cmp = list->cmp ? list->cmp : strcmp;
Johannes Schindelinc455c872008-07-21 19:03:49 +010017
18 while (left + 1 < right) {
Derrick Stolee19716b22017-10-08 14:29:37 -040019 int middle = left + (right - left) / 2;
Junio C Hamano8dd5afc2013-01-07 12:24:55 -080020 int compare = cmp(string, list->items[middle].string);
Johannes Schindelinc455c872008-07-21 19:03:49 +010021 if (compare < 0)
22 right = middle;
23 else if (compare > 0)
24 left = middle;
25 else {
26 *exact_match = 1;
27 return middle;
28 }
29 }
30
31 *exact_match = 0;
32 return right;
33}
34
35/* returns -1-index if already exists */
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010036static int add_entry(int insert_at, struct string_list *list, const char *string)
Johannes Schindelinc455c872008-07-21 19:03:49 +010037{
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010038 int exact_match = 0;
39 int index = insert_at != -1 ? insert_at : get_entry_index(list, string, &exact_match);
Johannes Schindelinc455c872008-07-21 19:03:49 +010040
41 if (exact_match)
42 return -1 - index;
43
Jeff Hostetler950a2342017-04-14 19:51:52 +000044 ALLOC_GROW(list->items, list->nr+1, list->alloc);
Johannes Schindelinc455c872008-07-21 19:03:49 +010045 if (index < list->nr)
René Scharfef331ab92017-07-15 22:00:45 +020046 MOVE_ARRAY(list->items + index + 1, list->items + index,
47 list->nr - index);
Johannes Schindelinc455c872008-07-21 19:03:49 +010048 list->items[index].string = list->strdup_strings ?
49 xstrdup(string) : (char *)string;
50 list->items[index].util = NULL;
51 list->nr++;
52
53 return index;
54}
55
Julian Phillips78a395d2010-06-26 00:41:35 +010056struct string_list_item *string_list_insert(struct string_list *list, const char *string)
Johannes Schindelinc455c872008-07-21 19:03:49 +010057{
Stefan Bellerf8c4ab62014-11-24 13:22:04 -080058 int index = add_entry(-1, list, string);
Johannes Schindelinc455c872008-07-21 19:03:49 +010059
60 if (index < 0)
61 index = -1 - index;
62
63 return list->items + index;
64}
65
Brandon Williams3a300332017-04-19 16:13:21 -070066void string_list_remove(struct string_list *list, const char *string,
67 int free_util)
68{
69 int exact_match;
70 int i = get_entry_index(list, string, &exact_match);
71
72 if (exact_match) {
73 if (list->strdup_strings)
74 free(list->items[i].string);
75 if (free_util)
76 free(list->items[i].util);
77
78 list->nr--;
René Scharfef331ab92017-07-15 22:00:45 +020079 MOVE_ARRAY(list->items + i, list->items + i + 1, list->nr - i);
Brandon Williams3a300332017-04-19 16:13:21 -070080 }
81}
82
Johannes Schindelinc455c872008-07-21 19:03:49 +010083int string_list_has_string(const struct string_list *list, const char *string)
84{
85 int exact_match;
86 get_entry_index(list, string, &exact_match);
87 return exact_match;
88}
89
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +010090int string_list_find_insert_index(const struct string_list *list, const char *string,
91 int negative_existing_index)
92{
93 int exact_match;
94 int index = get_entry_index(list, string, &exact_match);
95 if (exact_match)
96 index = -1 - (negative_existing_index ? index : 0);
97 return index;
98}
99
Julian Phillipse8c8b712010-06-26 00:41:37 +0100100struct string_list_item *string_list_lookup(struct string_list *list, const char *string)
Johannes Schindelinc455c872008-07-21 19:03:49 +0100101{
102 int exact_match, i = get_entry_index(list, string, &exact_match);
103 if (!exact_match)
104 return NULL;
105 return list->items + i;
106}
107
Michael Haggerty31d54512012-09-12 16:04:45 +0200108void string_list_remove_duplicates(struct string_list *list, int free_util)
109{
110 if (list->nr > 1) {
111 int src, dst;
Junio C Hamano8dd5afc2013-01-07 12:24:55 -0800112 compare_strings_fn cmp = list->cmp ? list->cmp : strcmp;
Michael Haggerty31d54512012-09-12 16:04:45 +0200113 for (src = dst = 1; src < list->nr; src++) {
Junio C Hamano8dd5afc2013-01-07 12:24:55 -0800114 if (!cmp(list->items[dst - 1].string, list->items[src].string)) {
Michael Haggerty31d54512012-09-12 16:04:45 +0200115 if (list->strdup_strings)
116 free(list->items[src].string);
117 if (free_util)
118 free(list->items[src].util);
119 } else
120 list->items[dst++] = list->items[src];
121 }
122 list->nr = dst;
123 }
124}
125
Julian Phillipsb684e972010-06-26 00:41:34 +0100126int for_each_string_list(struct string_list *list,
127 string_list_each_func_t fn, void *cb_data)
Jay Soffianc6f5a7a2009-02-25 03:32:18 -0500128{
129 int i, ret = 0;
130 for (i = 0; i < list->nr; i++)
131 if ((ret = fn(&list->items[i], cb_data)))
132 break;
133 return ret;
134}
135
Michael Haggertyeb5f0c72012-09-12 16:04:44 +0200136void filter_string_list(struct string_list *list, int free_util,
137 string_list_each_func_t want, void *cb_data)
138{
139 int src, dst = 0;
140 for (src = 0; src < list->nr; src++) {
141 if (want(&list->items[src], cb_data)) {
142 list->items[dst++] = list->items[src];
143 } else {
144 if (list->strdup_strings)
145 free(list->items[src].string);
146 if (free_util)
147 free(list->items[src].util);
148 }
149 }
150 list->nr = dst;
151}
152
Michael Haggerty6bb2a132012-11-04 08:07:06 +0100153static int item_is_not_empty(struct string_list_item *item, void *unused)
154{
155 return *item->string != '\0';
156}
157
Nguyễn Thái Ngọc Duy3b335762018-12-09 11:25:21 +0100158void string_list_remove_empty_items(struct string_list *list, int free_util)
159{
Michael Haggerty6bb2a132012-11-04 08:07:06 +0100160 filter_string_list(list, free_util, item_is_not_empty, NULL);
161}
162
Johannes Schindelinc455c872008-07-21 19:03:49 +0100163void string_list_clear(struct string_list *list, int free_util)
164{
165 if (list->items) {
166 int i;
167 if (list->strdup_strings) {
168 for (i = 0; i < list->nr; i++)
169 free(list->items[i].string);
170 }
171 if (free_util) {
172 for (i = 0; i < list->nr; i++)
173 free(list->items[i].util);
174 }
175 free(list->items);
176 }
177 list->items = NULL;
178 list->nr = list->alloc = 0;
179}
180
Marius Storm-Olsencfa1ee62009-02-08 15:34:28 +0100181void string_list_clear_func(struct string_list *list, string_list_clear_func_t clearfunc)
182{
183 if (list->items) {
184 int i;
185 if (clearfunc) {
186 for (i = 0; i < list->nr; i++)
187 clearfunc(list->items[i].util, list->items[i].string);
188 }
189 if (list->strdup_strings) {
190 for (i = 0; i < list->nr; i++)
191 free(list->items[i].string);
192 }
193 free(list->items);
194 }
195 list->items = NULL;
196 list->nr = list->alloc = 0;
197}
198
Michael Haggertye448fed2012-09-12 16:04:42 +0200199struct string_list_item *string_list_append_nodup(struct string_list *list,
200 char *string)
Johannes Schindelinc455c872008-07-21 19:03:49 +0100201{
Michael Haggertye448fed2012-09-12 16:04:42 +0200202 struct string_list_item *retval;
Johannes Schindelinc455c872008-07-21 19:03:49 +0100203 ALLOC_GROW(list->items, list->nr + 1, list->alloc);
Michael Haggertye448fed2012-09-12 16:04:42 +0200204 retval = &list->items[list->nr++];
205 retval->string = string;
206 retval->util = NULL;
207 return retval;
208}
209
210struct string_list_item *string_list_append(struct string_list *list,
211 const char *string)
212{
213 return string_list_append_nodup(
214 list,
215 list->strdup_strings ? xstrdup(string) : (char *)string);
Johannes Schindelinc455c872008-07-21 19:03:49 +0100216}
217
Beat Bollib6d3f5a2018-07-09 21:25:36 +0200218/*
219 * Encapsulate the compare function pointer because ISO C99 forbids
220 * casting from void * to a function pointer and vice versa.
221 */
222struct string_list_sort_ctx
223{
224 compare_strings_fn cmp;
225};
226
René Scharfe5ebd9472017-01-22 18:57:09 +0100227static int cmp_items(const void *a, const void *b, void *ctx)
Johannes Schindelinc455c872008-07-21 19:03:49 +0100228{
Beat Bollib6d3f5a2018-07-09 21:25:36 +0200229 struct string_list_sort_ctx *sort_ctx = ctx;
Johannes Schindelinc455c872008-07-21 19:03:49 +0100230 const struct string_list_item *one = a;
231 const struct string_list_item *two = b;
Beat Bollib6d3f5a2018-07-09 21:25:36 +0200232 return sort_ctx->cmp(one->string, two->string);
Johannes Schindelinc455c872008-07-21 19:03:49 +0100233}
234
Michael Haggerty3383e192014-11-25 09:02:35 +0100235void string_list_sort(struct string_list *list)
Johannes Schindelinc455c872008-07-21 19:03:49 +0100236{
Beat Bollib6d3f5a2018-07-09 21:25:36 +0200237 struct string_list_sort_ctx sort_ctx = {list->cmp ? list->cmp : strcmp};
238
239 QSORT_S(list->items, list->nr, cmp_items, &sort_ctx);
Johannes Schindelinc455c872008-07-21 19:03:49 +0100240}
241
Stephen Boyde2421482010-03-24 00:16:02 -0700242struct string_list_item *unsorted_string_list_lookup(struct string_list *list,
243 const char *string)
Johannes Schindelinc455c872008-07-21 19:03:49 +0100244{
Ralf Thielowd16df0c2016-04-25 19:40:00 +0200245 struct string_list_item *item;
Junio C Hamano8dd5afc2013-01-07 12:24:55 -0800246 compare_strings_fn cmp = list->cmp ? list->cmp : strcmp;
247
Ralf Thielowd16df0c2016-04-25 19:40:00 +0200248 for_each_string_list_item(item, list)
249 if (!cmp(string, item->string))
250 return item;
Stephen Boyde2421482010-03-24 00:16:02 -0700251 return NULL;
252}
253
254int unsorted_string_list_has_string(struct string_list *list,
255 const char *string)
256{
257 return unsorted_string_list_lookup(list, string) != NULL;
Johannes Schindelinc455c872008-07-21 19:03:49 +0100258}
259
Johannes Sixt86d4b522011-08-11 23:20:00 -0600260void unsorted_string_list_delete_item(struct string_list *list, int i, int free_util)
261{
262 if (list->strdup_strings)
263 free(list->items[i].string);
264 if (free_util)
265 free(list->items[i].util);
266 list->items[i] = list->items[list->nr-1];
267 list->nr--;
268}
Michael Haggertyff919f92012-09-12 16:04:43 +0200269
270int string_list_split(struct string_list *list, const char *string,
271 int delim, int maxsplit)
272{
273 int count = 0;
274 const char *p = string, *end;
275
276 if (!list->strdup_strings)
277 die("internal error in string_list_split(): "
278 "list->strdup_strings must be set");
279 for (;;) {
280 count++;
281 if (maxsplit >= 0 && count > maxsplit) {
282 string_list_append(list, p);
283 return count;
284 }
285 end = strchr(p, delim);
286 if (end) {
287 string_list_append_nodup(list, xmemdupz(p, end - p));
288 p = end + 1;
289 } else {
290 string_list_append(list, p);
291 return count;
292 }
293 }
294}
295
296int string_list_split_in_place(struct string_list *list, char *string,
297 int delim, int maxsplit)
298{
299 int count = 0;
300 char *p = string, *end;
301
302 if (list->strdup_strings)
303 die("internal error in string_list_split_in_place(): "
304 "list->strdup_strings must not be set");
305 for (;;) {
306 count++;
307 if (maxsplit >= 0 && count > maxsplit) {
308 string_list_append(list, p);
309 return count;
310 }
311 end = strchr(p, delim);
312 if (end) {
313 *end = '\0';
314 string_list_append(list, p);
315 p = end + 1;
316 } else {
317 string_list_append(list, p);
318 return count;
319 }
320 }
321}