]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
c2f1db8f | 2 | #pragma once |
60918275 | 3 | |
84ac7bea | 4 | #include <fnmatch.h> |
15ae422b LP |
5 | #include <stdarg.h> |
6 | #include <stdbool.h> | |
11c3a366 | 7 | #include <stddef.h> |
ca78ad1d | 8 | #include <stdio.h> |
15ae422b | 9 | |
11c3a366 | 10 | #include "alloc-util.h" |
93cc7779 | 11 | #include "extract-word.h" |
cde79109 | 12 | #include "hashmap.h" |
11c3a366 | 13 | #include "macro.h" |
8059aa9c | 14 | #include "string-util.h" |
60918275 | 15 | |
14337c37 ZJS |
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_; | |
2ed74695 LB |
20 | /* Given two vectors, the first a list of keys and the second a list of key-value pairs, returns the value |
21 | * of the first key from the first vector that is found in the second vector. */ | |
22 | char* strv_find_first_field(char * const *needles, char * const *haystack) _pure_; | |
a4bfb399 | 23 | |
ddd6a22a LP |
24 | #define strv_contains(l, s) (!!strv_find((l), (s))) |
25 | #define strv_contains_case(l, s) (!!strv_find_case((l), (s))) | |
26 | ||
14337c37 | 27 | char** strv_free(char **l); |
14bf2c9d | 28 | DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free); |
dfb33a97 LP |
29 | #define _cleanup_strv_free_ _cleanup_(strv_freep) |
30 | ||
14337c37 | 31 | char** strv_free_erase(char **l); |
ab84f5b9 ZJS |
32 | DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase); |
33 | #define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep) | |
34 | ||
a39cba25 LB |
35 | void strv_free_many(char ***strvs, size_t n); |
36 | ||
4ea517a6 LP |
37 | char** strv_copy_n(char * const *l, size_t n); |
38 | static inline char** strv_copy(char * const *l) { | |
39 | return strv_copy_n(l, SIZE_MAX); | |
40 | } | |
da6053d0 | 41 | size_t strv_length(char * const *l) _pure_; |
60918275 | 42 | |
479ddcdf YW |
43 | int strv_extend_strv(char ***a, char * const *b, bool filter_duplicates); |
44 | int strv_extend_strv_concat(char ***a, char * const *b, const char *suffix); | |
82443be5 | 45 | int strv_prepend(char ***l, const char *value); |
3ec3ae68 ZJS |
46 | |
47 | /* _with_size() are lower-level functions where the size can be provided externally, | |
48 | * which allows us to skip iterating over the strv to find the end, which saves | |
49 | * a bit of time and reduces the complexity of appending from O(n²) to O(n). */ | |
50 | ||
51 | int strv_extend_with_size(char ***l, size_t *n, const char *value); | |
52 | static inline int strv_extend(char ***l, const char *value) { | |
53 | return strv_extend_with_size(l, NULL, value); | |
54 | } | |
55 | ||
400102ec | 56 | int strv_extendf(char ***l, const char *format, ...) _printf_(2,3); |
4f4afc88 | 57 | int strv_extend_front(char ***l, const char *value); |
3ec3ae68 ZJS |
58 | |
59 | int strv_push_with_size(char ***l, size_t *n, char *value); | |
60 | static inline int strv_push(char ***l, char *value) { | |
61 | return strv_push_with_size(l, NULL, value); | |
62 | } | |
98940a3c | 63 | int strv_push_pair(char ***l, char *a, char *b); |
3ec3ae68 | 64 | |
da6053d0 | 65 | int strv_insert(char ***l, size_t position, char *value); |
6e888894 ZJS |
66 | |
67 | static inline int strv_push_prepend(char ***l, char *value) { | |
68 | return strv_insert(l, 0, value); | |
69 | } | |
70 | ||
3ec3ae68 ZJS |
71 | int strv_consume_with_size(char ***l, size_t *n, char *value); |
72 | static inline int strv_consume(char ***l, char *value) { | |
73 | return strv_consume_with_size(l, NULL, value); | |
74 | } | |
75 | ||
98940a3c | 76 | int strv_consume_pair(char ***l, char *a, char *b); |
9a00f57a | 77 | int strv_consume_prepend(char ***l, char *value); |
034c6ed7 | 78 | |
14337c37 ZJS |
79 | char** strv_remove(char **l, const char *s); |
80 | char** strv_uniq(char **l); | |
479ddcdf | 81 | bool strv_is_uniq(char * const *l); |
5f9a22c3 | 82 | |
8b75798d YW |
83 | int strv_compare(char * const *a, char * const *b); |
84 | static inline bool strv_equal(char * const *a, char * const *b) { | |
85 | return strv_compare(a, b) == 0; | |
86 | } | |
0f84a72e | 87 | |
14337c37 ZJS |
88 | char** strv_new_internal(const char *x, ...) _sentinel_; |
89 | char** strv_new_ap(const char *x, va_list ap); | |
bea1a013 | 90 | #define strv_new(...) strv_new_internal(__VA_ARGS__, NULL) |
60918275 | 91 | |
66032ef4 | 92 | #define STRV_IGNORE ((const char *) POINTER_MAX) |
f9d14060 | 93 | |
07719a21 | 94 | static inline const char* STRV_IFNOTNULL(const char *x) { |
1da3cb81 | 95 | return x ?: STRV_IGNORE; |
07719a21 LP |
96 | } |
97 | ||
2fd9ae2e | 98 | static inline bool strv_isempty(char * const *l) { |
5f9a22c3 LP |
99 | return !l || !*l; |
100 | } | |
101 | ||
90e30d76 | 102 | int strv_split_full(char ***t, const char *s, const char *separators, ExtractFlags flags); |
14337c37 | 103 | static inline char** strv_split(const char *s, const char *separators) { |
0645b83a | 104 | char **ret; |
0645b83a | 105 | |
b38a9d2d | 106 | if (strv_split_full(&ret, s, separators, EXTRACT_RETAIN_ESCAPE) < 0) |
f385c447 YW |
107 | return NULL; |
108 | ||
109 | return ret; | |
110 | } | |
111 | ||
3c318caa FS |
112 | int strv_split_and_extend_full(char ***t, const char *s, const char *separators, bool filter_duplicates, ExtractFlags flags); |
113 | #define strv_split_and_extend(t, s, sep, dup) strv_split_and_extend_full(t, s, sep, dup, 0) | |
114 | ||
f385c447 | 115 | int strv_split_newlines_full(char ***ret, const char *s, ExtractFlags flags); |
14337c37 | 116 | static inline char** strv_split_newlines(const char *s) { |
f385c447 YW |
117 | char **ret; |
118 | ||
119 | if (strv_split_newlines_full(&ret, s, 0) < 0) | |
0645b83a ZJS |
120 | return NULL; |
121 | ||
122 | return ret; | |
123 | } | |
f88e6be5 | 124 | |
a082edd5 LB |
125 | /* Given a string containing white-space separated tuples of words themselves separated by ':', |
126 | * returns a vector of strings. If the second element in a tuple is missing, the corresponding | |
127 | * string in the vector is an empty string. */ | |
128 | int strv_split_colon_pairs(char ***t, const char *s); | |
129 | ||
e5f2d77b | 130 | char* strv_join_full(char * const *l, const char *separator, const char *prefix, bool escape_separator); |
479ddcdf | 131 | static inline char *strv_join(char * const *l, const char *separator) { |
d4d9f034 | 132 | return strv_join_full(l, separator, NULL, false); |
2b9a7d2e | 133 | } |
5f9a22c3 | 134 | |
479ddcdf | 135 | bool strv_overlap(char * const *a, char * const *b) _pure_; |
0c85a4f3 | 136 | |
de010b0b YW |
137 | #define _STRV_FOREACH_BACKWARDS(s, l, h, i) \ |
138 | for (typeof(*(l)) *s, *h = (l), *i = ({ \ | |
139 | size_t _len = strv_length(h); \ | |
140 | _len > 0 ? h + _len - 1 : NULL; \ | |
141 | }); \ | |
9b01798b | 142 | (s = i); \ |
3e3ee420 | 143 | i = PTR_SUB1(i, h)) |
de010b0b YW |
144 | |
145 | #define STRV_FOREACH_BACKWARDS(s, l) \ | |
146 | _STRV_FOREACH_BACKWARDS(s, l, UNIQ_T(h, UNIQ), UNIQ_T(i, UNIQ)) | |
60918275 | 147 | |
de010b0b YW |
148 | #define _STRV_FOREACH_PAIR(x, y, l, i) \ |
149 | for (typeof(*l) *x, *y, *i = (l); \ | |
150 | i && *(x = i) && *(y = i + 1); \ | |
151 | i += 2) | |
857a493d | 152 | |
de010b0b YW |
153 | #define STRV_FOREACH_PAIR(x, y, l) \ |
154 | _STRV_FOREACH_PAIR(x, y, l, UNIQ_T(i, UNIQ)) | |
246aa6dd | 155 | |
14337c37 | 156 | char** strv_sort(char **l); |
00546c18 YW |
157 | void strv_print_full(char * const *l, const char *prefix); |
158 | static inline void strv_print(char * const *l) { | |
159 | strv_print_full(l, NULL); | |
160 | } | |
250a918d | 161 | |
eba8b541 MY |
162 | char* startswith_strv(const char *s, char * const *l); |
163 | ||
164 | #define STARTSWITH_SET(p, ...) \ | |
165 | startswith_strv(p, STRV_MAKE(__VA_ARGS__)) | |
166 | ||
2e6f012b MY |
167 | char* endswith_strv(const char *s, char * const *l); |
168 | ||
169 | #define ENDSWITH_SET(p, ...) \ | |
170 | endswith_strv(p, STRV_MAKE(__VA_ARGS__)) | |
171 | ||
250a918d LP |
172 | #define strv_from_stdarg_alloca(first) \ |
173 | ({ \ | |
174 | char **_l; \ | |
175 | \ | |
176 | if (!first) \ | |
897e7561 | 177 | _l = (char**) &first; \ |
250a918d | 178 | else { \ |
da6053d0 | 179 | size_t _n; \ |
250a918d LP |
180 | va_list _ap; \ |
181 | \ | |
182 | _n = 1; \ | |
183 | va_start(_ap, first); \ | |
184 | while (va_arg(_ap, char*)) \ | |
185 | _n++; \ | |
186 | va_end(_ap); \ | |
187 | \ | |
188 | _l = newa(char*, _n+1); \ | |
189 | _l[_n = 0] = (char*) first; \ | |
190 | va_start(_ap, first); \ | |
191 | for (;;) { \ | |
192 | _l[++_n] = va_arg(_ap, char*); \ | |
193 | if (!_l[_n]) \ | |
194 | break; \ | |
195 | } \ | |
196 | va_end(_ap); \ | |
197 | } \ | |
198 | _l; \ | |
199 | }) | |
53ede806 LP |
200 | |
201 | #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x) | |
c7bf9d51 ZJS |
202 | #define STRPTR_IN_SET(x, ...) \ |
203 | ({ \ | |
204 | const char* _x = (x); \ | |
205 | _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \ | |
206 | }) | |
c4a7b2c5 | 207 | |
ddd6a22a LP |
208 | #define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x) |
209 | #define STRCASEPTR_IN_SET(x, ...) \ | |
210 | ({ \ | |
211 | const char* _x = (x); \ | |
212 | _x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \ | |
213 | }) | |
214 | ||
f85b12d6 | 215 | #define _FOREACH_STRING(uniq, x, y, ...) \ |
5980d463 | 216 | for (const char *x, * const*UNIQ_T(l, uniq) = STRV_MAKE_CONST(({ x = y; }), ##__VA_ARGS__); \ |
66a64081 | 217 | x; \ |
f85b12d6 LP |
218 | x = *(++UNIQ_T(l, uniq))) |
219 | ||
220 | #define FOREACH_STRING(x, y, ...) \ | |
221 | _FOREACH_STRING(UNIQ, x, y, ##__VA_ARGS__) | |
e1dd6790 | 222 | |
14337c37 ZJS |
223 | char** strv_reverse(char **l); |
224 | char** strv_shell_escape(char **l, const char *bad); | |
bceccd5e | 225 | |
bcfc0e88 | 226 | bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *ret_matched_pos); |
191a3f16 ZJS |
227 | static inline bool strv_fnmatch(char* const* patterns, const char *s) { |
228 | return strv_fnmatch_full(patterns, s, 0, NULL); | |
0ef84b80 | 229 | } |
bceccd5e | 230 | |
2404701e | 231 | static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) { |
bceccd5e ZJS |
232 | assert(s); |
233 | return strv_isempty(patterns) || | |
191a3f16 | 234 | strv_fnmatch_full(patterns, s, flags, NULL); |
bceccd5e | 235 | } |
fe382237 | 236 | |
14337c37 | 237 | char** strv_skip(char **l, size_t n); |
8dd4c05b LP |
238 | |
239 | int strv_extend_n(char ***l, const char *value, size_t n); | |
3df9bec5 | 240 | |
6658f7c7 DDM |
241 | int strv_extend_assignment(char ***l, const char *lhs, const char *rhs); |
242 | ||
479ddcdf | 243 | int fputstrv(FILE *f, char * const *l, const char *separator, bool *space); |
b302a50d LP |
244 | |
245 | #define strv_free_and_replace(a, b) \ | |
fc4c10b2 | 246 | free_and_replace_full(a, b, strv_free) |
cde79109 ZJS |
247 | |
248 | extern const struct hash_ops string_strv_hash_ops; | |
856e5195 ZJS |
249 | int _string_strv_hashmap_put(Hashmap **h, const char *key, const char *value HASHMAP_DEBUG_PARAMS); |
250 | int _string_strv_ordered_hashmap_put(OrderedHashmap **h, const char *key, const char *value HASHMAP_DEBUG_PARAMS); | |
251 | #define string_strv_hashmap_put(h, k, v) _string_strv_hashmap_put(h, k, v HASHMAP_DEBUG_SRC_ARGS) | |
252 | #define string_strv_ordered_hashmap_put(h, k, v) _string_strv_ordered_hashmap_put(h, k, v HASHMAP_DEBUG_SRC_ARGS) |