chiark / gitweb /
Report disorder_eclient_volume() errors to the specific callback.
[disorder] / lib / hash.h
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder
5aff007d 3 * Copyright (C) 2005-2008 Richard Kettlewell
460b9539 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 2 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, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18 * USA
19 */
20
21#ifndef HASH_H
22#define HASH_H
23
24typedef struct hash hash;
9faa7a88 25struct kvp;
460b9539 26
27hash *hash_new(size_t valuesize);
28/* Create a new hash */
29
30int hash_add(hash *h, const char *key, const void *value, int mode);
31#define HASH_INSERT 0
32#define HASH_REPLACE 1
33#define HASH_INSERT_OR_REPLACE 2
34/* Insert/replace a value in the hash. Returns 0 on success, -1 on
35 * error. */
36
37int hash_remove(hash *h, const char *key);
38/* Remove a value in the hash. Returns 0 on success, -1 on error. */
39
40void *hash_find(hash *h, const char *key);
41/* Find a value in the hash. Returns a null pointer if not found. */
42
43int hash_foreach(hash *h,
44 int (*callback)(const char *key, void *value, void *u),
45 void *u);
46/* Visit all the elements in a hash in any old order. It's safe to remove
47 * items from inside the callback including the visited one. It is not safe to
48 * add items from inside the callback however.
49 *
50 * If the callback ever returns non-0 then that value is immediately returned.
51 * Otherwise the return value is 0.
52 */
53
54size_t hash_count(hash *h);
55/* Return the number of items in the hash */
56
57char **hash_keys(hash *h);
58/* Return all the keys of H */
59
60#endif /* HASH_H */
61
62/*
63Local Variables:
64c-basic-offset:2
65comment-column:40
66fill-column:79
67indent-tabs-mode:nil
68End:
69*/