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_extend_front(char ***l, const char *value);
  54 int strv_push(char ***l, char *value);
  55 int strv_push_pair(char ***l, char *a, char *b);
  56 int strv_push_prepend(char ***l, char *value);
  57 int strv_consume(char ***l, char *value);
  58 int strv_consume_pair(char ***l, char *a, char *b);
  59 int strv_consume_prepend(char ***l, char *value);
  60
  61 char **strv_remove(char **l, const char *s);
  62 char **strv_uniq(char **l);
  63 bool strv_is_uniq(char **l);
  64
  65 bool strv_equal(char **a, char **b);
  66
  67 #define strv_contains(l, s) (!!strv_find((l), (s)))
  68
  69 char **strv_new(const char *x, ...) _sentinel_;
  70 char **strv_new_ap(const char *x, va_list ap);
  71
  72 #define STRV_IGNORE ((const char *) -1)
  73
  74 static inline const char* STRV_IFNOTNULL(const char *x) {
  75         return x ? x : STRV_IGNORE;
  76 }
  77
  78 static inline bool strv_isempty(char * const *l) {
  79         return !l || !*l;
  80 }
  81
  82 char **strv_split(const char *s, const char *separator);
  83 char **strv_split_newlines(const char *s);
  84
  85 int strv_split_extract(char ***t, const char *s, const char *separators, ExtractFlags flags);
  86
  87 char *strv_join(char **l, const char *separator);
  88 char *strv_join_quoted(char **l);
  89
  90 char **strv_parse_nulstr(const char *s, size_t l);
  91 char **strv_split_nulstr(const char *s);
  92 int strv_make_nulstr(char **l, char **p, size_t *n);
  93
  94 bool strv_overlap(char **a, char **b) _pure_;
  95
  96 #define STRV_FOREACH(s, l)                      \
  97         for ((s) = (l); (s) && *(s); (s)++)
  98
  99 #define STRV_FOREACH_BACKWARDS(s, l)                                \
 100         for (s = ({                                                 \
 101                         char **_l = l;                              \
 102                         _l ? _l + strv_length(_l) - 1U : NULL;      \
 103                         });                                         \
 104              (l) && ((s) >= (l));                                   \
 105              (s)--)
 106
 107 #define STRV_FOREACH_PAIR(x, y, l)               \
 108         for ((x) = (l), (y) = (x+1); (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))
 109
 110 char **strv_sort(char **l);
 111 void strv_print(char **l);
 112
 113 #define STRV_MAKE(...) ((char**) ((const char*[]) { __VA_ARGS__, NULL }))
 114
 115 #define STRV_MAKE_EMPTY ((char*[1]) { NULL })
 116
 117 #define strv_from_stdarg_alloca(first)                          \
 118         ({                                                      \
 119                 char **_l;                                      \
 120                                                                 \
 121                 if (!first)                                     \
 122                         _l = (char**) &first;                   \
 123                 else {                                          \
 124                         unsigned _n;                            \
 125                         va_list _ap;                            \
 126                                                                 \
 127                         _n = 1;                                 \
 128                         va_start(_ap, first);                   \
 129                         while (va_arg(_ap, char*))              \
 130                                 _n++;                           \
 131                         va_end(_ap);                            \
 132                                                                 \
 133                         _l = newa(char*, _n+1);                 \
 134                         _l[_n = 0] = (char*) first;             \
 135                         va_start(_ap, first);                   \
 136                         for (;;) {                              \
 137                                 _l[++_n] = va_arg(_ap, char*);  \
 138                                 if (!_l[_n])                    \
 139                                         break;                  \
 140                         }                                       \
 141                         va_end(_ap);                            \
 142                 }                                               \
 143                 _l;                                             \
 144         })
 145
 146 #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
 147 #define STRPTR_IN_SET(x, ...)                                    \
 148         ({                                                       \
 149                 const char* _x = (x);                            \
 150                 _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
 151         })
 152
 153 #define FOREACH_STRING(x, ...)                               \
 154         for (char **_l = ({                                  \
 155                 char **_ll = STRV_MAKE(__VA_ARGS__);         \
 156                 x = _ll ? _ll[0] : NULL;                     \
 157                 _ll;                                         \
 158         });                                                  \
 159         _l && *_l;                                           \
 160         x = ({                                               \
 161                 _l ++;                                       \
 162                 _l[0];                                       \
 163         }))
 164
 165 char **strv_reverse(char **l);
 166 char **strv_shell_escape(char **l, const char *bad);
 167
 168 bool strv_fnmatch(char* const* patterns, const char *s, int flags);
 169
 170 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
 171         assert(s);
 172         return strv_isempty(patterns) ||
 173                strv_fnmatch(patterns, s, flags);
 174 }
 175
 176 char ***strv_free_free(char ***l);
 177
 178 char **strv_skip(char **l, size_t n);
 179
 180 int strv_extend_n(char ***l, const char *value, size_t n);
 181
 182 int fputstrv(FILE *f, char **l, const char *separator, bool *space);