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
  32 void strv_free(char **l);
  33 DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
  34 #define _cleanup_strv_free_ _cleanup_(strv_freep)
  35
  36 char **strv_copy(char * const *l);
  37 unsigned strv_length(char * const *l) _pure_;
  38
  39 int strv_extend_strv(char ***a, char **b);
  40 int strv_extend_strv_concat(char ***a, char **b, const char *suffix);
  41 int strv_extend(char ***l, const char *value);
  42 int strv_push(char ***l, char *value);
  43 int strv_consume(char ***l, char *value);
  44
  45 char **strv_remove(char **l, const char *s);
  46 char **strv_uniq(char **l);
  47
  48 #define strv_contains(l, s) (!!strv_find((l), (s)))
  49
  50 char **strv_new(const char *x, ...) _sentinel_;
  51 char **strv_new_ap(const char *x, va_list ap);
  52
  53 static inline const char* STRV_IFNOTNULL(const char *x) {
  54         return x ? x : (const char *) -1;
  55 }
  56
  57 static inline bool strv_isempty(char * const *l) {
  58         return !l || !*l;
  59 }
  60
  61 char **strv_split(const char *s, const char *separator);
  62 char **strv_split_quoted(const char *s);
  63 char **strv_split_newlines(const char *s);
  64
  65 char *strv_join(char **l, const char *separator);
  66 char *strv_join_quoted(char **l);
  67
  68 char **strv_parse_nulstr(const char *s, size_t l);
  69 char **strv_split_nulstr(const char *s);
  70
  71 bool strv_overlap(char **a, char **b) _pure_;
  72
  73 #define STRV_FOREACH(s, l)                      \
  74         for ((s) = (l); (s) && *(s); (s)++)
  75
  76 #define STRV_FOREACH_BACKWARDS(s, l)            \
  77         STRV_FOREACH(s, l)                      \
  78                 ;                               \
  79         for ((s)--; (l) && ((s) >= (l)); (s)--)
  80
  81 #define STRV_FOREACH_PAIR(x, y, l)               \
  82         for ((x) = (l), (y) = (x+1); (x) && *(x) && *(y); (x) += 2, (y) = (x + 1))
  83
  84 char **strv_sort(char **l);
  85 void strv_print(char **l);
  86
  87 #define STRV_MAKE(...) ((char**) ((const char*[]) { __VA_ARGS__, NULL }))
  88
  89 #define STRV_MAKE_EMPTY ((char*[1]) { NULL })
  90
  91 #define strv_from_stdarg_alloca(first)                          \
  92         ({                                                      \
  93                 char **_l;                                      \
  94                                                                 \
  95                 if (!first)                                     \
  96                         _l = (char**) &first;                   \
  97                 else {                                          \
  98                         unsigned _n;                            \
  99                         va_list _ap;                            \
 100                                                                 \
 101                         _n = 1;                                 \
 102                         va_start(_ap, first);                   \
 103                         while (va_arg(_ap, char*))              \
 104                                 _n++;                           \
 105                         va_end(_ap);                            \
 106                                                                 \
 107                         _l = newa(char*, _n+1);                 \
 108                         _l[_n = 0] = (char*) first;             \
 109                         va_start(_ap, first);                   \
 110                         for (;;) {                              \
 111                                 _l[++_n] = va_arg(_ap, char*);  \
 112                                 if (!_l[_n])                    \
 113                                         break;                  \
 114                         }                                       \
 115                         va_end(_ap);                            \
 116                 }                                               \
 117                 _l;                                             \
 118         })