1 /* Licensed under LGPLv2+ - see LICENSE file for details */
2 #ifndef CCAN_HTABLE_TYPE_H
3 #define CCAN_HTABLE_TYPE_H
4 #include <ccan/htable/htable.h>
5 #include <ccan/compiler/compiler.h>
9 * HTABLE_DEFINE_TYPE - create a set of htable ops for a type
10 * @type: a type whose pointers will be values in the hash.
11 * @keyof: a function/macro to extract a key: <keytype> @keyof(const type *elem)
12 * @hashfn: a hash function for a @key: size_t @hashfn(const <keytype> *)
13 * @eqfn: an equality function keys: bool @eqfn(const type *, const <keytype> *)
14 * @prefix: a prefix for all the functions to define (of form <name>_*)
16 * NULL values may not be placed into the hash table.
18 * This defines the type hashtable type and an iterator type:
22 * It also defines initialization and freeing functions:
23 * void <name>_init(struct <name> *);
24 * void <name>_init_sized(struct <name> *, size_t);
25 * void <name>_clear(struct <name> *);
27 * Add function only fails if we run out of memory:
28 * bool <name>_add(struct <name> *ht, const <type> *e);
30 * Delete and delete-by key return true if it was in the set:
31 * bool <name>_del(struct <name> *ht, const <type> *e);
32 * bool <name>_delkey(struct <name> *ht, const <keytype> *k);
34 * Find and return the (first) matching element, or NULL:
35 * type *<name>_get(const struct @name *ht, const <keytype> *k);
37 * Find and return all matching elements, or NULL:
38 * type *<name>_getfirst(const struct @name *ht, const <keytype> *k,
39 * struct <name>_iter *i);
40 * type *<name>_getnext(const struct @name *ht, const <keytype> *k,
41 * struct <name>_iter *i);
43 * Iteration over hashtable is also supported:
44 * type *<name>_first(const struct <name> *ht, struct <name>_iter *i);
45 * type *<name>_next(const struct <name> *ht, struct <name>_iter *i);
46 * type *<name>_prev(const struct <name> *ht, struct <name>_iter *i);
48 * It's currently safe to iterate over a changing hashtable, but you might
49 * miss an element. Iteration isn't very efficient, either.
51 * You can use HTABLE_INITIALIZER like so:
52 * struct <name> ht = { HTABLE_INITIALIZER(ht.raw, <name>_hash, NULL) };
54 #define HTABLE_DEFINE_TYPE(type, keyof, hashfn, eqfn, name) \
55 struct name { struct htable raw; }; \
56 struct name##_iter { struct htable_iter i; }; \
57 static inline size_t name##_hash(const void *elem, void *priv) \
60 return hashfn(keyof((const type *)elem)); \
62 static inline UNNEEDED void name##_init(struct name *ht) \
64 htable_init(&ht->raw, name##_hash, NULL); \
66 static inline UNNEEDED void name##_init_sized(struct name *ht, \
69 htable_init_sized(&ht->raw, name##_hash, NULL, s); \
71 static inline UNNEEDED void name##_clear(struct name *ht) \
73 htable_clear(&ht->raw); \
75 static inline bool name##_add(struct name *ht, const type *elem) \
77 return htable_add(&ht->raw, hashfn(keyof(elem)), elem); \
79 static inline UNNEEDED bool name##_del(struct name *ht, \
82 return htable_del(&ht->raw, hashfn(keyof(elem)), elem); \
84 static inline UNNEEDED type *name##_get(const struct name *ht, \
85 const HTABLE_KTYPE(keyof, type) k) \
87 /* Typecheck for eqfn */ \
88 (void)sizeof(eqfn((const type *)NULL, \
89 keyof((const type *)NULL))); \
90 return htable_get(&ht->raw, \
92 (bool (*)(const void *, void *))(eqfn), \
95 static inline UNNEEDED type *name##_getmatch_(const struct name *ht, \
96 const HTABLE_KTYPE(keyof, type) k, \
99 struct name##_iter *iter) \
104 v = htable_nextval(&ht->raw, &iter->i, h); \
108 static inline UNNEEDED type *name##_getfirst(const struct name *ht, \
109 const HTABLE_KTYPE(keyof, type) k, \
110 struct name##_iter *iter) \
112 size_t h = hashfn(k); \
113 type *v = htable_firstval(&ht->raw, &iter->i, h); \
114 return name##_getmatch_(ht, k, h, v, iter); \
116 static inline UNNEEDED type *name##_getnext(const struct name *ht, \
117 const HTABLE_KTYPE(keyof, type) k, \
118 struct name##_iter *iter) \
120 size_t h = hashfn(k); \
121 type *v = htable_nextval(&ht->raw, &iter->i, h); \
122 return name##_getmatch_(ht, k, h, v, iter); \
124 static inline UNNEEDED bool name##_delkey(struct name *ht, \
125 const HTABLE_KTYPE(keyof, type) k) \
127 type *elem = name##_get(ht, k); \
129 return name##_del(ht, elem); \
132 static inline UNNEEDED type *name##_first(const struct name *ht, \
133 struct name##_iter *iter) \
135 return htable_first(&ht->raw, &iter->i); \
137 static inline UNNEEDED type *name##_next(const struct name *ht, \
138 struct name##_iter *iter) \
140 return htable_next(&ht->raw, &iter->i); \
142 static inline UNNEEDED type *name##_prev(const struct name *ht, \
143 struct name##_iter *iter) \
145 return htable_prev(&ht->raw, &iter->i); \
149 #define HTABLE_KTYPE(keyof, type) typeof(keyof((const type *)NULL))
151 #define HTABLE_KTYPE(keyof, type) void *
153 #endif /* CCAN_HTABLE_TYPE_H */