src/basic/strv.h

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