src/basic/strv.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   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
  39 /* _with_size() are lower-level functions where the size can be provided externally,
  40  * which allows us to skip iterating over the strv to find the end, which saves
  41  * a bit of time and reduces the complexity of appending from O(n²) to O(n). */
  42
  43 int strv_extend_with_size(char ***l, size_t *n, const char *value);
  44 static inline int strv_extend(char ***l, const char *value) {
  45         return strv_extend_with_size(l, NULL, value);
  46 }
  47
  48 int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
  49 int strv_extend_front(char ***l, const char *value);
  50
  51 int strv_push_with_size(char ***l, size_t *n, char *value);
  52 static inline int strv_push(char ***l, char *value) {
  53         return strv_push_with_size(l, NULL, value);
  54 }
  55 int strv_push_pair(char ***l, char *a, char *b);
  56
  57 int strv_insert(char ***l, size_t 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_with_size(char ***l, size_t *n, char *value);
  64 static inline int strv_consume(char ***l, char *value) {
  65         return strv_consume_with_size(l, NULL, value);
  66 }
  67
  68 int strv_consume_pair(char ***l, char *a, char *b);
  69 int strv_consume_prepend(char ***l, char *value);
  70
  71 char** strv_remove(char **l, const char *s);
  72 char** strv_uniq(char **l);
  73 bool strv_is_uniq(char * const *l);
  74
  75 int strv_compare(char * const *a, char * const *b);
  76 static inline bool strv_equal(char * const *a, char * const *b) {
  77         return strv_compare(a, b) == 0;
  78 }
  79
  80 char** strv_new_internal(const char *x, ...) _sentinel_;
  81 char** strv_new_ap(const char *x, va_list ap);
  82 #define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)
  83
  84 #define STRV_IGNORE ((const char *) POINTER_MAX)
  85
  86 static inline const char* STRV_IFNOTNULL(const char *x) {
  87         return x ? x : STRV_IGNORE;
  88 }
  89
  90 static inline bool strv_isempty(char * const *l) {
  91         return !l || !*l;
  92 }
  93
  94 int strv_split_full(char ***t, const char *s, const char *separators, ExtractFlags flags);
  95 static inline char** strv_split(const char *s, const char *separators) {
  96         char **ret;
  97
  98         if (strv_split_full(&ret, s, separators, EXTRACT_RETAIN_ESCAPE) < 0)
  99                 return NULL;
 100
 101         return ret;
 102 }
 103
 104 int strv_split_and_extend_full(char ***t, const char *s, const char *separators, bool filter_duplicates, ExtractFlags flags);
 105 #define strv_split_and_extend(t, s, sep, dup) strv_split_and_extend_full(t, s, sep, dup, 0)
 106
 107 int strv_split_newlines_full(char ***ret, const char *s, ExtractFlags flags);
 108 static inline char** strv_split_newlines(const char *s) {
 109         char **ret;
 110
 111         if (strv_split_newlines_full(&ret, s, 0) < 0)
 112                 return NULL;
 113
 114         return ret;
 115 }
 116
 117 /* Given a string containing white-space separated tuples of words themselves separated by ':',
 118  * returns a vector of strings. If the second element in a tuple is missing, the corresponding
 119  * string in the vector is an empty string. */
 120 int strv_split_colon_pairs(char ***t, const char *s);
 121
 122 char* strv_join_full(char * const *l, const char *separator, const char *prefix, bool escape_separator);
 123 static inline char *strv_join(char * const *l, const char *separator) {
 124         return strv_join_full(l, separator, NULL, false);
 125 }
 126
 127 bool strv_overlap(char * const *a, char * const *b) _pure_;
 128
 129 #define _STRV_FOREACH_BACKWARDS(s, l, h, i)                             \
 130         for (typeof(*(l)) *s, *h = (l), *i = ({                         \
 131                                 size_t _len = strv_length(h);           \
 132                                 _len > 0 ? h + _len - 1 : NULL;         \
 133                         });                                             \
 134              (s = i);                                                   \
 135              i = PTR_SUB1(i, h))
 136
 137 #define STRV_FOREACH_BACKWARDS(s, l)                                    \
 138         _STRV_FOREACH_BACKWARDS(s, l, UNIQ_T(h, UNIQ), UNIQ_T(i, UNIQ))
 139
 140 #define _STRV_FOREACH_PAIR(x, y, l, i)                          \
 141         for (typeof(*l) *x, *y, *i = (l);                       \
 142              i && *(x = i) && *(y = i + 1);                     \
 143              i += 2)
 144
 145 #define STRV_FOREACH_PAIR(x, y, l)                      \
 146         _STRV_FOREACH_PAIR(x, y, l, UNIQ_T(i, UNIQ))
 147
 148 char** strv_sort(char **l);
 149 void strv_print(char * const *l);
 150
 151 #define strv_from_stdarg_alloca(first)                          \
 152         ({                                                      \
 153                 char **_l;                                      \
 154                                                                 \
 155                 if (!first)                                     \
 156                         _l = (char**) &first;                   \
 157                 else {                                          \
 158                         size_t _n;                              \
 159                         va_list _ap;                            \
 160                                                                 \
 161                         _n = 1;                                 \
 162                         va_start(_ap, first);                   \
 163                         while (va_arg(_ap, char*))              \
 164                                 _n++;                           \
 165                         va_end(_ap);                            \
 166                                                                 \
 167                         _l = newa(char*, _n+1);                 \
 168                         _l[_n = 0] = (char*) first;             \
 169                         va_start(_ap, first);                   \
 170                         for (;;) {                              \
 171                                 _l[++_n] = va_arg(_ap, char*);  \
 172                                 if (!_l[_n])                    \
 173                                         break;                  \
 174                         }                                       \
 175                         va_end(_ap);                            \
 176                 }                                               \
 177                 _l;                                             \
 178         })
 179
 180 #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
 181 #define STRPTR_IN_SET(x, ...)                                    \
 182         ({                                                       \
 183                 const char* _x = (x);                            \
 184                 _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
 185         })
 186
 187 #define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
 188 #define STRCASEPTR_IN_SET(x, ...)                                    \
 189         ({                                                       \
 190                 const char* _x = (x);                            \
 191                 _x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
 192         })
 193
 194 #define STARTSWITH_SET(p, ...)                                  \
 195         ({                                                      \
 196                 const char *_p = (p);                           \
 197                 char *_found = NULL;                            \
 198                 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
 199                         _found = startswith(_p, *_i);           \
 200                         if (_found)                             \
 201                                 break;                          \
 202                 }                                               \
 203                 _found;                                         \
 204         })
 205
 206 #define ENDSWITH_SET(p, ...)                                    \
 207         ({                                                      \
 208                 const char *_p = (p);                           \
 209                 char *_found = NULL;                            \
 210                 STRV_FOREACH(_i, STRV_MAKE(__VA_ARGS__)) {      \
 211                         _found = endswith(_p, *_i);             \
 212                         if (_found)                             \
 213                                 break;                          \
 214                 }                                               \
 215                 _found;                                         \
 216         })
 217
 218 #define _FOREACH_STRING(uniq, x, y, ...)                                \
 219         for (const char *x, * const*UNIQ_T(l, uniq) = STRV_MAKE_CONST(({ x = y; }), ##__VA_ARGS__); \
 220              x;                                                         \
 221              x = *(++UNIQ_T(l, uniq)))
 222
 223 #define FOREACH_STRING(x, y, ...)                       \
 224         _FOREACH_STRING(UNIQ, x, y, ##__VA_ARGS__)
 225
 226 char** strv_reverse(char **l);
 227 char** strv_shell_escape(char **l, const char *bad);
 228
 229 bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *ret_matched_pos);
 230 static inline bool strv_fnmatch(char* const* patterns, const char *s) {
 231         return strv_fnmatch_full(patterns, s, 0, NULL);
 232 }
 233
 234 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
 235         assert(s);
 236         return strv_isempty(patterns) ||
 237                strv_fnmatch_full(patterns, s, flags, NULL);
 238 }
 239
 240 char** strv_skip(char **l, size_t n);
 241
 242 int strv_extend_n(char ***l, const char *value, size_t n);
 243
 244 int fputstrv(FILE *f, char * const *l, const char *separator, bool *space);
 245
 246 #define strv_free_and_replace(a, b)             \
 247         free_and_replace_full(a, b, strv_free)
 248
 249 extern const struct hash_ops string_strv_hash_ops;
 250 int _string_strv_hashmap_put(Hashmap **h, const char *key, const char *value  HASHMAP_DEBUG_PARAMS);
 251 int _string_strv_ordered_hashmap_put(OrderedHashmap **h, const char *key, const char *value  HASHMAP_DEBUG_PARAMS);
 252 #define string_strv_hashmap_put(h, k, v) _string_strv_hashmap_put(h, k, v  HASHMAP_DEBUG_SRC_ARGS)
 253 #define string_strv_ordered_hashmap_put(h, k, v) _string_strv_ordered_hashmap_put(h, k, v  HASHMAP_DEBUG_SRC_ARGS)