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