ucx/dlist.h

changeset 122
540d99722f1f
parent 120
8170f658f017
equal deleted inserted replaced
121:311cac04d079 122:540d99722f1f
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 #ifndef UCX_DLIST_H
30 #define UCX_DLIST_H
31
32 #include "ucx.h"
33 #include <stddef.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /**
40 * Loop statement for UCX lists.
41 *
42 * The first argument is a pointer to the list. In most cases this will be the
43 * pointer to the first element of the list, but it may also be an arbitrary
44 * element of the list. The iteration will then start with that element.
45 *
46 * The second argument is the name of the iteration variable. The scope of
47 * this variable is limited to the <code>UCX_FOREACH</code> statement.
48 *
49 * @param list The first element of the list
50 * @param elem The variable name of the element
51 */
52 #define UCX_FOREACH(list,elem) \
53 for (UcxDlist* elem = list ; elem != NULL ; elem = elem->next)
54
55 typedef struct UcxDlist UcxDlist;
56 struct UcxDlist {
57 void *data;
58 UcxDlist *next;
59 UcxDlist *prev;
60 };
61
62 UcxDlist *ucx_dlist_clone(UcxDlist *l, copy_func fnc, void* data);
63 int ucx_dlist_equals(const UcxDlist *l1, const UcxDlist *l2,
64 cmp_func fnc, void* data);
65
66 void ucx_dlist_free(UcxDlist *l);
67 UcxDlist *ucx_dlist_append(UcxDlist *l, void *data);
68 UcxDlist *ucx_dlist_prepend(UcxDlist *l, void *data);
69 UcxDlist *ucx_dlist_concat(UcxDlist *l1, UcxDlist *l2);
70 UcxDlist *ucx_dlist_last(const UcxDlist *l);
71 UcxDlist *ucx_dlist_get(const UcxDlist *l, int index);
72 size_t ucx_dlist_size(const UcxDlist *l);
73 int ucx_dlist_contains(UcxDlist *l, void *elem, cmp_func fnc, void *cmpdata);
74
75 UcxDlist *ucx_dlist_sort(UcxDlist *l, cmp_func fnc, void *data);
76
77 /* dlist specific functions */
78 UcxDlist *ucx_dlist_first(const UcxDlist *l);
79 UcxDlist *ucx_dlist_remove(UcxDlist *l, UcxDlist *e);
80
81 #ifdef __cplusplus
82 }
83 #endif
84
85 #endif /* UCX_DLIST_H */
86

mercurial