3 * File name: ir/adt/pset.h
4 * Purpose: Declarations for pset.
5 * Author: Markus Armbruster
7 * Created: 1999 by getting from fiasco
9 * Copyright: (c) 1995, 1996 Markus Armbruster
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
22 * The default comparison function for pointers.
25 * @return 0 if @p x and @p y are equal. Some value != 0 otherwise.
27 int pset_default_ptr_cmp(const void *x, const void *y);
30 * The abstract type of a pset (Set of pointers).
32 * This kind of sets stores only pointer to elements, the elements itself
33 * must be stored somewhere else.
37 typedef struct pset pset;
40 * Define some convenience macros using the predefined hash function.
42 #define pset_insert_ptr(set,key) pset_insert(set, key, HASH_PTR(key))
43 #define pset_hinsert_ptr(set,key) pset_hinsert(set, key, HASH_PTR(key))
44 #define pset_remove_ptr(set,key) pset_remove(set, key, HASH_PTR(key))
45 #define pset_find_ptr(set,key) pset_find(set, key, HASH_PTR(key))
46 #define pset_new_ptr(slots) new_pset(pset_default_ptr_cmp, slots)
47 #define pset_new_ptr_default() pset_new_ptr(64)
49 /** The entry of a pset, representing an element pointer in the set and it's meta-information */
56 * The type of a set compare function.
58 * @param elt pointer to an element
59 * @param key pointer to another element
62 * 0 if the elements are identically, non-zero else
64 typedef int (*pset_cmp_fun) (const void *elt, const void *key);
69 * @param func The compare function of this pset.
70 * @param slots Initial number of collision chains. I.e., #slots
71 * different keys can be hashed without collisions.
76 pset *new_pset (pset_cmp_fun func, int slots);
81 * @param pset the pset
84 * This does NOT delete the elements of this pset, just it's pointers!
86 void del_pset (pset *pset);
89 * Returns the number of elements in a pset.
91 * @param pset the pset
93 int pset_count (pset *pset);
96 * Searches an element pointer in a pset.
98 * @param pset the pset to search in
99 * @param key the element to search
100 * @param hash the hash value of key
103 * the pointer of the found element in the pset or NULL if it was not found
105 void *pset_find (pset *pset, const void *key, unsigned hash);
108 * Inserts an element pointer into a pset.
110 * @param pset the pset to insert in
111 * @param key a pointer to the element to be inserted
112 * @param hash the hash-value of the element
114 * @return a pointer to the inserted element
117 * It is not possible to insert an element more than once. If an element
118 * that should be inserted is already in the set, this functions does
119 * nothing but returning its already existing set_entry.
122 void *pset_insert (pset *pset, const void *key, unsigned hash);
125 * Inserts an element pointer into a pset and returns its pset_entry.
127 * @param pset the pset to insert in
128 * @param key a pointer to the element to be inserted
129 * @param hash the hash-value of the element
131 * @return a pointer to the pset_entry of the inserted element
134 * It is not possible to insert an element more than once. If an element
135 * that should be inserted is already in the pset, this functions does
136 * nothing but returning its pset_entry.
138 pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
141 * Removes an element from a pset.
143 * @param pset the pset to delete in
144 * @param key a pointer to the element to be deleted
145 * @param hash the hash-value of the element
148 * the pointer to the removed element
151 * The current implementation did not allow to remove non-existing elements.
152 * @@@ so, does it do now?
153 * Further, it is allowed to remove elements during an iteration
154 * including the current one.
156 void *pset_remove (pset *pset, const void *key, unsigned hash);
159 * Returns the first element of a pset.
161 * @param pset the pset to iterate
163 * @return a pointer to the element or NULL if the set is empty
165 void *pset_first (pset *pset);
168 * Returns the next element of a pset.
170 * @param pset the pset to iterate
172 * @return a pointer to the next element or NULL if the
173 * iteration is finished
175 void *pset_next (pset *pset);
178 * Breaks the iteration of a set. Must be called before
179 * the next pset_first() call if the iteration was NOT
182 * @param pset the pset
184 void pset_break (pset *pset);
187 * Iterates oven an pset.
189 * @param pset the pset
190 * @param entry the iterator
192 #define foreach_pset(pset, entry) for (entry = pset_first(pset); entry; entry = pset_next(pset))
195 * Inserts all elements of the pointer set src into
196 * the set target (union).
198 * @param target the target set, will contain the union
199 * @param src a set, will not be changed
201 void pset_insert_pset_ptr(pset *target, pset *src);
203 #define new_pset(cmp, slots) (PSET_TRACE (new_pset) ((cmp), (slots)))
204 #define pset_find(pset, key, hash) \
205 _pset_search ((pset), (key), (hash), _pset_find)
206 #define pset_insert(pset, key, hash) \
207 _pset_search ((pset), (key), (hash), _pset_insert)
208 #define pset_hinsert(pset, key, hash) \
209 ((pset_entry *)_pset_search ((pset), (key), (hash), _pset_hinsert))
213 * Prints statistics on a set to stdout.
215 * @param pset the pset
217 void pset_stats (pset *pset);
219 # define pset_stats(s) ((void)0)
226 * Writes a description of a set to stdout. The description includes:
227 * - a header telling how many elements (nkey) and segments (nseg) are in use
228 * - for every collision chain the number of element with its hash values
230 * @param pset the pset
232 void pset_describe (pset *pset);
236 #define PSET_VRFY(pset) (void)0
241 typedef enum { _pset_find, _pset_insert, _pset_hinsert } _pset_action;
243 void *_pset_search (pset *, const void *, unsigned, _pset_action);
245 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
246 extern const char *pset_tag;
248 # define PSET_TRACE pset_tag = SET_ID,
250 # define PSET_TRACE pset_tag = __FILE__,
252 #else /* !(DEBUG && HAVE_GNU_MALLOC) */
254 #endif /* !(DEBUG && HAVE_GNU_MALLOC) */