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