src/basic/set.h

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