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_extend(char ***l, const char *value);
  38 int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
  39 int strv_extend_front(char ***l, const char *value);
  40 int strv_push(char ***l, char *value);
  41 int strv_push_pair(char ***l, char *a, char *b);
  42 int strv_insert(char ***l, size_t position, char *value);
  43
  44 static inline int strv_push_prepend(char ***l, char *value) {
  45         return strv_insert(l, 0, value);
  46 }
  47
  48 int strv_consume(char ***l, char *value);
  49 int strv_consume_pair(char ***l, char *a, char *b);
  50 int strv_consume_prepend(char ***l, char *value);
  51
  52 char **strv_remove(char **l, const char *s);
  53 char **strv_uniq(char **l);
  54 bool strv_is_uniq(char * const *l);
  55
  56 int strv_compare(char * const *a, char * const *b);
  57 static inline bool strv_equal(char * const *a, char * const *b) {
  58         return strv_compare(a, b) == 0;
  59 }
  60
  61 char **strv_new_internal(const char *x, ...) _sentinel_;
  62 char **strv_new_ap(const char *x, va_list ap);
  63 #define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)
  64
  65 #define STRV_IGNORE ((const char *) -1)
  66
  67 static inline const char* STRV_IFNOTNULL(const char *x) {
  68         return x ? x : STRV_IGNORE;
  69 }
  70
  71 static inline bool strv_isempty(char * const *l) {
  72         return !l || !*l;
  73 }
  74
  75 char **strv_split_full(const char *s, const char *separator, SplitFlags flags);
  76 static inline char **strv_split(const char *s, const char *separator) {
  77         return strv_split_full(s, separator, 0);
  78 }
  79 char **strv_split_newlines(const char *s);
  80
  81 int strv_split_extract(char ***t, const char *s, const char *separators, ExtractFlags flags);
  82
  83 char *strv_join_prefix(char * const *l, const char *separator, const char *prefix);
  84 static inline char *strv_join(char * const *l, const char *separator) {
  85         return strv_join_prefix(l, separator, NULL);
  86 }
  87
  88 char **strv_parse_nulstr(const char *s, size_t l);
  89 char **strv_split_nulstr(const char *s);
  90 int strv_make_nulstr(char * const *l, char **p, size_t *n);
  91
  92 static inline int strv_from_nulstr(char ***a, const char *nulstr) {
  93         char **t;
  94
  95         t = strv_split_nulstr(nulstr);
  96         if (!t)
  97                 return -ENOMEM;
  98         *a = t;
  99         return 0;
 100 }
 101
 102 bool strv_overlap(char * const *a, char * const *b) _pure_;
 103
 104 #define STRV_FOREACH(s, l)                      \
 105         for ((s) = (l); (s) && *(s); (s)++)
 106
 107 #define STRV_FOREACH_BACKWARDS(s, l)                                \
 108         for (s = ({                                                 \
 109                         char **_l = l;                              \
 110                         _l ? _l + strv_length(_l) - 1U : NULL;      \
 111                         });                                         \
 112              (l) && ((s) >= (l));                                   \
 113              (s)--)
 114
 115 #define STRV_FOREACH_PAIR(x, y, l)               \
 116         for ((x) = (l), (y) = (x) ? (x+1) : NULL; (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))
 117
 118 char **strv_sort(char **l);
 119 void strv_print(char * const *l);
 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                         size_t _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 #define STRPTR_IN_SET(x, ...)                                    \
 156         ({                                                       \
 157                 const char* _x = (x);                            \
 158                 _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
 159         })
 160
 161 #define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
 162 #define STRCASEPTR_IN_SET(x, ...)                                    \
 163         ({                                                       \
 164                 const char* _x = (x);                            \
 165                 _x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
 166         })
 167
 168 #define STARTSWITH_SET(p, ...)                                  \
 169         ({                                                      \
 170                 const char *_p = (p);                           \
 171                 char  *_found = NULL, **_i;                     \
 172                 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
 173                         _found = startswith(_p, *_i);           \
 174                         if (_found)                             \
 175                                 break;                          \
 176                 }                                               \
 177                 _found;                                         \
 178         })
 179
 180 #define ENDSWITH_SET(p, ...)                                    \
 181         ({                                                      \
 182                 const char *_p = (p);                           \
 183                 char  *_found = NULL, **_i;                     \
 184                 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
 185                         _found = endswith(_p, *_i);             \
 186                         if (_found)                             \
 187                                 break;                          \
 188                 }                                               \
 189                 _found;                                         \
 190         })
 191
 192 #define FOREACH_STRING(x, y, ...)                                       \
 193         for (char **_l = STRV_MAKE(({ x = y; }), ##__VA_ARGS__);        \
 194              x;                                                         \
 195              x = *(++_l))
 196
 197 char **strv_reverse(char **l);
 198 char **strv_shell_escape(char **l, const char *bad);
 199
 200 bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *matched_pos);
 201 static inline bool strv_fnmatch(char* const* patterns, const char *s) {
 202         return strv_fnmatch_full(patterns, s, 0, NULL);
 203 }
 204
 205 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
 206         assert(s);
 207         return strv_isempty(patterns) ||
 208                strv_fnmatch_full(patterns, s, flags, NULL);
 209 }
 210
 211 char ***strv_free_free(char ***l);
 212 DEFINE_TRIVIAL_CLEANUP_FUNC(char***, strv_free_free);
 213
 214 char **strv_skip(char **l, size_t n);
 215
 216 int strv_extend_n(char ***l, const char *value, size_t n);
 217
 218 int fputstrv(FILE *f, char * const *l, const char *separator, bool *space);
 219
 220 #define strv_free_and_replace(a, b)             \
 221         ({                                      \
 222                 strv_free(a);                   \
 223                 (a) = (b);                      \
 224                 (b) = NULL;                     \
 225                 0;                              \
 226         })
 227
 228 extern const struct hash_ops string_strv_hash_ops;
 229 int string_strv_hashmap_put(Hashmap **h, const char *key, const char *value);
 230 int string_strv_ordered_hashmap_put(OrderedHashmap **h, const char *key, const char *value);