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 #include <stdio.h>
   9
  10 #include "alloc-util.h"
  11 #include "extract-word.h"
  12 #include "hashmap.h"
  13 #include "macro.h"
  14 #include "string-util.h"
  15
  16 char *strv_find(char * const *l, const char *name) _pure_;
  17 char *strv_find_case(char * const *l, const char *name) _pure_;
  18 char *strv_find_prefix(char * const *l, const char *name) _pure_;
  19 char *strv_find_startswith(char * const *l, const char *name) _pure_;
  20
  21 #define strv_contains(l, s) (!!strv_find((l), (s)))
  22 #define strv_contains_case(l, s) (!!strv_find_case((l), (s)))
  23
  24 char **strv_free(char **l);
  25 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
  26 #define _cleanup_strv_free_ _cleanup_(strv_freep)
  27
  28 char **strv_free_erase(char **l);
  29 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
  30 #define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)
  31
  32 char **strv_copy(char * const *l);
  33 size_t strv_length(char * const *l) _pure_;
  34
  35 int strv_extend_strv(char ***a, char * const *b, bool filter_duplicates);
  36 int strv_extend_strv_concat(char ***a, char * const *b, const char *suffix);
  37 int strv_prepend(char ***l, const char *value);
  38 int strv_extend(char ***l, const char *value);
  39 int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
  40 int strv_extend_front(char ***l, const char *value);
  41 int strv_push(char ***l, char *value);
  42 int strv_push_pair(char ***l, char *a, char *b);
  43 int strv_insert(char ***l, size_t position, char *value);
  44
  45 static inline int strv_push_prepend(char ***l, char *value) {
  46         return strv_insert(l, 0, value);
  47 }
  48
  49 int strv_consume(char ***l, char *value);
  50 int strv_consume_pair(char ***l, char *a, char *b);
  51 int strv_consume_prepend(char ***l, char *value);
  52
  53 char **strv_remove(char **l, const char *s);
  54 char **strv_uniq(char **l);
  55 bool strv_is_uniq(char * const *l);
  56
  57 int strv_compare(char * const *a, char * const *b);
  58 static inline bool strv_equal(char * const *a, char * const *b) {
  59         return strv_compare(a, b) == 0;
  60 }
  61
  62 char **strv_new_internal(const char *x, ...) _sentinel_;
  63 char **strv_new_ap(const char *x, va_list ap);
  64 #define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)
  65
  66 #define STRV_IGNORE ((const char *) -1)
  67
  68 static inline const char* STRV_IFNOTNULL(const char *x) {
  69         return x ? x : STRV_IGNORE;
  70 }
  71
  72 static inline bool strv_isempty(char * const *l) {
  73         return !l || !*l;
  74 }
  75
  76 char **strv_split_newlines(const char *s);
  77
  78 int strv_split_full(char ***t, const char *s, const char *separators, ExtractFlags flags);
  79 static inline char **strv_split(const char *s, const char *separators) {
  80         char **ret;
  81         int r;
  82
  83         r = strv_split_full(&ret, s, separators, 0);
  84         if (r < 0)
  85                 return NULL;
  86
  87         return ret;
  88 }
  89
  90 /* Given a string containing white-space separated tuples of words themselves separated by ':',
  91  * returns a vector of strings. If the second element in a tuple is missing, the corresponding
  92  * string in the vector is an empty string. */
  93 int strv_split_colon_pairs(char ***t, const char *s);
  94
  95 char *strv_join_full(char * const *l, const char *separator, const char *prefix, bool escape_separtor);
  96 static inline char *strv_join(char * const *l, const char *separator) {
  97         return strv_join_full(l, separator, NULL, false);
  98 }
  99
 100 char **strv_parse_nulstr(const char *s, size_t l);
 101 char **strv_split_nulstr(const char *s);
 102 int strv_make_nulstr(char * const *l, char **p, size_t *n);
 103
 104 static inline int strv_from_nulstr(char ***a, const char *nulstr) {
 105         char **t;
 106
 107         t = strv_split_nulstr(nulstr);
 108         if (!t)
 109                 return -ENOMEM;
 110         *a = t;
 111         return 0;
 112 }
 113
 114 bool strv_overlap(char * const *a, char * const *b) _pure_;
 115
 116 #define STRV_FOREACH(s, l)                      \
 117         for ((s) = (l); (s) && *(s); (s)++)
 118
 119 #define STRV_FOREACH_BACKWARDS(s, l)                                \
 120         for (s = ({                                                 \
 121                         typeof(l) _l = l;                           \
 122                         _l ? _l + strv_length(_l) - 1U : NULL;      \
 123                         });                                         \
 124              (l) && ((s) >= (l));                                   \
 125              (s)--)
 126
 127 #define STRV_FOREACH_PAIR(x, y, l)               \
 128         for ((x) = (l), (y) = (x) ? (x+1) : NULL; (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))
 129
 130 char **strv_sort(char **l);
 131 void strv_print(char * const *l);
 132
 133 #define strv_from_stdarg_alloca(first)                          \
 134         ({                                                      \
 135                 char **_l;                                      \
 136                                                                 \
 137                 if (!first)                                     \
 138                         _l = (char**) &first;                   \
 139                 else {                                          \
 140                         size_t _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 STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
 170 #define STRCASEPTR_IN_SET(x, ...)                                    \
 171         ({                                                       \
 172                 const char* _x = (x);                            \
 173                 _x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
 174         })
 175
 176 #define STARTSWITH_SET(p, ...)                                  \
 177         ({                                                      \
 178                 const char *_p = (p);                           \
 179                 char  *_found = NULL, **_i;                     \
 180                 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
 181                         _found = startswith(_p, *_i);           \
 182                         if (_found)                             \
 183                                 break;                          \
 184                 }                                               \
 185                 _found;                                         \
 186         })
 187
 188 #define ENDSWITH_SET(p, ...)                                    \
 189         ({                                                      \
 190                 const char *_p = (p);                           \
 191                 char  *_found = NULL, **_i;                     \
 192                 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
 193                         _found = endswith(_p, *_i);             \
 194                         if (_found)                             \
 195                                 break;                          \
 196                 }                                               \
 197                 _found;                                         \
 198         })
 199
 200 #define FOREACH_STRING(x, y, ...)                                       \
 201         for (char **_l = STRV_MAKE(({ x = y; }), ##__VA_ARGS__);        \
 202              x;                                                         \
 203              x = *(++_l))
 204
 205 char **strv_reverse(char **l);
 206 char **strv_shell_escape(char **l, const char *bad);
 207
 208 bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *matched_pos);
 209 static inline bool strv_fnmatch(char* const* patterns, const char *s) {
 210         return strv_fnmatch_full(patterns, s, 0, NULL);
 211 }
 212
 213 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
 214         assert(s);
 215         return strv_isempty(patterns) ||
 216                strv_fnmatch_full(patterns, s, flags, NULL);
 217 }
 218
 219 char ***strv_free_free(char ***l);
 220 DEFINE_TRIVIAL_CLEANUP_FUNC(char***, strv_free_free);
 221
 222 char **strv_skip(char **l, size_t n);
 223
 224 int strv_extend_n(char ***l, const char *value, size_t n);
 225
 226 int fputstrv(FILE *f, char * const *l, const char *separator, bool *space);
 227
 228 #define strv_free_and_replace(a, b)             \
 229         ({                                      \
 230                 strv_free(a);                   \
 231                 (a) = (b);                      \
 232                 (b) = NULL;                     \
 233                 0;                              \
 234         })
 235
 236 extern const struct hash_ops string_strv_hash_ops;
 237 int _string_strv_hashmap_put(Hashmap **h, const char *key, const char *value  HASHMAP_DEBUG_PARAMS);
 238 int _string_strv_ordered_hashmap_put(OrderedHashmap **h, const char *key, const char *value  HASHMAP_DEBUG_PARAMS);
 239 #define string_strv_hashmap_put(h, k, v) _string_strv_hashmap_put(h, k, v  HASHMAP_DEBUG_SRC_ARGS)
 240 #define string_strv_ordered_hashmap_put(h, k, v) _string_strv_ordered_hashmap_put(h, k, v  HASHMAP_DEBUG_SRC_ARGS)