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 somewere 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)
48 void pset_insert_pset_ptr(pset *target, pset *src); /* Inserts all elements of src in target. */
51 /** The entry of a pset, representing an element pointer in the set and it's meta-information */
58 * The type of a set compare function.
60 * @param elt pointer to an element
61 * @param key pointer to another element
64 * 0 if the elements are identically, non-zero else
66 typedef int (*pset_cmp_fun) (const void *elt, const void *key);
71 * @param func The compare function of this pset.
72 * @param slots Initial number of collision chains. I.e., #slots
73 * different keys can be hashed without collisions.
78 pset *new_pset (pset_cmp_fun func, int slots);
83 * @param pset the pset
86 * This does NOT delete the elements of this pset, just it's pointers!
88 void del_pset (pset *pset);
91 * Returns the number of elements in a pset.
93 * @param pset the pset
95 int pset_count (pset *pset);
98 * Searches an element pointer in a pset.
100 * @param pset the pset to search in
101 * @param key the element to search
102 * @param hash the hash value of key
105 * the pointer of the found element in the pset or NULL if it was not found
107 void *pset_find (pset *pset, const void *key, unsigned hash);
110 * Inserts an element pointer into a pset.
112 * @param pset the pset to insert in
113 * @param key a pointer to the element to be inserted
114 * @param hash the hash-value of the element
116 * @return a pointer to the inserted element
119 * It is not possible to insert an element more than once. If an element
120 * that should be inserted is already in the set, this functions does
121 * nothing but returning its already existing set_entry.
124 void *pset_insert (pset *pset, const void *key, unsigned hash);
127 * Inserts an element pointer into a pset and returns its pset_entry.
129 * @param pset the pset to insert in
130 * @param key a pointer to the element to be inserted
131 * @param hash the hash-value of the element
133 * @return a pointer to the pset_entry of the inserted element
136 * It is not possible to insert an element more than once. If an element
137 * that should be inserted is already in the pset, this functions does
138 * nothing but returning its pset_entry.
140 pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
143 * Removes an element from a pset.
145 * @param pset the pset to delete in
146 * @param key a pointer to the element to be deleted
147 * @param hash the hash-value of the element
150 * the pointer to the removed element
153 * The current implementation did not allow to remove non-existing elements.
154 * Further, it is allowed to remove elements during an iteration
155 * including the current one.
157 void *pset_remove (pset *pset, const void *key, unsigned hash);
160 * Returns the first element of a pset.
162 * @param pset the pset to iterate
164 * @return a pointer to the element or NULL if the set is empty
166 void *pset_first (pset *pset);
169 * Returns the next element of a pset.
171 * @param pset the pset to iterate
173 * @return a pointer to the next element or NULL if the
174 * iteration is finished
176 void *pset_next (pset *pset);
179 * Breaks the iteration of a set. Must be called before
180 * the next pset_first() call if the iteration was NOT
183 * @param pset the pset
185 void pset_break (pset *pset);
187 #define new_pset(cmp, slots) (PSET_TRACE (new_pset) ((cmp), (slots)))
188 #define pset_find(pset, key, hash) \
189 _pset_search ((pset), (key), (hash), _pset_find)
190 #define pset_insert(pset, key, hash) \
191 _pset_search ((pset), (key), (hash), _pset_insert)
192 #define pset_hinsert(pset, key, hash) \
193 ((pset_entry *)_pset_search ((pset), (key), (hash), _pset_hinsert))
197 * Prints statistics on a set to stdout.
199 * @param pset the pset
201 void pset_stats (pset *pset);
203 # define pset_stats(s) ((void)0)
210 * Writes a description of a set to stdout. The description includes:
211 * - a header telling how many elements (nkey) and segments (nseg) are in use
212 * - for every collision chain the number of element with its hash values
214 * @param pset the pset
216 void pset_describe (pset *pset);
220 #define PSET_VRFY(pset) (void)0
225 typedef enum { _pset_find, _pset_insert, _pset_hinsert } _pset_action;
227 void *_pset_search (pset *, const void *, unsigned, _pset_action);
229 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
230 extern const char *pset_tag;
232 # define PSET_TRACE pset_tag = SET_ID,
234 # define PSET_TRACE pset_tag = __FILE__,
236 #else /* !(DEBUG && HAVE_GNU_MALLOC) */
238 #endif /* !(DEBUG && HAVE_GNU_MALLOC) */