1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include <fnmatch.h>
5 #include <stdarg.h>
6 #include <stdbool.h>
7 #include <stddef.h>
8 #include <stdio.h>
9
10 #include "alloc-util.h"
11 #include "extract-word.h"
12 #include "hashmap.h"
13 #include "macro.h"
14 #include "string-util.h"
15
16 char* strv_find(char * const *l, const char *name) _pure_;
17 char* strv_find_case(char * const *l, const char *name) _pure_;
18 char* strv_find_prefix(char * const *l, const char *name) _pure_;
19 char* strv_find_startswith(char * const *l, const char *name) _pure_;
20
21 #define strv_contains(l, s) (!!strv_find((l), (s)))
22 #define strv_contains_case(l, s) (!!strv_find_case((l), (s)))
23
24 char** strv_free(char **l);
25 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
26 #define _cleanup_strv_free_ _cleanup_(strv_freep)
27
28 char** strv_free_erase(char **l);
29 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
30 #define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)
31
32 char** strv_copy(char * const *l);
33 size_t strv_length(char * const *l) _pure_;
34
35 int strv_extend_strv(char ***a, char * const *b, bool filter_duplicates);
36 int strv_extend_strv_concat(char ***a, char * const *b, const char *suffix);
37 int strv_prepend(char ***l, const char *value);
38 int strv_extend(char ***l, const char *value);
39 int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
40 int strv_extend_front(char ***l, const char *value);
41 int strv_push(char ***l, char *value);
42 int strv_push_pair(char ***l, char *a, char *b);
43 int strv_insert(char ***l, size_t position, char *value);
44
strv_push_prepend(char *** l,char * value)45 static inline int strv_push_prepend(char ***l, char *value) {
46 return strv_insert(l, 0, value);
47 }
48
49 int strv_consume(char ***l, char *value);
50 int strv_consume_pair(char ***l, char *a, char *b);
51 int strv_consume_prepend(char ***l, char *value);
52
53 char** strv_remove(char **l, const char *s);
54 char** strv_uniq(char **l);
55 bool strv_is_uniq(char * const *l);
56
57 int strv_compare(char * const *a, char * const *b);
strv_equal(char * const * a,char * const * b)58 static inline bool strv_equal(char * const *a, char * const *b) {
59 return strv_compare(a, b) == 0;
60 }
61
62 char** strv_new_internal(const char *x, ...) _sentinel_;
63 char** strv_new_ap(const char *x, va_list ap);
64 #define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)
65
66 #define STRV_IGNORE ((const char *) POINTER_MAX)
67
STRV_IFNOTNULL(const char * x)68 static inline const char* STRV_IFNOTNULL(const char *x) {
69 return x ? x : STRV_IGNORE;
70 }
71
strv_isempty(char * const * l)72 static inline bool strv_isempty(char * const *l) {
73 return !l || !*l;
74 }
75
76 int strv_split_full(char ***t, const char *s, const char *separators, ExtractFlags flags);
strv_split(const char * s,const char * separators)77 static inline char** strv_split(const char *s, const char *separators) {
78 char **ret;
79
80 if (strv_split_full(&ret, s, separators, EXTRACT_RETAIN_ESCAPE) < 0)
81 return NULL;
82
83 return ret;
84 }
85
86 int strv_split_and_extend_full(char ***t, const char *s, const char *separators, bool filter_duplicates, ExtractFlags flags);
87 #define strv_split_and_extend(t, s, sep, dup) strv_split_and_extend_full(t, s, sep, dup, 0)
88
89 int strv_split_newlines_full(char ***ret, const char *s, ExtractFlags flags);
strv_split_newlines(const char * s)90 static inline char** strv_split_newlines(const char *s) {
91 char **ret;
92
93 if (strv_split_newlines_full(&ret, s, 0) < 0)
94 return NULL;
95
96 return ret;
97 }
98
99 /* Given a string containing white-space separated tuples of words themselves separated by ':',
100 * returns a vector of strings. If the second element in a tuple is missing, the corresponding
101 * string in the vector is an empty string. */
102 int strv_split_colon_pairs(char ***t, const char *s);
103
104 char* strv_join_full(char * const *l, const char *separator, const char *prefix, bool escape_separator);
strv_join(char * const * l,const char * separator)105 static inline char *strv_join(char * const *l, const char *separator) {
106 return strv_join_full(l, separator, NULL, false);
107 }
108
109 char** strv_parse_nulstr(const char *s, size_t l);
110 char** strv_split_nulstr(const char *s);
111 int strv_make_nulstr(char * const *l, char **p, size_t *n);
112
strv_from_nulstr(char *** a,const char * nulstr)113 static inline int strv_from_nulstr(char ***a, const char *nulstr) {
114 char **t;
115
116 t = strv_split_nulstr(nulstr);
117 if (!t)
118 return -ENOMEM;
119 *a = t;
120 return 0;
121 }
122
123 bool strv_overlap(char * const *a, char * const *b) _pure_;
124
125 #define _STRV_FOREACH(s, l, i) \
126 for (typeof(*(l)) *s, *i = (l); (s = i) && *i; i++)
127
128 #define STRV_FOREACH(s, l) \
129 _STRV_FOREACH(s, l, UNIQ_T(i, UNIQ))
130
131 #define _STRV_FOREACH_BACKWARDS(s, l, h, i) \
132 for (typeof(*(l)) *s, *h = (l), *i = ({ \
133 size_t _len = strv_length(h); \
134 _len > 0 ? h + _len - 1 : NULL; \
135 }); \
136 (s = i); \
137 i = PTR_SUB1(i, h))
138
139 #define STRV_FOREACH_BACKWARDS(s, l) \
140 _STRV_FOREACH_BACKWARDS(s, l, UNIQ_T(h, UNIQ), UNIQ_T(i, UNIQ))
141
142 #define _STRV_FOREACH_PAIR(x, y, l, i) \
143 for (typeof(*l) *x, *y, *i = (l); \
144 i && *(x = i) && *(y = i + 1); \
145 i += 2)
146
147 #define STRV_FOREACH_PAIR(x, y, l) \
148 _STRV_FOREACH_PAIR(x, y, l, UNIQ_T(i, UNIQ))
149
150 char** strv_sort(char **l);
151 void strv_print(char * const *l);
152
153 #define strv_from_stdarg_alloca(first) \
154 ({ \
155 char **_l; \
156 \
157 if (!first) \
158 _l = (char**) &first; \
159 else { \
160 size_t _n; \
161 va_list _ap; \
162 \
163 _n = 1; \
164 va_start(_ap, first); \
165 while (va_arg(_ap, char*)) \
166 _n++; \
167 va_end(_ap); \
168 \
169 _l = newa(char*, _n+1); \
170 _l[_n = 0] = (char*) first; \
171 va_start(_ap, first); \
172 for (;;) { \
173 _l[++_n] = va_arg(_ap, char*); \
174 if (!_l[_n]) \
175 break; \
176 } \
177 va_end(_ap); \
178 } \
179 _l; \
180 })
181
182 #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
183 #define STRPTR_IN_SET(x, ...) \
184 ({ \
185 const char* _x = (x); \
186 _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
187 })
188
189 #define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
190 #define STRCASEPTR_IN_SET(x, ...) \
191 ({ \
192 const char* _x = (x); \
193 _x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
194 })
195
196 #define STARTSWITH_SET(p, ...) \
197 ({ \
198 const char *_p = (p); \
199 char *_found = NULL; \
200 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) { \
201 _found = startswith(_p, *_i); \
202 if (_found) \
203 break; \
204 } \
205 _found; \
206 })
207
208 #define ENDSWITH_SET(p, ...) \
209 ({ \
210 const char *_p = (p); \
211 char *_found = NULL; \
212 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) { \
213 _found = endswith(_p, *_i); \
214 if (_found) \
215 break; \
216 } \
217 _found; \
218 })
219
220 #define _FOREACH_STRING(uniq, x, y, ...) \
221 for (const char *x, * const*UNIQ_T(l, uniq) = STRV_MAKE_CONST(({ x = y; }), ##__VA_ARGS__); \
222 x; \
223 x = *(++UNIQ_T(l, uniq)))
224
225 #define FOREACH_STRING(x, y, ...) \
226 _FOREACH_STRING(UNIQ, x, y, ##__VA_ARGS__)
227
228 char** strv_reverse(char **l);
229 char** strv_shell_escape(char **l, const char *bad);
230
231 bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *matched_pos);
strv_fnmatch(char * const * patterns,const char * s)232 static inline bool strv_fnmatch(char* const* patterns, const char *s) {
233 return strv_fnmatch_full(patterns, s, 0, NULL);
234 }
235
strv_fnmatch_or_empty(char * const * patterns,const char * s,int flags)236 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
237 assert(s);
238 return strv_isempty(patterns) ||
239 strv_fnmatch_full(patterns, s, flags, NULL);
240 }
241
242 char** strv_skip(char **l, size_t n);
243
244 int strv_extend_n(char ***l, const char *value, size_t n);
245
246 int fputstrv(FILE *f, char * const *l, const char *separator, bool *space);
247
248 #define strv_free_and_replace(a, b) \
249 ({ \
250 char ***_a = &(a); \
251 char ***_b = &(b); \
252 strv_free(*_a); \
253 (*_a) = (*_b); \
254 (*_b) = NULL; \
255 0; \
256 })
257
258 extern const struct hash_ops string_strv_hash_ops;
259 int _string_strv_hashmap_put(Hashmap **h, const char *key, const char *value HASHMAP_DEBUG_PARAMS);
260 int _string_strv_ordered_hashmap_put(OrderedHashmap **h, const char *key, const char *value HASHMAP_DEBUG_PARAMS);
261 #define string_strv_hashmap_put(h, k, v) _string_strv_hashmap_put(h, k, v HASHMAP_DEBUG_SRC_ARGS)
262 #define string_strv_ordered_hashmap_put(h, k, v) _string_strv_ordered_hashmap_put(h, k, v HASHMAP_DEBUG_SRC_ARGS)
263