src/shared/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
  27 #include "util.h"
  28
  29 char *strv_find(char **l, const char *name) _pure_;
  30 char *strv_find_prefix(char **l, const char *name) _pure_;
  31 char *strv_find_startswith(char **l, const char *name) _pure_;
  32
  33 void strv_free(char **l);
  34 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
  35 #define _cleanup_strv_free_ _cleanup_(strv_freep)
  36
  37 char **strv_copy(char * const *l);
  38 unsigned strv_length(char * const *l) _pure_;
  39
  40 int strv_extend_strv(char ***a, char **b);
  41 int strv_extend_strv_concat(char ***a, char **b, const char *suffix);
  42 int strv_extend(char ***l, const char *value);
  43 int strv_extendf(char ***l, const char *format, ...) _printf_(2,0);
  44 int strv_push(char ***l, char *value);
  45 int strv_push_pair(char ***l, char *a, char *b);
  46 int strv_push_prepend(char ***l, char *value);
  47 int strv_consume(char ***l, char *value);
  48 int strv_consume_pair(char ***l, char *a, char *b);
  49 int strv_consume_prepend(char ***l, char *value);
  50
  51 char **strv_remove(char **l, const char *s);
  52 char **strv_uniq(char **l);
  53
  54 bool strv_equal(char **a, char **b);
  55
  56 #define strv_contains(l, s) (!!strv_find((l), (s)))
  57
  58 char **strv_new(const char *x, ...) _sentinel_;
  59 char **strv_new_ap(const char *x, va_list ap);
  60
  61 static inline const char* STRV_IFNOTNULL(const char *x) {
  62         return x ? x : (const char *) -1;
  63 }
  64
  65 static inline bool strv_isempty(char * const *l) {
  66         return !l || !*l;
  67 }
  68
  69 char **strv_split(const char *s, const char *separator);
  70 char **strv_split_newlines(const char *s);
  71
  72 int strv_split_quoted(char ***t, const char *s, bool relax);
  73
  74 char *strv_join(char **l, const char *separator);
  75 char *strv_join_quoted(char **l);
  76
  77 char **strv_parse_nulstr(const char *s, size_t l);
  78 char **strv_split_nulstr(const char *s);
  79
  80 bool strv_overlap(char **a, char **b) _pure_;
  81
  82 #define STRV_FOREACH(s, l)                      \
  83         for ((s) = (l); (s) && *(s); (s)++)
  84
  85 #define STRV_FOREACH_BACKWARDS(s, l)            \
  86         STRV_FOREACH(s, l)                      \
  87                 ;                               \
  88         for ((s)--; (l) && ((s) >= (l)); (s)--)
  89
  90 #define STRV_FOREACH_PAIR(x, y, l)               \
  91         for ((x) = (l), (y) = (x+1); (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))
  92
  93 char **strv_sort(char **l);
  94 void strv_print(char **l);
  95
  96 #define STRV_MAKE(...) ((char**) ((const char*[]) { __VA_ARGS__, NULL }))
  97
  98 #define STRV_MAKE_EMPTY ((char*[1]) { NULL })
  99
 100 #define strv_from_stdarg_alloca(first)                          \
 101         ({                                                      \
 102                 char **_l;                                      \
 103                                                                 \
 104                 if (!first)                                     \
 105                         _l = (char**) &first;                   \
 106                 else {                                          \
 107                         unsigned _n;                            \
 108                         va_list _ap;                            \
 109                                                                 \
 110                         _n = 1;                                 \
 111                         va_start(_ap, first);                   \
 112                         while (va_arg(_ap, char*))              \
 113                                 _n++;                           \
 114                         va_end(_ap);                            \
 115                                                                 \
 116                         _l = newa(char*, _n+1);                 \
 117                         _l[_n = 0] = (char*) first;             \
 118                         va_start(_ap, first);                   \
 119                         for (;;) {                              \
 120                                 _l[++_n] = va_arg(_ap, char*);  \
 121                                 if (!_l[_n])                    \
 122                                         break;                  \
 123                         }                                       \
 124                         va_end(_ap);                            \
 125                 }                                               \
 126                 _l;                                             \
 127         })
 128
 129 #define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
 130
 131 #define FOREACH_STRING(x, ...)                               \
 132         for (char **_l = ({                                  \
 133                 char **_ll = STRV_MAKE(__VA_ARGS__);         \
 134                 x = _ll ? _ll[0] : NULL;                     \
 135                 _ll;                                         \
 136         });                                                  \
 137         _l && *_l;                                           \
 138         x = ({                                               \
 139                 _l ++;                                       \
 140                 _l[0];                                       \
 141         }))