1/* $Id: strhash.h,v 1.1 2003/06/04 00:25:42 marka Exp $ */
2/*
3 * Copyright (c) 2000 Japan Network Information Center.  All rights reserved.
4 *
5 * By using this file, you agree to the terms and conditions set forth bellow.
6 *
7 * 			LICENSE TERMS AND CONDITIONS
8 *
9 * The following License Terms and Conditions apply, unless a different
10 * license is obtained from Japan Network Information Center ("JPNIC"),
11 * a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,
12 * Chiyoda-ku, Tokyo 101-0047, Japan.
13 *
14 * 1. Use, Modification and Redistribution (including distribution of any
15 *    modified or derived work) in source and/or binary forms is permitted
16 *    under this License Terms and Conditions.
17 *
18 * 2. Redistribution of source code must retain the copyright notices as they
19 *    appear in each source code file, this License Terms and Conditions.
20 *
21 * 3. Redistribution in binary form must reproduce the Copyright Notice,
22 *    this License Terms and Conditions, in the documentation and/or other
23 *    materials provided with the distribution.  For the purposes of binary
24 *    distribution the "Copyright Notice" refers to the following language:
25 *    "Copyright (c) 2000-2002 Japan Network Information Center.  All rights reserved."
26 *
27 * 4. The name of JPNIC may not be used to endorse or promote products
28 *    derived from this Software without specific prior written approval of
29 *    JPNIC.
30 *
31 * 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
32 *    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 *    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
34 *    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL JPNIC BE LIABLE
35 *    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
38 *    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
39 *    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
40 *    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 *    ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef IDN_STRHASH_H
45#define IDN_STRHASH_H 1
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
51/*
52 * String-keyed hash table
53 *
54 * Just a hash table.  Nothing special.  Number of hash buckets
55 * grows automatically.
56 */
57
58#include <idn/result.h>
59
60/*
61 * Hash table type, which is opaque.
62 */
63typedef struct idn__strhash *idn__strhash_t;
64
65/*
66 * Hash value free proc.
67 */
68typedef void (*idn__strhash_freeproc_t)(void *value);
69
70/*
71 * Create a hash table.
72 *
73 * Returns:
74 *	idn_success		-- ok.
75 *	idn_nomemory		-- malloc failed.
76 */
77extern idn_result_t
78idn__strhash_create(idn__strhash_t *hashp);
79
80/*
81 * Delete a hash table created by 'idn__strhash_create'.
82 * If 'proc' is not NULL, it is called for each value in the
83 * hash to release memory for them.
84 */
85extern void
86idn__strhash_destroy(idn__strhash_t hash, idn__strhash_freeproc_t proc);
87
88/*
89 * Register an item to the hash table.  This function makes a
90 * private copy of the key string.
91 *
92 * Returns:
93 *	idn_success		-- ok.
94 *	idn_nomemory		-- malloc failed.
95 */
96extern idn_result_t
97idn__strhash_put(idn__strhash_t hash, const char *key, void *value);
98
99/*
100 * Find an item with the specified key.
101 *
102 * Returns:
103 *	idn_success		-- ok. found.
104 *	idn_noentry		-- not found.
105 */
106extern idn_result_t
107idn__strhash_get(idn__strhash_t hash, const char *key, void **valuep);
108
109/*
110 * Check if an item with the specified key exists.
111 *
112 * Returns:
113 *	1			-- yes.
114 *	0			-- no.
115 */
116extern int
117idn__strhash_exists(idn__strhash_t hash, const char *key);
118
119#ifdef __cplusplus
120}
121#endif
122
123#endif /* IDN_STRHASH_H */
124