src/basic/set.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2010 Lennart Poettering
   6 ***/
   7
   8 #include "extract-word.h"
   9 #include "hashmap.h"
  10 #include "macro.h"
  11
  12 Set *internal_set_new(const struct hash_ops *hash_ops HASHMAP_DEBUG_PARAMS);
  13 #define set_new(ops) internal_set_new(ops HASHMAP_DEBUG_SRC_ARGS)
  14
  15 static inline Set *set_free(Set *s) {
  16         internal_hashmap_free(HASHMAP_BASE(s));
  17         return NULL;
  18 }
  19
  20 static inline Set *set_free_free(Set *s) {
  21         internal_hashmap_free_free(HASHMAP_BASE(s));
  22         return NULL;
  23 }
  24
  25 /* no set_free_free_free */
  26
  27 static inline Set *set_copy(Set *s) {
  28         return (Set*) internal_hashmap_copy(HASHMAP_BASE(s));
  29 }
  30
  31 int internal_set_ensure_allocated(Set **s, const struct hash_ops *hash_ops HASHMAP_DEBUG_PARAMS);
  32 #define set_ensure_allocated(h, ops) internal_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(Set *s, void *key) {
  38         return internal_hashmap_get(HASHMAP_BASE(s), key);
  39 }
  40 /* no set_get2 */
  41
  42 static inline bool set_contains(Set *s, const void *key) {
  43         return internal_hashmap_contains(HASHMAP_BASE(s), key);
  44 }
  45
  46 static inline void *set_remove(Set *s, const void *key) {
  47         return internal_hashmap_remove(HASHMAP_BASE(s), key);
  48 }
  49
  50 /* no set_remove2 */
  51 /* no set_remove_value */
  52 #if 0 /// UNNEEDED by elogind
  53 int set_remove_and_put(Set *s, const void *old_key, const void *new_key);
  54 #endif // 0
  55 /* no set_remove_and_replace */
  56 int set_merge(Set *s, Set *other);
  57
  58 static inline int set_reserve(Set *h, unsigned entries_add) {
  59         return internal_hashmap_reserve(HASHMAP_BASE(h), entries_add);
  60 }
  61
  62 static inline int set_move(Set *s, Set *other) {
  63         return internal_hashmap_move(HASHMAP_BASE(s), HASHMAP_BASE(other));
  64 }
  65
  66 static inline int set_move_one(Set *s, Set *other, const void *key) {
  67         return internal_hashmap_move_one(HASHMAP_BASE(s), HASHMAP_BASE(other), key);
  68 }
  69
  70 static inline unsigned set_size(Set *s) {
  71         return internal_hashmap_size(HASHMAP_BASE(s));
  72 }
  73
  74 static inline bool set_isempty(Set *s) {
  75         return set_size(s) == 0;
  76 }
  77
  78 static inline unsigned set_buckets(Set *s) {
  79         return internal_hashmap_buckets(HASHMAP_BASE(s));
  80 }
  81
  82 bool set_iterate(Set *s, Iterator *i, void **value);
  83
  84 static inline void set_clear(Set *s) {
  85         internal_hashmap_clear(HASHMAP_BASE(s));
  86 }
  87
  88 static inline void set_clear_free(Set *s) {
  89         internal_hashmap_clear_free(HASHMAP_BASE(s));
  90 }
  91
  92 /* no set_clear_free_free */
  93
  94 static inline void *set_steal_first(Set *s) {
  95         return internal_hashmap_steal_first(HASHMAP_BASE(s));
  96 }
  97
  98 #define set_clear_with_destructor(_s, _f)               \
  99         ({                                              \
 100                 void *_item;                            \
 101                 while ((_item = set_steal_first(_s)))   \
 102                         _f(_item);                      \
 103         })
 104 #define set_free_with_destructor(_s, _f)                \
 105         ({                                              \
 106                 set_clear_with_destructor(_s, _f);      \
 107                 set_free(_s);                           \
 108         })
 109
 110 /* no set_steal_first_key */
 111 /* no set_first_key */
 112
 113 static inline void *set_first(Set *s) {
 114         return internal_hashmap_first(HASHMAP_BASE(s));
 115 }
 116
 117 /* no set_next */
 118
 119 static inline char **set_get_strv(Set *s) {
 120         return internal_hashmap_get_strv(HASHMAP_BASE(s));
 121 }
 122
 123 int set_consume(Set *s, void *value);
 124 int set_put_strdup(Set *s, const char *p);
 125 #if 0 /// UNNEEDED by elogind
 126 int set_put_strdupv(Set *s, char **l);
 127 int set_put_strsplit(Set *s, const char *v, const char *separators, ExtractFlags flags);
 128 #endif // 0
 129
 130 #define SET_FOREACH(e, s, i) \
 131         for ((i) = ITERATOR_FIRST; set_iterate((s), &(i), (void**)&(e)); )
 132
 133 #define SET_FOREACH_MOVE(e, d, s)                                       \
 134         for (; ({ e = set_first(s); assert_se(!e || set_move_one(d, s, e) >= 0); e; }); )
 135
 136 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free);
 137 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free_free);
 138
 139 #define _cleanup_set_free_ _cleanup_(set_freep)
 140 #define _cleanup_set_free_free_ _cleanup_(set_free_freep)