Daan De Meyer
c09ce222b6
Passing in the func, file and line information complicates the interface. On top of that, it prevents forward declaring Hashmap in strv.h, as we need to pass the macros everywhere that we allocate a hashmap, which means we have to include the hashmap header everywhere we have a function that allocates a hashmap instead of just having to forward declare Hashmap. Let's drop the file, func and line information from the debug information. Instead, in the future we can add a description field to hashmaps like we already have in various other structs to describe the purpose of the hashmap which should be much more useful than having the file, line and function where the hashmap was allocated.
273 lines
11 KiB
C
273 lines
11 KiB
C
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
#pragma once
|
|
|
|
#include <fnmatch.h>
|
|
#include <stdarg.h>
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
|
|
#include "alloc-util.h"
|
|
#include "extract-word.h"
|
|
#include "hashmap.h"
|
|
#include "macro.h"
|
|
#include "string-util.h"
|
|
|
|
char* strv_find(char * const *l, const char *name) _pure_;
|
|
char* strv_find_case(char * const *l, const char *name) _pure_;
|
|
char* strv_find_prefix(char * const *l, const char *name) _pure_;
|
|
char* strv_find_startswith(char * const *l, const char *name) _pure_;
|
|
char* strv_find_closest(char * const *l, const char *name) _pure_;
|
|
/* Given two vectors, the first a list of keys and the second a list of key-value pairs, returns the value
|
|
* of the first key from the first vector that is found in the second vector. */
|
|
char* strv_find_first_field(char * const *needles, char * const *haystack) _pure_;
|
|
|
|
#define strv_contains(l, s) (!!strv_find((l), (s)))
|
|
#define strv_contains_case(l, s) (!!strv_find_case((l), (s)))
|
|
|
|
char** strv_free(char **l);
|
|
DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free);
|
|
#define _cleanup_strv_free_ _cleanup_(strv_freep)
|
|
|
|
char** strv_free_erase(char **l);
|
|
DEFINE_TRIVIAL_CLEANUP_FUNC(char**, strv_free_erase);
|
|
#define _cleanup_strv_free_erase_ _cleanup_(strv_free_erasep)
|
|
|
|
void strv_free_many(char ***strvs, size_t n) _nonnull_if_nonzero_(1, 2);
|
|
|
|
char** strv_copy_n(char * const *l, size_t n);
|
|
static inline char** strv_copy(char * const *l) {
|
|
return strv_copy_n(l, SIZE_MAX);
|
|
}
|
|
int strv_copy_unless_empty(char * const *l, char ***ret);
|
|
|
|
size_t strv_length(char * const *l) _pure_;
|
|
|
|
int strv_extend_strv(char ***a, char * const *b, bool filter_duplicates);
|
|
int strv_extend_strv_consume(char ***a, char **b, bool filter_duplicates);
|
|
|
|
int strv_extend_strv_biconcat(char ***a, const char *prefix, const char* const *b, const char *suffix);
|
|
static inline int strv_extend_strv_concat(char ***a, const char* const *b, const char *suffix) {
|
|
return strv_extend_strv_biconcat(a, NULL, b, suffix);
|
|
}
|
|
|
|
int strv_prepend(char ***l, const char *value);
|
|
|
|
/* _with_size() are lower-level functions where the size can be provided externally,
|
|
* which allows us to skip iterating over the strv to find the end, which saves
|
|
* a bit of time and reduces the complexity of appending from O(n²) to O(n). */
|
|
|
|
int strv_extend_with_size(char ***l, size_t *n, const char *value);
|
|
static inline int strv_extend(char ***l, const char *value) {
|
|
return strv_extend_with_size(l, NULL, value);
|
|
}
|
|
|
|
int strv_extend_many_internal(char ***l, const char *value, ...);
|
|
#define strv_extend_many(l, ...) strv_extend_many_internal(l, __VA_ARGS__, POINTER_MAX)
|
|
|
|
int strv_extendf(char ***l, const char *format, ...) _printf_(2,3);
|
|
|
|
int strv_push_with_size(char ***l, size_t *n, char *value);
|
|
static inline int strv_push(char ***l, char *value) {
|
|
return strv_push_with_size(l, NULL, value);
|
|
}
|
|
int strv_push_pair(char ***l, char *a, char *b);
|
|
|
|
int strv_insert(char ***l, size_t position, char *value);
|
|
|
|
static inline int strv_push_prepend(char ***l, char *value) {
|
|
return strv_insert(l, 0, value);
|
|
}
|
|
|
|
int strv_consume_with_size(char ***l, size_t *n, char *value);
|
|
static inline int strv_consume(char ***l, char *value) {
|
|
return strv_consume_with_size(l, NULL, value);
|
|
}
|
|
|
|
int strv_consume_pair(char ***l, char *a, char *b);
|
|
int strv_consume_prepend(char ***l, char *value);
|
|
|
|
char** strv_remove(char **l, const char *s);
|
|
char** strv_uniq(char **l);
|
|
bool strv_is_uniq(char * const *l);
|
|
|
|
int strv_compare(char * const *a, char * const *b);
|
|
static inline bool strv_equal(char * const *a, char * const *b) {
|
|
return strv_compare(a, b) == 0;
|
|
}
|
|
|
|
bool strv_equal_ignore_order(char * const *a, char * const *b);
|
|
|
|
char** strv_new_internal(const char *x, ...) _sentinel_;
|
|
char** strv_new_ap(const char *x, va_list ap);
|
|
#define strv_new(...) strv_new_internal(__VA_ARGS__, NULL)
|
|
|
|
#define STRV_IGNORE ((const char *) POINTER_MAX)
|
|
|
|
static inline const char* STRV_IFNOTNULL(const char *x) {
|
|
return x ?: STRV_IGNORE;
|
|
}
|
|
|
|
static inline bool strv_isempty(char * const *l) {
|
|
return !l || !*l;
|
|
}
|
|
|
|
int strv_split_full(char ***t, const char *s, const char *separators, ExtractFlags flags);
|
|
static inline char** strv_split(const char *s, const char *separators) {
|
|
char **ret;
|
|
|
|
if (strv_split_full(&ret, s, separators, EXTRACT_RETAIN_ESCAPE) < 0)
|
|
return NULL;
|
|
|
|
return ret;
|
|
}
|
|
|
|
int strv_split_and_extend_full(char ***t, const char *s, const char *separators, bool filter_duplicates, ExtractFlags flags);
|
|
#define strv_split_and_extend(t, s, sep, dup) strv_split_and_extend_full(t, s, sep, dup, 0)
|
|
|
|
int strv_split_newlines_full(char ***ret, const char *s, ExtractFlags flags);
|
|
static inline char** strv_split_newlines(const char *s) {
|
|
char **ret;
|
|
|
|
if (strv_split_newlines_full(&ret, s, 0) < 0)
|
|
return NULL;
|
|
|
|
return ret;
|
|
}
|
|
|
|
/* Given a string containing white-space separated tuples of words themselves separated by ':',
|
|
* returns a vector of strings. If the second element in a tuple is missing, the corresponding
|
|
* string in the vector is an empty string. */
|
|
int strv_split_colon_pairs(char ***t, const char *s);
|
|
|
|
char* strv_join_full(char * const *l, const char *separator, const char *prefix, bool escape_separator);
|
|
static inline char *strv_join(char * const *l, const char *separator) {
|
|
return strv_join_full(l, separator, NULL, false);
|
|
}
|
|
|
|
bool strv_overlap(char * const *a, char * const *b) _pure_;
|
|
|
|
#define _STRV_FOREACH_BACKWARDS(s, l, h, i) \
|
|
for (typeof(*(l)) *s, *h = (l), *i = ({ \
|
|
size_t _len = strv_length(h); \
|
|
_len > 0 ? h + _len - 1 : NULL; \
|
|
}); \
|
|
(s = i); \
|
|
i = PTR_SUB1(i, h))
|
|
|
|
#define STRV_FOREACH_BACKWARDS(s, l) \
|
|
_STRV_FOREACH_BACKWARDS(s, l, UNIQ_T(h, UNIQ), UNIQ_T(i, UNIQ))
|
|
|
|
#define _STRV_FOREACH_PAIR(x, y, l, i) \
|
|
for (typeof(*(l)) *x, *y, *i = (l); \
|
|
i && *(x = i) && *(y = i + 1); \
|
|
i += 2)
|
|
|
|
#define STRV_FOREACH_PAIR(x, y, l) \
|
|
_STRV_FOREACH_PAIR(x, y, l, UNIQ_T(i, UNIQ))
|
|
|
|
char** strv_sort(char **l);
|
|
char** strv_sort_uniq(char **l);
|
|
void strv_print_full(char * const *l, const char *prefix);
|
|
static inline void strv_print(char * const *l) {
|
|
strv_print_full(l, NULL);
|
|
}
|
|
|
|
char* startswith_strv(const char *s, char * const *l);
|
|
|
|
#define STARTSWITH_SET(p, ...) \
|
|
startswith_strv(p, STRV_MAKE(__VA_ARGS__))
|
|
|
|
char* endswith_strv(const char *s, char * const *l);
|
|
|
|
#define ENDSWITH_SET(p, ...) \
|
|
endswith_strv(p, STRV_MAKE(__VA_ARGS__))
|
|
|
|
#define strv_from_stdarg_alloca(first) \
|
|
({ \
|
|
char **_l; \
|
|
\
|
|
if (!first) \
|
|
_l = (char**) &first; \
|
|
else { \
|
|
size_t _n; \
|
|
va_list _ap; \
|
|
\
|
|
_n = 1; \
|
|
va_start(_ap, first); \
|
|
while (va_arg(_ap, char*)) \
|
|
_n++; \
|
|
va_end(_ap); \
|
|
\
|
|
_l = newa(char*, _n+1); \
|
|
_l[_n = 0] = (char*) first; \
|
|
va_start(_ap, first); \
|
|
for (;;) { \
|
|
_l[++_n] = va_arg(_ap, char*); \
|
|
if (!_l[_n]) \
|
|
break; \
|
|
} \
|
|
va_end(_ap); \
|
|
} \
|
|
_l; \
|
|
})
|
|
|
|
#define STR_IN_SET(x, ...) strv_contains(STRV_MAKE(__VA_ARGS__), x)
|
|
#define STRPTR_IN_SET(x, ...) \
|
|
({ \
|
|
const char* _x = (x); \
|
|
_x && strv_contains(STRV_MAKE(__VA_ARGS__), _x); \
|
|
})
|
|
|
|
#define STRCASE_IN_SET(x, ...) strv_contains_case(STRV_MAKE(__VA_ARGS__), x)
|
|
#define STRCASEPTR_IN_SET(x, ...) \
|
|
({ \
|
|
const char* _x = (x); \
|
|
_x && strv_contains_case(STRV_MAKE(__VA_ARGS__), _x); \
|
|
})
|
|
|
|
#define _FOREACH_STRING(uniq, x, y, ...) \
|
|
for (const char *x, * const*UNIQ_T(l, uniq) = STRV_MAKE_CONST(({ x = y; }), ##__VA_ARGS__); \
|
|
x; \
|
|
x = *(++UNIQ_T(l, uniq)))
|
|
|
|
#define FOREACH_STRING(x, y, ...) \
|
|
_FOREACH_STRING(UNIQ, x, y, ##__VA_ARGS__)
|
|
|
|
char** strv_reverse(char **l);
|
|
char** strv_shell_escape(char **l, const char *bad);
|
|
|
|
bool strv_fnmatch_full(char* const* patterns, const char *s, int flags, size_t *ret_matched_pos);
|
|
static inline bool strv_fnmatch(char* const* patterns, const char *s) {
|
|
return strv_fnmatch_full(patterns, s, 0, NULL);
|
|
}
|
|
static inline bool strv_fnmatch_or_empty(char* const* patterns, const char *s, int flags) {
|
|
assert(s);
|
|
return strv_isempty(patterns) ||
|
|
strv_fnmatch_full(patterns, s, flags, NULL);
|
|
}
|
|
|
|
char** strv_skip(char **l, size_t n);
|
|
|
|
int strv_extend_n(char ***l, const char *value, size_t n);
|
|
|
|
int strv_extend_assignment(char ***l, const char *lhs, const char *rhs);
|
|
|
|
int fputstrv(FILE *f, char * const *l, const char *separator, bool *space);
|
|
|
|
#define strv_free_and_replace(a, b) \
|
|
free_and_replace_full(a, b, strv_free)
|
|
|
|
void string_strv_hashmap_remove(Hashmap *h, const char *key, const char *value);
|
|
static inline void string_strv_ordered_hashmap_remove(OrderedHashmap *h, const char *key, const char *value) {
|
|
string_strv_hashmap_remove(PLAIN_HASHMAP(h), key, value);
|
|
}
|
|
int _string_strv_hashmap_put(Hashmap **h, const char *key, const char *value);
|
|
int _string_strv_ordered_hashmap_put(OrderedHashmap **h, const char *key, const char *value);
|
|
#define string_strv_hashmap_put(h, k, v) _string_strv_hashmap_put(h, k, v)
|
|
#define string_strv_ordered_hashmap_put(h, k, v) _string_strv_ordered_hashmap_put(h, k, v)
|
|
|
|
int strv_rebreak_lines(char **l, size_t width, char ***ret);
|
|
|
|
char** strv_filter_prefix(char * const *l, const char *prefix);
|