[thirdparty/systemd.git] / src / basic / strv.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once

#include <fnmatch.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>

#include "alloc-util.h"
#include "extract-word.h"
#include "hashmap.h"
#include "macro.h"
#include "string-util.h"

char* strv_find(char * const *l, const char *name) _pure_;
char* strv_find_case(char * const *l, const char *name) _pure_;
char* strv_find_prefix(char * const *l, const char *name) _pure_;
char* strv_find_startswith(char * const *l, const char *name) _pure_;

#define strv_contains(l, s) (!!strv_find((l), (s)))
#define strv_contains_case(l, s) (!!strv_find_case((l), (s)))

char** strv_free(char **l);
DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
#define _cleanup_strv_free_ _cleanup_(strv_freep)

char** strv_free_erase(char **l);
DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
#define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)

char** strv_copy(char * const *l);
size_t strv_length(char * const *l) _pure_;

int strv_extend_strv(char ***a, char * const *b, bool filter_duplicates);
int strv_extend_strv_concat(char ***a, char * const *b, const char *suffix);
int strv_prepend(char ***l, const char *value);

/* _with_size() are lower-level functions where the size can be provided externally,
 * which allows us to skip iterating over the strv to find the end, which saves
 * a bit of time and reduces the complexity of appending from O(n²) to O(n). */

int strv_extend_with_size(char ***l, size_t *n, const char *value);
static inline int strv_extend(char ***l, const char *value) {
        return strv_extend_with_size(l, NULL, value);
}

int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
int strv_extend_front(char ***l, const char *value);

int strv_push_with_size(char ***l, size_t *n, char *value);
static inline int strv_push(char ***l, char *value) {
        return strv_push_with_size(l, NULL, value);
}
int strv_push_pair(char ***l, char *a, char *b);

int strv_insert(char ***l, size_t position, char *value);

static inline int strv_push_prepend(char ***l, char *value) {
        return strv_insert(l, 0, value);
}

int strv_consume_with_size(char ***l, size_t *n, char *value);
static inline int strv_consume(char ***l, char *value) {
        return strv_consume_with_size(l, NULL, value);
}

int strv_consume_pair(char ***l, char *a, char *b);
int strv_consume_prepend(char ***l, char *value);

char** strv_remove(char **l, const char *s);
char** strv_uniq(char **l);
bool strv_is_uniq(char * const *l);

int strv_compare(char * const *a, char * const *b);
static inline bool strv_equal(char * const *a, char * const *b) {
        return strv_compare(a, b) == 0;
}

char** strv_new_internal(const char *x, ...) _sentinel_;
char** strv_new_ap(const char *x, va_list ap);
#define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)

#define STRV_IGNORE ((const char *) POINTER_MAX)

static inline const char* STRV_IFNOTNULL(const char *x) {
        return x ? x : STRV_IGNORE;
}

static inline bool strv_isempty(char * const *l) {
        return !l || !*l;
}

int strv_split_full(char ***t, const char *s, const char *separators, ExtractFlags flags);
static inline char** strv_split(const char *s, const char *separators) {
        char **ret;

        if (strv_split_full(&ret, s, separators, EXTRACT_RETAIN_ESCAPE) < 0)
                return NULL;

        return ret;
}

int strv_split_and_extend_full(char ***t, const char *s, const char *separators, bool filter_duplicates, ExtractFlags flags);
#define strv_split_and_extend(t, s, sep, dup) strv_split_and_extend_full(t, s, sep, dup, 0)

int strv_split_newlines_full(char ***ret, const char *s, ExtractFlags flags);
static inline char** strv_split_newlines(const char *s) {
        char **ret;

        if (strv_split_newlines_full(&ret, s, 0) < 0)
                return NULL;

        return ret;
}

/* Given a string containing white-space separated tuples of words themselves separated by ':',
 * returns a vector of strings. If the second element in a tuple is missing, the corresponding
 * string in the vector is an empty string. */
int strv_split_colon_pairs(char ***t, const char *s);

char* strv_join_full(char * const *l, const char *separator, const char *prefix, bool escape_separator);
static inline char *strv_join(char * const *l, const char *separator) {
        return strv_join_full(l, separator, NULL, false);
}

bool strv_overlap(char * const *a, char * const *b) _pure_;

#define _STRV_FOREACH_BACKWARDS(s, l, h, i)                             \
        for (typeof(*(l)) *s, *h = (l), *i = ({                         \
                                size_t _len = strv_length(h);           \
                                _len > 0 ? h + _len - 1 : NULL;         \
                        });                                             \
             (s = i);                                                   \
             i = PTR_SUB1(i, h))

#define STRV_FOREACH_BACKWARDS(s, l)                                    \
        _STRV_FOREACH_BACKWARDS(s, l, UNIQ_T(h, UNIQ), UNIQ_T(i, UNIQ))

#define _STRV_FOREACH_PAIR(x, y, l, i)                          \
        for (typeof(*l) *x, *y, *i = (l);                       \
             i && *(x = i) && *(y = i + 1);                     \
             i += 2)

#define STRV_FOREACH_PAIR(x, y, l)                      \
        _STRV_FOREACH_PAIR(x, y, l, UNIQ_T(i, UNIQ))

char** strv_sort(char **l);
void strv_print(char * const *l);

#define strv_from_stdarg_alloca(first)                          \
        ({                                                      \
                char **_l;                                      \
                                                                \
                if (!first)                                     \
                        _l = (char**) &first;                   \
                else {                                          \
                        size_t _n;                              \
                        va_list _ap;                            \
                                                                \
                        _n = 1;                                 \
                        va_start(_ap, first);                   \
                        while (va_arg(_ap, char*))              \
                                _n++;                           \
                        va_end(_ap);                            \
                                                                \
                        _l = newa(char*, _n+1);                 \
                        _l[_n = 0] = (char*) first;             \
                        va_start(_ap, first);                   \
                        for (;;) {                              \
                                _l[++_n] = va_arg(_ap, char*);  \
                                if (!_l[_n])                    \
                                        break;                  \
                        }                                       \
                        va_end(_ap);                            \
                }                                               \
                _l;                                             \
        })

#define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
#define STRPTR_IN_SET(x, ...)                                    \
        ({                                                       \
                const char* _x = (x);                            \
                _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
        })

#define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
#define STRCASEPTR_IN_SET(x, ...)                                    \
        ({                                                       \
                const char* _x = (x);                            \
                _x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
        })

#define STARTSWITH_SET(p, ...)                                  \
        ({                                                      \
                const char *_p = (p);                           \
                char *_found = NULL;                            \
                STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
                        _found = startswith(_p, *_i);           \
                        if (_found)                             \
                                break;                          \
                }                                               \
                _found;                                         \
        })

#define ENDSWITH_SET(p, ...)                                    \
        ({                                                      \
                const char *_p = (p);                           \
                char *_found = NULL;                            \
                STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
                        _found = endswith(_p, *_i);             \
                        if (_found)                             \
                                break;                          \
                }                                               \
                _found;                                         \
        })

#define _FOREACH_STRING(uniq, x, y, ...)                                \
        for (const char *x, * const*UNIQ_T(l, uniq) = STRV_MAKE_CONST(({ x = y; }), ##__VA_ARGS__); \
             x;                                                         \
             x = *(++UNIQ_T(l, uniq)))

#define FOREACH_STRING(x, y, ...)                       \
        _FOREACH_STRING(UNIQ, x, y, ##__VA_ARGS__)

char** strv_reverse(char **l);
char** strv_shell_escape(char **l, const char *bad);

bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *ret_matched_pos);
static inline bool strv_fnmatch(char* const* patterns, const char *s) {
        return strv_fnmatch_full(patterns, s, 0, NULL);
}

static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
        assert(s);
        return strv_isempty(patterns) ||
               strv_fnmatch_full(patterns, s, flags, NULL);
}

char** strv_skip(char **l, size_t n);

int strv_extend_n(char ***l, const char *value, size_t n);

int fputstrv(FILE *f, char * const *l, const char *separator, bool *space);

#define strv_free_and_replace(a, b)             \
        free_and_replace_full(a, b, strv_free)

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