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