Home | History | Annotate | Download | only in util 
      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 (at) 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 
     62 
     63 enum pipe_error
     64 util_hash_table_set(struct util_hash_table *ht,
     65                     void *key,
     66                     void *value);
     67 
     68 void *
     69 util_hash_table_get(struct util_hash_table *ht,
     70                     void *key);
     71 
     72 
     73 void
     74 util_hash_table_remove(struct util_hash_table *ht,
     75                        void *key);
     76 
     77 
     78 void
     79 util_hash_table_clear(struct util_hash_table *ht);
     80 
     81 
     82 enum pipe_error
     83 util_hash_table_foreach(struct util_hash_table *ht,
     84                         enum pipe_error (*callback)
     85                         (void *key, void *value, void *data),
     86                         void *data);
     87 
     88 void
     89 util_hash_table_destroy(struct util_hash_table *ht);
     90 
     91 
     92 #ifdef __cplusplus
     93 }
     94 #endif
     95 
     96 #endif /* U_HASH_TABLE_H_ */
     97