merge 16951:17122
[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 struct GHash;
36 typedef struct GHash GHash;
37
38 typedef struct GHashIterator {
39         GHash *gh;
40         int curBucket;
41         struct Entry *curEntry;
42 } GHashIterator;
43
44 typedef unsigned int    (*GHashHashFP)          (void *key);
45 typedef int                             (*GHashCmpFP)           (void *a, void *b);
46 typedef void                    (*GHashKeyFreeFP)       (void *key);
47 typedef void                    (*GHashValFreeFP)       (void *val);
48
49 GHash*  BLI_ghash_new           (GHashHashFP hashfp, GHashCmpFP cmpfp);
50 void    BLI_ghash_free          (GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
51
52 void    BLI_ghash_insert        (GHash *gh, void *key, void *val);
53 int             BLI_ghash_remove        (GHash *gh, void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp);
54 void*   BLI_ghash_lookup        (GHash *gh, void *key);
55 int             BLI_ghash_haskey        (GHash *gh, void *key);
56
57 int             BLI_ghash_size          (GHash *gh);
58
59 /* *** */
60
61         /**
62          * Create a new GHashIterator. The hash table must not be mutated
63          * while the iterator is in use, and the iterator will step exactly
64          * BLI_ghash_size(gh) times before becoming done.
65          * 
66          * @param gh The GHash to iterate over.
67          * @return Pointer to a new DynStr.
68          */
69 GHashIterator*  BLI_ghashIterator_new           (GHash *gh);
70         /**
71          * Init an already allocated GHashIterator. The hash table must not
72          * be mutated while the iterator is in use, and the iterator will
73          * step exactly BLI_ghash_size(gh) times before becoming done.
74          * 
75          * @param ghi The GHashIterator to initialize.
76          * @param gh The GHash to iterate over.
77          */
78 void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh);
79         /**
80          * Free a GHashIterator.
81          *
82          * @param ghi The iterator to free.
83          */
84 void                    BLI_ghashIterator_free          (GHashIterator *ghi);
85
86         /**
87          * Retrieve the key from an iterator.
88          *
89          * @param ghi The iterator.
90          * @return The key at the current index, or NULL if the 
91          * iterator is done.
92          */
93 void*                   BLI_ghashIterator_getKey        (GHashIterator *ghi);
94         /**
95          * Retrieve the value from an iterator.
96          *
97          * @param ghi The iterator.
98          * @return The value at the current index, or NULL if the 
99          * iterator is done.
100          */
101 void*                   BLI_ghashIterator_getValue      (GHashIterator *ghi);
102         /**
103          * Steps the iterator to the next index.
104          *
105          * @param ghi The iterator.
106          */
107 void                    BLI_ghashIterator_step          (GHashIterator *ghi);
108         /**
109          * Determine if an iterator is done (has reached the end of
110          * the hash table).
111          *
112          * @param ghi The iterator.
113          * @return True if done, False otherwise.
114          */
115 int                             BLI_ghashIterator_isDone        (GHashIterator *ghi);
116
117 /* *** */
118
119 unsigned int    BLI_ghashutil_ptrhash   (void *key);
120 int                             BLI_ghashutil_ptrcmp    (void *a, void *b);
121
122 unsigned int    BLI_ghashutil_strhash   (void *key);
123 int                             BLI_ghashutil_strcmp    (void *a, void *b);
124
125 unsigned int    BLI_ghashutil_inthash   (void *ptr);
126 int                             BLI_ghashutil_intcmp(void *a, void *b);
127
128 #endif
129