s3: Attempt to fix the build on NetBSD
[Samba/gebeck_regimport.git] / lib / util / util_strlist.c
blob953862da85fab967cc53bc76bb33f091e886d208
1 /*
2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 2005
5 Copyright (C) Jelmer Vernooij 2005
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "includes.h"
22 #include "system/locale.h"
23 #include "lib/util/tsort.h"
25 #undef strcasecmp
27 /**
28 * @file
29 * @brief String list manipulation
32 /**
33 build an empty (only NULL terminated) list of strings (for expansion with str_list_add() etc)
35 _PUBLIC_ char **str_list_make_empty(TALLOC_CTX *mem_ctx)
37 char **ret = NULL;
39 ret = talloc_array(mem_ctx, char *, 1);
40 if (ret == NULL) {
41 return NULL;
44 ret[0] = NULL;
46 return ret;
49 /**
50 place the only element 'entry' into a new, NULL terminated string list
52 _PUBLIC_ char **str_list_make_single(TALLOC_CTX *mem_ctx, const char *entry)
54 char **ret = NULL;
56 ret = talloc_array(mem_ctx, char *, 2);
57 if (ret == NULL) {
58 return NULL;
61 ret[0] = talloc_strdup(ret, entry);
62 if (!ret[0]) {
63 talloc_free(ret);
64 return NULL;
66 ret[1] = NULL;
68 return ret;
71 /**
72 build a null terminated list of strings from a input string and a
73 separator list. The separator list must contain characters less than
74 or equal to 0x2f for this to work correctly on multi-byte strings
76 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep)
78 int num_elements = 0;
79 char **ret = NULL;
81 if (sep == NULL) {
82 sep = LIST_SEP;
85 ret = talloc_array(mem_ctx, char *, 1);
86 if (ret == NULL) {
87 return NULL;
90 while (string && *string) {
91 size_t len = strcspn(string, sep);
92 char **ret2;
94 if (len == 0) {
95 string += strspn(string, sep);
96 continue;
99 ret2 = talloc_realloc(mem_ctx, ret, char *,
100 num_elements+2);
101 if (ret2 == NULL) {
102 talloc_free(ret);
103 return NULL;
105 ret = ret2;
107 ret[num_elements] = talloc_strndup(ret, string, len);
108 if (ret[num_elements] == NULL) {
109 talloc_free(ret);
110 return NULL;
113 num_elements++;
114 string += len;
117 ret[num_elements] = NULL;
119 return ret;
123 * build a null terminated list of strings from an argv-like input string
124 * Entries are separated by spaces and can be enclosed by quotes.
125 * Does NOT support escaping
127 _PUBLIC_ char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep)
129 int num_elements = 0;
130 char **ret = NULL;
132 ret = talloc_array(mem_ctx, char *, 1);
133 if (ret == NULL) {
134 return NULL;
137 if (sep == NULL)
138 sep = " \t\n\r";
140 while (string && *string) {
141 size_t len = strcspn(string, sep);
142 char *element;
143 char **ret2;
145 if (len == 0) {
146 string += strspn(string, sep);
147 continue;
150 if (*string == '\"') {
151 string++;
152 len = strcspn(string, "\"");
153 element = talloc_strndup(ret, string, len);
154 string += len + 1;
155 } else {
156 element = talloc_strndup(ret, string, len);
157 string += len;
160 if (element == NULL) {
161 talloc_free(ret);
162 return NULL;
165 ret2 = talloc_realloc(mem_ctx, ret, char *, num_elements+2);
166 if (ret2 == NULL) {
167 talloc_free(ret);
168 return NULL;
170 ret = ret2;
172 ret[num_elements] = element;
174 num_elements++;
177 ret[num_elements] = NULL;
179 return ret;
184 * join a list back to one string
186 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char separator)
188 char *ret = NULL;
189 int i;
191 if (list[0] == NULL)
192 return talloc_strdup(mem_ctx, "");
194 ret = talloc_strdup(mem_ctx, list[0]);
196 for (i = 1; list[i]; i++) {
197 ret = talloc_asprintf_append_buffer(ret, "%c%s", separator, list[i]);
200 return ret;
203 /** join a list back to one (shell-like) string; entries
204 * separated by spaces, using quotes where necessary */
205 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep)
207 char *ret = NULL;
208 int i;
210 if (list[0] == NULL)
211 return talloc_strdup(mem_ctx, "");
213 if (strchr(list[0], ' ') || strlen(list[0]) == 0)
214 ret = talloc_asprintf(mem_ctx, "\"%s\"", list[0]);
215 else
216 ret = talloc_strdup(mem_ctx, list[0]);
218 for (i = 1; list[i]; i++) {
219 if (strchr(list[i], ' ') || strlen(list[i]) == 0)
220 ret = talloc_asprintf_append_buffer(ret, "%c\"%s\"", sep, list[i]);
221 else
222 ret = talloc_asprintf_append_buffer(ret, "%c%s", sep, list[i]);
225 return ret;
229 return the number of elements in a string list
231 _PUBLIC_ size_t str_list_length(const char * const *list)
233 size_t ret;
234 for (ret=0;list && list[ret];ret++) /* noop */ ;
235 return ret;
240 copy a string list
242 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list)
244 int i;
245 char **ret;
247 if (list == NULL)
248 return NULL;
250 ret = talloc_array(mem_ctx, char *, str_list_length(list)+1);
251 if (ret == NULL)
252 return NULL;
254 for (i=0;list && list[i];i++) {
255 ret[i] = talloc_strdup(ret, list[i]);
256 if (ret[i] == NULL) {
257 talloc_free(ret);
258 return NULL;
261 ret[i] = NULL;
262 return ret;
266 Return true if all the elements of the list match exactly.
268 _PUBLIC_ bool str_list_equal(const char * const *list1,
269 const char * const *list2)
271 int i;
273 if (list1 == NULL || list2 == NULL) {
274 return (list1 == list2);
277 for (i=0;list1[i] && list2[i];i++) {
278 if (strcmp(list1[i], list2[i]) != 0) {
279 return false;
282 if (list1[i] || list2[i]) {
283 return false;
285 return true;
290 add an entry to a string list
292 _PUBLIC_ const char **str_list_add(const char **list, const char *s)
294 size_t len = str_list_length(list);
295 const char **ret;
297 ret = talloc_realloc(NULL, list, const char *, len+2);
298 if (ret == NULL) return NULL;
300 ret[len] = talloc_strdup(ret, s);
301 if (ret[len] == NULL) return NULL;
303 ret[len+1] = NULL;
305 return ret;
309 remove an entry from a string list
311 _PUBLIC_ void str_list_remove(const char **list, const char *s)
313 int i;
315 for (i=0;list[i];i++) {
316 if (strcmp(list[i], s) == 0) break;
318 if (!list[i]) return;
320 for (;list[i];i++) {
321 list[i] = list[i+1];
327 return true if a string is in a list
329 _PUBLIC_ bool str_list_check(const char **list, const char *s)
331 int i;
333 for (i=0;list[i];i++) {
334 if (strcmp(list[i], s) == 0) return true;
336 return false;
340 return true if a string is in a list, case insensitively
342 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s)
344 int i;
346 for (i=0;list[i];i++) {
347 if (strcasecmp(list[i], s) == 0) return true;
349 return false;
354 append one list to another - expanding list1
356 _PUBLIC_ const char **str_list_append(const char **list1,
357 const char * const *list2)
359 size_t len1 = str_list_length(list1);
360 size_t len2 = str_list_length(list2);
361 const char **ret;
362 int i;
364 ret = talloc_realloc(NULL, list1, const char *, len1+len2+1);
365 if (ret == NULL) return NULL;
367 for (i=len1;i<len1+len2;i++) {
368 ret[i] = talloc_strdup(ret, list2[i-len1]);
369 if (ret[i] == NULL) {
370 return NULL;
373 ret[i] = NULL;
375 return ret;
378 static int list_cmp(const char **el1, const char **el2)
380 return strcmp(*el1, *el2);
384 return a list that only contains the unique elements of a list,
385 removing any duplicates
387 _PUBLIC_ const char **str_list_unique(const char **list)
389 size_t len = str_list_length(list);
390 const char **list2;
391 int i, j;
392 if (len < 2) {
393 return list;
395 list2 = (const char **)talloc_memdup(list, list,
396 sizeof(list[0])*(len+1));
397 TYPESAFE_QSORT(list2, len, list_cmp);
398 list[0] = list2[0];
399 for (i=j=1;i<len;i++) {
400 if (strcmp(list2[i], list[j-1]) != 0) {
401 list[j] = list2[i];
402 j++;
405 list[j] = NULL;
406 list = talloc_realloc(NULL, list, const char *, j + 1);
407 talloc_free(list2);
408 return list;
412 very useful when debugging complex list related code
414 _PUBLIC_ void str_list_show(const char **list)
416 int i;
417 DEBUG(0,("{ "));
418 for (i=0;list && list[i];i++) {
419 DEBUG(0,("\"%s\", ", list[i]));
421 DEBUG(0,("}\n"));
427 append one list to another - expanding list1
428 this assumes the elements of list2 are const pointers, so we can re-use them
430 _PUBLIC_ const char **str_list_append_const(const char **list1,
431 const char **list2)
433 size_t len1 = str_list_length(list1);
434 size_t len2 = str_list_length(list2);
435 const char **ret;
436 int i;
438 ret = talloc_realloc(NULL, list1, const char *, len1+len2+1);
439 if (ret == NULL) return NULL;
441 for (i=len1;i<len1+len2;i++) {
442 ret[i] = list2[i-len1];
444 ret[i] = NULL;
446 return ret;
450 add an entry to a string list
451 this assumes s will not change
453 _PUBLIC_ const char **str_list_add_const(const char **list, const char *s)
455 size_t len = str_list_length(list);
456 const char **ret;
458 ret = talloc_realloc(NULL, list, const char *, len+2);
459 if (ret == NULL) return NULL;
461 ret[len] = s;
462 ret[len+1] = NULL;
464 return ret;
468 copy a string list
469 this assumes list will not change
471 _PUBLIC_ const char **str_list_copy_const(TALLOC_CTX *mem_ctx,
472 const char **list)
474 int i;
475 const char **ret;
477 if (list == NULL)
478 return NULL;
480 ret = talloc_array(mem_ctx, const char *, str_list_length(list)+1);
481 if (ret == NULL)
482 return NULL;
484 for (i=0;list && list[i];i++) {
485 ret[i] = list[i];
487 ret[i] = NULL;
488 return ret;
492 * Needed for making an "unconst" list "const"
494 _PUBLIC_ const char **const_str_list(char **list)
496 return (const char **)list;