2 * Copyright (C) 1995-2007 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 a set of pointers with a custom compare function
24 * @author Matthias Braun
27 #ifndef FIRM_ADT_CPSET_H
28 #define FIRM_ADT_CPSET_H
31 * The type of a cpset compare function.
33 * @param p1 pointer to an element
34 * @param p2 pointer to another element
36 * @return 1 if the elements are identically, zero else
38 typedef int (*cpset_cmp_function) (const void *p1, const void *p2);
41 * The type of a cpset hash function.
43 * @param p1 pointer to an element
44 * @param p2 pointer to another element
46 * @return 1 if the elements are identically, zero else
48 typedef unsigned (*cpset_hash_function) (const void *obj);
50 #define HashSet cpset_t
51 #define HashSetIterator cpset_iterator_t
52 #define HashSetEntry cpset_hashset_entry_t
53 #define ValueType void*
54 #define ADDITIONAL_DATA cpset_cmp_function cmp_function; cpset_hash_function hash_function;
56 #undef ADDITIONAL_DATA
59 #undef HashSetIterator
65 * @param cpset Pointer to allocated space for the cpset
66 * @param cmp_function The compare function to use
68 void cpset_init(cpset_t *cpset, cpset_hash_function hash_function,
69 cpset_cmp_function cmp_function);
74 * @param cpset Pointer to allocated space for the cpset
75 * @param cmp_function The compare function to use
76 * @param expected_elements Number of elements expected in the cpset (roughly)
78 void cpset_init_size(cpset_t *cpset, cpset_hash_function hash_function,
79 cpset_cmp_function cmp_function,
80 size_t expected_elements);
83 * Destroys a cpset and frees the memory allocated for hashtable. The memory of
84 * the cpset itself is not freed.
86 * @param cpset Pointer to the cpset
88 void cpset_destroy(cpset_t *cpset);
91 * Inserts an element into a cpset.
93 * @param cpset Pointer to the cpset
94 * @param obj Element to insert into the cpset
95 * @returns The element itself or a pointer to an existing element
97 void* cpset_insert(cpset_t *cpset, void *obj);
100 * Removes an element from a cpset. Does nothing if the cpset doesn't contain the
103 * @param cpset Pointer to the cpset
104 * @param obj Pointer to remove from the cpset
106 void cpset_remove(cpset_t *cpset, const void *obj);
109 * Tests whether a cpset contains a pointer
111 * @param cpset Pointer to the cpset
112 * @param obj The pointer to find
113 * @returns An equivalent object to @p obj or NULL
115 void *cpset_find(const cpset_t *cpset, const void *obj);
118 * Returns the number of pointers contained in the cpset
120 * @param cpset Pointer to the cpset
121 * @returns Number of pointers contained in the cpset
123 size_t cpset_size(const cpset_t *cpset);
126 * Initializes a cpset iterator. Sets the iterator before the first element in
129 * @param iterator Pointer to already allocated iterator memory
130 * @param cpset Pointer to the cpset
132 void cpset_iterator_init(cpset_iterator_t *iterator, const cpset_t *cpset);
135 * Advances the iterator and returns the current element or NULL if all elements
136 * in the cpset have been processed.
137 * @attention It is not allowed to use cpset_insert or cpset_remove while
138 * iterating over a cpset.
140 * @param iterator Pointer to the cpset iterator.
141 * @returns Next element in the cpset or NULL
143 void *cpset_iterator_next(cpset_iterator_t *iterator);
146 * Removed the element the iterator currently points to
148 * @param cpset Pointer to the cpset
149 * @param iterator Pointer to the cpset iterator.
151 void cpset_remove_iterator(cpset_t *cpset, const cpset_iterator_t *iterator);
153 #endif /* FIRM_ADT_CPSET_H */