src/basic/strv.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <fnmatch.h>
   5 #include <stdarg.h>
   6 #include <stdbool.h>
   7 #include <stddef.h>
   8
   9 #include "alloc-util.h"
  10 #include "extract-word.h"
  11 #include "macro.h"
  12 #include "util.h"
  13
  14 char *strv_find(char **l, const char *name) _pure_;
  15 char *strv_find_prefix(char **l, const char *name) _pure_;
  16 char *strv_find_startswith(char **l, const char *name) _pure_;
  17
  18 char **strv_free(char **l);
  19 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
  20 #define _cleanup_strv_free_ _cleanup_(strv_freep)
  21
  22 char **strv_free_erase(char **l);
  23 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
  24 #define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)
  25
  26 void strv_clear(char **l);
  27
  28 char **strv_copy(char * const *l);
  29 size_t strv_length(char * const *l) _pure_;
  30
  31 int strv_extend_strv(char ***a, char **b, bool filter_duplicates);
  32 int strv_extend_strv_concat(char ***a, char **b, const char *suffix);
  33 int strv_extend(char ***l, const char *value);
  34 int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
  35 int strv_extend_front(char ***l, const char *value);
  36 int strv_push(char ***l, char *value);
  37 int strv_push_pair(char ***l, char *a, char *b);
  38 int strv_insert(char ***l, size_t position, char *value);
  39
  40 static inline int strv_push_prepend(char ***l, char *value) {
  41         return strv_insert(l, 0, value);
  42 }
  43
  44 int strv_consume(char ***l, char *value);
  45 int strv_consume_pair(char ***l, char *a, char *b);
  46 int strv_consume_prepend(char ***l, char *value);
  47
  48 char **strv_remove(char **l, const char *s);
  49 char **strv_uniq(char **l);
  50 bool strv_is_uniq(char **l);
  51
  52 bool strv_equal(char **a, char **b);
  53
  54 #define strv_contains(l, s) (!!strv_find((l), (s)))
  55
  56 char **strv_new(const char *x, ...) _sentinel_;
  57 char **strv_new_ap(const char *x, va_list ap);
  58
  59 #define STRV_IGNORE ((const char *) -1)
  60
  61 static inline const char* STRV_IFNOTNULL(const char *x) {
  62         return x ? x : STRV_IGNORE;
  63 }
  64
  65 static inline bool strv_isempty(char * const *l) {
  66         return !l || !*l;
  67 }
  68
  69 char **strv_split(const char *s, const char *separator);
  70 char **strv_split_newlines(const char *s);
  71
  72 int strv_split_extract(char ***t, const char *s, const char *separators, ExtractFlags flags);
  73
  74 char *strv_join(char **l, const char *separator);
  75
  76 char **strv_parse_nulstr(const char *s, size_t l);
  77 char **strv_split_nulstr(const char *s);
  78 int strv_make_nulstr(char **l, char **p, size_t *n);
  79
  80 bool strv_overlap(char **a, char **b) _pure_;
  81
  82 #define STRV_FOREACH(s, l)                      \
  83         for ((s) = (l); (s) && *(s); (s)++)
  84
  85 #define STRV_FOREACH_BACKWARDS(s, l)                                \
  86         for (s = ({                                                 \
  87                         char **_l = l;                              \
  88                         _l ? _l + strv_length(_l) - 1U : NULL;      \
  89                         });                                         \
  90              (l) && ((s) >= (l));                                   \
  91              (s)--)
  92
  93 #define STRV_FOREACH_PAIR(x, y, l)               \
  94         for ((x) = (l), (y) = (x+1); (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))
  95
  96 char **strv_sort(char **l);
  97 void strv_print(char **l);
  98
  99 #define STRV_MAKE(...) ((char**) ((const char*[]) { __VA_ARGS__, NULL }))
 100
 101 #define STRV_MAKE_EMPTY ((char*[1]) { NULL })
 102
 103 #define strv_from_stdarg_alloca(first)                          \
 104         ({                                                      \
 105                 char **_l;                                      \
 106                                                                 \
 107                 if (!first)                                     \
 108                         _l = (char**) &first;                   \
 109                 else {                                          \
 110                         size_t _n;                              \
 111                         va_list _ap;                            \
 112                                                                 \
 113                         _n = 1;                                 \
 114                         va_start(_ap, first);                   \
 115                         while (va_arg(_ap, char*))              \
 116                                 _n++;                           \
 117                         va_end(_ap);                            \
 118                                                                 \
 119                         _l = newa(char*, _n+1);                 \
 120                         _l[_n = 0] = (char*) first;             \
 121                         va_start(_ap, first);                   \
 122                         for (;;) {                              \
 123                                 _l[++_n] = va_arg(_ap, char*);  \
 124                                 if (!_l[_n])                    \
 125                                         break;                  \
 126                         }                                       \
 127                         va_end(_ap);                            \
 128                 }                                               \
 129                 _l;                                             \
 130         })
 131
 132 #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
 133 #define STRPTR_IN_SET(x, ...)                                    \
 134         ({                                                       \
 135                 const char* _x = (x);                            \
 136                 _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
 137         })
 138
 139 #define FOREACH_STRING(x, ...)                               \
 140         for (char **_l = ({                                  \
 141                 char **_ll = STRV_MAKE(__VA_ARGS__);         \
 142                 x = _ll ? _ll[0] : NULL;                     \
 143                 _ll;                                         \
 144         });                                                  \
 145         _l && *_l;                                           \
 146         x = ({                                               \
 147                 _l ++;                                       \
 148                 _l[0];                                       \
 149         }))
 150
 151 char **strv_reverse(char **l);
 152 char **strv_shell_escape(char **l, const char *bad);
 153
 154 bool strv_fnmatch(char* const* patterns, const char *s, int flags);
 155
 156 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
 157         assert(s);
 158         return strv_isempty(patterns) ||
 159                strv_fnmatch(patterns, s, flags);
 160 }
 161
 162 char ***strv_free_free(char ***l);
 163 DEFINE_TRIVIAL_CLEANUP_FUNC(char***, strv_free_free);
 164
 165 char **strv_skip(char **l, size_t n);
 166
 167 int strv_extend_n(char ***l, const char *value, size_t n);
 168
 169 int fputstrv(FILE *f, char **l, const char *separator, bool *space);
 170
 171 #define strv_free_and_replace(a, b)             \
 172         ({                                      \
 173                 strv_free(a);                   \
 174                 (a) = (b);                      \
 175                 (b) = NULL;                     \
 176                 0;                              \
 177         })