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