]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/basic/string-util.h
1 /* SPDX-License-Identifier: LGPL-2.1+ */
9 #include "alloc-util.h"
12 /* What is interpreted as whitespace? */
13 #define WHITESPACE " \t\n\r"
14 #define NEWLINE "\n\r"
17 #define GLOB_CHARS "*?["
18 #define DIGITS "0123456789"
19 #define LOWERCASE_LETTERS "abcdefghijklmnopqrstuvwxyz"
20 #define UPPERCASE_LETTERS "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
21 #define LETTERS LOWERCASE_LETTERS UPPERCASE_LETTERS
22 #define ALPHANUMERICAL LETTERS DIGITS
23 #define HEXDIGITS DIGITS "abcdefABCDEF"
25 #define streq(a,b) (strcmp((a),(b)) == 0)
26 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
27 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
28 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
30 int strcmp_ptr(const char *a
, const char *b
) _pure_
;
32 static inline bool streq_ptr(const char *a
, const char *b
) {
33 return strcmp_ptr(a
, b
) == 0;
36 static inline const char* strempty(const char *s
) {
40 static inline const char* strnull(const char *s
) {
44 static inline const char *strna(const char *s
) {
48 static inline bool isempty(const char *p
) {
52 static inline const char *empty_to_null(const char *p
) {
53 return isempty(p
) ? NULL
: p
;
56 static inline const char *empty_to_dash(const char *str
) {
57 return isempty(str
) ? "-" : str
;
60 static inline char *startswith(const char *s
, const char *prefix
) {
64 if (strncmp(s
, prefix
, l
) == 0)
70 static inline char *startswith_no_case(const char *s
, const char *prefix
) {
74 if (strncasecmp(s
, prefix
, l
) == 0)
80 char *endswith(const char *s
, const char *postfix
) _pure_
;
81 char *endswith_no_case(const char *s
, const char *postfix
) _pure_
;
83 char *first_word(const char *s
, const char *word
) _pure_
;
85 typedef enum SplitFlags
{
86 SPLIT_QUOTES
= 0x01 << 0,
87 SPLIT_RELAX
= 0x01 << 1,
90 const char* split(const char **state
, size_t *l
, const char *separator
, SplitFlags flags
);
92 #define FOREACH_WORD(word, length, s, state) \
93 _FOREACH_WORD(word, length, s, WHITESPACE, 0, state)
95 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
96 _FOREACH_WORD(word, length, s, separator, 0, state)
98 #define _FOREACH_WORD(word, length, s, separator, flags, state) \
99 for ((state) = (s), (word) = split(&(state), &(length), (separator), (flags)); (word); (word) = split(&(state), &(length), (separator), (flags)))
101 char *strappend(const char *s
, const char *suffix
);
102 char *strnappend(const char *s
, const char *suffix
, size_t length
);
104 char *strjoin_real(const char *x
, ...) _sentinel_
;
105 #define strjoin(a, ...) strjoin_real((a), __VA_ARGS__, NULL)
107 #define strjoina(a, ...) \
109 const char *_appendees_[] = { a, __VA_ARGS__ }; \
113 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
114 _len_ += strlen(_appendees_[_i_]); \
115 _p_ = _d_ = newa(char, _len_ + 1); \
116 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
117 _p_ = stpcpy(_p_, _appendees_[_i_]); \
122 char *strstrip(char *s
);
123 char *delete_chars(char *s
, const char *bad
);
124 char *delete_trailing_chars(char *s
, const char *bad
);
125 char *truncate_nl(char *s
);
127 static inline char *skip_leading_chars(const char *s
, const char *bad
) {
135 return (char*) s
+ strspn(s
, bad
);
138 char ascii_tolower(char x
);
139 char *ascii_strlower(char *s
);
140 char *ascii_strlower_n(char *s
, size_t n
);
142 char ascii_toupper(char x
);
143 char *ascii_strupper(char *s
);
145 int ascii_strcasecmp_n(const char *a
, const char *b
, size_t n
);
146 int ascii_strcasecmp_nn(const char *a
, size_t n
, const char *b
, size_t m
);
148 bool chars_intersect(const char *a
, const char *b
) _pure_
;
150 static inline bool _pure_
in_charset(const char *s
, const char* charset
) {
153 return s
[strspn(s
, charset
)] == '\0';
156 bool string_has_cc(const char *p
, const char *ok
) _pure_
;
158 char *ellipsize_mem(const char *s
, size_t old_length_bytes
, size_t new_length_columns
, unsigned percent
);
159 static inline char *ellipsize(const char *s
, size_t length
, unsigned percent
) {
160 return ellipsize_mem(s
, strlen(s
), length
, percent
);
163 char *cellescape(char *buf
, size_t len
, const char *s
);
165 /* This limit is arbitrary, enough to give some idea what the string contains */
166 #define CELLESCAPE_DEFAULT_LENGTH 64
168 bool nulstr_contains(const char *nulstr
, const char *needle
);
170 char* strshorten(char *s
, size_t l
);
172 char *strreplace(const char *text
, const char *old_string
, const char *new_string
);
174 char *strip_tab_ansi(char **ibuf
, size_t *_isz
, size_t highlight
[2]);
176 char *strextend_with_separator(char **x
, const char *separator
, ...) _sentinel_
;
178 #define strextend(x, ...) strextend_with_separator(x, NULL, __VA_ARGS__)
180 char *strrep(const char *s
, unsigned n
);
182 int split_pair(const char *s
, const char *sep
, char **l
, char **r
);
184 int free_and_strdup(char **p
, const char *s
);
185 int free_and_strndup(char **p
, const char *s
, size_t l
);
187 /* Normal memmem() requires haystack to be nonnull, which is annoying for zero-length buffers */
188 static inline void *memmem_safe(const void *haystack
, size_t haystacklen
, const void *needle
, size_t needlelen
) {
191 return (void*) haystack
;
193 if (haystacklen
< needlelen
)
199 return memmem(haystack
, haystacklen
, needle
, needlelen
);
202 #if HAVE_EXPLICIT_BZERO
203 static inline void* explicit_bzero_safe(void *p
, size_t l
) {
205 explicit_bzero(p
, l
);
210 void *explicit_bzero_safe(void *p
, size_t l
);
213 char *string_erase(char *x
);
215 char *string_free_erase(char *s
);
216 DEFINE_TRIVIAL_CLEANUP_FUNC(char *, string_free_erase
);
217 #define _cleanup_string_free_erase_ _cleanup_(string_free_erasep)
219 bool string_is_safe(const char *p
) _pure_
;
221 static inline size_t strlen_ptr(const char *s
) {
228 /* Like startswith(), but operates on arbitrary memory blocks */
229 static inline void *memory_startswith(const void *p
, size_t sz
, const char *token
) {
240 if (memcmp(p
, token
, n
) != 0)
243 return (uint8_t*) p
+ n
;
246 /* Like startswith_no_case(), but operates on arbitrary memory blocks.
247 * It works only for ASCII strings.
249 static inline void *memory_startswith_no_case(const void *p
, size_t sz
, const char *token
) {
260 for (i
= 0; i
< n
; i
++) {
261 if (ascii_tolower(((char *)p
)[i
]) != ascii_tolower(token
[i
]))
265 return (uint8_t*) p
+ n
;