src/basic/string-util.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 #include <alloca.h>
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25 #include <string.h>
  26
  27 #include "macro.h"
  28
  29 /* What is interpreted as whitespace? */
  30 #define WHITESPACE        " \t\n\r"
  31 #define NEWLINE           "\n\r"
  32 #define QUOTES            "\"\'"
  33 #define COMMENTS          "#;"
  34 #define GLOB_CHARS        "*?["
  35 #define DIGITS            "0123456789"
  36 #define LOWERCASE_LETTERS "abcdefghijklmnopqrstuvwxyz"
  37 #define UPPERCASE_LETTERS "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  38 #define LETTERS           LOWERCASE_LETTERS UPPERCASE_LETTERS
  39 #define ALPHANUMERICAL    LETTERS DIGITS
  40 #define HEXDIGITS         DIGITS "abcdefABCDEF"
  41
  42 #define streq(a,b) (strcmp((a),(b)) == 0)
  43 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
  44 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
  45 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
  46
  47 int strcmp_ptr(const char *a, const char *b) _pure_;
  48
  49 static inline bool streq_ptr(const char *a, const char *b) {
  50         return strcmp_ptr(a, b) == 0;
  51 }
  52
  53 static inline const char* strempty(const char *s) {
  54         return s ? s : "";
  55 }
  56
  57 static inline const char* strnull(const char *s) {
  58         return s ? s : "(null)";
  59 }
  60
  61 static inline const char *strna(const char *s) {
  62         return s ? s : "n/a";
  63 }
  64
  65 static inline bool isempty(const char *p) {
  66         return !p || !p[0];
  67 }
  68
  69 static inline const char *empty_to_null(const char *p) {
  70         return isempty(p) ? NULL : p;
  71 }
  72
  73 static inline char *startswith(const char *s, const char *prefix) {
  74         size_t l;
  75
  76         l = strlen(prefix);
  77         if (strncmp(s, prefix, l) == 0)
  78                 return (char*) s + l;
  79
  80         return NULL;
  81 }
  82
  83 static inline char *startswith_no_case(const char *s, const char *prefix) {
  84         size_t l;
  85
  86         l = strlen(prefix);
  87         if (strncasecmp(s, prefix, l) == 0)
  88                 return (char*) s + l;
  89
  90         return NULL;
  91 }
  92
  93 char *endswith(const char *s, const char *postfix) _pure_;
  94 char *endswith_no_case(const char *s, const char *postfix) _pure_;
  95
  96 char *first_word(const char *s, const char *word) _pure_;
  97
  98 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
  99
 100 #define FOREACH_WORD(word, length, s, state)                            \
 101         _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
 102
 103 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 104         _FOREACH_WORD(word, length, s, separator, false, state)
 105
 106 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 107         _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
 108
 109 #define _FOREACH_WORD(word, length, s, separator, quoted, state)        \
 110         for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
 111
 112 char *strappend(const char *s, const char *suffix);
 113 char *strnappend(const char *s, const char *suffix, size_t length);
 114
 115 char *strjoin(const char *x, ...) _sentinel_;
 116
 117 #define strjoina(a, ...)                                                \
 118         ({                                                              \
 119                 const char *_appendees_[] = { a, __VA_ARGS__ };         \
 120                 char *_d_, *_p_;                                        \
 121                 int _len_ = 0;                                          \
 122                 unsigned _i_;                                           \
 123                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 124                         _len_ += strlen(_appendees_[_i_]);              \
 125                 _p_ = _d_ = alloca(_len_ + 1);                          \
 126                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 127                         _p_ = stpcpy(_p_, _appendees_[_i_]);            \
 128                 *_p_ = 0;                                               \
 129                 _d_;                                                    \
 130         })
 131
 132 char *strstrip(char *s);
 133 char *delete_chars(char *s, const char *bad);
 134 char *truncate_nl(char *s);
 135
 136 char ascii_tolower(char x);
 137 char *ascii_strlower(char *s);
 138 char *ascii_strlower_n(char *s, size_t n);
 139
 140 char ascii_toupper(char x);
 141 char *ascii_strupper(char *s);
 142
 143 int ascii_strcasecmp_n(const char *a, const char *b, size_t n);
 144 int ascii_strcasecmp_nn(const char *a, size_t n, const char *b, size_t m);
 145
 146 bool chars_intersect(const char *a, const char *b) _pure_;
 147
 148 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 149         assert(s);
 150         assert(charset);
 151         return s[strspn(s, charset)] == '\0';
 152 }
 153
 154 bool string_has_cc(const char *p, const char *ok) _pure_;
 155
 156 char *ellipsize_mem(const char *s, size_t old_length_bytes, size_t new_length_columns, unsigned percent);
 157 char *ellipsize(const char *s, size_t length, unsigned percent);
 158
 159 bool nulstr_contains(const char*nulstr, const char *needle);
 160
 161 char* strshorten(char *s, size_t l);
 162
 163 char *strreplace(const char *text, const char *old_string, const char *new_string);
 164
 165 char *strip_tab_ansi(char **p, size_t *l);
 166
 167 char *strextend(char **x, ...) _sentinel_;
 168
 169 char *strrep(const char *s, unsigned n);
 170
 171 int split_pair(const char *s, const char *sep, char **l, char **r);
 172
 173 int free_and_strdup(char **p, const char *s);
 174
 175 /* Normal memmem() requires haystack to be nonnull, which is annoying for zero-length buffers */
 176 static inline void *memmem_safe(const void *haystack, size_t haystacklen, const void *needle, size_t needlelen) {
 177
 178         if (needlelen <= 0)
 179                 return (void*) haystack;
 180
 181         if (haystacklen < needlelen)
 182                 return NULL;
 183
 184         assert(haystack);
 185         assert(needle);
 186
 187         return memmem(haystack, haystacklen, needle, needlelen);
 188 }
 189
 190 void* memory_erase(void *p, size_t l);
 191 char *string_erase(char *x);
 192
 193 char *string_free_erase(char *s);
 194 DEFINE_TRIVIAL_CLEANUP_FUNC(char *, string_free_erase);
 195 #define _cleanup_string_free_erase_ _cleanup_(string_free_erasep)
 196
 197 bool string_is_safe(const char *p) _pure_;