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   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include "extract-word.h"
  24 #include "hashmap.h"
  25 #include "macro.h"
  26
  27 Set *internal_set_new(const struct hash_ops *hash_ops HASHMAP_DEBUG_PARAMS);
  28 #define set_new(ops) internal_set_new(ops HASHMAP_DEBUG_SRC_ARGS)
  29
  30 static inline Set *set_free(Set *s) {
  31         internal_hashmap_free(HASHMAP_BASE(s));
  32         return NULL;
  33 }
  34
  35 static inline Set *set_free_free(Set *s) {
  36         internal_hashmap_free_free(HASHMAP_BASE(s));
  37         return NULL;
  38 }
  39
  40 /* no set_free_free_free */
  41
  42 static inline Set *set_copy(Set *s) {
  43         return (Set*) internal_hashmap_copy(HASHMAP_BASE(s));
  44 }
  45
  46 int internal_set_ensure_allocated(Set **s, const struct hash_ops *hash_ops HASHMAP_DEBUG_PARAMS);
  47 #define set_ensure_allocated(h, ops) internal_set_ensure_allocated(h, ops HASHMAP_DEBUG_SRC_ARGS)
  48
  49 int set_put(Set *s, const void *key);
  50 /* no set_update */
  51 /* no set_replace */
  52 static inline void *set_get(Set *s, void *key) {
  53         return internal_hashmap_get(HASHMAP_BASE(s), key);
  54 }
  55 /* no set_get2 */
  56
  57 static inline bool set_contains(Set *s, const void *key) {
  58         return internal_hashmap_contains(HASHMAP_BASE(s), key);
  59 }
  60
  61 static inline void *set_remove(Set *s, const void *key) {
  62         return internal_hashmap_remove(HASHMAP_BASE(s), key);
  63 }
  64
  65 /* no set_remove2 */
  66 /* no set_remove_value */
  67 int set_remove_and_put(Set *s, const void *old_key, const void *new_key);
  68 /* no set_remove_and_replace */
  69 int set_merge(Set *s, Set *other);
  70
  71 static inline int set_reserve(Set *h, unsigned entries_add) {
  72         return internal_hashmap_reserve(HASHMAP_BASE(h), entries_add);
  73 }
  74
  75 static inline int set_move(Set *s, Set *other) {
  76         return internal_hashmap_move(HASHMAP_BASE(s), HASHMAP_BASE(other));
  77 }
  78
  79 static inline int set_move_one(Set *s, Set *other, const void *key) {
  80         return internal_hashmap_move_one(HASHMAP_BASE(s), HASHMAP_BASE(other), key);
  81 }
  82
  83 static inline unsigned set_size(Set *s) {
  84         return internal_hashmap_size(HASHMAP_BASE(s));
  85 }
  86
  87 static inline bool set_isempty(Set *s) {
  88         return set_size(s) == 0;
  89 }
  90
  91 static inline unsigned set_buckets(Set *s) {
  92         return internal_hashmap_buckets(HASHMAP_BASE(s));
  93 }
  94
  95 bool set_iterate(Set *s, Iterator *i, void **value);
  96
  97 static inline void set_clear(Set *s) {
  98         internal_hashmap_clear(HASHMAP_BASE(s));
  99 }
 100
 101 static inline void set_clear_free(Set *s) {
 102         internal_hashmap_clear_free(HASHMAP_BASE(s));
 103 }
 104
 105 /* no set_clear_free_free */
 106
 107 static inline void *set_steal_first(Set *s) {
 108         return internal_hashmap_steal_first(HASHMAP_BASE(s));
 109 }
 110
 111 #define set_clear_with_destructor(_s, _f)               \
 112         ({                                              \
 113                 void *_item;                            \
 114                 while ((_item = set_steal_first(_s)))   \
 115                         _f(_item);                      \
 116         })
 117 #define set_free_with_destructor(_s, _f)                \
 118         ({                                              \
 119                 set_clear_with_destructor(_s, _f);      \
 120                 set_free(_s);                           \
 121         })
 122
 123 /* no set_steal_first_key */
 124 /* no set_first_key */
 125
 126 static inline void *set_first(Set *s) {
 127         return internal_hashmap_first(HASHMAP_BASE(s));
 128 }
 129
 130 /* no set_next */
 131
 132 static inline char **set_get_strv(Set *s) {
 133         return internal_hashmap_get_strv(HASHMAP_BASE(s));
 134 }
 135
 136 int set_consume(Set *s, void *value);
 137 int set_put_strdup(Set *s, const char *p);
 138 int set_put_strdupv(Set *s, char **l);
 139 int set_put_strsplit(Set *s, const char *v, const char *separators, ExtractFlags flags);
 140
 141 #define SET_FOREACH(e, s, i) \
 142         for ((i) = ITERATOR_FIRST; set_iterate((s), &(i), (void**)&(e)); )
 143
 144 #define SET_FOREACH_MOVE(e, d, s)                                       \
 145         for (; ({ e = set_first(s); assert_se(!e || set_move_one(d, s, e) >= 0); e; }); )
 146
 147 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free);
 148 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free_free);
 149
 150 #define _cleanup_set_free_ _cleanup_(set_freep)
 151 #define _cleanup_set_free_free_ _cleanup_(set_free_freep)
 152
 153 int set_make(Set **ret, const struct hash_ops *hash_ops HASHMAP_DEBUG_PARAMS, void *add, ...);