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
22 * @author Kimon Hoffmann
24 * @brief Simple, non circular, double linked pointer list.
25 * Created because the properties of the standard circular list were
26 * not very well suited for the interference graph implementation.
27 * This list uses an obstack and a free-list to efficiently manage its
31 #ifndef FIRM_ADT_PLIST_H
32 #define FIRM_ADT_PLIST_H
39 typedef struct plist_element plist_element_t;
40 typedef struct plist plist_t;
43 * The plist data type.
46 /** The obstack used for all allocations. */
49 /** Set to 1 if plist uses a foreign obstack */
50 unsigned foreign_obstack : 1;
52 /** First element in the list. */
53 plist_element_t *first_element;
55 /** Last element in the list. */
56 plist_element_t *last_element;
58 /** Current number of elements in the list. */
62 * First element in the free list.
63 * Please note that the free list is a single linked list and all back
64 * references are invalid.
66 plist_element_t* first_free_element;
70 * An element in the pointer list.
72 struct plist_element {
73 plist_element_t *next; /**< next element in double linked list */
74 plist_element_t *prev; /**< previous element in double linked list */
75 void *data; /**< element data */
79 * Creates a new pointer list and initializes it.
80 * @return The newly created pointer list.
82 FIRM_API plist_t *plist_new(void);
85 * Creates a new pointer list and initializes it.
86 * Uses the given obstack instead of creating one.
87 * @param obst The obstack to use
88 * @return The newly created pointer list.
90 FIRM_API plist_t *plist_obstack_new(struct obstack *obst);
93 * Frees the passed pointer list.
94 * After a call to this function all references to the list and any of
95 * its elements are invalid.
97 FIRM_API void plist_free(plist_t *list);
100 * Returns the number of elements in a pointer list.
101 * @param list the pointer list
102 * @return The number of elements in a pointer list.
104 #define plist_count(list) \
105 ((list)->element_count)
108 * Inserts an element at the back of a pointer list.
109 * @param list the pointer list to append the new element to.
110 * @param value the element value to append.
112 FIRM_API void plist_insert_back(plist_t *list, void *value);
115 * Inserts an element at the front of a pointer list.
116 * @param list the pointer list to prepend the new element to.
117 * @param value the element value to prepend.
119 FIRM_API void plist_insert_front(plist_t *list, void *value);
122 * Inserts an element into a pointer list before the specified element,
123 * which must be non null.
124 * @param list the pointer list to insert the new element into.
125 * @param element the list element before which the new element should
126 * be inserted. This element must be a part of @p list.
127 * @param value the element value to insert.
129 FIRM_API void plist_insert_before(plist_t *list, plist_element_t *element, void *value);
132 * Inserts an element into a pointer list after the specified element,
133 * which must be non null.
134 * @param list the pointer list to insert the new element into.
135 * @param element the list element after which the new element should
136 * be inserted. This element must be a part of @p list.
137 * @param value the element value to insert.
139 FIRM_API void plist_insert_after(plist_t *list, plist_element_t *element, void *value);
142 * Checks if list has an element with the given data pointer.
143 * @param list the list to check
144 * @param value the data pointer to look for
145 * @return 1 if element with data pointer found, 0 otherwise
147 FIRM_API int plist_has_value(plist_t *list, void *value);
150 * Tries to find list element associated to the given data pointer.
151 * @param list the list to check
152 * @param value the data pointer to look for
153 * @return The first list element associated to data pointer if found, NULL otherwise
155 FIRM_API plist_element_t *plist_find_value(plist_t *list, void *value);
158 * Erases the specified element from the pointer list.
159 * @param list the pointer list from which the element should be erased.
160 * @param element the list element to erase. This element must be a part
163 FIRM_API void plist_erase(plist_t *list, plist_element_t *element);
166 * Erases all elements from the specified pointer list.
167 * @param list the pointer list that should be cleared.
169 FIRM_API void plist_clear(plist_t *list);
172 * Returns the first element of a pointer list.
173 * @param list the pointer list to iterate
174 * @return a pointer to the element or NULL if the list is empty
176 #define plist_first(list) \
177 ((list)->first_element)
180 * Returns the last element of a pointer list.
181 * @param list the pointer list to iterate
182 * @return a pointer to the element or NULL if the list is empty
184 #define plist_last(list) \
185 ((list)->last_element)
188 * Checks whether a pointer list element has a successor or not.
189 * @param element the list element that should be queried for existence
191 * @return TRUE if @p element has a successor, otherwise FALSE.
193 #define plist_element_has_next(element) \
194 ((element)->next != NULL)
197 * Checks whether a pointer list element has a predecessor or not.
198 * @param element the list element that should be queried for existence
200 * @return TRUE if @p element has a successor, otherwise FALSE.
202 #define plist_element_has_prev(element) \
203 ((element)->prev != NULL)
206 * Gets the successor of the passed list element.
207 * @param element the list element to return the successor of.
208 * @return The successor of @p element or NULL if @p element is the last
209 * element in the sequence.
211 #define plist_element_get_next(element) \
215 * Gets the predecessor of the passed list element.
216 * @param element the list element to return the predecessor of.
217 * @return The predecessor of @p element or NULL if @p element is the last
218 * element in the sequence.
220 #define plist_element_get_prev(element) \
224 * Gets the value stored in the passed list element.
225 * @param element the list element to return the value of.
226 * @return The value stored in @p element.
228 #define plist_element_get_value(element) \
232 * Convenience macro to iterate over a plist.
234 #define foreach_plist(list, el) \
235 for (el = plist_first(list); el; el = plist_element_get_next(el))