src/include/eina_hash.h

   1 /* EINA - EFL data type library
   2  * Copyright (C) 2002-2008 Carsten Haitzler, Gustavo Sverzut Barbieri,
   3  *                         Vincent Torri, Jorge Luis Zapata Muga, Cedric Bail
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library;
  17  * if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef EINA_HASH_H_
  21 #define EINA_HASH_H_
  22
  23 #include "eina_types.h"
  24 #include "eina_iterator.h"
  25
  26 /**
  27  * @addtogroup Eina_Data_Types_Group Data Types
  28  *
  29  * @{
  30  */
  31
  32 /**
  33  * @addtogroup Eina_Containers_Group Containers
  34  *
  35  * @{
  36  */
  37
  38 /**
  39  * @defgroup Eina_Hash_Group Hash Table
  40  *
  41  * @{
  42  */
  43
  44 typedef struct _Eina_Hash Eina_Hash;
  45 typedef struct _Eina_Hash_Tuple Eina_Hash_Tuple;
  46 struct _Eina_Hash_Tuple
  47 {
  48    const void *key;
  49    void *data;
  50
  51    unsigned int key_length;
  52 };
  53
  54 typedef unsigned int (*Eina_Key_Length)(const void *key);
  55 #define EINA_KEY_LENGTH(Function) ((Eina_Key_Length)Function)
  56 typedef int (*Eina_Key_Cmp)(const void *key1, int key1_length,
  57                             const void *key2, int key2_length);
  58 #define EINA_KEY_CMP(Function) ((Eina_Key_Cmp)Function)
  59 typedef int (*Eina_Key_Hash)(const void *key, int key_length);
  60 #define EINA_KEY_HASH(Function) ((Eina_Key_Hash)Function)
  61
  62 EAPI int eina_hash_init(void);
  63 EAPI int eina_hash_shutdown(void);
  64
  65 EAPI Eina_Hash * eina_hash_new(Eina_Key_Length key_length_cb,
  66                                Eina_Key_Cmp key_cmp_cb,
  67                                Eina_Key_Hash key_hash_cb,
  68                                Eina_Free_Cb data_free_cb);
  69 EAPI Eina_Hash * eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb);
  70 EAPI Eina_Hash * eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb);
  71
  72 EAPI Eina_Bool   eina_hash_add(Eina_Hash *hash, const void *key, const void *data);
  73 EAPI Eina_Bool   eina_hash_direct_add(Eina_Hash *hash, const void *key, const void *data);
  74 EAPI Eina_Bool   eina_hash_del(Eina_Hash *hash, const void *key, const void *data);
  75 EAPI void      * eina_hash_find(const Eina_Hash *hash, const void *key);
  76 EAPI void      * eina_hash_modify(Eina_Hash *hash, const void *key, const void *data);
  77 EAPI void        eina_hash_free(Eina_Hash *hash);
  78 EAPI int         eina_hash_population(const Eina_Hash *hash);
  79
  80 EAPI Eina_Bool   eina_hash_add_by_hash(Eina_Hash *hash,
  81                                        const void *key, int key_length, int key_hash,
  82                                        const void *data);
  83 EAPI Eina_Bool   eina_hash_direct_add_by_hash(Eina_Hash *hash,
  84                                               const void *key, int key_length, int key_hash,
  85                                               const void *data);
  86 EAPI Eina_Bool   eina_hash_del_by_hash(Eina_Hash *hash,
  87                                        const void *key, int key_length, int key_hash,
  88                                        const void *data);
  89 EAPI void      * eina_hash_find_by_hash(const Eina_Hash *hash,
  90                                         const void *key, int key_length, int key_hash);
  91 EAPI void      * eina_hash_modify_by_hash(Eina_Hash *hash,
  92                                           const void *key, int key_length, int key_hash,
  93                                           const void *data);
  94
  95 EAPI Eina_Iterator * eina_hash_iterator_key_new(const Eina_Hash *hash);
  96 EAPI Eina_Iterator * eina_hash_iterator_data_new(const Eina_Hash *hash);
  97 EAPI Eina_Iterator * eina_hash_iterator_tuple_new(const Eina_Hash *hash);
  98
  99 typedef Eina_Bool (*Eina_Foreach)(const Eina_Hash *hash, const void *key, void *data, void *fdata);
 100 EAPI void        eina_hash_foreach(const Eina_Hash *hash,
 101                                    Eina_Foreach cb,
 102                                    const void *fdata);
 103
 104 /* Paul Hsieh (http://www.azillionmonkeys.com/qed/hash.html) hash function
 105    used by WebCore (http://webkit.org/blog/8/hashtables-part-2/) */
 106 EAPI int eina_hash_superfast(const char *key, int len);
 107
 108 /* Hash function first reported by dan bernstein many years ago in comp.lang.c */
 109 static inline int eina_hash_djb2(const char *key, int len);
 110
 111 #include "eina_inline_hash.x"
 112
 113 /**
 114  * @}
 115  */
 116
 117 /**
 118  * @}
 119  */
 120
 121 /**
 122  * @}
 123  */
 124
 125 #endif /*EINA_HASH_H_*/