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