2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @brief A simple hash table
25 /** @brief Hash structure
27 * A hash table has string keys and byte blocks of fixed size as values.
29 typedef struct hash hash;
32 hash *hash_new(size_t valuesize);
33 /* Create a new hash */
35 int hash_add(hash *h, const char *key, const void *value, int mode);
37 #define HASH_REPLACE 1
38 #define HASH_INSERT_OR_REPLACE 2
39 /* Insert/replace a value in the hash. Returns 0 on success, -1 on
42 int hash_remove(hash *h, const char *key);
43 /* Remove a value in the hash. Returns 0 on success, -1 on error. */
45 void *hash_find(hash *h, const char *key);
46 /* Find a value in the hash. Returns a null pointer if not found. */
48 int hash_foreach(hash *h,
49 int (*callback)(const char *key, void *value, void *u),
51 /* Visit all the elements in a hash in any old order. It's safe to remove
52 * items from inside the callback including the visited one. It is not safe to
53 * add items from inside the callback however.
55 * If the callback ever returns non-0 then that value is immediately returned.
56 * Otherwise the return value is 0.
59 size_t hash_count(hash *h);
60 /* Return the number of items in the hash */
62 char **hash_keys(hash *h);
63 /* Return all the keys of H */