src/basic/strv.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <stdarg.h>
  25 #include <stdbool.h>
  26 #include <fnmatch.h>
  27
  28 #include "util.h"
  29
  30 char *strv_find(char **l, const char *name) _pure_;
  31 char *strv_find_prefix(char **l, const char *name) _pure_;
  32 char *strv_find_startswith(char **l, const char *name) _pure_;
  33
  34 char **strv_free(char **l);
  35 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
  36 #define _cleanup_strv_free_ _cleanup_(strv_freep)
  37
  38 char **strv_free_erase(char **l);
  39 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
  40 #define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)
  41
  42 void strv_clear(char **l);
  43
  44 char **strv_copy(char * const *l);
  45 unsigned strv_length(char * const *l) _pure_;
  46
  47 int strv_extend_strv(char ***a, char **b, bool filter_duplicates);
  48 int strv_extend_strv_concat(char ***a, char **b, const char *suffix);
  49 int strv_extend(char ***l, const char *value);
  50 int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
  51 int strv_push(char ***l, char *value);
  52 int strv_push_pair(char ***l, char *a, char *b);
  53 int strv_push_prepend(char ***l, char *value);
  54 int strv_consume(char ***l, char *value);
  55 int strv_consume_pair(char ***l, char *a, char *b);
  56 int strv_consume_prepend(char ***l, char *value);
  57
  58 char **strv_remove(char **l, const char *s);
  59 char **strv_uniq(char **l);
  60 bool strv_is_uniq(char **l);
  61
  62 bool strv_equal(char **a, char **b);
  63
  64 #define strv_contains(l, s) (!!strv_find((l), (s)))
  65
  66 char **strv_new(const char *x, ...) _sentinel_;
  67 char **strv_new_ap(const char *x, va_list ap);
  68
  69 static inline const char* STRV_IFNOTNULL(const char *x) {
  70         return x ? x : (const char *) -1;
  71 }
  72
  73 static inline bool strv_isempty(char * const *l) {
  74         return !l || !*l;
  75 }
  76
  77 char **strv_split(const char *s, const char *separator);
  78 char **strv_split_newlines(const char *s);
  79
  80 int strv_split_extract(char ***t, const char *s, const char *separators, ExtractFlags flags);
  81
  82 char *strv_join(char **l, const char *separator);
  83 char *strv_join_quoted(char **l);
  84
  85 char **strv_parse_nulstr(const char *s, size_t l);
  86 char **strv_split_nulstr(const char *s);
  87 int strv_make_nulstr(char **l, char **p, size_t *n);
  88
  89 bool strv_overlap(char **a, char **b) _pure_;
  90
  91 #define STRV_FOREACH(s, l)                      \
  92         for ((s) = (l); (s) && *(s); (s)++)
  93
  94 #define STRV_FOREACH_BACKWARDS(s, l)            \
  95         STRV_FOREACH(s, l)                      \
  96                 ;                               \
  97         for ((s)--; (l) && ((s) >= (l)); (s)--)
  98
  99 #define STRV_FOREACH_PAIR(x, y, l)               \
 100         for ((x) = (l), (y) = (x+1); (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))
 101
 102 char **strv_sort(char **l);
 103 void strv_print(char **l);
 104
 105 #define STRV_MAKE(...) ((char**) ((const char*[]) { __VA_ARGS__, NULL }))
 106
 107 #define STRV_MAKE_EMPTY ((char*[1]) { NULL })
 108
 109 #define strv_from_stdarg_alloca(first)                          \
 110         ({                                                      \
 111                 char **_l;                                      \
 112                                                                 \
 113                 if (!first)                                     \
 114                         _l = (char**) &first;                   \
 115                 else {                                          \
 116                         unsigned _n;                            \
 117                         va_list _ap;                            \
 118                                                                 \
 119                         _n = 1;                                 \
 120                         va_start(_ap, first);                   \
 121                         while (va_arg(_ap, char*))              \
 122                                 _n++;                           \
 123                         va_end(_ap);                            \
 124                                                                 \
 125                         _l = newa(char*, _n+1);                 \
 126                         _l[_n = 0] = (char*) first;             \
 127                         va_start(_ap, first);                   \
 128                         for (;;) {                              \
 129                                 _l[++_n] = va_arg(_ap, char*);  \
 130                                 if (!_l[_n])                    \
 131                                         break;                  \
 132                         }                                       \
 133                         va_end(_ap);                            \
 134                 }                                               \
 135                 _l;                                             \
 136         })
 137
 138 #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
 139
 140 #define FOREACH_STRING(x, ...)                               \
 141         for (char **_l = ({                                  \
 142                 char **_ll = STRV_MAKE(__VA_ARGS__);         \
 143                 x = _ll ? _ll[0] : NULL;                     \
 144                 _ll;                                         \
 145         });                                                  \
 146         _l && *_l;                                           \
 147         x = ({                                               \
 148                 _l ++;                                       \
 149                 _l[0];                                       \
 150         }))
 151
 152 char **strv_reverse(char **l);
 153 char **strv_shell_escape(char **l, const char *bad);
 154
 155 bool strv_fnmatch(char* const* patterns, const char *s, int flags);
 156
 157 static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
 158         assert(s);
 159         return strv_isempty(patterns) ||
 160                strv_fnmatch(patterns, s, flags);
 161 }
 162
 163 char ***strv_free_free(char ***l);
 164
 165 char **strv_skip(char **l, size_t n);
 166
 167 int strv_extend_n(char ***l, const char *value, size_t n);