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