2 * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of California, Berkeley nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * Simple hash table API
31 * This file provides functions to store objects in hash tables, using strings
41 typedef void (*ec_keyval_elt_free_t)(void *);
46 * Create a hash table.
49 * The hash table, or NULL on error (errno is set).
51 struct ec_keyval *ec_keyval(void);
54 * Get a value from the hash table.
61 * The element if it is found, or NULL on error (errno is set).
62 * In case of success but the element is NULL, errno is set to 0.
64 void *ec_keyval_get(const struct ec_keyval *keyval, const char *key);
67 * Check if the hash table contains this key.
74 * true if it contains the key, else false.
76 bool ec_keyval_has_key(const struct ec_keyval *keyval, const char *key);
79 * Delete an object from the hash table.
86 * 0 on success, or -1 on error (errno is set).
88 int ec_keyval_del(struct ec_keyval *keyval, const char *key);
91 * Add/replace an object in the hash table.
98 * The pointer to be saved in the hash table.
100 * An optional pointer to a destructor function called when an
101 * object is destroyed (ec_keyval_del() or ec_keyval_free()).
103 * 0 on success, or -1 on error (errno is set).
104 * On error, the passed value is freed (free_cb(val) is called).
106 int ec_keyval_set(struct ec_keyval *keyval, const char *key, void *val,
107 ec_keyval_elt_free_t free_cb);
110 * Free a hash table an all its objects.
115 void ec_keyval_free(struct ec_keyval *keyval);
118 * Get the length of a hash table.
123 * The length of the hash table.
125 size_t ec_keyval_len(const struct ec_keyval *keyval);
128 struct ec_keyval *ec_keyval_dup(const struct ec_keyval *keyval);
134 * The stream where the dump is sent.
138 void ec_keyval_dump(FILE *out, const struct ec_keyval *keyval);