2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * @brief hashset containing pointers
24 * @author Matthias Braun
27 * @note This has been named pset_new_new for now until all code has been
28 * changed to use this instead of the old deprecated pset_new functions!
29 * This version performs better than pset in terms of speed and memory
30 * usage and allows multiple iterators over the set
32 #ifndef FIRM_ADT_PSET_NEW_H
33 #define FIRM_ADT_PSET_NEW_H
37 #define HashSet pset_new_t
38 #define HashSetIterator pset_new_iterator_t
39 #define ValueType void*
44 #undef HashSetIterator
47 typedef struct pset_new_t pset_new_t;
48 typedef struct pset_new_iterator_t pset_new_iterator_t;
51 * Initializes a pset_new
53 * @param pset_new Pointer to allocated space for the pset_new
55 FIRM_API void pset_new_init(pset_new_t *pset_new);
58 * Initializes a pset_new
60 * @param pset_new Pointer to allocated space for the pset_new
61 * @param expected_elements Number of elements expected in the pset_new (roughly)
63 FIRM_API void pset_new_init_size(pset_new_t *pset_new, size_t expected_elements);
66 * Destroys a pset_new and frees the memory allocated for hashtable. The memory of
67 * the pset_new itself is not freed.
69 * @param pset_new Pointer to the pset_new
71 FIRM_API void pset_new_destroy(pset_new_t *pset_new);
74 * Inserts an element into a pset_new.
76 * @param pset_new Pointer to the pset_new
77 * @param ptr Pointer to insert into the pset_new
78 * @returns 1 if the pointer was inserted, 0 if it was already there
80 FIRM_API int pset_new_insert(pset_new_t *pset_new, void *ptr);
83 * Removes an element from a pset_new. Does nothing if the pset_new doesn't contain the
86 * @param pset_new Pointer to the pset_new
87 * @param ptr Pointer to remove from the pset_new
89 FIRM_API void pset_new_remove(pset_new_t *pset_new, const void *ptr);
92 * Tests whether a pset_new contains a pointer
94 * @param pset_new Pointer to the pset_new
95 * @param ptr The pointer to test
96 * @returns 1 @p pset_new contains the @p ptr, 0 otherwise
98 FIRM_API int pset_new_contains(const pset_new_t *pset_new, const void *ptr);
101 * Returns the number of pointers contained in the pset_new
103 * @param pset_new Pointer to the pset_new
104 * @returns Number of pointers contained in the pset_new
106 FIRM_API size_t pset_new_size(const pset_new_t *pset_new);
109 * Initializes a pset_new iterator. Sets the iterator before the first element in
112 * @param iterator Pointer to already allocated iterator memory
113 * @param pset_new Pointer to the pset_new
115 FIRM_API void pset_new_iterator_init(pset_new_iterator_t *iterator, const pset_new_t *pset_new);
118 * Advances the iterator and returns the current element or NULL if all elements
119 * in the pset_new have been processed.
120 * @attention It is not allowed to use pset_new_insert or pset_new_remove while
121 * iterating over a pset_new; pset_new_remove_iter is allowed.
123 * @param iterator Pointer to the pset_new iterator.
124 * @returns Next element in the pset_new or NULL
126 FIRM_API void* pset_new_iterator_next(pset_new_iterator_t *iterator);
129 * Removes the element that the iterator currently points to from the hashset.
131 * @param pset_new Pointer to the pset_new
132 * @param iterator Pointer to the iterator
134 FIRM_API void pset_new_remove_iterator(pset_new_t *pset_new, const pset_new_iterator_t *iterator);
137 * Convenience macro for iterating over a pset_new.
139 #define foreach_pset_new(pset_new, ptr, iter) \
140 for(pset_new_iterator_init(&iter, pset_new), \
141 ptr = pset_new_iterator_next(&iter); \
142 ptr != NULL; ptr = pset_new_iterator_next(&iter))