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

/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/

#pragma once

/***
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

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

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

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

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)

void strv_clear(char **l);

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

int strv_extend_strv(char ***a, char **b, bool filter_duplicates);
int strv_extend_strv_concat(char ***a, char **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_push(char ***l, char *value);
int strv_push_pair(char ***l, char *a, char *b);
int strv_push_prepend(char ***l, char *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 **l);

bool strv_equal(char **a, char **b);

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

char **strv_new(const char *x, ...) _sentinel_;
char **strv_new_ap(const char *x, va_list ap);

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

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

char **strv_split(const char *s, const char *separator);
char **strv_split_newlines(const char *s);

int strv_split_extract(char ***t, const char *s, const char *separators, ExtractFlags flags);

char *strv_join(char **l, const char *separator);
char *strv_join_quoted(char **l);

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

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

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

#define STRV_FOREACH_BACKWARDS(s, l)            \
        STRV_FOREACH(s, l)                      \
                ;                               \
        for ((s)--; (l) && ((s) >= (l)); (s)--)

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

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

#define STRV_MAKE(...) ((char**) ((const char*[]) { __VA_ARGS__, NULL }))

#define STRV_MAKE_EMPTY ((char*[1]) { NULL })

#define strv_from_stdarg_alloca(first)                          \
        ({                                                      \
                char **_l;                                      \
                                                                \
                if (!first)                                     \
                        _l = (char**) &first;                   \
                else {                                          \
                        unsigned _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 FOREACH_STRING(x, ...)                               \
        for (char **_l = ({                                  \
                char **_ll = STRV_MAKE(__VA_ARGS__);         \
                x = _ll ? _ll[0] : NULL;                     \
                _ll;                                         \
        });                                                  \
        _l && *_l;                                           \
        x = ({                                               \
                _l ++;                                       \
                _l[0];                                       \
        }))

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

bool strv_fnmatch(char* const* patterns, const char *s, int flags);

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

char ***strv_free_free(char ***l);

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

int strv_extend_n(char ***l, const char *value, size_t n);
Commit	Line	Data
	1	/-- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil --/
	2
	3	#pragma once
	4
	5	/***
	6	This file is part of systemd.
	7
	8	Copyright 2010 Lennart Poettering
	9
	10	systemd is free software; you can redistribute it and/or modify it
	11	under the terms of the GNU Lesser General Public License as published by
	12	the Free Software Foundation; either version 2.1 of the License, or
	13	(at your option) any later version.
	14
	15	systemd is distributed in the hope that it will be useful, but
	16	WITHOUT ANY WARRANTY; without even the implied warranty of
	17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	Lesser General Public License for more details.
	19
	20	You should have received a copy of the GNU Lesser General Public License
	21	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	22	***/
	23
	24	#include <fnmatch.h>
	25	#include <stdarg.h>
	26	#include <stdbool.h>
	27	#include <stddef.h>
	28
	29	#include "extract-word.h"
	30	#include "alloc-util.h"
	31	#include "macro.h"
	32	#include "util.h"
	33
	34	char strv_find(char l, const char name) _pure_;
	35	char strv_find_prefix(char l, const char name) _pure_;
	36	char strv_find_startswith(char l, const char name) _pure_;
	37
	38	char strv_free(char l);
	39	DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
	40	#define _cleanup_strv_free_ _cleanup_(strv_freep)
	41
	42	char strv_free_erase(char l);
	43	DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
	44	#define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)
	45
	46	void strv_clear(char **l);
	47
	48	char *strv_copy(char const *l);
	49	unsigned strv_length(char * const *l) _pure_;
	50
	51	int strv_extend_strv(char *a, char b, bool filter_duplicates);
	52	int strv_extend_strv_concat(char *a, char b, const char *suffix);
	53	int strv_extend(char **l, const char value);
	54	int strv_extendf(char **l, const char format, ...) _printf_(2,0);
	55	int strv_push(char **l, char value);
	56	int strv_push_pair(char **l, char a, char *b);
	57	int strv_push_prepend(char **l, char value);
	58	int strv_consume(char **l, char value);
	59	int strv_consume_pair(char **l, char a, char *b);
	60	int strv_consume_prepend(char **l, char value);
	61
	62	char strv_remove(char l, const char *s);
	63	char strv_uniq(char l);
	64	bool strv_is_uniq(char **l);
	65
	66	bool strv_equal(char a, char b);
	67
	68	#define strv_contains(l, s) (!!strv_find((l), (s)))
	69
	70	char *strv_new(const char x, ...) _sentinel_;
	71	char *strv_new_ap(const char x, va_list ap);
	72
	73	static inline const char* STRV_IFNOTNULL(const char *x) {
	74	return x ? x : (const char *) -1;
	75	}
	76
	77	static inline bool strv_isempty(char * const *l) {
	78	return !l \|\| !*l;
	79	}
	80
	81	char *strv_split(const char s, const char *separator);
	82	char *strv_split_newlines(const char s);
	83
	84	int strv_split_extract(char **t, const char s, const char *separators, ExtractFlags flags);
	85
	86	char strv_join(char l, const char separator);
	87	char strv_join_quoted(char *l);
	88
	89	char *strv_parse_nulstr(const char s, size_t l);
	90	char *strv_split_nulstr(const char s);
	91	int strv_make_nulstr(char l, char p, size_t *n);
	92
	93	bool strv_overlap(char a, char b) _pure_;
	94
	95	#define STRV_FOREACH(s, l) \
	96	for ((s) = (l); (s) && *(s); (s)++)
	97
	98	#define STRV_FOREACH_BACKWARDS(s, l) \
	99	STRV_FOREACH(s, l) \
	100	; \
	101	for ((s)--; (l) && ((s) >= (l)); (s)--)
	102
	103	#define STRV_FOREACH_PAIR(x, y, l) \
	104	for ((x) = (l), (y) = (x+1); (x) && (x) && (y); (x) += 2, (y) = (x + 1))
	105
	106	char strv_sort(char l);
	107	void strv_print(char **l);
	108
	109	#define STRV_MAKE(...) ((char*) ((const char[]) { __VA_ARGS__, NULL }))
	110
	111	#define STRV_MAKE_EMPTY ((char*[1]) { NULL })
	112
	113	#define strv_from_stdarg_alloca(first) \
	114	({ \
	115	char **_l; \
	116	\
	117	if (!first) \
	118	_l = (char**) &first; \
	119	else { \
	120	unsigned _n; \
	121	va_list _ap; \
	122	\
	123	_n = 1; \
	124	va_start(_ap, first); \
	125	while (va_arg(_ap, char*)) \
	126	_n++; \
	127	va_end(_ap); \
	128	\
	129	_l = newa(char*, _n+1); \
	130	_l[_n = 0] = (char*) first; \
	131	va_start(_ap, first); \
	132	for (;;) { \
	133	_l[++_n] = va_arg(_ap, char*); \
	134	if (!_l[_n]) \
	135	break; \
	136	} \
	137	va_end(_ap); \
	138	} \
	139	_l; \
	140	})
	141
	142	#define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
	143
	144	#define FOREACH_STRING(x, ...) \
	145	for (char **_l = ({ \
	146	char **_ll = STRV_MAKE(__VA_ARGS__); \
	147	x = _ll ? _ll[0] : NULL; \
	148	_ll; \
	149	}); \
	150	_l && *_l; \
	151	x = ({ \
	152	_l ++; \
	153	_l[0]; \
	154	}))
	155
	156	char strv_reverse(char l);
	157	char strv_shell_escape(char l, const char *bad);
	158
	159	bool strv_fnmatch(char* const* patterns, const char *s, int flags);
	160
	161	static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
	162	assert(s);
	163	return strv_isempty(patterns) \|\|
	164	strv_fnmatch(patterns, s, flags);
	165	}
	166
	167	char *strv_free_free(char *l);
	168
	169	char strv_skip(char l, size_t n);
	170
	171	int strv_extend_n(char **l, const char value, size_t n);