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

/* SPDX-License-Identifier: LGPL-2.1+ */
#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_extend(char ***l, const char *value);
int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
int strv_extend_front(char ***l, const char *value);
int strv_push(char ***l, char *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(char ***l, char *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 *) -1)

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;
}

char **strv_split_newlines(const char *s);

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;
        int r;

        r = strv_split_full(&ret, s, separators, 0);
        if (r < 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_separtor);
static inline char *strv_join(char * const *l, const char *separator) {
        return strv_join_full(l, separator, NULL, false);
}

char **strv_parse_nulstr(const char *s, size_t l);
char **strv_split_nulstr(const char *s);
int strv_make_nulstr(char * const *l, char **p, size_t *n);

static inline int strv_from_nulstr(char ***a, const char *nulstr) {
        char **t;

        t = strv_split_nulstr(nulstr);
        if (!t)
                return -ENOMEM;
        *a = t;
        return 0;
}

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

#define STRV_FOREACH(s, l)                      \
        for ((s) = (l); (s) && *(s); (s)++)

#define STRV_FOREACH_BACKWARDS(s, l)                                \
        for (s = ({                                                 \
                        typeof(l) _l = l;                           \
                        _l ? _l + strv_length(_l) - 1U : NULL;      \
                        });                                         \
             (l) && ((s) >= (l));                                   \
             (s)--)

#define STRV_FOREACH_PAIR(x, y, l)               \
        for ((x) = (l), (y) = (x) ? (x+1) : NULL; (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))

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, **_i;                     \
                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, **_i;                     \
                STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
                        _found = endswith(_p, *_i);             \
                        if (_found)                             \
                                break;                          \
                }                                               \
                _found;                                         \
        })

#define FOREACH_STRING(x, y, ...)                                       \
        for (char **_l = STRV_MAKE(({ x = y; }), ##__VA_ARGS__);        \
             x;                                                         \
             x = *(++_l))

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 *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_free_free(char ***l);
DEFINE_TRIVIAL_CLEANUP_FUNC(char***, strv_free_free);

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)             \
        ({                                      \
                strv_free(a);                   \
                (a) = (b);                      \
                (b) = NULL;                     \
                0;                              \
        })

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
53e1b683	1	/* SPDX-License-Identifier: LGPL-2.1+ */
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
479ddcdf	16	char strv_find(char const l, const char name) _pure_;
ddd6a22a	17	char strv_find_case(char const l, const char name) _pure_;
479ddcdf YW	18	char strv_find_prefix(char const l, const char name) _pure_;
479ddcdf YW	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
33c2ce7b	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
ab84f5b9 ZJS	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
b231b547	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);
5926ccca	37	int strv_extend(char **l, const char value);
20e265d4	38	int strv_extendf(char **l, const char format, ...) _printf_(2,0);
4f4afc88	39	int strv_extend_front(char **l, const char value);
4468addc	40	int strv_push(char **l, char value);
98940a3c	41	int strv_push_pair(char **l, char a, char *b);
da6053d0	42	int strv_insert(char **l, size_t position, char value);
6e888894 ZJS	43
	44	static inline int strv_push_prepend(char **l, char value) {
	45	return strv_insert(l, 0, value);
	46	}
	47
6e18964d	48	int strv_consume(char **l, char value);
98940a3c	49	int strv_consume_pair(char **l, char a, char *b);
9a00f57a	50	int strv_consume_prepend(char **l, char value);
034c6ed7	51
5f9a22c3 LP	52	char strv_remove(char l, const char *s);
5f9a22c3 LP	53	char strv_uniq(char l);
479ddcdf	54	bool strv_is_uniq(char * const *l);
5f9a22c3	55
8b75798d YW	56	int strv_compare(char * const a, char const *b);
	57	static inline bool strv_equal(char * const a, char const *b) {
	58	return strv_compare(a, b) == 0;
	59	}
0f84a72e	60
bea1a013	61	char *strv_new_internal(const char x, ...) _sentinel_;
b231b547	62	char *strv_new_ap(const char x, va_list ap);
bea1a013	63	#define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)
60918275	64
f9d14060 AK	65	#define STRV_IGNORE ((const char *) -1)
f9d14060 AK	66
07719a21	67	static inline const char* STRV_IFNOTNULL(const char *x) {
f9d14060	68	return x ? x : STRV_IGNORE;
07719a21 LP	69	}
07719a21 LP	70
2fd9ae2e	71	static inline bool strv_isempty(char * const *l) {
5f9a22c3 LP	72	return !l \|\| !*l;
	73	}
	74
b231b547	75	char *strv_split_newlines(const char s);
5f9a22c3	76
90e30d76	77	int strv_split_full(char **t, const char s, const char *separators, ExtractFlags flags);
0645b83a ZJS	78	static inline char *strv_split(const char s, const char *separators) {
	79	char **ret;
	80	int r;
	81
90e30d76	82	r = strv_split_full(&ret, s, separators, 0);
0645b83a ZJS	83	if (r < 0)
	84	return NULL;
	85
	86	return ret;
	87	}
f88e6be5	88
a082edd5 LB	89	/* Given a string containing white-space separated tuples of words themselves separated by ':',
	90	* returns a vector of strings. If the second element in a tuple is missing, the corresponding
	91	* string in the vector is an empty string. */
	92	int strv_split_colon_pairs(char **t, const char s);
	93
d4d9f034	94	char strv_join_full(char const l, const char separator, const char *prefix, bool escape_separtor);
479ddcdf	95	static inline char strv_join(char const l, const char separator) {
d4d9f034	96	return strv_join_full(l, separator, NULL, false);
2b9a7d2e	97	}
5f9a22c3	98
21bc923a	99	char *strv_parse_nulstr(const char s, size_t l);
fabe5c0e	100	char *strv_split_nulstr(const char s);
479ddcdf	101	int strv_make_nulstr(char * const l, char p, size_t n);
21bc923a	102
a7addf32 ZJS	103	static inline int strv_from_nulstr(char **a, const char nulstr) {
	104	char **t;
	105
	106	t = strv_split_nulstr(nulstr);
	107	if (!t)
	108	return -ENOMEM;
	109	*a = t;
	110	return 0;
	111	}
	112
479ddcdf	113	bool strv_overlap(char * const a, char const *b) _pure_;
0c85a4f3	114
60918275	115	#define STRV_FOREACH(s, l) \
cba8922f	116	for ((s) = (l); (s) && *(s); (s)++)
60918275	117
4a39c774 LP	118	#define STRV_FOREACH_BACKWARDS(s, l) \
4a39c774 LP	119	for (s = ({ \
147d8fc1	120	typeof(l) _l = l; \
4a39c774 LP	121	_l ? _l + strv_length(_l) - 1U : NULL; \
	122	}); \
	123	(l) && ((s) >= (l)); \
	124	(s)--)
857a493d	125
246aa6dd	126	#define STRV_FOREACH_PAIR(x, y, l) \
0cd41757	127	for ((x) = (l), (y) = (x) ? (x+1) : NULL; (x) && (x) && (y); (x) += 2, (y) = (x + 1))
246aa6dd	128
857a493d	129	char strv_sort(char l);
479ddcdf	130	void strv_print(char * const *l);
250a918d LP	131
	132	#define strv_from_stdarg_alloca(first) \
	133	({ \
	134	char **_l; \
	135	\
	136	if (!first) \
897e7561	137	_l = (char**) &first; \
250a918d	138	else { \
da6053d0	139	size_t _n; \
250a918d LP	140	va_list _ap; \
	141	\
	142	_n = 1; \
	143	va_start(_ap, first); \
	144	while (va_arg(_ap, char*)) \
	145	_n++; \
	146	va_end(_ap); \
	147	\
	148	_l = newa(char*, _n+1); \
	149	_l[_n = 0] = (char*) first; \
	150	va_start(_ap, first); \
	151	for (;;) { \
	152	_l[++_n] = va_arg(_ap, char*); \
	153	if (!_l[_n]) \
	154	break; \
	155	} \
	156	va_end(_ap); \
	157	} \
	158	_l; \
	159	})
53ede806 LP	160
53ede806 LP	161	#define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
c7bf9d51 ZJS	162	#define STRPTR_IN_SET(x, ...) \
	163	({ \
	164	const char* _x = (x); \
	165	_x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
	166	})
c4a7b2c5	167
ddd6a22a LP	168	#define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
	169	#define STRCASEPTR_IN_SET(x, ...) \
	170	({ \
	171	const char* _x = (x); \
	172	_x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
	173	})
	174
52f15520 LP	175	#define STARTSWITH_SET(p, ...) \
	176	({ \
	177	const char *_p = (p); \
	178	char _found = NULL, *_i; \
	179	STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) { \
	180	_found = startswith(_p, *_i); \
	181	if (_found) \
	182	break; \
	183	} \
	184	_found; \
	185	})
	186
890befcf ZJS	187	#define ENDSWITH_SET(p, ...) \
	188	({ \
	189	const char *_p = (p); \
	190	char _found = NULL, *_i; \
	191	STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) { \
	192	_found = endswith(_p, *_i); \
	193	if (_found) \
	194	break; \
	195	} \
	196	_found; \
	197	})
	198
66a64081 LP	199	#define FOREACH_STRING(x, y, ...) \
	200	for (char **_l = STRV_MAKE(({ x = y; }), ##__VA_ARGS__); \
	201	x; \
	202	x = *(++_l))
e1dd6790 LP	203
e1dd6790 LP	204	char strv_reverse(char l);
04c14b25	205	char strv_shell_escape(char l, const char *bad);
bceccd5e	206
0ef84b80	207	bool strv_fnmatch_full(char* const* patterns, const char s, int flags, size_t matched_pos);
191a3f16 ZJS	208	static inline bool strv_fnmatch(char* const* patterns, const char *s) {
191a3f16 ZJS	209	return strv_fnmatch_full(patterns, s, 0, NULL);
0ef84b80	210	}
bceccd5e	211
2404701e	212	static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
bceccd5e ZJS	213	assert(s);
bceccd5e ZJS	214	return strv_isempty(patterns) \|\|
191a3f16	215	strv_fnmatch_full(patterns, s, flags, NULL);
bceccd5e	216	}
fe382237 LP	217
fe382237 LP	218	char *strv_free_free(char *l);
9ecdba8c	219	DEFINE_TRIVIAL_CLEANUP_FUNC(char***, strv_free_free);
e3ead6bb LP	220
e3ead6bb LP	221	char strv_skip(char l, size_t n);
8dd4c05b LP	222
8dd4c05b LP	223	int strv_extend_n(char **l, const char value, size_t n);
3df9bec5	224
479ddcdf	225	int fputstrv(FILE f, char const l, const char separator, bool *space);
b302a50d LP	226
	227	#define strv_free_and_replace(a, b) \
	228	({ \
	229	strv_free(a); \
	230	(a) = (b); \
	231	(b) = NULL; \
	232	0; \
	233	})
cde79109 ZJS	234
cde79109 ZJS	235	extern const struct hash_ops string_strv_hash_ops;
856e5195 ZJS	236	int _string_strv_hashmap_put(Hashmap *h, const char key, const char *value HASHMAP_DEBUG_PARAMS);
	237	int _string_strv_ordered_hashmap_put(OrderedHashmap *h, const char key, const char *value HASHMAP_DEBUG_PARAMS);
	238	#define string_strv_hashmap_put(h, k, v) _string_strv_hashmap_put(h, k, v HASHMAP_DEBUG_SRC_ARGS)
	239	#define string_strv_ordered_hashmap_put(h, k, v) _string_strv_ordered_hashmap_put(h, k, v HASHMAP_DEBUG_SRC_ARGS)