4 #include <ccan/tcon/tcon.h>
5 #include <ccan/typesafe_cb/typesafe_cb.h>
10 * struct strmap - representation of a string map
12 * It's exposed here to allow you to embed it and so we can inline the
24 * STRMAP_MEMBERS - declare members for a type-specific strmap.
25 * @type: type for this map's values, or void * for any pointer.
27 * You use this to create your own typed strmap for a particular type.
28 * You can use an integer type, *but* remember you can't use "0" as a
32 * struct strmap_intp {
33 * STRMAP_MEMBERS(int *);
36 #define STRMAP_MEMBERS(type) \
42 * strmap_init - initialize a string map (empty)
43 * @map: the typed strmap to initialize.
45 * For completeness; if you've arranged for it to be NULL already you don't
49 * struct strmap_intp map;
53 #define strmap_init(map) strmap_init_(&(map)->raw)
55 static inline void strmap_init_(struct strmap *map)
61 * strmap_empty - is this string map empty?
62 * @map: the typed strmap to check.
65 * if (!strmap_empty(&map))
68 #define strmap_empty(map) strmap_empty_(&(map)->raw)
70 static inline bool strmap_empty_(const struct strmap *map)
72 return map->u.n == NULL;
76 * strmap_get - get a value from a string map
77 * @map: the typed strmap to search.
78 * @member: the string to search for.
80 * Returns the value, or NULL if it isn't in the map.
83 * int *val = strmap_get(&map, "hello");
85 * printf("hello => %i\n", *val);
87 #define strmap_get(map, member) \
88 tcon_cast((map), canary, strmap_get_(&(map)->raw, (member)))
89 void *strmap_get_(const struct strmap *map, const char *member);
92 * strmap_add - place a member in the string map.
93 * @map: the typed strmap to add to.
94 * @member: the string to place in the map.
95 * @v: the (non-NULL) value.
97 * This returns false if we run out of memory (errno = ENOMEM), or
98 * (more normally) if that string already appears in the map (EEXIST).
100 * Note that the pointer is placed in the map, the string is not copied. If
101 * you want a copy in the map, use strdup(). Similarly for the value.
104 * val = malloc(sizeof *val);
106 * if (!strmap_add(&map, "goodbye", val))
107 * printf("goodbye was already in the map\n");
109 #define strmap_add(map, member, value) \
110 strmap_add_(&tcon_check((map), canary, (value))->raw, \
111 (member), (void *)(value))
113 bool strmap_add_(struct strmap *map, const char *member, const void *value);
116 * strmap_del - remove a member from the string map.
117 * @map: the typed strmap to delete from.
118 * @member: the string to remove from the map.
119 * @valuep: the value (if non-NULL)
121 * This returns the string which was passed to strmap_map(), or NULL.
122 * This means that if you allocated a string (eg. using strdup()), you
123 * can free it here. Similarly, the value is returned in @valuep if
124 * @valuep is not NULL.
127 * if (!strmap_del(&map, "goodbye", NULL))
128 * printf("goodbye was not in the map?\n");
130 #define strmap_del(map, member, valuep) \
131 strmap_del_(&tcon_check_ptr((map), canary, valuep)->raw, \
132 (member), (void **)valuep)
133 char *strmap_del_(struct strmap *map, const char *member, void **valuep);
136 * strmap_clear - remove every member from the map.
137 * @map: the typed strmap to clear.
139 * The map will be empty after this.
142 * strmap_clear(&map);
144 #define strmap_clear(map) strmap_clear_(&(map)->raw)
146 void strmap_clear_(struct strmap *map);
149 * strmap_iterate - ordered iteration over a map
150 * @map: the typed strmap to iterate through.
151 * @handle: the function to call.
152 * @arg: the argument for the function (types should match).
154 * @handle's prototype should be:
155 * bool @handle(const char *member, type value, typeof(arg) arg)
157 * If @handle returns true, the iteration will stop.
158 * You should not alter the map within the @handle function!
161 * struct strmap_intp {
162 * STRMAP_MEMBERS(int *);
164 * static bool dump_some(const char *member, int *value, int *num)
166 * // Only dump out num nodes.
169 * printf("%s=>%i\n", member, *value);
173 * static void dump_map(const struct strmap_intp *map)
176 * strmap_iterate(map, dump_some, &max);
178 * printf("... (truncated to 100 entries)\n");
181 #define strmap_iterate(map, handle, arg) \
182 strmap_iterate_(&(map)->raw, \
183 typesafe_cb_cast(bool (*)(const char *, \
185 bool (*)(const char *, \
186 tcon_type((map), canary), \
187 __typeof__(arg)), (handle)), \
189 void strmap_iterate_(const struct strmap *map,
190 bool (*handle)(const char *, void *, void *), void *data);
194 * strmap_prefix - return a submap matching a prefix
196 * @prefix: the prefix.
198 * This returns a pointer into @map, so don't alter @map while using
199 * the return value. You can use strmap_iterate(), strmap_get() or
200 * strmap_empty() on the returned pointer.
203 * static void dump_prefix(const struct strmap_intp *map,
204 * const char *prefix)
207 * printf("Nodes with prefix %s:\n", prefix);
208 * strmap_iterate(strmap_prefix(map, prefix), dump_some, &max);
210 * printf("... (truncated to 100 entries)\n");
214 #define strmap_prefix(map, prefix) \
215 ((const __typeof__(map))strmap_prefix_(&(map)->raw, (prefix)))
217 #define strmap_prefix(map, prefix) \
218 ((const void *)strmap_prefix_(&(map)->raw, (prefix)))
221 const struct strmap *strmap_prefix_(const struct strmap *map,
224 #endif /* CCAN_STRMAP_H */