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