BLI_ghash.h was including BLI_blenlib.h, remove from ghash header and include in...
[blender.git] / source / blender / blenlib / BLI_ghash.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29  
30 #ifndef BLI_GHASH_H
31 #define BLI_GHASH_H
32
33 /** \file BLI_ghash.h
34  *  \ingroup bli
35  *  \brief A general (pointer -> pointer) hash table ADT
36  */
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 typedef unsigned int    (*GHashHashFP)          (const void *key);
43 typedef int                             (*GHashCmpFP)           (const void *a, const void *b);
44 typedef void                    (*GHashKeyFreeFP)       (void *key);
45 typedef void                    (*GHashValFreeFP)       (void *val);
46
47 typedef struct Entry {
48         struct Entry *next;
49
50         void *key, *val;
51 } Entry;
52
53 typedef struct GHash {
54         GHashHashFP     hashfp;
55         GHashCmpFP      cmpfp;
56
57         Entry **buckets;
58         struct BLI_mempool *entrypool;
59         int nbuckets, nentries, cursize;
60 } GHash;
61
62 typedef struct GHashIterator {
63         GHash *gh;
64         int curBucket;
65         struct Entry *curEntry;
66 } GHashIterator;
67
68 /* *** */
69
70 GHash* BLI_ghash_new   (GHashHashFP hashfp, GHashCmpFP cmpfp, const char *info);
71 void   BLI_ghash_free  (GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
72 void   BLI_ghash_insert(GHash *gh, void *key, void *val);
73 void * BLI_ghash_lookup(GHash *gh, const void *key);
74 int    BLI_ghash_remove(GHash *gh, void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
75 int    BLI_ghash_haskey(GHash *gh, void *key);
76 int        BLI_ghash_size  (GHash *gh);
77
78 /* *** */
79
80         /**
81          * Create a new GHashIterator. The hash table must not be mutated
82          * while the iterator is in use, and the iterator will step exactly
83          * BLI_ghash_size(gh) times before becoming done.
84          * 
85          * @param gh The GHash to iterate over.
86          * @return Pointer to a new DynStr.
87          */
88 GHashIterator*  BLI_ghashIterator_new           (GHash *gh);
89         /**
90          * Init an already allocated GHashIterator. The hash table must not
91          * be mutated while the iterator is in use, and the iterator will
92          * step exactly BLI_ghash_size(gh) times before becoming done.
93          * 
94          * @param ghi The GHashIterator to initialize.
95          * @param gh The GHash to iterate over.
96          */
97 void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh);
98         /**
99          * Free a GHashIterator.
100          *
101          * @param ghi The iterator to free.
102          */
103 void                    BLI_ghashIterator_free          (GHashIterator *ghi);
104
105         /**
106          * Retrieve the key from an iterator.
107          *
108          * @param ghi The iterator.
109          * @return The key at the current index, or NULL if the 
110          * iterator is done.
111          */
112 void*                   BLI_ghashIterator_getKey        (GHashIterator *ghi);
113         /**
114          * Retrieve the value from an iterator.
115          *
116          * @param ghi The iterator.
117          * @return The value at the current index, or NULL if the 
118          * iterator is done.
119          */
120 void*                   BLI_ghashIterator_getValue      (GHashIterator *ghi);
121         /**
122          * Steps the iterator to the next index.
123          *
124          * @param ghi The iterator.
125          */
126 void                    BLI_ghashIterator_step          (GHashIterator *ghi);
127         /**
128          * Determine if an iterator is done (has reached the end of
129          * the hash table).
130          *
131          * @param ghi The iterator.
132          * @return True if done, False otherwise.
133          */
134 int                             BLI_ghashIterator_isDone        (GHashIterator *ghi);
135
136 /* *** */
137
138 unsigned int    BLI_ghashutil_ptrhash   (const void *key);
139 int                             BLI_ghashutil_ptrcmp    (const void *a, const void *b);
140
141 unsigned int    BLI_ghashutil_strhash   (const void *key);
142 int                             BLI_ghashutil_strcmp    (const void *a, const void *b);
143
144 unsigned int    BLI_ghashutil_inthash   (const void *ptr);
145 int                             BLI_ghashutil_intcmp    (const void *a, const void *b);
146
147 #ifdef __cplusplus
148 }
149 #endif
150
151 #endif /* BLI_GHASH_H */