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