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