chiark / gitweb /
Move player/decoder PIDs back into the main queue_entry structure, now
[disorder] / lib / hash.h
... / ...
CommitLineData
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
25typedef struct hash hash;
26struct kvp;
27
28hash *hash_new(size_t valuesize);
29/* Create a new hash */
30
31int hash_add(hash *h, const char *key, const void *value, int mode);
32#define HASH_INSERT 0
33#define HASH_REPLACE 1
34#define HASH_INSERT_OR_REPLACE 2
35/* Insert/replace a value in the hash. Returns 0 on success, -1 on
36 * error. */
37
38int hash_remove(hash *h, const char *key);
39/* Remove a value in the hash. Returns 0 on success, -1 on error. */
40
41void *hash_find(hash *h, const char *key);
42/* Find a value in the hash. Returns a null pointer if not found. */
43
44int hash_foreach(hash *h,
45 int (*callback)(const char *key, void *value, void *u),
46 void *u);
47/* Visit all the elements in a hash in any old order. It's safe to remove
48 * items from inside the callback including the visited one. It is not safe to
49 * add items from inside the callback however.
50 *
51 * If the callback ever returns non-0 then that value is immediately returned.
52 * Otherwise the return value is 0.
53 */
54
55size_t hash_count(hash *h);
56/* Return the number of items in the hash */
57
58char **hash_keys(hash *h);
59/* Return all the keys of H */
60
61#endif /* HASH_H */
62
63/*
64Local Variables:
65c-basic-offset:2
66comment-column:40
67fill-column:79
68indent-tabs-mode:nil
69End:
70*/