1 /************************************************************************** 2 * 3 * Copyright 2008 VMware, Inc. 4 * All Rights Reserved. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a 7 * copy of this software and associated documentation files (the 8 * "Software"), to deal in the Software without restriction, including 9 * without limitation the rights to use, copy, modify, merge, publish, 10 * distribute, sub license, and/or sell copies of the Software, and to 11 * permit persons to whom the Software is furnished to do so, subject to 12 * the following conditions: 13 * 14 * The above copyright notice and this permission notice (including the 15 * next paragraph) shall be included in all copies or substantial portions 16 * of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR 22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25 * 26 **************************************************************************/ 27 28 /** 29 * General purpose hash table. 30 * 31 * @author José Fonseca <jfonseca@vmware.com> 32 */ 33 34 #ifndef U_HASH_TABLE_H_ 35 #define U_HASH_TABLE_H_ 36 37 38 #include "pipe/p_defines.h" 39 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 46 /** 47 * Generic purpose hash table. 48 */ 49 struct util_hash_table; 50 51 52 /** 53 * Create an hash table. 54 * 55 * @param hash hash function 56 * @param compare should return 0 for two equal keys. 57 */ 58 struct util_hash_table * 59 util_hash_table_create(unsigned (*hash)(void *key), 60 int (*compare)(void *key1, void *key2), 61 void (*destroy)(void *value)); 62 63 64 enum pipe_error 65 util_hash_table_set(struct util_hash_table *ht, 66 void *key, 67 void *value); 68 69 void * 70 util_hash_table_get(struct util_hash_table *ht, 71 void *key); 72 73 74 void 75 util_hash_table_remove(struct util_hash_table *ht, 76 void *key); 77 78 79 void 80 util_hash_table_clear(struct util_hash_table *ht); 81 82 83 enum pipe_error 84 util_hash_table_foreach(struct util_hash_table *ht, 85 enum pipe_error (*callback) 86 (void *key, void *value, void *data), 87 void *data); 88 89 void 90 util_hash_table_destroy(struct util_hash_table *ht); 91 92 93 #ifdef __cplusplus 94 } 95 #endif 96 97 #endif /* U_HASH_TABLE_H_ */ 98