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 * @brief double ended queue of generic pointers.
23 * @author Christian von Roques
26 #ifndef FIRM_ADT_PDEQ_H
27 #define FIRM_ADT_PDEQ_H
32 * The type of the pointer compare function.
34 * @param elem The list element.
35 * @param key The user supplied key.
37 * @return 0 if the element matches the key, non-zero else.
39 typedef int (*cmp_fun)(const void *elem, const void *key);
42 * The pointer double ended queue (list).
44 typedef struct pdeq pdeq;
47 * Creates a new double ended pointer list.
51 FIRM_API pdeq *new_pdeq(void);
54 * Creates a new double ended pointer list and puts an initial pointer element in.
56 * @param x The pointer element to put in.
58 * @return The new list.
60 FIRM_API pdeq *new_pdeq1(const void *x);
63 * Delete a double ended pointer list.
65 * @param dq The list to be deleted.
67 FIRM_API void del_pdeq(pdeq *dq);
70 * Returns the length of a double ended pointer list.
74 FIRM_API int pdeq_len(pdeq *dq);
77 * Checks if a list is empty.
81 * @return non-zero if the list is empty.
83 FIRM_API int pdeq_empty(pdeq *dq);
86 * Returns non-zero if a double ended pointer list
87 * contains a pointer x.
90 * @param x The pointer to be searched for.
92 FIRM_API int pdeq_contains(pdeq *dq, const void *x);
95 * Search a key in a double ended pointer list, the search
96 * is controlled by a compare function.
97 * An element is found, if the compare function returns 0.
98 * The search is started from the left site of the list.
100 * @param qp The list.
101 * @param cmp The compare function.
102 * @param key The search key.
104 * @return The address of the element entry if the key was found,
107 FIRM_API void *pdeq_search(pdeq *qp, cmp_fun cmp, const void *key);
110 * Convert the double ended pointer list into a linear array beginning from
111 * left, the first element in the linear array will be the left one.
113 * @param qp The list.
114 * @param dst A pointer to a pointer array with must be at least
115 * pdeq_len(dq) * sizeof(void *)
119 FIRM_API void **pdeq_copyl(pdeq *qp, const void **dst);
122 * Convert the double ended pointer list into a linear array beginning from
123 * right, the first element in the linear array will be the right one.
125 * @param qp The list.
126 * @param dst A pointer to a pointer array with must be at least
127 * pdeq_len(dq) * sizeof(void *)
131 FIRM_API void **pdeq_copyr(pdeq *qp, const void **dst);
134 * Add a pointer to the left side of a double ended pointer list.
136 * @param dq The list to add a pointer to.
137 * @param x The pointer element to be added
141 FIRM_API pdeq *pdeq_putl(pdeq *dq, const void *x);
144 * Add a pointer to the right side of a double ended pointer list.
146 * @param dq The list to add a pointer to.
147 * @param x The pointer element to be added
151 FIRM_API pdeq *pdeq_putr(pdeq *dq, const void *x);
154 * Retrieve (and remove) a pointer from the left site of a double ended pointer
158 * @return The pointer element.
159 * @remark This function will fail if the list is empty.
161 FIRM_API void *pdeq_getl(pdeq *dq);
164 * Retrieve (and remove) a pointer from the right site of a double ended pointer
168 * @return The pointer element.
169 * @remark This function will fail if the list is empty.
171 FIRM_API void *pdeq_getr(pdeq *dq);
174 #define PDEQ_VRFY(deq) ((void)0)
176 #define PDEQ_VRFY(deq) _pdeq_vrfy ((deq))
177 FIRM_API void _pdeq_vrfy(pdeq *dq);
181 * The pdeq is often used as a wait queue. A helper
182 * type to support this.
187 * Creates a new pointer wait queue (fifo).
189 * @return A new queue.
191 #define new_waitq() new_pdeq()
194 * Delete a wait queue (fifo)
196 * @param wq The wait queue.
198 #define del_waitq(wq) del_pdeq(wq)
201 * Retrieve a pointer from the wait queue (fifo).
203 * @param wq The wait queue.
205 * @return The pointer element.
207 * @remark This function will fail if the queue is empty.
209 #define waitq_get(wq) pdeq_getl(wq)
212 * Add a pointer to the wait queue (fifo).
214 * @param wq The wait queue
215 * @param x The pointer element to be added
217 * @return The wait queue.
219 #define waitq_put(wq, x) pdeq_putr((wq), (x))
222 * Checks if a wait queue is empty.
224 * @param wq The wait queue.
226 * @return non-zero if the queue is empty.
228 #define waitq_empty(wq) pdeq_empty(wq)
231 * The pdeq can be used as a stack. A helper
232 * type to support this.
237 * Creates a new pointer stack (lifo).
239 * @return A new stack.
241 #define new_stack() new_pdeq()
244 * Pop a pointer from the stack (lifo).
246 * @param st The stack.
248 * @return The pointer element.
250 * @remark This function will fail if the stack is empty.
252 #define stack_pop(st) pdeq_getr(st)
255 * Push a pointer to the stack (lifo).
257 * @param st The stack.
258 * @param x The pointer element to be added
262 #define stack_push(st, x) pdeq_putr((st), (x))
265 * Checks if a stack is empty.
267 * @param st The stack.
269 * @return non-zero if the stack is empty.
271 #define stack_empty(st) pdeq_empty(wq)