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