src/shared/set.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 /* Pretty straightforward set implementation. Internally based on the
  25  * hashmap. That means that as a minor optimization a NULL set
  26  * object will be treated as empty set for all read
  27  * operations. That way it is not necessary to instantiate an object
  28  * for each set use. */
  29
  30 #include "hashmap.h"
  31 #include "util.h"
  32
  33 typedef struct Set Set;
  34
  35 Set *set_new(hash_func_t hash_func, compare_func_t compare_func);
  36 void set_free(Set* s);
  37 void set_free_free(Set *s);
  38
  39 Set* set_copy(Set *s);
  40 int set_ensure_allocated(Set **s, hash_func_t hash_func, compare_func_t compare_func);
  41
  42 int set_put(Set *s, void *value);
  43 int set_consume(Set *s, void *value);
  44 int set_replace(Set *s, void *value);
  45 void *set_get(Set *s, void *value);
  46 bool set_contains(Set *s, void *value);
  47 void *set_remove(Set *s, void *value);
  48 int set_remove_and_put(Set *s, void *old_value, void *new_value);
  49
  50 int set_merge(Set *s, Set *other);
  51 void set_move(Set *s, Set *other);
  52 int set_move_one(Set *s, Set *other, void *value);
  53
  54 unsigned set_size(Set *s);
  55 bool set_isempty(Set *s);
  56
  57 void *set_iterate(Set *s, Iterator *i);
  58 void *set_iterate_backwards(Set *s, Iterator *i);
  59 void *set_iterate_skip(Set *s, void *value, Iterator *i);
  60
  61 void set_clear(Set *s);
  62 void set_clear_free(Set *s);
  63
  64 void *set_steal_first(Set *s);
  65 void* set_first(Set *s);
  66 void* set_last(Set *s);
  67
  68 char **set_get_strv(Set *s);
  69
  70 #define SET_FOREACH(e, s, i) \
  71         for ((i) = ITERATOR_FIRST, (e) = set_iterate((s), &(i)); (e); (e) = set_iterate((s), &(i)))
  72
  73 #define SET_FOREACH_BACKWARDS(e, s, i) \
  74         for ((i) = ITERATOR_LAST, (e) = set_iterate_backwards((s), &(i)); (e); (e) = set_iterate_backwards((s), &(i)))
  75
  76 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free);
  77 DEFINE_TRIVIAL_CLEANUP_FUNC(Set*, set_free_free);
  78 #define _cleanup_set_free_ _cleanup_(set_freep)
  79 #define _cleanup_set_free_free_ _cleanup_(set_free_freep)