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 Initial number of collision chains. I.e., #slots
50 * different keys can be hashed without collisions.
55 pset *new_pset (pset_cmp_fun func, int slots);
60 * @param pset the pset
63 * This does NOT delete the elements of this pset, just it's pointers!
65 void del_pset (pset *pset);
68 * Returns the number of elements in a pset.
70 * @param pset the pset
72 int pset_count (pset *pset);
75 * Searches an element pointer in a pset.
77 * @param pset the pset to search in
78 * @param key the element to search
79 * @param hash the hash value of key
82 * the pointer of the found element in the pset of NULL if it was not found
84 void *pset_find (pset *pset, const void *key, unsigned hash);
87 * Inserts an element pointer into a pset.
89 * @param pset the pset to insert in
90 * @param key a pointer to the element to be inserted
91 * @param hash the hash-value of the element
93 * @return a pointer to the inserted element
96 * It is not possible to insert on element more than once. If a element
97 * that should be inserted is already in the set, this functions does
98 * nothing but returning its already existing set_entry.
101 void *pset_insert (pset *pset, const void *key, unsigned hash);
104 * Inserts an element pointer into a pset and returns its pset_entry.
106 * @param pset the pset to insert in
107 * @param key a pointer to the element to be inserted
108 * @param hash the hash-value of the element
110 * @return a pointer to the pset_entry of the inserted element
113 * It is not possible to insert on element more than once. If a element
114 * that should be inserted is already in the pset, this functions does
115 * nothing but returning its pset_entry.
117 pset_entry *pset_hinsert (pset *pset, const void *key, unsigned hash);
120 * Removes an element from a pset.
122 * @param pset the pset to insert in
123 * @param key a pointer to the element to be inserted
124 * @param hash the hash-value of the element
127 * the pointer to the removed element
130 * The current implementation did not allow to remove non-existing elements.
131 * Further, it is allowed to remove elements during an iteration
132 * including the current one.
134 void *pset_remove (pset *pset, const void *key, unsigned hash);
137 * Returns the first element of a pset.
139 * @param pset the pset to iterate
141 * @return a pointer to the element or NULL if the set is empty
143 void *pset_first (pset *pset);
146 * Returns the next element of a pset.
148 * @param pset the pset to iterate
150 * @return a pointer to the next element or NULL if the
151 * iteration is finished
153 void *pset_next (pset *pset);
156 * Breaks the iteration of a set. Must be called before
157 * the next pset_first() call if the iteration was NOT
160 * @param pset the pset
162 void pset_break (pset *pset);
164 #define new_pset(cmp, slots) (PSET_TRACE (new_pset) ((cmp), (slots)))
165 #define pset_find(pset, key, hash) \
166 _pset_search ((pset), (key), (hash), _pset_find)
167 #define pset_insert(pset, key, hash) \
168 _pset_search ((pset), (key), (hash), _pset_insert)
169 #define pset_hinsert(pset, key, hash) \
170 ((pset_entry *)_pset_search ((pset), (key), (hash), _pset_hinsert))
174 * Prints statistics on a set to stdout.
176 * @param pset the pset
178 void pset_stats (pset *pset);
180 # define pset_stats(s) ((void)0)
185 * Describe a set by printing all elements
188 void pset_describe (pset *);
192 #define PSET_VRFY(pset) (void)0
197 typedef enum { _pset_find, _pset_insert, _pset_hinsert } _pset_action;
199 void *_pset_search (pset *, const void *, unsigned, _pset_action);
201 #if defined(DEBUG) && defined(HAVE_GNU_MALLOC)
202 extern const char *pset_tag;
204 # define PSET_TRACE pset_tag = SET_ID,
206 # define PSET_TRACE pset_tag = __FILE__,
208 #else /* !(DEBUG && HAVE_GNU_MALLOC) */
210 #endif /* !(DEBUG && HAVE_GNU_MALLOC) */