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/>.
22 #include "system/locale.h"
28 * @brief String list manipulation
32 build an empty (only NULL terminated) list of strings (for expansion with str_list_add() etc)
34 _PUBLIC_ char **str_list_make_empty(TALLOC_CTX *mem_ctx)
38 ret = talloc_array(mem_ctx, char *, 1);
49 place the only element 'entry' into a new, NULL terminated string list
51 _PUBLIC_ char **str_list_make_single(TALLOC_CTX *mem_ctx, const char *entry)
55 ret = talloc_array(mem_ctx, char *, 2);
60 ret[0] = talloc_strdup(ret, entry);
71 build a null terminated list of strings from a input string and a
72 separator list. The separator list must contain characters less than
73 or equal to 0x2f for this to work correctly on multi-byte strings
75 _PUBLIC_ char **str_list_make(TALLOC_CTX *mem_ctx, const char *string, const char *sep)
84 ret = talloc_array(mem_ctx, char *, 1);
89 while (string && *string) {
90 size_t len = strcspn(string, sep);
94 string += strspn(string, sep);
98 ret2 = talloc_realloc(mem_ctx, ret, char *, num_elements+2);
105 ret[num_elements] = talloc_strndup(ret, string, len);
106 if (ret[num_elements] == NULL) {
115 ret[num_elements] = NULL;
121 * build a null terminated list of strings from an argv-like input string
122 * Entries are seperated by spaces and can be enclosed by quotes.
123 * Does NOT support escaping
125 _PUBLIC_ const char **str_list_make_shell(TALLOC_CTX *mem_ctx, const char *string, const char *sep)
127 int num_elements = 0;
128 const char **ret = NULL;
130 ret = talloc_array(mem_ctx, const char *, 1);
138 while (string && *string) {
139 size_t len = strcspn(string, sep);
144 string += strspn(string, sep);
148 if (*string == '\"') {
150 len = strcspn(string, "\"");
151 element = talloc_strndup(ret, string, len);
154 element = talloc_strndup(ret, string, len);
158 if (element == NULL) {
163 ret2 = talloc_realloc(mem_ctx, ret, const char *, num_elements+2);
170 ret[num_elements] = element;
175 ret[num_elements] = NULL;
182 * join a list back to one string
184 _PUBLIC_ char *str_list_join(TALLOC_CTX *mem_ctx, const char **list, char seperator)
190 return talloc_strdup(mem_ctx, "");
192 ret = talloc_strdup(mem_ctx, list[0]);
194 for (i = 1; list[i]; i++) {
195 ret = talloc_asprintf_append_buffer(ret, "%c%s", seperator, list[i]);
201 /** join a list back to one (shell-like) string; entries
202 * seperated by spaces, using quotes where necessary */
203 _PUBLIC_ char *str_list_join_shell(TALLOC_CTX *mem_ctx, const char **list, char sep)
209 return talloc_strdup(mem_ctx, "");
211 if (strchr(list[0], ' ') || strlen(list[0]) == 0)
212 ret = talloc_asprintf(mem_ctx, "\"%s\"", list[0]);
214 ret = talloc_strdup(mem_ctx, list[0]);
216 for (i = 1; list[i]; i++) {
217 if (strchr(list[i], ' ') || strlen(list[i]) == 0)
218 ret = talloc_asprintf_append_buffer(ret, "%c\"%s\"", sep, list[i]);
220 ret = talloc_asprintf_append_buffer(ret, "%c%s", sep, list[i]);
227 return the number of elements in a string list
229 _PUBLIC_ size_t str_list_length(const char * const *list)
232 for (ret=0;list && list[ret];ret++) /* noop */ ;
240 _PUBLIC_ char **str_list_copy(TALLOC_CTX *mem_ctx, const char **list)
248 ret = talloc_array(mem_ctx, char *, str_list_length(list)+1);
252 for (i=0;list && list[i];i++) {
253 ret[i] = talloc_strdup(ret, list[i]);
254 if (ret[i] == NULL) {
264 Return true if all the elements of the list match exactly.
266 _PUBLIC_ bool str_list_equal(const char **list1, const char **list2)
270 if (list1 == NULL || list2 == NULL) {
271 return (list1 == list2);
274 for (i=0;list1[i] && list2[i];i++) {
275 if (strcmp(list1[i], list2[i]) != 0) {
279 if (list1[i] || list2[i]) {
287 add an entry to a string list
289 _PUBLIC_ const char **str_list_add(const char **list, const char *s)
291 size_t len = str_list_length(list);
294 ret = talloc_realloc(NULL, list, const char *, len+2);
295 if (ret == NULL) return NULL;
297 ret[len] = talloc_strdup(ret, s);
298 if (ret[len] == NULL) return NULL;
306 remove an entry from a string list
308 _PUBLIC_ void str_list_remove(const char **list, const char *s)
312 for (i=0;list[i];i++) {
313 if (strcmp(list[i], s) == 0) break;
315 if (!list[i]) return;
324 return true if a string is in a list
326 _PUBLIC_ bool str_list_check(const char **list, const char *s)
330 for (i=0;list[i];i++) {
331 if (strcmp(list[i], s) == 0) return true;
337 return true if a string is in a list, case insensitively
339 _PUBLIC_ bool str_list_check_ci(const char **list, const char *s)
343 for (i=0;list[i];i++) {
344 if (strcasecmp(list[i], s) == 0) return true;
351 append one list to another - expanding list1
353 _PUBLIC_ char **str_list_append(const char **list1, const char * const *list2)
355 size_t len1 = str_list_length(list1);
356 size_t len2 = str_list_length(list2);
360 ret = talloc_realloc(NULL, list1, char *, len1+len2+1);
361 if (ret == NULL) return NULL;
363 for (i=len1;i<len1+len2;i++) {
364 ret[i] = talloc_strdup(ret, list2[i-len1]);
365 if (ret[i] == NULL) {
374 static int list_cmp(const char **el1, const char **el2)
376 return strcmp(*el1, *el2);
380 return a list that only contains the unique elements of a list,
381 removing any duplicates
383 _PUBLIC_ const char **str_list_unique(const char **list)
385 size_t len = str_list_length(list);
391 list2 = (const char **)talloc_memdup(list, list,
392 sizeof(list[0])*(len+1));
393 qsort(list2, len, sizeof(list2[0]), QSORT_CAST list_cmp);
395 for (i=j=1;i<len;i++) {
396 if (strcmp(list2[i], list[j-1]) != 0) {
402 list = talloc_realloc(NULL, list, const char *, j);
408 very useful when debugging complex list related code
410 _PUBLIC_ void str_list_show(const char **list)
414 for (i=0;list && list[i];i++) {
415 DEBUG(0,("\"%s\", ", list[i]));
423 append one list to another - expanding list1
424 this assumes the elements of list2 are const pointers, so we can re-use them
426 _PUBLIC_ const char **str_list_append_const(const char **list1,
429 size_t len1 = str_list_length(list1);
430 size_t len2 = str_list_length(list2);
434 ret = talloc_realloc(NULL, list1, const char *, len1+len2+1);
435 if (ret == NULL) return NULL;
437 for (i=len1;i<len1+len2;i++) {
438 ret[i] = list2[i-len1];
446 add an entry to a string list
447 this assumes s will not change
449 _PUBLIC_ const char **str_list_add_const(const char **list, const char *s)
451 size_t len = str_list_length(list);
454 ret = talloc_realloc(NULL, list, const char *, len+2);
455 if (ret == NULL) return NULL;
465 this assumes list will not change
467 _PUBLIC_ const char **str_list_copy_const(TALLOC_CTX *mem_ctx,
476 ret = talloc_array(mem_ctx, const char *, str_list_length(list)+1);
480 for (i=0;list && list[i];i++) {