1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/*
* Copyright (c) 2004 Stefan Walter
* Copyright (c) 2011 Collabora Ltd.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the
* above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* * The names of contributors to this software may not be
* used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* Author: Stef Waler <stefw@collabora.co.uk>
*/
#ifndef HASHMAP_H_
#define HASHMAP_H_
#include <sys/types.h>
/*
* ARGUMENT DOCUMENTATION
*
* map: The hashmap
* key: Pointer to the key value
* val: Pointer to the value
* iter: A hashmap iterator
*/
/* ----------------------------------------------------------------------------------
* TYPES
*/
/* Abstract type for hash maps. */
typedef struct _hashmap hashmap;
/* Type for scanning hash tables. */
typedef struct _hashiter {
hashmap *map;
struct _hashbucket *next;
unsigned int index;
} hashiter;
typedef unsigned int (*hash_hash_func) (const void *data);
typedef int (*hash_equal_func) (const void *one,
const void *two);
typedef void (*hash_destroy_func) (void *data);
/* -----------------------------------------------------------------------------
* MAIN
*/
/*
* _p11_hash_create : Create a hash table
* - returns an allocated hashtable
*/
hashmap* _p11_hash_create (hash_hash_func hash_func,
hash_equal_func equal_func,
hash_destroy_func key_destroy_func,
hash_destroy_func value_destroy_func);
/*
* _p11_hash_free : Free a hash table
*/
void _p11_hash_free (hashmap *map);
/*
* _p11_hash_size: Number of values in hash table
* - returns the number of entries in hash table
*/
unsigned int _p11_hash_size (hashmap *map);
/*
* _p11_hash_get: Retrieves a value from the hash table
* - returns the value of the entry
*/
void* _p11_hash_get (hashmap *map,
const void *key);
/*
* _p11_hash_set: Set a value in the hash table
* - returns 1 if the entry was added properly
*/
int _p11_hash_set (hashmap *map,
void *key,
void *value);
/*
* _p11_hash_remove: Remove a value from the hash table
* - returns 1 if the entry was found
*/
int _p11_hash_remove (hashmap *map,
const void *key);
/*
* _p11_hash_steal: Remove a value from the hash table without calling
* destroy funcs
* - returns 1 if the entry was found
*/
int _p11_hash_steal (hashmap *map,
const void *key,
void **stolen_key,
void **stolen_value);
/*
* _p11_hash_iterate: Start enumerating through the hash table
* - returns a hash iterator
*/
void _p11_hash_iterate (hashmap *map,
hashiter *iter);
/*
* _p11_hash_next: Enumerate through hash table
* - sets key and value to key and/or value
* - returns whether there was another entry
*/
int _p11_hash_next (hashiter *iter,
void **key,
void **value);
/*
* _p11_hash_clear: Clear all values from has htable.
*/
void _p11_hash_clear (hashmap *map);
/* -----------------------------------------------------------------------------
* HASH FUNCTIONS
*/
unsigned int _p11_hash_string_hash (const void *string);
int _p11_hash_string_equal (const void *string_one,
const void *string_two);
unsigned int _p11_hash_ulongptr_hash (const void *to_ulong);
int _p11_hash_ulongptr_equal (const void *ulong_one,
const void *ulong_two);
unsigned int _p11_hash_intptr_hash (const void *to_int);
int _p11_hash_intptr_equal (const void *int_one,
const void *int_two);
unsigned int _p11_hash_direct_hash (const void *ptr);
int _p11_hash_direct_equal (const void *ptr_one,
const void *ptr_two);
#endif /* __HASHMAP_H__ */
|
