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.
19 * The abstract type of a pset (Set of pointers).
21 * This kind of sets stores only pointer to elements, the elements itself
22 * must be stored somewere else.
26 typedef struct pset pset;
28 /** The entry of a pset, representing an element pointer in the set and it's meta-information */
35 * The type of a set compare function.
37 * @param elt pointer to an element
38 * @param key pointer to another element
41 * 0 if the elements are identically, non-zero else
43 typedef int (*pset_cmp_fun) (const void *elt, const void *key);
48 * @param func the compare function of this pset
49 * @param slots number of initial slots
54 pset *new_pset (pset_cmp_fun func, int slots);
60 * This does NOT delete the elements of this pset, just it's pointers!
62 void del_pset (pset *pset);
65 * Returns the number of elements in a pset.
67 * @param pset the pset
69 int pset_count (pset *pset);
72 * Searches an element pointer in a pset.
74 * @param pset the pset to search in
75 * @param key the element to is searched
76 * @param hash the hash value of key
79 * the pointer of the found element in the pset of NULL if it was not found
81 void *pset_find (pset *pset, const void *key, unsigned hash);
84 * Inserts an element pointer into a pset.
86 * @param pset the pset to insert in
87 * @param key a pointer to the element to be inserted
88 * @param hash the hash-value of the element
90 * @return a pointer to the inserted element
93 * It is not possible to insert on element more than once. If a element
94 * that should be inserted is already in the set, this functions does
95 * nothing but returning its set_entry.
98 void *pset_insert (pset *pset, const void *key, unsigned hash);
101 * Inserts an element pointer into a pset and returns its pset_entry.
103 * @param pset the pset to insert in
104 * @param key a pointer to the element to be inserted
105 * @param hash the hash-value of the element
107 * @return a pointer to the pset_entry of the inserted element
110 * It is not possible to insert on element more than once. If a element
111 * that should be inserted is already in the pset, this functions does
112 * nothing but returning its pset_entry.
114 pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
117 * Removes an element from a pset.
119 * @param pset the pset to insert in
120 * @param key a pointer to the element to be inserted
121 * @param hash the hash-value of the element
124 * the pointer to the removed element
127 * The current implementation did not allow to remove non-existing elements.
128 * Further, it is allowed to remove elements during an iteration
129 * including the current one.
131 void *pset_remove (pset *pset, const void *key, unsigned hash);
134 * Returns the first element of a pset.
136 * @param pset the pset to iterate
138 * @return a pointer to the element or NULL if the set is empty
140 void *pset_first (pset *pset);
143 * Returns the next element of a pset.
145 * @param pset the pset to iterate
147 * @return a pointer to the next element or NULL if the
148 * iteration is finished
150 void *pset_next (pset *pset);
153 * Breaks the iteration of a set. Must be called before
154 * the next pset_first() call if the iteration was NOT
157 * @param pset the pset
159 void pset_break (pset *pset);
161 #define new_pset(cmp, slots) (PSET_TRACE (new_pset) ((cmp), (slots)))
162 #define pset_find(pset, key, hash) \
163 _pset_search ((pset), (key), (hash), _pset_find)
164 #define pset_insert(pset, key, hash) \
165 _pset_search ((pset), (key), (hash), _pset_insert)
166 #define pset_hinsert(pset, key, hash) \
167 ((pset_entry *)_pset_search ((pset), (key), (hash), _pset_hinsert))
171 * Prints statistics on a set to stdout.
173 * @param pset the pset
175 void pset_stats (pset *pset);
177 # define pset_stats(s) ((void)0)
182 * Describe a set by printing all elements
185 void pset_describe (pset *);
189 #define PSET_VRFY(pset) (void)0
194 typedef enum { _pset_find, _pset_insert, _pset_hinsert } _pset_action;
196 void *_pset_search (pset *, const void *, unsigned, _pset_action);
198 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
199 extern const char *pset_tag;
201 # define PSET_TRACE pset_tag = SET_ID,
203 # define PSET_TRACE pset_tag = __FILE__,
205 #else /* !(DEBUG && HAVE_GNU_MALLOC) */
207 #endif /* !(DEBUG && HAVE_GNU_MALLOC) */