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
25 #ifndef FIRM_ADT_PDEQ_H
26 #define FIRM_ADT_PDEQ_H
34 * @defgroup pdeq Double Ended Queue
35 * Implementation if a double ended queue datastructure for generic pointers
40 * The type of the pointer compare function.
42 * @param elem The list element.
43 * @param key The user supplied key.
45 * @return 0 if the element matches the key, non-zero else.
47 typedef int (*cmp_fun)(const void *elem, const void *key);
50 * The pointer double ended queue (list).
52 typedef struct pdeq pdeq;
55 * Creates a new double ended pointer list.
59 FIRM_API pdeq *new_pdeq(void);
62 * Creates a new double ended pointer list and puts an initial pointer element in.
64 * @param x The pointer element to put in.
66 * @return The new list.
68 FIRM_API pdeq *new_pdeq1(const void *x);
71 * Delete a double ended pointer list.
73 * @param dq The list to be deleted.
75 FIRM_API void del_pdeq(pdeq *dq);
78 * Returns the length of a double ended pointer list.
82 FIRM_API size_t pdeq_len(pdeq *dq);
85 * Checks if a list is empty.
89 * @return non-zero if the list is empty.
91 FIRM_API int pdeq_empty(pdeq *dq);
94 * Returns non-zero if a double ended pointer list
95 * contains a pointer x.
98 * @param x The pointer to be searched for.
100 FIRM_API int pdeq_contains(pdeq *dq, const void *x);
103 * Search a key in a double ended pointer list, the search
104 * is controlled by a compare function.
105 * An element is found, if the compare function returns 0.
106 * The search is started from the left site of the list.
108 * @param qp The list.
109 * @param cmp The compare function.
110 * @param key The search key.
112 * @return The address of the element entry if the key was found,
115 FIRM_API void *pdeq_search(pdeq *qp, cmp_fun cmp, const void *key);
118 * Convert the double ended pointer list into a linear array beginning from
119 * left, the first element in the linear array will be the left one.
121 * @param qp The list.
122 * @param dst A pointer to a pointer array with must be at least
123 * pdeq_len(dq) * sizeof(void *)
127 FIRM_API void **pdeq_copyl(pdeq *qp, const void **dst);
130 * Convert the double ended pointer list into a linear array beginning from
131 * right, the first element in the linear array will be the right one.
133 * @param qp The list.
134 * @param dst A pointer to a pointer array with must be at least
135 * pdeq_len(dq) * sizeof(void *)
139 FIRM_API void **pdeq_copyr(pdeq *qp, const void **dst);
142 * Add a pointer to the left side of a double ended pointer list.
144 * @param dq The list to add a pointer to.
145 * @param x The pointer element to be added
149 FIRM_API pdeq *pdeq_putl(pdeq *dq, const void *x);
152 * Add a pointer to the right side of a double ended pointer list.
154 * @param dq The list to add a pointer to.
155 * @param x The pointer element to be added
159 FIRM_API pdeq *pdeq_putr(pdeq *dq, const void *x);
162 * Retrieve (and remove) a pointer from the left site of a double ended pointer
166 * @return The pointer element.
167 * @remark This function will fail if the list is empty.
169 FIRM_API void *pdeq_getl(pdeq *dq);
172 * Retrieve (and remove) a pointer from the right site of a double ended pointer
176 * @return The pointer element.
177 * @remark This function will fail if the list is empty.
179 FIRM_API void *pdeq_getr(pdeq *dq);
182 * The pdeq is often used as a wait queue. A helper
183 * type to support this.
188 * Creates a new pointer wait queue (fifo).
190 * @return A new queue.
192 #define new_waitq() new_pdeq()
195 * Delete a wait queue (fifo)
197 * @param wq The wait queue.
199 #define del_waitq(wq) del_pdeq(wq)
202 * Retrieve a pointer from the wait queue (fifo).
204 * @param wq The wait queue.
206 * @return The pointer element.
208 * @remark This function will fail if the queue is empty.
210 #define waitq_get(wq) pdeq_getl(wq)
213 * Add a pointer to the wait queue (fifo).
215 * @param wq The wait queue
216 * @param x The pointer element to be added
218 * @return The wait queue.
220 #define waitq_put(wq, x) pdeq_putr((wq), (x))
223 * Checks if a wait queue is empty.
225 * @param wq The wait queue.
227 * @return non-zero if the queue is empty.
229 #define waitq_empty(wq) pdeq_empty(wq)
232 * The pdeq can be used as a stack. A helper
233 * type to support this.
238 * Creates a new pointer stack (lifo).
240 * @return A new stack.
242 #define new_stack() new_pdeq()
245 * Pop a pointer from the stack (lifo).
247 * @param st The stack.
249 * @return The pointer element.
251 * @remark This function will fail if the stack is empty.
253 #define stack_pop(st) pdeq_getr(st)
256 * Push a pointer to the stack (lifo).
258 * @param st The stack.
259 * @param x The pointer element to be added
263 #define stack_push(st, x) pdeq_putr((st), (x))
266 * Checks if a stack is empty.
268 * @param st The stack.
270 * @return non-zero if the stack is empty.
272 #define stack_empty(st) pdeq_empty(wq)