src/basic/strv.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include "forward.h"
   5 #include "strv-fundamental.h"   /* IWYU pragma: export */
   6
   7 char* strv_find(char * const *l, const char *name) _pure_;
   8 char* strv_find_case(char * const *l, const char *name) _pure_;
   9 char* strv_find_prefix(char * const *l, const char *name) _pure_;
  10 char* strv_find_startswith(char * const *l, const char *name) _pure_;
  11 char* strv_find_closest(char * const *l, const char *name) _pure_;
  12 /* Given two vectors, the first a list of keys and the second a list of key-value pairs, returns the value
  13  * of the first key from the first vector that is found in the second vector. */
  14 char* strv_find_first_field(char * const *needles, char * const *haystack) _pure_;
  15
  16 #define strv_contains(l, s) (!!strv_find((l), (s)))
  17 #define strv_contains_case(l, s) (!!strv_find_case((l), (s)))
  18
  19 char** strv_free(char **l);
  20 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
  21 #define _cleanup_strv_free_ _cleanup_(strv_freep)
  22
  23 char** strv_free_erase(char **l);
  24 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
  25 #define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)
  26
  27 void strv_free_many(char ***strvs, size_t n) _nonnull_if_nonzero_(1, 2);
  28
  29 char** strv_copy_n(char * const *l, size_t n);
  30 static inline char** strv_copy(char * const *l) {
  31         return strv_copy_n(l, SIZE_MAX);
  32 }
  33 int strv_copy_unless_empty(char * const *l, char ***ret);
  34
  35 size_t strv_length(char * const *l) _pure_;
  36
  37 int strv_extend_strv(char ***a, char * const *b, bool filter_duplicates);
  38 int strv_extend_strv_consume(char ***a, char **b, bool filter_duplicates);
  39
  40 int strv_extend_strv_biconcat(char ***a, const char *prefix, const char* const *b, const char *suffix);
  41 static inline int strv_extend_strv_concat(char ***a, const char* const *b, const char *suffix) {
  42         return strv_extend_strv_biconcat(a, NULL, b, suffix);
  43 }
  44
  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_extend_many_internal(char ***l, const char *value, ...);
  57 #define strv_extend_many(l, ...) strv_extend_many_internal(l, __VA_ARGS__, POINTER_MAX)
  58
  59 int strv_extendf(char ***l, const char *format, ...) _printf_(2,3);
  60
  61 int strv_push_with_size(char ***l, size_t *n, char *value);
  62 static inline int strv_push(char ***l, char *value) {
  63         return strv_push_with_size(l, NULL, value);
  64 }
  65 int strv_push_pair(char ***l, char *a, char *b);
  66
  67 int strv_insert(char ***l, size_t position, char *value);
  68
  69 static inline int strv_push_prepend(char ***l, char *value) {
  70         return strv_insert(l, 0, value);
  71 }
  72
  73 int strv_consume_with_size(char ***l, size_t *n, char *value);
  74 static inline int strv_consume(char ***l, char *value) {
  75         return strv_consume_with_size(l, NULL, value);
  76 }
  77
  78 int strv_consume_pair(char ***l, char *a, char *b);
  79 int strv_consume_prepend(char ***l, char *value);
  80
  81 char** strv_remove(char **l, const char *s);
  82 char** strv_uniq(char **l);
  83 bool strv_is_uniq(char * const *l) _pure_;
  84
  85 int strv_compare(char * const *a, char * const *b) _pure_;
  86 static inline bool strv_equal(char * const *a, char * const *b) {
  87         return strv_compare(a, b) == 0;
  88 }
  89
  90 bool strv_equal_ignore_order(char * const *a, char * const *b) _pure_;
  91
  92 char** strv_new_internal(const char *x, ...) _sentinel_;
  93 char** strv_new_ap(const char *x, va_list ap);
  94 #define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)
  95
  96 #define STRV_IGNORE ((const char *) POINTER_MAX)
  97
  98 static inline const char* STRV_IFNOTNULL(const char *x) {
  99         return x ?: STRV_IGNORE;
 100 }
 101
 102 static inline bool strv_isempty(char * const *l) {
 103         return !l || !*l;
 104 }
 105
 106 int strv_split_full(char ***t, const char *s, const char *separators, ExtractFlags flags);
 107 char** strv_split(const char *s, const char *separators);
 108
 109 int strv_split_and_extend_full(char ***t, const char *s, const char *separators, bool filter_duplicates, ExtractFlags flags);
 110 int strv_split_and_extend(char ***t, const char *s, const char *separators, bool filter_duplicates);
 111
 112 int strv_split_newlines_full(char ***ret, const char *s, ExtractFlags flags);
 113 char** strv_split_newlines(const char *s);
 114
 115 /* Given a string containing white-space separated tuples of words themselves separated by ':',
 116  * returns a vector of strings. If the second element in a tuple is missing, the corresponding
 117  * string in the vector is an empty string. */
 118 int strv_split_colon_pairs(char ***t, const char *s);
 119
 120 char* strv_join_full(char * const *l, const char *separator, const char *prefix, bool escape_separator);
 121 static inline char *strv_join(char * const *l, const char *separator) {
 122         return strv_join_full(l, separator, NULL, false);
 123 }
 124
 125 bool strv_overlap(char * const *a, char * const *b) _pure_;
 126
 127 #define _STRV_FOREACH_BACKWARDS(s, l, h, i)                             \
 128         for (typeof(*(l)) *s, *h = (l), *i = ({                         \
 129                                 size_t _len = strv_length(h);           \
 130                                 _len > 0 ? h + _len - 1 : NULL;         \
 131                         });                                             \
 132              (s = i);                                                   \
 133              i = PTR_SUB1(i, h))
 134
 135 #define STRV_FOREACH_BACKWARDS(s, l)                                    \
 136         _STRV_FOREACH_BACKWARDS(s, l, UNIQ_T(h, UNIQ), UNIQ_T(i, UNIQ))
 137
 138 #define _STRV_FOREACH_PAIR(x, y, l, i)                          \
 139         for (typeof(*(l)) *x, *y, *i = (l);                     \
 140              i && *(x = i) && *(y = i + 1);                     \
 141              i += 2)
 142
 143 #define STRV_FOREACH_PAIR(x, y, l)                      \
 144         _STRV_FOREACH_PAIR(x, y, l, UNIQ_T(i, UNIQ))
 145
 146 char** strv_sort(char **l);
 147 char** strv_sort_uniq(char **l);
 148 void strv_print_full(char * const *l, const char *prefix);
 149 static inline void strv_print(char * const *l) {
 150         strv_print_full(l, NULL);
 151 }
 152
 153 char* startswith_strv(const char *s, char * const *l);
 154
 155 #define STARTSWITH_SET(p, ...)                                  \
 156         startswith_strv(p, STRV_MAKE(__VA_ARGS__))
 157
 158 char* endswith_strv(const char *s, char * const *l);
 159
 160 #define ENDSWITH_SET(p, ...)                                    \
 161         endswith_strv(p, STRV_MAKE(__VA_ARGS__))
 162
 163 #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
 164 #define STRPTR_IN_SET(x, ...)                                    \
 165         ({                                                       \
 166                 const char* _x = (x);                            \
 167                 _x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
 168         })
 169
 170 #define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
 171 #define STRCASEPTR_IN_SET(x, ...)                                    \
 172         ({                                                       \
 173                 const char* _x = (x);                            \
 174                 _x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
 175         })
 176
 177 #define _FOREACH_STRING(uniq, x, y, ...)                                \
 178         for (const char *x, * const*UNIQ_T(l, uniq) = STRV_MAKE_CONST(({ x = y; }), ##__VA_ARGS__); \
 179              x;                                                         \
 180              x = *(++UNIQ_T(l, uniq)))
 181
 182 #define FOREACH_STRING(x, y, ...)                       \
 183         _FOREACH_STRING(UNIQ, x, y, ##__VA_ARGS__)
 184
 185 char** strv_reverse(char **l);
 186 char** strv_shell_escape(char **l, const char *bad);
 187
 188 bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *ret_matched_pos);
 189 static inline bool strv_fnmatch(char* const* patterns, const char *s) {
 190         return strv_fnmatch_full(patterns, s, 0, NULL);
 191 }
 192 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
 193         assert(s);
 194         return strv_isempty(patterns) ||
 195                strv_fnmatch_full(patterns, s, flags, NULL);
 196 }
 197
 198 char** strv_skip(char **l, size_t n);
 199
 200 int strv_extend_n(char ***l, const char *value, size_t n);
 201
 202 int strv_extend_assignment(char ***l, const char *lhs, const char *rhs);
 203
 204 int fputstrv(FILE *f, char * const *l, const char *separator, bool *space);
 205
 206 #define strv_free_and_replace(a, b)             \
 207         free_and_replace_full(a, b, strv_free)
 208
 209 void string_strv_hashmap_remove(Hashmap *h, const char *key, const char *value);
 210 void string_strv_ordered_hashmap_remove(OrderedHashmap *h, const char *key, const char *value);
 211 int string_strv_hashmap_put(Hashmap **h, const char *key, const char *value);
 212 int string_strv_ordered_hashmap_put(OrderedHashmap **h, const char *key, const char *value);
 213
 214 int strv_rebreak_lines(char **l, size_t width, char ***ret);
 215
 216 char** strv_filter_prefix(char * const *l, const char *prefix);