src/shared/hashmap.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 #include <stdbool.h>
  25
  26 #include "macro.h"
  27
  28 /* Pretty straightforward hash table implementation. As a minor
  29  * optimization a NULL hashmap object will be treated as empty hashmap
  30  * for all read operations. That way it is not necessary to
  31  * instantiate an object for each Hashmap use. */
  32
  33 typedef struct Hashmap Hashmap;
  34 typedef struct _IteratorStruct _IteratorStruct;
  35 typedef _IteratorStruct* Iterator;
  36
  37 #define ITERATOR_FIRST ((Iterator) 0)
  38 #define ITERATOR_LAST ((Iterator) -1)
  39
  40 typedef unsigned (*hash_func_t)(const void *p);
  41 typedef int (*compare_func_t)(const void *a, const void *b);
  42
  43 unsigned string_hash_func(const void *p) _pure_;
  44 int string_compare_func(const void *a, const void *b) _pure_;
  45
  46 unsigned trivial_hash_func(const void *p) _const_;
  47 int trivial_compare_func(const void *a, const void *b) _const_;
  48
  49 unsigned uint64_hash_func(const void *p) _pure_;
  50 int uint64_compare_func(const void *a, const void *b) _pure_;
  51
  52 Hashmap *hashmap_new(hash_func_t hash_func, compare_func_t compare_func);
  53 void hashmap_free(Hashmap *h);
  54 void hashmap_free_free(Hashmap *h);
  55 void hashmap_free_free_free(Hashmap *h);
  56 Hashmap *hashmap_copy(Hashmap *h);
  57 int hashmap_ensure_allocated(Hashmap **h, hash_func_t hash_func, compare_func_t compare_func);
  58
  59 int hashmap_put(Hashmap *h, const void *key, void *value);
  60 int hashmap_update(Hashmap *h, const void *key, void *value);
  61 int hashmap_replace(Hashmap *h, const void *key, void *value);
  62 void *hashmap_get(Hashmap *h, const void *key);
  63 void *hashmap_get2(Hashmap *h, const void *key, void **rkey);
  64 bool hashmap_contains(Hashmap *h, const void *key);
  65 void *hashmap_remove(Hashmap *h, const void *key);
  66 void *hashmap_remove_value(Hashmap *h, const void *key, void *value);
  67 int hashmap_remove_and_put(Hashmap *h, const void *old_key, const void *new_key, void *value);
  68 int hashmap_remove_and_replace(Hashmap *h, const void *old_key, const void *new_key, void *value);
  69
  70 int hashmap_merge(Hashmap *h, Hashmap *other);
  71 void hashmap_move(Hashmap *h, Hashmap *other);
  72 int hashmap_move_one(Hashmap *h, Hashmap *other, const void *key);
  73
  74 unsigned hashmap_size(Hashmap *h) _pure_;
  75 bool hashmap_isempty(Hashmap *h) _pure_;
  76
  77 void *hashmap_iterate(Hashmap *h, Iterator *i, const void **key);
  78 void *hashmap_iterate_backwards(Hashmap *h, Iterator *i, const void **key);
  79 void *hashmap_iterate_skip(Hashmap *h, const void *key, Iterator *i);
  80
  81 void hashmap_clear(Hashmap *h);
  82 void hashmap_clear_free(Hashmap *h);
  83 void hashmap_clear_free_free(Hashmap *h);
  84
  85 void *hashmap_steal_first(Hashmap *h);
  86 void *hashmap_steal_first_key(Hashmap *h);
  87 void *hashmap_first(Hashmap *h) _pure_;
  88 void *hashmap_first_key(Hashmap *h) _pure_;
  89 void *hashmap_last(Hashmap *h) _pure_;
  90
  91 void *hashmap_next(Hashmap *h, const void *key);
  92
  93 char **hashmap_get_strv(Hashmap *h);
  94
  95 #define HASHMAP_FOREACH(e, h, i) \
  96         for ((i) = ITERATOR_FIRST, (e) = hashmap_iterate((h), &(i), NULL); (e); (e) = hashmap_iterate((h), &(i), NULL))
  97
  98 #define HASHMAP_FOREACH_KEY(e, k, h, i) \
  99         for ((i) = ITERATOR_FIRST, (e) = hashmap_iterate((h), &(i), (const void**) &(k)); (e); (e) = hashmap_iterate((h), &(i), (const void**) &(k)))
 100
 101 #define HASHMAP_FOREACH_BACKWARDS(e, h, i) \
 102         for ((i) = ITERATOR_LAST, (e) = hashmap_iterate_backwards((h), &(i), NULL); (e); (e) = hashmap_iterate_backwards((h), &(i), NULL))