7a2d992490496b3fececbd6e0d649bed1f6d311c
[blender.git] / source / blender / blenlib / BLI_ghash.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 #ifndef __BLI_GHASH_H__
27 #define __BLI_GHASH_H__
28
29 /** \file BLI_ghash.h
30  *  \ingroup bli
31  *
32  * GHash is a hash-map implementation (unordered key, value pairs).
33  *
34  * This is also used to implement a 'set' (see #GSet below).
35  */
36
37 #include "BLI_sys_types.h" /* for bool */
38 #include "BLI_compiler_attrs.h"
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #define _GHASH_INTERNAL_ATTR
45 #ifndef GHASH_INTERNAL_API
46 #  ifdef __GNUC__
47 #    undef  _GHASH_INTERNAL_ATTR
48 #    define _GHASH_INTERNAL_ATTR __attribute__ ((deprecated))  /* not deprecated, just private. */
49 #  endif
50 #endif
51
52 typedef unsigned int  (*GHashHashFP)     (const void *key);
53 /** returns false when equal */
54 typedef bool          (*GHashCmpFP)      (const void *a, const void *b);
55 typedef void          (*GHashKeyFreeFP)  (void *key);
56 typedef void          (*GHashValFreeFP)  (void *val);
57 typedef void         *(*GHashKeyCopyFP)  (const void *key);
58 typedef void         *(*GHashValCopyFP)  (const void *val);
59
60 typedef struct GHash GHash;
61
62 typedef struct GHashIterator {
63         GHash *gh;
64         struct Entry *curEntry;
65         unsigned int curBucket;
66 } GHashIterator;
67
68 typedef struct GHashIterState {
69         unsigned int curr_bucket _GHASH_INTERNAL_ATTR;
70 } GHashIterState;
71
72
73
74 enum {
75         GHASH_FLAG_ALLOW_DUPES  = (1 << 0),  /* Only checked for in debug mode */
76         GHASH_FLAG_ALLOW_SHRINK = (1 << 1),  /* Allow to shrink buckets' size. */
77
78 #ifdef GHASH_INTERNAL_API
79         /* Internal usage only */
80         GHASH_FLAG_IS_GSET      = (1 << 16),  /* Whether the GHash is actually used as GSet (no value storage). */
81 #endif
82 };
83
84 /* *** */
85
86 GHash *BLI_ghash_new_ex(
87         GHashHashFP hashfp, GHashCmpFP cmpfp, const char *info,
88         const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
89 GHash *BLI_ghash_new(
90         GHashHashFP hashfp, GHashCmpFP cmpfp, const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
91 GHash *BLI_ghash_copy(
92         GHash *gh, GHashKeyCopyFP keycopyfp,
93         GHashValCopyFP valcopyfp) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
94 void   BLI_ghash_free(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
95 void   BLI_ghash_reserve(GHash *gh, const unsigned int nentries_reserve);
96 void   BLI_ghash_insert(GHash *gh, void *key, void *val);
97 bool   BLI_ghash_reinsert(GHash *gh, void *key, void *val, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
98 void  *BLI_ghash_replace_key(GHash *gh, void *key);
99 void  *BLI_ghash_lookup(GHash *gh, const void *key) ATTR_WARN_UNUSED_RESULT;
100 void  *BLI_ghash_lookup_default(GHash *gh, const void *key, void *val_default) ATTR_WARN_UNUSED_RESULT;
101 void **BLI_ghash_lookup_p(GHash *gh, const void *key) ATTR_WARN_UNUSED_RESULT;
102 bool   BLI_ghash_ensure_p(GHash *gh, void *key, void ***r_val) ATTR_WARN_UNUSED_RESULT;
103 bool   BLI_ghash_ensure_p_ex(GHash *gh, const void *key, void ***r_key, void ***r_val) ATTR_WARN_UNUSED_RESULT;
104 bool   BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
105 void   BLI_ghash_clear(
106         GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
107 void   BLI_ghash_clear_ex(
108         GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp,
109         const unsigned int nentries_reserve);
110 void  *BLI_ghash_popkey(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp) ATTR_WARN_UNUSED_RESULT;
111 bool   BLI_ghash_haskey(GHash *gh, const void *key) ATTR_WARN_UNUSED_RESULT;
112 bool   BLI_ghash_pop(GHash *gh, GHashIterState *state, void **r_key, void **r_val) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
113 unsigned int BLI_ghash_len(GHash *gh) ATTR_WARN_UNUSED_RESULT;
114 void   BLI_ghash_flag_set(GHash *gh, unsigned int flag);
115 void   BLI_ghash_flag_clear(GHash *gh, unsigned int flag);
116
117 /* *** */
118
119 GHashIterator *BLI_ghashIterator_new(GHash *gh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
120
121 void           BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh);
122 void           BLI_ghashIterator_free(GHashIterator *ghi);
123 void           BLI_ghashIterator_step(GHashIterator *ghi);
124
125 BLI_INLINE void  *BLI_ghashIterator_getKey(GHashIterator *ghi) ATTR_WARN_UNUSED_RESULT;
126 BLI_INLINE void  *BLI_ghashIterator_getValue(GHashIterator *ghi) ATTR_WARN_UNUSED_RESULT;
127 BLI_INLINE void **BLI_ghashIterator_getValue_p(GHashIterator *ghi) ATTR_WARN_UNUSED_RESULT;
128 BLI_INLINE bool   BLI_ghashIterator_done(GHashIterator *ghi) ATTR_WARN_UNUSED_RESULT;
129
130 struct _gh_Entry { void *next, *key, *val; };
131 BLI_INLINE void  *BLI_ghashIterator_getKey(GHashIterator *ghi)     { return  ((struct _gh_Entry *)ghi->curEntry)->key; }
132 BLI_INLINE void  *BLI_ghashIterator_getValue(GHashIterator *ghi)   { return  ((struct _gh_Entry *)ghi->curEntry)->val; }
133 BLI_INLINE void **BLI_ghashIterator_getValue_p(GHashIterator *ghi) { return &((struct _gh_Entry *)ghi->curEntry)->val; }
134 BLI_INLINE bool   BLI_ghashIterator_done(GHashIterator *ghi)       { return !ghi->curEntry; }
135 /* disallow further access */
136 #ifdef __GNUC__
137 #  pragma GCC poison _gh_Entry
138 #else
139 #  define _gh_Entry void
140 #endif
141
142 #define GHASH_ITER(gh_iter_, ghash_) \
143         for (BLI_ghashIterator_init(&gh_iter_, ghash_); \
144              BLI_ghashIterator_done(&gh_iter_) == false; \
145              BLI_ghashIterator_step(&gh_iter_))
146
147 #define GHASH_ITER_INDEX(gh_iter_, ghash_, i_) \
148         for (BLI_ghashIterator_init(&gh_iter_, ghash_), i_ = 0; \
149              BLI_ghashIterator_done(&gh_iter_) == false; \
150              BLI_ghashIterator_step(&gh_iter_), i_++)
151
152 /** \name Callbacks for GHash
153  *
154  * \note '_p' suffix denotes void pointer arg,
155  * so we can have functions that take correctly typed args too.
156  * \{ */
157
158 unsigned int    BLI_ghashutil_ptrhash(const void *key);
159 bool            BLI_ghashutil_ptrcmp(const void *a, const void *b);
160
161 unsigned int    BLI_ghashutil_strhash_n(const char *key, size_t n);
162 #define         BLI_ghashutil_strhash(key) ( \
163                 CHECK_TYPE_ANY(key, char *, const char *, const char * const), \
164                 BLI_ghashutil_strhash_p(key))
165 unsigned int    BLI_ghashutil_strhash_p(const void *key);
166 unsigned int    BLI_ghashutil_strhash_p_murmur(const void *key);
167 bool            BLI_ghashutil_strcmp(const void *a, const void *b);
168
169 #define         BLI_ghashutil_inthash(key) ( \
170                 CHECK_TYPE_ANY(&(key), int *, const int *), \
171                 BLI_ghashutil_uinthash((unsigned int)key))
172 unsigned int    BLI_ghashutil_uinthash(unsigned int key);
173 unsigned int    BLI_ghashutil_inthash_p(const void *ptr);
174 unsigned int    BLI_ghashutil_inthash_p_murmur(const void *ptr);
175 unsigned int    BLI_ghashutil_inthash_p_simple(const void *ptr);
176 bool            BLI_ghashutil_intcmp(const void *a, const void *b);
177
178 size_t          BLI_ghashutil_combine_hash(size_t hash_a, size_t hash_b);
179
180
181 unsigned int    BLI_ghashutil_uinthash_v4(const unsigned int key[4]);
182 #define         BLI_ghashutil_inthash_v4(key) ( \
183                 CHECK_TYPE_ANY(key, int *, const int *), \
184                 BLI_ghashutil_uinthash_v4((const unsigned int *)key))
185 #define         BLI_ghashutil_inthash_v4_p \
186    ((GSetHashFP)BLI_ghashutil_uinthash_v4)
187 #define         BLI_ghashutil_uinthash_v4_p \
188    ((GSetHashFP)BLI_ghashutil_uinthash_v4)
189 unsigned int    BLI_ghashutil_uinthash_v4_murmur(const unsigned int key[4]);
190 #define         BLI_ghashutil_inthash_v4_murmur(key) ( \
191                 CHECK_TYPE_ANY(key, int *, const int *), \
192                 BLI_ghashutil_uinthash_v4_murmur((const unsigned int *)key))
193 #define         BLI_ghashutil_inthash_v4_p_murmur \
194    ((GSetHashFP)BLI_ghashutil_uinthash_v4_murmur)
195 #define         BLI_ghashutil_uinthash_v4_p_murmur \
196    ((GSetHashFP)BLI_ghashutil_uinthash_v4_murmur)
197 bool            BLI_ghashutil_uinthash_v4_cmp(const void *a, const void *b);
198 #define         BLI_ghashutil_inthash_v4_cmp \
199                 BLI_ghashutil_uinthash_v4_cmp
200
201 /** \} */
202
203 GHash *BLI_ghash_ptr_new_ex(
204         const char *info,
205         const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
206 GHash *BLI_ghash_ptr_new(
207         const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
208 GHash *BLI_ghash_str_new_ex(
209         const char *info,
210         const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
211 GHash *BLI_ghash_str_new(
212         const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
213 GHash *BLI_ghash_int_new_ex(
214         const char *info,
215         const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
216 GHash *BLI_ghash_int_new(
217         const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
218 GHash *BLI_ghash_pair_new_ex(
219         const char *info,
220         const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
221 GHash *BLI_ghash_pair_new(
222         const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
223
224 typedef struct GHashPair {
225         const void *first;
226         const void *second;
227 } GHashPair;
228
229 GHashPair      *BLI_ghashutil_pairalloc(const void *first, const void *second);
230 unsigned int    BLI_ghashutil_pairhash(const void *ptr);
231 bool            BLI_ghashutil_paircmp(const void *a, const void *b);
232 void            BLI_ghashutil_pairfree(void *ptr);
233
234 /**
235  * GSet is a 'set' implementation (unordered collection of unique elements).
236  *
237  * Internally this is a 'GHash' without any keys,
238  * which is why this API's are in the same header & source file.
239  */
240
241 typedef struct GSet GSet;
242
243 typedef GHashHashFP GSetHashFP;
244 typedef GHashCmpFP GSetCmpFP;
245 typedef GHashKeyFreeFP GSetKeyFreeFP;
246 typedef GHashKeyCopyFP GSetKeyCopyFP;
247
248 typedef GHashIterState GSetIterState;
249
250 /* so we can cast but compiler sees as different */
251 typedef struct GSetIterator {
252         GHashIterator _ghi
253 #ifdef __GNUC__
254         __attribute__ ((deprecated))
255 #endif
256         ;
257 } GSetIterator;
258
259 GSet  *BLI_gset_new_ex(
260         GSetHashFP hashfp, GSetCmpFP cmpfp, const char *info,
261         const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
262 GSet  *BLI_gset_new(GSetHashFP hashfp, GSetCmpFP cmpfp, const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
263 GSet  *BLI_gset_copy(GSet *gs, GSetKeyCopyFP keycopyfp) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
264 unsigned int BLI_gset_len(GSet *gs) ATTR_WARN_UNUSED_RESULT;
265 void   BLI_gset_flag_set(GSet *gs, unsigned int flag);
266 void   BLI_gset_flag_clear(GSet *gs, unsigned int flag);
267 void   BLI_gset_free(GSet *gs, GSetKeyFreeFP keyfreefp);
268 void   BLI_gset_insert(GSet *gh, void *key);
269 bool   BLI_gset_add(GSet *gs, void *key);
270 bool   BLI_gset_ensure_p_ex(GSet *gs, const void *key, void ***r_key);
271 bool   BLI_gset_reinsert(GSet *gh, void *key, GSetKeyFreeFP keyfreefp);
272 void  *BLI_gset_replace_key(GSet *gs, void *key);
273 bool   BLI_gset_haskey(GSet *gs, const void *key) ATTR_WARN_UNUSED_RESULT;
274 bool   BLI_gset_pop(GSet *gs, GSetIterState *state, void **r_key) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
275 bool   BLI_gset_remove(GSet *gs, const void *key, GSetKeyFreeFP keyfreefp);
276 void   BLI_gset_clear_ex(GSet *gs, GSetKeyFreeFP keyfreefp,
277                          const unsigned int nentries_reserve);
278 void   BLI_gset_clear(GSet *gs, GSetKeyFreeFP keyfreefp);
279
280 /* When set's are used for key & value. */
281 void  *BLI_gset_lookup(GSet *gh, const void *key) ATTR_WARN_UNUSED_RESULT;
282 void  *BLI_gset_pop_key(GSet *gs, const void *key) ATTR_WARN_UNUSED_RESULT;
283
284 GSet *BLI_gset_ptr_new_ex(const char *info, const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
285 GSet *BLI_gset_ptr_new(const char *info);
286 GSet *BLI_gset_str_new_ex(const char *info, const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
287 GSet *BLI_gset_str_new(const char *info);
288 GSet *BLI_gset_pair_new_ex(const char *info, const unsigned int nentries_reserve) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
289 GSet *BLI_gset_pair_new(const char *info) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
290
291 /* rely on inline api for now */
292 BLI_INLINE GSetIterator *BLI_gsetIterator_new(GSet *gs) { return (GSetIterator *)BLI_ghashIterator_new((GHash *)gs); }
293 BLI_INLINE void BLI_gsetIterator_init(GSetIterator *gsi, GSet *gs) { BLI_ghashIterator_init((GHashIterator *)gsi, (GHash *)gs); }
294 BLI_INLINE void BLI_gsetIterator_free(GSetIterator *gsi) { BLI_ghashIterator_free((GHashIterator *)gsi); }
295 BLI_INLINE void *BLI_gsetIterator_getKey(GSetIterator *gsi) { return BLI_ghashIterator_getKey((GHashIterator *)gsi); }
296 BLI_INLINE void BLI_gsetIterator_step(GSetIterator *gsi) { BLI_ghashIterator_step((GHashIterator *)gsi); }
297 BLI_INLINE bool BLI_gsetIterator_done(GSetIterator *gsi) { return BLI_ghashIterator_done((GHashIterator *)gsi); }
298
299 #define GSET_ITER(gs_iter_, gset_) \
300         for (BLI_gsetIterator_init(&gs_iter_, gset_); \
301              BLI_gsetIterator_done(&gs_iter_) == false; \
302              BLI_gsetIterator_step(&gs_iter_))
303
304 #define GSET_ITER_INDEX(gs_iter_, gset_, i_) \
305         for (BLI_gsetIterator_init(&gs_iter_, gset_), i_ = 0; \
306              BLI_gsetIterator_done(&gs_iter_) == false; \
307              BLI_gsetIterator_step(&gs_iter_), i_++)
308
309
310 /* For testing, debugging only */
311 #ifdef GHASH_INTERNAL_API
312 int BLI_ghash_buckets_len(GHash *gh);
313 int BLI_gset_buckets_len(GSet *gs);
314
315 double BLI_ghash_calc_quality_ex(
316         GHash *gh, double *r_load, double *r_variance,
317         double *r_prop_empty_buckets, double *r_prop_overloaded_buckets, int *r_biggest_bucket);
318 double BLI_gset_calc_quality_ex(
319         GSet *gs, double *r_load, double *r_variance,
320         double *r_prop_empty_buckets, double *r_prop_overloaded_buckets, int *r_biggest_bucket);
321 double BLI_ghash_calc_quality(GHash *gh);
322 double BLI_gset_calc_quality(GSet *gs);
323 #endif  /* GHASH_INTERNAL_API */
324
325 #define GHASH_FOREACH_BEGIN(type, var, what) \
326         do { \
327                 GHashIterator gh_iter##var; \
328                 GHASH_ITER(gh_iter##var, what) { \
329                         type var = (type)(BLI_ghashIterator_getValue(&gh_iter##var)); \
330
331 #define GHASH_FOREACH_END() \
332                 } \
333         } while(0)
334
335 #define GSET_FOREACH_BEGIN(type, var, what) \
336         do { \
337                 GSetIterator gh_iter##var; \
338                 GSET_ITER(gh_iter##var, what) { \
339                         type var = (type)(BLI_gsetIterator_getKey(&gh_iter##var));
340
341 #define GSET_FOREACH_END() \
342                 } \
343         } while(0)
344
345 #ifdef __cplusplus
346 }
347 #endif
348
349 #endif /* __BLI_GHASH_H__ */