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