chiark / gitweb /
examples/disorder.init.in: Read settings from `/etc/default/disorder'.
[disorder] / lib / hash.h
1 /*
2  * This file is part of DisOrder
3  * Copyright (C) 2005-2008 Richard Kettlewell
4  *
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.
9  * 
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.
14  * 
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/>.
17  */
18 /** @file lib/hash.h
19  * @brief A simple hash table
20  */
21
22 #ifndef HASH_H
23 #define HASH_H
24
25 /** @brief Hash structure
26  *
27  * A hash table has string keys and byte blocks of fixed size as values.
28  */
29 typedef struct hash hash;
30 struct kvp;
31
32 hash *hash_new(size_t valuesize);
33 /* Create a new hash */
34
35 int hash_add(hash *h, const char *key, const void *value, int mode);
36 #define HASH_INSERT 0
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
40  * error. */
41
42 int hash_remove(hash *h, const char *key);
43 /* Remove a value in the hash.  Returns 0 on success, -1 on error. */
44
45 void *hash_find(hash *h, const char *key);
46 /* Find a value in the hash.  Returns a null pointer if not found. */
47
48 int hash_foreach(hash *h,
49                  int (*callback)(const char *key, void *value, void *u),
50                  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.
54  *
55  * If the callback ever returns non-0 then that value is immediately returned.
56  * Otherwise the return value is 0.
57  */
58
59 size_t hash_count(hash *h);
60 /* Return the number of items in the hash */
61
62 char **hash_keys(hash *h);
63 /* Return all the keys of H */
64
65 #endif /* HASH_H */
66
67 /*
68 Local Variables:
69 c-basic-offset:2
70 comment-column:40
71 fill-column:79
72 indent-tabs-mode:nil
73 End:
74 */