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 #ifdef EINA_RWLOCKS_ENABLED
  27 # include <pthread.h>
  28 # include <errno.h>
  29 #endif
  30 /**
  31  * @addtogroup Eina_Data_Types_Group Data Types
  32  *
  33  * @{
  34  */
  35
  36 /**
  37  * @addtogroup Eina_Containers_Group Containers
  38  *
  39  * @{
  40  */
  41
  42 /**
  43  * @defgroup Eina_Hash_Group Hash Table
  44  *
  45  * @{
  46  */
  47
  48 typedef struct _Eina_Hash Eina_Hash;
  49 typedef struct _Eina_Hash_Tuple Eina_Hash_Tuple;
  50 struct _Eina_Hash_Tuple
  51 {
  52    const void *key;
  53    void *data;
  54    unsigned int key_length;
  55 };
  56
  57 typedef unsigned int (*Eina_Key_Length)(const void *key);
  58 #define EINA_KEY_LENGTH(Function) ((Eina_Key_Length)Function)
  59 typedef int (*Eina_Key_Cmp)(const void *key1, int key1_length, const void *key2, int key2_length);
  60 #define EINA_KEY_CMP(Function) ((Eina_Key_Cmp)Function)
  61 typedef int (*Eina_Key_Hash)(const void *key, int key_length);
  62 #define EINA_KEY_HASH(Function) ((Eina_Key_Hash)Function)
  63 typedef Eina_Bool (*Eina_Hash_Foreach)(const Eina_Hash *hash, const void *key, void *data, void *fdata);
  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                                    int buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2, 3);
  70 EAPI Eina_Hash *     eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb);
  71 EAPI Eina_Hash *     eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb);
  72 EAPI Eina_Hash *     eina_hash_string_small_new(Eina_Free_Cb data_free_cb);
  73 EAPI Eina_Hash *     eina_hash_int32_new(Eina_Free_Cb data_free_cb);
  74 EAPI Eina_Hash *     eina_hash_int64_new(Eina_Free_Cb data_free_cb);
  75 EAPI Eina_Hash *     eina_hash_pointer_new(Eina_Free_Cb data_free_cb);
  76 EAPI Eina_Hash *     eina_hash_stringshared_new(Eina_Free_Cb data_free_cb);
  77 EAPI Eina_Hash *     eina_hash_threadsafe_new(Eina_Key_Length key_length_cb,
  78                                               Eina_Key_Cmp key_cmp_cb,
  79                                               Eina_Key_Hash key_hash_cb,
  80                                               Eina_Free_Cb data_free_cb,
  81                                               int buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2, 3);
  82 EAPI Eina_Hash *     eina_hash_threadsafe_string_djb2_new(Eina_Free_Cb data_free_cb);
  83 EAPI Eina_Hash *     eina_hash_threadsafe_string_superfast_new(Eina_Free_Cb data_free_cb);
  84 EAPI Eina_Hash *     eina_hash_threadsafe_string_small_new(Eina_Free_Cb data_free_cb);
  85 EAPI Eina_Hash *     eina_hash_threadsafe_int32_new(Eina_Free_Cb data_free_cb);
  86 EAPI Eina_Hash *     eina_hash_threadsafe_int64_new(Eina_Free_Cb data_free_cb);
  87 EAPI Eina_Hash *     eina_hash_threadsafe_pointer_new(Eina_Free_Cb data_free_cb);
  88 EAPI Eina_Hash *     eina_hash_threadsafe_stringshared_new(Eina_Free_Cb data_free_cb);
  89 EAPI Eina_Bool       eina_hash_add(Eina_Hash *hash,
  90                                    const void *key,
  91                                    const void *data) EINA_ARG_NONNULL(1, 2, 3);
  92 EAPI Eina_Bool       eina_hash_direct_add(Eina_Hash *hash,
  93                                           const void *key,
  94                                           const void *data) EINA_ARG_NONNULL(1, 2, 3);
  95 EAPI Eina_Bool       eina_hash_del(Eina_Hash *hash,
  96                                    const void *key,
  97                                    const void *data) EINA_ARG_NONNULL(1);
  98 EAPI void *          eina_hash_find(const Eina_Hash *hash,
  99                                     const void *key) EINA_ARG_NONNULL(1, 2);
 100 EAPI void *          eina_hash_modify(Eina_Hash *hash,
 101                                       const void *key,
 102                                       const void *data) EINA_ARG_NONNULL(1, 2, 3);
 103 EAPI void *          eina_hash_set(Eina_Hash *hash,
 104                                    const void *key,
 105                                    const void *data) EINA_ARG_NONNULL(1, 2, 3);
 106 EAPI Eina_Bool       eina_hash_move(Eina_Hash *hash,
 107                                     const void *old_key,
 108                                     const void *new_key) EINA_ARG_NONNULL(1, 2, 3);
 109 EAPI void            eina_hash_free(Eina_Hash *hash) EINA_ARG_NONNULL(1);
 110 EAPI void            eina_hash_free_buckets(Eina_Hash *hash) EINA_ARG_NONNULL(1);
 111 EAPI int             eina_hash_population(const Eina_Hash *hash) EINA_ARG_NONNULL(1);
 112 EAPI Eina_Bool       eina_hash_add_by_hash(Eina_Hash *hash,
 113                                            const void *key,
 114                                            int key_length,
 115                                            int key_hash,
 116                                            const void *data) EINA_ARG_NONNULL(1, 2, 5);
 117 EAPI Eina_Bool       eina_hash_direct_add_by_hash(Eina_Hash *hash,
 118                                                   const void *key,
 119                                                   int key_length,
 120                                                   int key_hash,
 121                                                   const void *data) EINA_ARG_NONNULL(1, 2, 5);
 122 EAPI Eina_Bool       eina_hash_del_by_key_hash(Eina_Hash *hash,
 123                                                const void *key,
 124                                                int key_length,
 125                                                int key_hash) EINA_ARG_NONNULL(1, 2);
 126 EAPI Eina_Bool       eina_hash_del_by_key(Eina_Hash *hash,
 127                                           const void *key) EINA_ARG_NONNULL(1, 2);
 128 EAPI Eina_Bool       eina_hash_del_by_data(Eina_Hash *hash,
 129                                            const void *data) EINA_ARG_NONNULL(1, 2);
 130 EAPI Eina_Bool       eina_hash_del_by_hash(Eina_Hash *hash,
 131                                            const void *key,
 132                                            int key_length,
 133                                            int key_hash,
 134                                            const void *data) EINA_ARG_NONNULL(1);
 135 EAPI void *          eina_hash_find_by_hash(const Eina_Hash *hash,
 136                                             const void *key,
 137                                             int key_length,
 138                                             int key_hash) EINA_ARG_NONNULL(1, 2);
 139 EAPI void *          eina_hash_modify_by_hash(Eina_Hash *hash,
 140                                               const void *key,
 141                                               int key_length,
 142                                               int key_hash,
 143                                               const void *data) EINA_ARG_NONNULL(1, 2, 5);
 144 EAPI Eina_Iterator * eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
 145 EAPI Eina_Iterator * eina_hash_iterator_data_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
 146 EAPI Eina_Iterator * eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
 147 EAPI void            eina_hash_foreach(const Eina_Hash *hash,
 148                                        Eina_Hash_Foreach cb,
 149                                        const void *fdata) EINA_ARG_NONNULL(1, 2);
 150 /* Paul Hsieh (http://www.azillionmonkeys.com/qed/hash.html) hash function used by WebCore (http://webkit.org/blog/8/hashtables-part-2/) */
 151 EAPI int             eina_hash_superfast(const char *key,
 152                                          int len) EINA_ARG_NONNULL(1);
 153 /* Hash function first reported by dan bernstein many years ago in comp.lang.c */
 154 static inline int    eina_hash_djb2(const char *key,
 155                                     int len) EINA_ARG_NONNULL(1);
 156 static inline int    eina_hash_djb2_len(const char *key,
 157                                         int *plen) EINA_ARG_NONNULL(1, 2);
 158 /* Hash function from http://www.concentric.net/~Ttwang/tech/inthash.htm */
 159 static inline int    eina_hash_int32(const unsigned int *pkey,
 160                                      int len) EINA_ARG_NONNULL(1);
 161 static inline int    eina_hash_int64(const unsigned long int *pkey,
 162                                      int len) EINA_ARG_NONNULL(1);
 163
 164 #include "eina_inline_hash.x"
 165
 166 /**
 167  * @}
 168  */
 169
 170 /**
 171  * @}
 172  */
 173
 174 /**
 175  * @}
 176  */
 177
 178 #endif /*EINA_HASH_H_*/