2 /* EINA - EFL data type library
3 * Copyright (C) 2002-2008 Carsten Haitzler, Gustavo Sverzut Barbieri,
4 * Vincent Torri, Jorge Luis Zapata Muga, Cedric Bail
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library;
18 * if not, see <http://www.gnu.org/licenses/>.
24 #include "eina_types.h"
25 #include "eina_iterator.h"
28 * @addtogroup Eina_Data_Types_Group Data Types
34 * @addtogroup Eina_Containers_Group Containers
40 * @defgroup Eina_Hash_Group Hash Table
45 typedef struct _Eina_Hash Eina_Hash;
46 typedef struct _Eina_Hash_Tuple Eina_Hash_Tuple;
47 struct _Eina_Hash_Tuple
52 unsigned int key_length;
55 typedef unsigned int (*Eina_Key_Length)(const void *key);
56 #define EINA_KEY_LENGTH(Function) ((Eina_Key_Length)Function)
57 typedef int (*Eina_Key_Cmp)(const void *key1, int key1_length,
58 const void *key2, int key2_length);
59 #define EINA_KEY_CMP(Function) ((Eina_Key_Cmp)Function)
60 typedef int (*Eina_Key_Hash)(const void *key, int key_length);
61 #define EINA_KEY_HASH(Function) ((Eina_Key_Hash)Function)
63 EAPI int eina_hash_init(void);
64 EAPI int eina_hash_shutdown(void);
66 EAPI Eina_Hash * eina_hash_new(Eina_Key_Length key_length_cb,
67 Eina_Key_Cmp key_cmp_cb,
68 Eina_Key_Hash key_hash_cb,
69 Eina_Free_Cb data_free_cb,
70 int buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2, 3);
71 EAPI Eina_Hash * eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb);
72 EAPI Eina_Hash * eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb);
73 EAPI Eina_Hash * eina_hash_string_small_new(Eina_Free_Cb data_free_cb);
74 EAPI Eina_Hash * eina_hash_int32_new(Eina_Free_Cb data_free_cb);
75 EAPI Eina_Hash * eina_hash_int64_new(Eina_Free_Cb data_free_cb);
76 EAPI Eina_Hash * eina_hash_pointer_new(Eina_Free_Cb data_free_cb);
77 EAPI Eina_Hash * eina_hash_stringshared_new(Eina_Free_Cb data_free_cb);
79 EAPI Eina_Bool eina_hash_add(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);
80 EAPI Eina_Bool eina_hash_direct_add(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);
81 EAPI Eina_Bool eina_hash_del(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1);
82 EAPI void * eina_hash_find(const Eina_Hash *hash, const void *key) EINA_ARG_NONNULL(1, 2);
83 EAPI void * eina_hash_modify(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);
84 EAPI void eina_hash_free(Eina_Hash *hash) EINA_ARG_NONNULL(1);
85 EAPI int eina_hash_population(const Eina_Hash *hash) EINA_ARG_NONNULL(1) EINA_PURE;
87 EAPI Eina_Bool eina_hash_add_by_hash(Eina_Hash *hash,
88 const void *key, int key_length, int key_hash,
89 const void *data) EINA_ARG_NONNULL(1, 2, 5);
90 EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash,
91 const void *key, int key_length, int key_hash,
92 const void *data) EINA_ARG_NONNULL(1, 2, 5);
94 EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash, const void *key, int key_length, int key_hash) EINA_ARG_NONNULL(1, 2);
96 EAPI Eina_Bool eina_hash_del_by_key(Eina_Hash *hash, const void *key) EINA_ARG_NONNULL(1, 2);
97 EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash, const void *data) EINA_ARG_NONNULL(1, 2);
99 EAPI Eina_Bool eina_hash_del_by_hash(Eina_Hash *hash,
100 const void *key, int key_length, int key_hash,
101 const void *data) EINA_ARG_NONNULL(1);
102 EAPI void * eina_hash_find_by_hash(const Eina_Hash *hash,
103 const void *key, int key_length, int key_hash) EINA_ARG_NONNULL(1, 2);
104 EAPI void * eina_hash_modify_by_hash(Eina_Hash *hash,
105 const void *key, int key_length, int key_hash,
106 const void *data) EINA_ARG_NONNULL(1, 2, 5);
108 EAPI Eina_Iterator * eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
109 EAPI Eina_Iterator * eina_hash_iterator_data_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
110 EAPI Eina_Iterator * eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
112 typedef Eina_Bool (*Eina_Hash_Foreach)(const Eina_Hash *hash, const void *key, void *data, void *fdata);
113 EAPI void eina_hash_foreach(const Eina_Hash *hash,
114 Eina_Hash_Foreach cb,
115 const void *fdata) EINA_ARG_NONNULL(1, 2);
117 /* Paul Hsieh (http://www.azillionmonkeys.com/qed/hash.html) hash function
118 used by WebCore (http://webkit.org/blog/8/hashtables-part-2/) */
119 EAPI int eina_hash_superfast(const char *key, int len) EINA_ARG_NONNULL(1);
121 /* Hash function first reported by dan bernstein many years ago in comp.lang.c */
122 static inline int eina_hash_djb2(const char *key, int len) EINA_ARG_NONNULL(1);
123 static inline int eina_hash_djb2_len(const char *key, int *plen) EINA_ARG_NONNULL(1, 2);
125 /* Hash function from http://www.concentric.net/~Ttwang/tech/inthash.htm */
126 static inline int eina_hash_int32(const unsigned int *pkey, int len) EINA_ARG_NONNULL(1);
127 static inline int eina_hash_int64(const unsigned long int *pkey, int len) EINA_ARG_NONNULL(1);
129 #include "eina_inline_hash.x"
143 #endif /*EINA_HASH_H_*/