src/basic/set.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include "forward.h"
   5 #include "hashmap.h"
   6
   7 #define set_free_and_replace(a, b)              \
   8         free_and_replace_full(a, b, set_free)
   9
  10 Set* set_new(const struct hash_ops *hash_ops);
  11
  12 static inline Set* set_free(Set *s) {
  13         return (Set*) _hashmap_free(HASHMAP_BASE(s));
  14 }
  15
  16 #define set_copy(s) ((Set*) _hashmap_copy(HASHMAP_BASE(s)))
  17
  18 int set_ensure_allocated(Set **s, const struct hash_ops *hash_ops);
  19
  20 int set_put(Set *s, const void *key);
  21 /* no set_update */
  22 /* no set_replace */
  23 static inline void *set_get(const Set *s, const void *key) {
  24         return _hashmap_get(HASHMAP_BASE((Set *) s), key);
  25 }
  26 /* no set_get2 */
  27
  28 static inline bool set_contains(const Set *s, const void *key) {
  29         return _hashmap_contains(HASHMAP_BASE((Set *) s), key);
  30 }
  31
  32 static inline void *set_remove(Set *s, const void *key) {
  33         return _hashmap_remove(HASHMAP_BASE(s), key);
  34 }
  35
  36 /* no set_remove2 */
  37 /* no set_remove_value */
  38 int set_remove_and_put(Set *s, const void *old_key, const void *new_key);
  39 /* no set_remove_and_replace */
  40 int set_merge(Set *s, Set *other);
  41
  42 static inline int set_reserve(Set *h, unsigned entries_add) {
  43         return _hashmap_reserve(HASHMAP_BASE(h), entries_add);
  44 }
  45
  46 static inline int set_move(Set *s, Set *other) {
  47         return _hashmap_move(HASHMAP_BASE(s), HASHMAP_BASE(other));
  48 }
  49
  50 static inline int set_move_one(Set *s, Set *other, const void *key) {
  51         return _hashmap_move_one(HASHMAP_BASE(s), HASHMAP_BASE(other), key);
  52 }
  53
  54 static inline unsigned set_size(const Set *s) {
  55         return _hashmap_size(HASHMAP_BASE((Set *) s));
  56 }
  57
  58 static inline bool set_isempty(const Set *s) {
  59         return set_size(s) == 0;
  60 }
  61
  62 static inline unsigned set_buckets(const Set *s) {
  63         return _hashmap_buckets(HASHMAP_BASE((Set *) s));
  64 }
  65
  66 static inline bool set_iterate(const Set *s, Iterator *i, void **value) {
  67         return _hashmap_iterate(HASHMAP_BASE((Set*) s), i, value, NULL);
  68 }
  69
  70 static inline void set_clear(Set *s) {
  71         _hashmap_clear(HASHMAP_BASE(s));
  72 }
  73
  74 static inline void *set_steal_first(Set *s) {
  75         return _hashmap_first_key_and_value(HASHMAP_BASE(s), true, NULL);
  76 }
  77
  78 /* no set_steal_first_key */
  79 /* no set_first_key */
  80
  81 static inline void *set_first(const Set *s) {
  82         return _hashmap_first_key_and_value(HASHMAP_BASE((Set *) s), false, NULL);
  83 }
  84
  85 /* no set_next */
  86
  87 static inline char **set_get_strv(Set *s) {
  88         return _hashmap_get_strv(HASHMAP_BASE(s));
  89 }
  90
  91 char** set_to_strv(Set **s);
  92
  93 int set_ensure_put(Set **s, const struct hash_ops *hash_ops, const void *key);
  94
  95 int set_ensure_consume(Set **s, const struct hash_ops *hash_ops, void *key);
  96
  97 int set_consume(Set *s, void *value);
  98
  99 int set_put_strndup_full(Set **s, const struct hash_ops *hash_ops, const char *p, size_t n);
 100 #define set_put_strdup_full(s, hash_ops, p) set_put_strndup_full(s, hash_ops, p, SIZE_MAX)
 101 #define set_put_strndup(s, p, n) set_put_strndup_full(s, &string_hash_ops_free, p, n)
 102 #define set_put_strdup(s, p) set_put_strndup(s, p, SIZE_MAX)
 103
 104 int set_put_strdupv_full(Set **s, const struct hash_ops *hash_ops, char **l);
 105 #define set_put_strdupv(s, l) set_put_strdupv_full(s, &string_hash_ops_free, l)
 106
 107 int set_put_strsplit(Set *s, const char *v, const char *separators, ExtractFlags flags);
 108
 109 #define _SET_FOREACH(e, s, i) \
 110         for (Iterator i = ITERATOR_FIRST; set_iterate((s), &i, (void**)&(e)); )
 111 #define SET_FOREACH(e, s) \
 112         _SET_FOREACH(e, s, UNIQ_T(i, UNIQ))
 113
 114 #define SET_FOREACH_MOVE(e, d, s)                                       \
 115         for (; ({ e = set_first(s); assert_se(!e || set_move_one(d, s, e) >= 0); e; }); )
 116
 117 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free);
 118
 119 #define _cleanup_set_free_ _cleanup_(set_freep)
 120
 121 int set_strjoin(Set *s, const char *separator, bool wrap_with_separator, char **ret);
 122
 123 bool set_equal(Set *a, Set *b);
 124
 125 bool set_fnmatch(Set *include_patterns, Set *exclude_patterns, const char *needle);