src/basic/strv.h

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