Tue, 04 Oct 2022 19:25:07 +0200
fix over-optimization of strstr
1. it's actually less performant to frequently read bytes
from an array instead of using the native word length
2. the SBO buffer should be local and not static to allow
multi-threading usage
390 | 1 | /* |
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
3 | * | |
4 | * Copyright 2021 Mike Becker, 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 | */ | |
453
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
28 | /** |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
29 | * \file list.h |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
30 | * \brief Interface for list implementations. |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
31 | * \author Mike Becker |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
32 | * \author Olaf Wintermann |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
33 | * \version 3.0 |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
34 | * \copyright 2-Clause BSD License |
bb144d08cd44
add some documentation and changes some signatures
Mike Becker <universe@uap-core.de>
parents:
439
diff
changeset
|
35 | */ |
390 | 36 | |
37 | #ifndef UCX_LIST_H | |
38 | #define UCX_LIST_H | |
39 | ||
484
9e6900b1cf9d
add common.h include to all other header files
Mike Becker <universe@uap-core.de>
parents:
474
diff
changeset
|
40 | #include "common.h" |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
41 | #include "allocator.h" |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
42 | #include "iterator.h" |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
43 | |
415 | 44 | #ifdef __cplusplus |
45 | extern "C" { | |
46 | #endif | |
47 | ||
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
48 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
49 | * A comparator function comparing two list elements. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
50 | */ |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
51 | typedef int(*CxListComparator)( |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
52 | void const *left, |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
53 | void const *right |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
54 | ); |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
55 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
56 | /** |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
57 | * List class type. |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
58 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
59 | typedef struct cx_list_class_s cx_list_class; |
435
0fe204d50f54
change inheritance model for lists
Mike Becker <universe@uap-core.de>
parents:
415
diff
changeset
|
60 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
61 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
62 | * Structure for holding the base data of a list. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
63 | */ |
435
0fe204d50f54
change inheritance model for lists
Mike Becker <universe@uap-core.de>
parents:
415
diff
changeset
|
64 | struct cx_list_s { |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
65 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
66 | * The list class definition. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
67 | */ |
435
0fe204d50f54
change inheritance model for lists
Mike Becker <universe@uap-core.de>
parents:
415
diff
changeset
|
68 | cx_list_class *cl; |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
69 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
70 | * The allocator to use. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
71 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
72 | CxAllocator const *allocator; |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
73 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
74 | * The comparator function for the elements. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
75 | */ |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
76 | CxListComparator cmpfunc; |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
77 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
78 | * The size of each element (payload only). |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
79 | */ |
401
e6a8f7fb0c45
copy list items when they are added to the list
Mike Becker <universe@uap-core.de>
parents:
398
diff
changeset
|
80 | size_t itemsize; |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
81 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
82 | * The size of the list (number of currently stored elements). |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
83 | */ |
401
e6a8f7fb0c45
copy list items when they are added to the list
Mike Becker <universe@uap-core.de>
parents:
398
diff
changeset
|
84 | size_t size; |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
85 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
86 | * The capacity of the list (maximum number of elements). |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
87 | */ |
401
e6a8f7fb0c45
copy list items when they are added to the list
Mike Becker <universe@uap-core.de>
parents:
398
diff
changeset
|
88 | size_t capacity; |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
89 | union { |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
90 | /** |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
91 | * An optional simple destructor for the list contents that admits the free() interface. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
92 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
93 | * @remark Set content_destructor_type to #CX_DESTRUCTOR_SIMPLE. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
94 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
95 | * @attention Read the documentation of the particular list implementation |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
96 | * whether this destructor shall only destroy the contents or also free the memory. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
97 | */ |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
98 | cx_destructor_func simple_destructor; |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
99 | /** |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
100 | * An optional advanced destructor for the list contents providing additional data. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
101 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
102 | * @remark Set content_destructor_type to #CX_DESTRUCTOR_ADVANCED. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
103 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
104 | * @attention Read the documentation of the particular list implementation |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
105 | * whether this destructor shall only destroy the contents or also free the memory. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
106 | */ |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
107 | cx_advanced_destructor advanced_destructor; |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
108 | }; |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
109 | /** |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
110 | * The type of destructor to use. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
111 | */ |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
112 | enum cx_destructor_type content_destructor_type; |
435
0fe204d50f54
change inheritance model for lists
Mike Becker <universe@uap-core.de>
parents:
415
diff
changeset
|
113 | }; |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
114 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
115 | /** |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
116 | * The class definition for arbitrary lists. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
117 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
118 | struct cx_list_class_s { |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
119 | /** |
524 | 120 | * Destructor function. |
121 | */ | |
122 | void (*destructor)(struct cx_list_s *list); | |
123 | ||
124 | /** | |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
125 | * Member function for adding an element. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
126 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
127 | int (*add)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
128 | struct cx_list_s *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
129 | void const *elem |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
130 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
131 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
132 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
133 | * Member function for inserting an element. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
134 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
135 | int (*insert)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
136 | struct cx_list_s *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
137 | size_t index, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
138 | void const *elem |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
139 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
140 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
141 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
142 | * Member function for inserting an element relative to an iterator position. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
143 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
144 | int (*insert_iter)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
145 | struct cx_iterator_s *iter, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
146 | void const *elem, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
147 | int prepend |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
148 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
149 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
150 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
151 | * Member function for removing an element. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
152 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
153 | int (*remove)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
154 | struct cx_list_s *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
155 | size_t index |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
156 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
157 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
158 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
159 | * Member function for element lookup. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
160 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
161 | void *(*at)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
162 | struct cx_list_s const *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
163 | size_t index |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
164 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
165 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
166 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
167 | * Member function for finding an element. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
168 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
169 | size_t (*find)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
170 | struct cx_list_s const *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
171 | void const *elem |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
172 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
173 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
174 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
175 | * Member function for sorting the list in place. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
176 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
177 | void (*sort)(struct cx_list_s *list); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
178 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
179 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
180 | * Member function for comparing this list to another list of the same type. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
181 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
182 | int (*compare)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
183 | struct cx_list_s const *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
184 | struct cx_list_s const *other |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
185 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
186 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
187 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
188 | * Member function for reversing the order of the items. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
189 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
190 | void (*reverse)(struct cx_list_s *list); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
191 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
192 | /** |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
193 | * Returns an iterator pointing to the specified index. |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
194 | */ |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
195 | struct cx_iterator_s (*iterator)( |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
196 | struct cx_list_s *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
197 | size_t index |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
198 | ); |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
199 | }; |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
200 | |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
201 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
202 | * Common type for all list implementations. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
203 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
204 | typedef struct cx_list_s CxList; |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
205 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
206 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
207 | * Adds an item to the end of the list. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
208 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
209 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
210 | * @param elem a pointer to the element to add |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
211 | * @return zero on success, non-zero on memory allocation failure |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
212 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
213 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
214 | static inline int cxListAdd( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
215 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
216 | void const *elem |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
217 | ) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
218 | return list->cl->add(list, elem); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
219 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
220 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
221 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
222 | * Inserts an item at the specified index. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
223 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
224 | * If \p index equals the list \c size, this is effectively cxListAdd(). |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
225 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
226 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
227 | * @param index the index the element shall have |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
228 | * @param elem a pointer to the element to add |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
229 | * @return zero on success, non-zero on memory allocation failure |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
230 | * or when the index is out of bounds |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
231 | * @see cxListInsertAfter() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
232 | * @see cxListInsertBefore() |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
233 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
234 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
235 | static inline int cxListInsert( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
236 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
237 | size_t index, |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
238 | void const *elem |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
239 | ) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
240 | return list->cl->insert(list, index, elem); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
241 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
242 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
243 | /** |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
244 | * Inserts an element after the current location of the specified iterator. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
245 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
246 | * The used iterator remains operational, but all other active iterators should |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
247 | * be considered invalidated. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
248 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
249 | * If \p iter is not a list iterator, the behavior is undefined. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
250 | * If \p iter is a past-the-end iterator, the new element gets appended to the list. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
251 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
252 | * @param iter an iterator |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
253 | * @param elem the element to insert |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
254 | * @return zero on success, non-zero on memory allocation failure |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
255 | * @see cxListInsert() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
256 | * @see cxListInsertBefore() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
257 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
258 | __attribute__((__nonnull__)) |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
259 | static inline int cxListInsertAfter( |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
260 | CxIterator *iter, |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
261 | void const *elem |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
262 | ) { |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
263 | return ((struct cx_list_s *) iter->src_handle)->cl->insert_iter(iter, elem, 0); |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
264 | } |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
265 | |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
266 | /** |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
267 | * Inserts an element before the current location of the specified iterator. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
268 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
269 | * The used iterator remains operational, but all other active iterators should |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
270 | * be considered invalidated. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
271 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
272 | * If \p iter is not a list iterator, the behavior is undefined. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
273 | * If \p iter is a past-the-end iterator, the new element gets appended to the list. |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
274 | * |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
275 | * @param iter an iterator |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
276 | * @param elem the element to insert |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
277 | * @return zero on success, non-zero on memory allocation failure |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
278 | * @see cxListInsert() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
279 | * @see cxListInsertAfter() |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
280 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
281 | __attribute__((__nonnull__)) |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
282 | static inline int cxListInsertBefore( |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
283 | CxIterator *iter, |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
284 | void const *elem |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
285 | ) { |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
286 | return ((struct cx_list_s *) iter->src_handle)->cl->insert_iter(iter, elem, 1); |
499
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
287 | } |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
288 | |
3dc9075df822
add cxListInsertAfter() and cxListInsertBefore()
Mike Becker <universe@uap-core.de>
parents:
495
diff
changeset
|
289 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
290 | * Removes the element at the specified index. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
291 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
292 | * @param index the index of the element |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
293 | * @return zero on success, non-zero if the index is out of bounds |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
294 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
295 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
296 | static inline int cxListRemove( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
297 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
298 | size_t index |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
299 | ) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
300 | return list->cl->remove(list, index); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
301 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
302 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
303 | /** |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
304 | * Returns a pointer to the element at the specified index. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
305 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
306 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
307 | * @param index the index of the element |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
308 | * @return a pointer to the element or \c NULL if the index is out of bounds |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
309 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
310 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
311 | static inline void *cxListAt( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
312 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
313 | size_t index |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
314 | ) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
315 | return list->cl->at(list, index); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
316 | } |
439
9a5adedd6de6
add high-level function cxListAt()
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
317 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
318 | /** |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
319 | * Returns an iterator pointing to the item at the specified index. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
320 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
321 | * The returned iterator is position-aware. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
322 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
323 | * If the index is out of range, a past-the-end iterator will be returned. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
324 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
325 | * @param list the list |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
326 | * @param index the index where the iterator shall point at |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
327 | * @return a new iterator |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
328 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
329 | __attribute__((__nonnull__, __warn_unused_result__)) |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
330 | static inline CxIterator cxListIterator( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
331 | CxList *list, |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
332 | size_t index |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
333 | ) { |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
334 | return list->cl->iterator(list, index); |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
335 | } |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
336 | |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
337 | /** |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
338 | * Returns an iterator pointing to the first item of the list. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
339 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
340 | * The returned iterator is position-aware. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
341 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
342 | * If the list is empty, a past-the-end iterator will be returned. |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
343 | * |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
344 | * @param list the list |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
345 | * @return a new iterator |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
346 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
347 | __attribute__((__nonnull__, __warn_unused_result__)) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
348 | static inline CxIterator cxListBegin(CxList *list) { |
494
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
349 | return list->cl->iterator(list, 0); |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
350 | } |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
351 | |
6ce8cfa10a96
add iterator interface + linked list iterator
Mike Becker <universe@uap-core.de>
parents:
490
diff
changeset
|
352 | /** |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
353 | * Returns the index of the first element that equals \p elem. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
354 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
355 | * Determining equality is performed by the list's comparator function. |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
356 | * |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
357 | * @param list the list |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
358 | * @param elem the element to find |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
359 | * @return the index of the element or \c (size+1) if the element is not found |
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
360 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
361 | __attribute__((__nonnull__)) |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
362 | static inline size_t cxListFind( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
363 | CxList *list, |
489
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
364 | void const *elem |
af6be1e123aa
add some const qualifiers
Mike Becker <universe@uap-core.de>
parents:
488
diff
changeset
|
365 | ) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
366 | return list->cl->find(list, elem); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
367 | } |
398
8d506ed6c1c0
adds first draft for linked list implementation
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
368 | |
464
7fafc95968fc
add documentation for list.h
Mike Becker <universe@uap-core.de>
parents:
460
diff
changeset
|
369 | /** |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
370 | * Sorts the list in place. |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
371 | * |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
372 | * \remark The underlying sort algorithm is implementation defined. |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
373 | * |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
374 | * @param list the list |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
375 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
376 | __attribute__((__nonnull__)) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
377 | static inline void cxListSort(CxList *list) { |
469
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
378 | list->cl->sort(list); |
0458bff0b1cd
add high level list sort and inlines method invocation functions
Mike Becker <universe@uap-core.de>
parents:
464
diff
changeset
|
379 | } |
404 | 380 | |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
381 | /** |
490 | 382 | * Reverses the order of the items. |
383 | * | |
384 | * @param list the list | |
385 | */ | |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
386 | __attribute__((__nonnull__)) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
387 | static inline void cxListReverse(CxList *list) { |
490 | 388 | list->cl->reverse(list); |
389 | } | |
390 | ||
391 | /** | |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
392 | * Compares a list to another list of the same type. |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
393 | * |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
394 | * First, the list sizes are compared. If they match, the lists are compared element-wise. |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
395 | * |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
396 | * @param list the list |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
397 | * @param other the list to compare to |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
398 | * @return zero, if both lists are equal element wise, negative if the first list is smaller, zero if the first list is larger |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
399 | */ |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
505
diff
changeset
|
400 | __attribute__((__nonnull__)) |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
401 | static inline int cxListCompare( |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
402 | CxList *list, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
499
diff
changeset
|
403 | CxList *other |
488
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
404 | ) { |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
405 | return list->cl->compare(list, other); |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
406 | } |
9138acaa494b
add cxLinkedListFromArray() and cxListCompare()
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
407 | |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
408 | /** |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
409 | * Deallocates the memory of the specified list structure. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
410 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
411 | * Also calls content a destructor function, depending on the configuration |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
412 | * in CxList.content_destructor_type. |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
413 | * |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
414 | * This function itself is a destructor function for the CxList. |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
415 | * |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
416 | * @param list the list which shall be destroyed |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
417 | */ |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
418 | __attribute__((__nonnull__)) |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
419 | void cxListDestroy(CxList *list); |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
420 | |
415 | 421 | #ifdef __cplusplus |
422 | } /* extern "C" */ | |
423 | #endif | |
424 | ||
393 | 425 | #endif /* UCX_LIST_H */ |