src/basic/set.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include "extract-word.h"
   5 #include "hashmap.h"
   6 #include "macro.h"
   7
   8 #define set_free_and_replace(a, b)              \
   9         ({                                      \
  10                 set_free(a);                    \
  11                 (a) = (b);                      \
  12                 (b) = NULL;                     \
  13                 0;                              \
  14         })
  15
  16 Set *_set_new(const struct hash_ops *hash_ops HASHMAP_DEBUG_PARAMS);
  17 #define set_new(ops) _set_new(ops HASHMAP_DEBUG_SRC_ARGS)
  18
  19 static inline Set *set_free(Set *s) {
  20         return (Set*) _hashmap_free(HASHMAP_BASE(s), NULL, NULL);
  21 }
  22
  23 static inline Set *set_free_free(Set *s) {
  24         return (Set*) _hashmap_free(HASHMAP_BASE(s), free, NULL);
  25 }
  26
  27 /* no set_free_free_free */
  28
  29 #define set_copy(s) ((Set*) _hashmap_copy(HASHMAP_BASE(h)  HASHMAP_DEBUG_SRC_ARGS))
  30
  31 int _set_ensure_allocated(Set **s, const struct hash_ops *hash_ops HASHMAP_DEBUG_PARAMS);
  32 #define set_ensure_allocated(h, ops) _set_ensure_allocated(h, ops HASHMAP_DEBUG_SRC_ARGS)
  33
  34 int set_put(Set *s, const void *key);
  35 /* no set_update */
  36 /* no set_replace */
  37 static inline void *set_get(const Set *s, void *key) {
  38         return _hashmap_get(HASHMAP_BASE((Set *) s), key);
  39 }
  40 /* no set_get2 */
  41
  42 static inline bool set_contains(const Set *s, const void *key) {
  43         return _hashmap_contains(HASHMAP_BASE((Set *) s), key);
  44 }
  45
  46 static inline void *set_remove(Set *s, const void *key) {
  47         return _hashmap_remove(HASHMAP_BASE(s), key);
  48 }
  49
  50 /* no set_remove2 */
  51 /* no set_remove_value */
  52 int set_remove_and_put(Set *s, const void *old_key, const void *new_key);
  53 /* no set_remove_and_replace */
  54 int set_merge(Set *s, Set *other);
  55
  56 static inline int set_reserve(Set *h, unsigned entries_add) {
  57         return _hashmap_reserve(HASHMAP_BASE(h), entries_add);
  58 }
  59
  60 static inline int set_move(Set *s, Set *other) {
  61         return _hashmap_move(HASHMAP_BASE(s), HASHMAP_BASE(other));
  62 }
  63
  64 static inline int set_move_one(Set *s, Set *other, const void *key) {
  65         return _hashmap_move_one(HASHMAP_BASE(s), HASHMAP_BASE(other), key);
  66 }
  67
  68 static inline unsigned set_size(const Set *s) {
  69         return _hashmap_size(HASHMAP_BASE((Set *) s));
  70 }
  71
  72 static inline bool set_isempty(const Set *s) {
  73         return set_size(s) == 0;
  74 }
  75
  76 static inline unsigned set_buckets(const Set *s) {
  77         return _hashmap_buckets(HASHMAP_BASE((Set *) s));
  78 }
  79
  80 bool set_iterate(const Set *s, Iterator *i, void **value);
  81
  82 static inline void set_clear(Set *s) {
  83         _hashmap_clear(HASHMAP_BASE(s), NULL, NULL);
  84 }
  85
  86 static inline void set_clear_free(Set *s) {
  87         _hashmap_clear(HASHMAP_BASE(s), free, NULL);
  88 }
  89
  90 /* no set_clear_free_free */
  91
  92 static inline void *set_steal_first(Set *s) {
  93         return _hashmap_first_key_and_value(HASHMAP_BASE(s), true, NULL);
  94 }
  95
  96 #define set_clear_with_destructor(_s, _f)               \
  97         ({                                              \
  98                 void *_item;                            \
  99                 while ((_item = set_steal_first(_s)))   \
 100                         _f(_item);                      \
 101         })
 102 #define set_free_with_destructor(_s, _f)                \
 103         ({                                              \
 104                 set_clear_with_destructor(_s, _f);      \
 105                 set_free(_s);                           \
 106         })
 107
 108 /* no set_steal_first_key */
 109 /* no set_first_key */
 110
 111 static inline void *set_first(const Set *s) {
 112         return _hashmap_first_key_and_value(HASHMAP_BASE((Set *) s), false, NULL);
 113 }
 114
 115 /* no set_next */
 116
 117 static inline char **set_get_strv(Set *s) {
 118         return _hashmap_get_strv(HASHMAP_BASE(s));
 119 }
 120
 121 int _set_ensure_put(Set **s, const struct hash_ops *hash_ops, const void *key  HASHMAP_DEBUG_PARAMS);
 122 #define set_ensure_put(s, hash_ops, key) _set_ensure_put(s, hash_ops, key  HASHMAP_DEBUG_SRC_ARGS)
 123
 124 int _set_ensure_consume(Set **s, const struct hash_ops *hash_ops, void *key  HASHMAP_DEBUG_PARAMS);
 125 #define set_ensure_consume(s, hash_ops, key) _set_ensure_consume(s, hash_ops, key  HASHMAP_DEBUG_SRC_ARGS)
 126
 127 int set_consume(Set *s, void *value);
 128
 129 int _set_put_strdup(Set **s, const char *p  HASHMAP_DEBUG_PARAMS);
 130 #define set_put_strdup(s, p) _set_put_strdup(s, p  HASHMAP_DEBUG_SRC_ARGS)
 131 int _set_put_strdupv(Set **s, char **l  HASHMAP_DEBUG_PARAMS);
 132 #define set_put_strdupv(s, l) _set_put_strdupv(s, l  HASHMAP_DEBUG_SRC_ARGS)
 133
 134 int set_put_strsplit(Set *s, const char *v, const char *separators, ExtractFlags flags);
 135
 136 #define SET_FOREACH(e, s, i) \
 137         for ((i) = ITERATOR_FIRST; set_iterate((s), &(i), (void**)&(e)); )
 138
 139 #define SET_FOREACH_MOVE(e, d, s)                                       \
 140         for (; ({ e = set_first(s); assert_se(!e || set_move_one(d, s, e) >= 0); e; }); )
 141
 142 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free);
 143 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free_free);
 144
 145 #define _cleanup_set_free_ _cleanup_(set_freep)
 146 #define _cleanup_set_free_free_ _cleanup_(set_free_freep)