src/set.h

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