Mercurial > hg > toolkit / file comparison

comparison: ucx/list.h

ucx/list.h

changeset 0
1f419bd32da1
child 124
80609f9675f1
equal deleted inserted replaced
-1:000000000000 0:1f419bd32da1
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2013 Olaf Wintermann. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28 /**
29 * Doubly linked list implementation.
30 *
31 * @file list.h
32 * @author Mike Becker
33 * @author Olaf Wintermann
34 */
35
36 #ifndef UCX_LIST_H
37 #define UCX_LIST_H
38
39 #include "ucx.h"
40 #include "allocator.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 /**
47 * Loop statement for UCX lists.
48 *
49 * The first argument is a pointer to the list. In most cases this will be the
50 * pointer to the first element of the list, but it may also be an arbitrary
51 * element of the list. The iteration will then start with that element.
52 *
53 * The second argument is the name of the iteration variable. The scope of
54 * this variable is limited to the <code>UCX_FOREACH</code> statement.
55 *
56 * @param list The first element of the list
57 * @param elem The variable name of the element
58 */
59 #define UCX_FOREACH(elem,list) \
60 for (UcxList* elem = list ; elem != NULL ; elem = elem->next)
61
62 /**
63 * UCX list type.
64 * @see UcxList
65 */
66 typedef struct UcxList UcxList;
67
68 /**
69 * UCX list structure.
70 */
71 struct UcxList {
72 /**
73 * List element payload.
74 */
75 void *data;
76 /**
77 * Pointer to the next list element or <code>NULL</code>, if this is the
78 * last element.
79 */
80 UcxList *next;
81 /**
82 * Pointer to the previous list element or <code>NULL</code>, if this is
83 * the first element.
84 */
85 UcxList *prev;
86 };
87
88 /**
89 * Creates an element-wise copy of a list.
90 *
91 * This function clones the specified list by creating new list elements and
92 * copying the data with the specified copy_func(). If no copy_func() is
93 * specified, a shallow copy is created and the new list will reference the
94 * same data as the source list.
95 *
96 * @param list the list to copy
97 * @param cpyfnc a pointer to the function that shall copy an element (may be
98 * <code>NULL</code>)
99 * @param data additional data for the copy_func()
100 * @return a pointer to the copy
101 */
102 UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data);
103
104 /**
105 * Creates an element-wise copy of a list using an UcxAllocator.
106 *
107 * See ucx_list_clone() for details.
108 *
109 * Keep in mind, that you might want to pass the allocator as an (part of the)
110 * argument for the <code>data</code> parameter, if you want the copy_func() to
111 * make use of the allocator.
112 *
113 * @param allocator the allocator to use
114 * @param list the list to copy
115 * @param cpyfnc a pointer to the function that shall copy an element (may be
116 * <code>NULL</code>)
117 * @param data additional data for the copy_func()
118 * @return a pointer to the copy
119 * @see ucx_list_clone()
120 */
121 UcxList *ucx_list_clone_a(UcxAllocator *allocator, UcxList *list,
122 copy_func cpyfnc, void* data);
123
124 /**
125 * Compares two UCX lists element-wise by using a compare function.
126 *
127 * Each element of the two specified lists are compared by using the specified
128 * compare function and the additional data. The type and content of this
129 * additional data depends on the cmp_func() used.
130 *
131 * If the list pointers denote elements within a list, the lists are compared
132 * starting with the denoted elements. Thus any previous elements are not taken
133 * into account. This might be useful to check, if certain list tails match
134 * each other.
135 *
136 * @param list1 the first list
137 * @param list2 the second list
138 * @param cmpfnc the compare function
139 * @param data additional data for the compare function
140 * @return 1, if and only if the two lists equal element-wise, 0 otherwise
141 */
142 int ucx_list_equals(const UcxList *list1, const UcxList *list2,
143 cmp_func cmpfnc, void* data);
144
145 /**
146 * Destroys the entire list.
147 *
148 * The members of the list are not automatically freed, so ensure they are
149 * otherwise referenced or a memory leak will occur.
150 *
151 * <b>Caution:</b> the argument <b>MUST</b> denote an entire list (i.e. a call
152 * to ucx_list_first() on the argument must return the argument itself)
153 *
154 * @param list the list to free
155 */
156 void ucx_list_free(UcxList *list);
157
158 /**
159 * Destroys the entire list using an UcxAllocator.
160 *
161 * See ucx_list_free() for details.
162 *
163 * @param allocator the allocator to use
164 * @param list the list to free
165 * @see ucx_list_free()
166 */
167 void ucx_list_free_a(UcxAllocator *allocator, UcxList *list);
168
169 /**
170 * Inserts an element at the end of the list.
171 *
172 * This is generally an O(n) operation, as the end of the list is seeked with
173 * ucx_list_last().
174 *
175 * @param list the list where to append the data, or <code>NULL</code> to
176 * create a new list
177 * @param data the data to insert
178 * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to
179 * the newly created list otherwise
180 */
181 UcxList *ucx_list_append(UcxList *list, void *data);
182
183 /**
184 * Inserts an element at the end of the list using an UcxAllocator.
185 *
186 * See ucx_list_append() for details.
187 *
188 * @param allocator the allocator to use
189 * @param list the list where to append the data, or <code>NULL</code> to
190 * create a new list
191 * @param data the data to insert
192 * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to
193 * the newly created list otherwise
194 * @see ucx_list_append()
195 */
196 UcxList *ucx_list_append_a(UcxAllocator *allocator, UcxList *list, void *data);
197
198 /**
199 * Inserts an element at the beginning of the list.
200 *
201 * You <i>should</i> overwrite the old list pointer by calling
202 * <code>mylist = ucx_list_prepend(mylist, mydata);</code>. However, you may
203 * also perform successive calls of ucx_list_prepend() on the same list pointer,
204 * as this function always searchs for the head of the list with
205 * ucx_list_first().
206 *
207 * @param list the list where to insert the data or <code>NULL</code> to create
208 * a new list
209 * @param data the data to insert
210 * @return a pointer to the new list head
211 */
212 UcxList *ucx_list_prepend(UcxList *list, void *data);
213
214 /**
215 * Inserts an element at the beginning of the list using an UcxAllocator.
216 *
217 * See ucx_list_prepend() for details.
218 *
219 * @param allocator the allocator to use
220 * @param list the list where to insert the data or <code>NULL</code> to create
221 * a new list
222 * @param data the data to insert
223 * @return a pointer to the new list head
224 * @see ucx_list_prepend()
225 */
226 UcxList *ucx_list_prepend_a(UcxAllocator *allocator, UcxList *list, void *data);
227
228 /**
229 * Concatenates two lists.
230 *
231 * Either of the two arguments may be <code>NULL</code>.
232 *
233 * This function modifies the references to the next/previous element of
234 * the last/first element of <code>list1</code>/<code>
235 * list2</code>.
236 *
237 * @param list1 first list
238 * @param list2 second list
239 * @return if <code>list1</code> is <code>NULL</code>, <code>list2</code> is
240 * returned, otherwise <code>list1</code> is returned
241 */
242 UcxList *ucx_list_concat(UcxList *list1, UcxList *list2);
243
244 /**
245 * Returns the first element of a list.
246 *
247 * If the argument is the list pointer, it is directly returned. Otherwise
248 * this function traverses to the first element of the list and returns the
249 * list pointer.
250 *
251 * @param elem one element of the list
252 * @return the first element of the list, the specified element is a member of
253 */
254 UcxList *ucx_list_first(const UcxList *elem);
255
256 /**
257 * Returns the last element of a list.
258 *
259 * If the argument has no successor, it is the last element and therefore
260 * directly returned. Otherwise this function traverses to the last element of
261 * the list and returns it.
262 *
263 * @param elem one element of the list
264 * @return the last element of the list, the specified element is a member of
265 */
266 UcxList *ucx_list_last(const UcxList *elem);
267
268 /**
269 * Returns the list element at the specified index.
270 *
271 * @param list the list to retrieve the element from
272 * @param index index of the element to return
273 * @return the element at the specified index or <code>NULL</code>, if the
274 * index is greater than the list size
275 */
276 UcxList *ucx_list_get(const UcxList *list, int index);
277
278 /**
279 * Returns the index of an element.
280 *
281 * @param list the list where to search for the element
282 * @param elem the element to find
283 * @return the index of the element or -1 if the list does not contain the
284 * element
285 */
286 ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem);
287
288 /**
289 * Returns the element count of the list.
290 *
291 * @param list the list whose elements are counted
292 * @return the element count
293 */
294 size_t ucx_list_size(const UcxList *list);
295
296 /**
297 * Returns the index of an element containing the specified data.
298 *
299 * This function uses a cmp_func() to compare the data of each list element
300 * with the specified data. If no cmp_func is provided, the pointers are
301 * compared.
302 *
303 * If the list contains the data more than once, the index of the first
304 * occurrence is returned.
305 *
306 * @param list the list where to search for the data
307 * @param elem the element data
308 * @param cmpfnc the compare function
309 * @param data additional data for the compare function
310 * @return the index of the element containing the specified data or -1 if the
311 * data is not found in this list
312 */
313 ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
314
315 /**
316 * Checks, if a list contains a specific element.
317 *
318 * An element is found, if ucx_list_find() returns a value greater than -1.
319 *
320 * @param list the list where to search for the data
321 * @param elem the element data
322 * @param cmpfnc the compare function
323 * @param data additional data for the compare function
324 * @return 1, if and only if the list contains the specified element data
325 * @see ucx_list_find()
326 */
327 int ucx_list_contains(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
328
329 /**
330 * Sorts an UcxList with natural merge sort.
331 *
332 * This function uses O(n) additional temporary memory for merge operations
333 * that is automatically freed after each merge.
334 *
335 * As the head of the list might change, you <b>MUST</b> call this function
336 * as follows: <code>mylist = ucx_list_sort(mylist, mycmpfnc, mydata);</code>.
337 *
338 * @param list the list to sort
339 * @param cmpfnc the function that shall be used to compare the element data
340 * @param data additional data for the cmp_func()
341 * @return the sorted list
342 */
343 UcxList *ucx_list_sort(UcxList *list, cmp_func cmpfnc, void *data);
344
345 /**
346 * Removes an element from the list.
347 *
348 * If the first element is removed, the list pointer changes. So it is
349 * <i>highly recommended</i> to <i>always</i> update the pointer by calling
350 * <code>mylist = ucx_list_remove(mylist, myelem);</code>.
351 *
352 * @param list the list from which the element shall be removed
353 * @param element the element to removed
354 * @return returns the updated list pointer or <code>NULL</code>, if the list
355 * is now empty
356 */
357 UcxList *ucx_list_remove(UcxList *list, UcxList *element);
358
359 /**
360 * Removes an element from the list using an UcxAllocator.
361 *
362 * See ucx_list_remove() for details.
363 *
364 * @param allocator the allocator to use
365 * @param list the list from which the element shall be removed
366 * @param element the element to removed
367 * @return returns the updated list pointer or <code>NULL</code>, if the list
368 * @see ucx_list_remove()
369 */
370 UcxList *ucx_list_remove_a(UcxAllocator *allocator, UcxList *list,
371 UcxList *element);
372
373 #ifdef __cplusplus
374 }
375 #endif
376
377 #endif /* UCX_LIST_H */
378

Mercurial Repository: toolkit

mercurial