summaryrefslogtreecommitdiff
path: root/strmap.h
blob: 1e152d832d6fca0da719763dd01ed416ed5d3301 (plain)
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
#ifndef STRMAP_H
#define STRMAP_H
 
#include "hashmap.h"
 
struct mem_pool;
struct strmap {
	struct hashmap map;
	struct mem_pool *pool;
	unsigned int strdup_strings:1;
};
 
struct strmap_entry {
	struct hashmap_entry ent;
	const char *key;
	void *value;
	/* strmap_entry may be allocated extra space to store the key at end */
};
 
int cmp_strmap_entry(const void *hashmap_cmp_fn_data,
		     const struct hashmap_entry *entry1,
		     const struct hashmap_entry *entry2,
		     const void *keydata);
 
#define STRMAP_INIT { \
			.map = HASHMAP_INIT(cmp_strmap_entry, NULL),  \
			.strdup_strings = 1,                          \
		    }
#define STRINTMAP_INIT { \
			.map = STRMAP_INIT,   \
			.default_value = 0,   \
		       }
#define STRSET_INIT { .map = STRMAP_INIT }
 
/*
 * Initialize the members of the strmap.  Any keys added to the strmap will
 * be strdup'ed with their memory managed by the strmap.
 */
void strmap_init(struct strmap *map);
 
/*
 * Same as strmap_init, but for those who want to control the memory management
 * carefully instead of using the default of strdup_strings=1 and pool=NULL.
 */
void strmap_init_with_options(struct strmap *map,
			      struct mem_pool *pool,
			      int strdup_strings);
 
/*
 * Remove all entries from the map, releasing any allocated resources.
 */
void strmap_clear(struct strmap *map, int free_values);
 
/*
 * Similar to strmap_clear() but leaves map->map->table allocated and
 * pre-sized so that subsequent uses won't need as many rehashings.
 */
void strmap_partial_clear(struct strmap *map, int free_values);
 
/*
 * Insert "str" into the map, pointing to "data".
 *
 * If an entry for "str" already exists, its data pointer is overwritten, and
 * the original data pointer returned. Otherwise, returns NULL.
 */
void *strmap_put(struct strmap *map, const char *str, void *data);
 
/*
 * Return the strmap_entry mapped by "str", or NULL if there is not such
 * an item in map.
 */
struct strmap_entry *strmap_get_entry(struct strmap *map, const char *str);
 
/*
 * Return the data pointer mapped by "str", or NULL if the entry does not
 * exist.
 */
void *strmap_get(struct strmap *map, const char *str);
 
/*
 * Return non-zero iff "str" is present in the map. This differs from
 * strmap_get() in that it can distinguish entries with a NULL data pointer.
 */
int strmap_contains(struct strmap *map, const char *str);
 
/*
 * Remove the given entry from the strmap.  If the string isn't in the
 * strmap, the map is not altered.
 */
void strmap_remove(struct strmap *map, const char *str, int free_value);
 
/*
 * Return how many entries the strmap has.
 */
static inline unsigned int strmap_get_size(struct strmap *map)
{
	return hashmap_get_size(&map->map);
}
 
/*
 * Return whether the strmap is empty.
 */
static inline int strmap_empty(struct strmap *map)
{
	return strmap_get_size(map) == 0;
}
 
/*
 * iterate through @map using @iter, @var is a pointer to a type strmap_entry
 */
#define strmap_for_each_entry(mystrmap, iter, var)	\
	hashmap_for_each_entry(&(mystrmap)->map, iter, var, ent)
 
 
/*
 * strintmap:
 *    A map of string -> int, typecasting the void* of strmap to an int.
 *
 * Primary differences:
 *    1) Since the void* value is just an int in disguise, there is no value
 *       to free.  (Thus one fewer argument to strintmap_clear)
 *    2) strintmap_get() returns an int, or returns the default_value if the
 *       key is not found in the strintmap.
 *    3) No strmap_put() equivalent; strintmap_set() and strintmap_incr()
 *       instead.
 */
 
struct strintmap {
	struct strmap map;
	int default_value;
};
 
#define strintmap_for_each_entry(mystrmap, iter, var)	\
	strmap_for_each_entry(&(mystrmap)->map, iter, var)
 
static inline void strintmap_init(struct strintmap *map, int default_value)
{
	strmap_init(&map->map);
	map->default_value = default_value;
}
 
static inline void strintmap_init_with_options(struct strintmap *map,
					       int default_value,
					       struct mem_pool *pool,
					       int strdup_strings)
{
	strmap_init_with_options(&map->map, pool, strdup_strings);
	map->default_value = default_value;
}
 
static inline void strintmap_clear(struct strintmap *map)
{
	strmap_clear(&map->map, 0);
}
 
static inline void strintmap_partial_clear(struct strintmap *map)
{
	strmap_partial_clear(&map->map, 0);
}
 
static inline int strintmap_contains(struct strintmap *map, const char *str)
{
	return strmap_contains(&map->map, str);
}
 
static inline void strintmap_remove(struct strintmap *map, const char *str)
{
	strmap_remove(&map->map, str, 0);
}
 
static inline int strintmap_empty(struct strintmap *map)
{
	return strmap_empty(&map->map);
}
 
static inline unsigned int strintmap_get_size(struct strintmap *map)
{
	return strmap_get_size(&map->map);
}
 
/*
 * Returns the value for str in the map.  If str isn't found in the map,
 * the map's default_value is returned.
 */
static inline int strintmap_get(struct strintmap *map, const char *str)
{
	struct strmap_entry *result = strmap_get_entry(&map->map, str);
	if (!result)
		return map->default_value;
	return (intptr_t)result->value;
}
 
static inline void strintmap_set(struct strintmap *map, const char *str,
				 intptr_t v)
{
	strmap_put(&map->map, str, (void *)v);
}
 
/*
 * Increment the value for str by amt.  If str isn't in the map, add it and
 * set its value to default_value + amt.
 */
void strintmap_incr(struct strintmap *map, const char *str, intptr_t amt);
 
/*
 * strset:
 *    A set of strings.
 *
 * Primary differences with strmap:
 *    1) The value is always NULL, and ignored.  As there is no value to free,
 *       there is one fewer argument to strset_clear
 *    2) No strset_get() because there is no value.
 *    3) No strset_put(); use strset_add() instead.
 */
 
struct strset {
	struct strmap map;
};
 
#define strset_for_each_entry(mystrset, iter, var)	\
	strmap_for_each_entry(&(mystrset)->map, iter, var)
 
static inline void strset_init(struct strset *set)
{
	strmap_init(&set->map);
}
 
static inline void strset_init_with_options(struct strset *set,
					    struct mem_pool *pool,
					    int strdup_strings)
{
	strmap_init_with_options(&set->map, pool, strdup_strings);
}
 
static inline void strset_clear(struct strset *set)
{
	strmap_clear(&set->map, 0);
}
 
static inline void strset_partial_clear(struct strset *set)
{
	strmap_partial_clear(&set->map, 0);
}
 
static inline int strset_contains(struct strset *set, const char *str)
{
	return strmap_contains(&set->map, str);
}
 
static inline void strset_remove(struct strset *set, const char *str)
{
	strmap_remove(&set->map, str, 0);
}
 
static inline int strset_empty(struct strset *set)
{
	return strmap_empty(&set->map);
}
 
static inline unsigned int strset_get_size(struct strset *set)
{
	return strmap_get_size(&set->map);
}
 
/* Returns 1 if str is added to the set; returns 0 if str was already in set */
int strset_add(struct strset *set, const char *str);
 
#endif /* STRMAP_H */