src/basic/strv.h

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