Mercurial > hg > dbutils / file comparison

comparison: ucx/cx/linked_list.h

ucx/cx/linked_list.h

changeset 16
04c9f8d8f03b
parent 11
0aa8cbd7912e
child 21
5ea41679e15d
equal deleted inserted replaced
15:862ab606ee06 16:04c9f8d8f03b
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 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 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE. 26 * POSSIBILITY OF SUCH DAMAGE.
27 */ 27 */
28 /** 28 /**
29 * \file linked_list.h 29 * @file linked_list.h
30 * \brief Linked list implementation. 30 * @brief Linked list implementation.
31 * \details Also provides several low-level functions for custom linked list implementations. 31 * @author Mike Becker
32 * \author Mike Becker 32 * @author Olaf Wintermann
33 * \author Olaf Wintermann 33 * @copyright 2-Clause BSD License
34 * \copyright 2-Clause BSD License
35 */ 34 */
36 35
37 #ifndef UCX_LINKED_LIST_H 36 #ifndef UCX_LINKED_LIST_H
38 #define UCX_LINKED_LIST_H 37 #define UCX_LINKED_LIST_H
39 38
43 #ifdef __cplusplus 42 #ifdef __cplusplus
44 extern "C" { 43 extern "C" {
45 #endif 44 #endif
46 45
47 /** 46 /**
48 * The maximum item size that uses SBO swap instead of relinking. 47 * Allocates a linked list for storing elements with @p elem_size bytes each.
49 */ 48 *
50 extern const unsigned cx_linked_list_swap_sbo_size; 49 * If @p elem_size is #CX_STORE_POINTERS, the created list stores pointers instead of
51 50 * copies of the added elements and the compare function will be automatically set
52 /** 51 * to cx_cmp_ptr(), if none is given.
53 * Allocates a linked list for storing elements with \p elem_size bytes each.
54 *
55 * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
56 * cxListStorePointers() was called immediately after creation and the compare
57 * function will be automatically set to cx_cmp_ptr(), if none is given.
58 * 52 *
59 * @param allocator the allocator for allocating the list nodes 53 * @param allocator the allocator for allocating the list nodes
60 * (if \c NULL, a default stdlib allocator will be used) 54 * (if @c NULL, a default stdlib allocator will be used)
61 * @param comparator the comparator for the elements 55 * @param comparator the comparator for the elements
62 * (if \c NULL, and the list is not storing pointers, sort and find 56 * (if @c NULL, and the list is not storing pointers, sort and find
63 * functions will not work) 57 * functions will not work)
64 * @param elem_size the size of each element in bytes 58 * @param elem_size the size of each element in bytes
65 * @return the created list 59 * @return the created list
66 */ 60 */
67 cx_attr_nodiscard 61 cx_attr_nodiscard
68 cx_attr_malloc 62 cx_attr_malloc
69 cx_attr_dealloc(cxListFree, 1) 63 cx_attr_dealloc(cxListFree, 1)
64 cx_attr_export
70 CxList *cxLinkedListCreate( 65 CxList *cxLinkedListCreate(
71 const CxAllocator *allocator, 66 const CxAllocator *allocator,
72 cx_compare_func comparator, 67 cx_compare_func comparator,
73 size_t elem_size 68 size_t elem_size
74 ); 69 );
75 70
76 /** 71 /**
77 * Allocates a linked list for storing elements with \p elem_size bytes each. 72 * Allocates a linked list for storing elements with @p elem_size bytes each.
78 * 73 *
79 * The list will use cxDefaultAllocator and no comparator function. If you want 74 * The list will use cxDefaultAllocator and no comparator function. If you want
80 * to call functions that need a comparator, you must either set one immediately 75 * to call functions that need a comparator, you must either set one immediately
81 * after list creation or use cxLinkedListCreate(). 76 * after list creation or use cxLinkedListCreate().
82 * 77 *
83 * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if 78 * If @p elem_size is #CX_STORE_POINTERS, the created list stores pointers instead of
84 * cxListStorePointers() was called immediately after creation and the compare 79 * copies of the added elements and the compare function will be automatically set
85 * function will be automatically set to cx_cmp_ptr(). 80 * to cx_cmp_ptr(), if none is given.
86 * 81 *
87 * @param elem_size the size of each element in bytes 82 * @param elem_size (@c size_t) the size of each element in bytes
88 * @return the created list 83 * @return (@c CxList*) the created list
89 */ 84 */
90 #define cxLinkedListCreateSimple(elem_size) \ 85 #define cxLinkedListCreateSimple(elem_size) \
91 cxLinkedListCreate(NULL, NULL, elem_size) 86 cxLinkedListCreate(NULL, NULL, elem_size)
92 87
93 /** 88 /**
94 * Finds the node at a certain index. 89 * Finds the node at a certain index.
95 * 90 *
96 * This function can be used to start at an arbitrary position within the list. 91 * This function can be used to start at an arbitrary position within the list.
97 * If the search index is large than the start index, \p loc_advance must denote 92 * If the search index is large than the start index, @p loc_advance must denote
98 * the location of some sort of \c next pointer (i.e. a pointer to the next node). 93 * the location of some sort of @c next pointer (i.e. a pointer to the next node).
99 * But it is also possible that the search index is smaller than the start index 94 * But it is also possible that the search index is smaller than the start index
100 * (e.g. in cases where traversing a list backwards is faster) in which case 95 * (e.g. in cases where traversing a list backwards is faster) in which case
101 * \p loc_advance must denote the location of some sort of \c prev pointer 96 * @p loc_advance must denote the location of some sort of @c prev pointer
102 * (i.e. a pointer to the previous node). 97 * (i.e. a pointer to the previous node).
103 * 98 *
104 * @param start a pointer to the start node 99 * @param start a pointer to the start node
105 * @param start_index the start index 100 * @param start_index the start index
106 * @param loc_advance the location of the pointer to advance 101 * @param loc_advance the location of the pointer to advance
107 * @param index the search index 102 * @param index the search index
108 * @return the node found at the specified index 103 * @return the node found at the specified index
109 */ 104 */
110 cx_attr_nonnull 105 cx_attr_nonnull
111 cx_attr_nodiscard 106 cx_attr_nodiscard
107 cx_attr_export
112 void *cx_linked_list_at( 108 void *cx_linked_list_at(
113 const void *start, 109 const void *start,
114 size_t start_index, 110 size_t start_index,
115 ptrdiff_t loc_advance, 111 ptrdiff_t loc_advance,
116 size_t index 112 size_t index
117 ); 113 );
118 114
119 /** 115 /**
120 * Finds the index of an element within a linked list. 116 * Finds the node containing an element within a linked list.
121 * 117 *
122 * @param start a pointer to the start node 118 * @param start a pointer to the start node
123 * @param loc_advance the location of the pointer to advance 119 * @param loc_advance the location of the pointer to advance
124 * @param loc_data the location of the \c data pointer within your node struct 120 * @param loc_data the location of the @c data pointer within your node struct
125 * @param cmp_func a compare function to compare \p elem against the node data 121 * @param cmp_func a compare function to compare @p elem against the node data
126 * @param elem a pointer to the element to find 122 * @param elem a pointer to the element to find
127 * @return the index of the element or a negative value if it could not be found 123 * @param found_index an optional pointer where the index of the found node
128 */ 124 * (given that @p start has index 0) is stored
129 cx_attr_nonnull 125 * @return the index of the element, if found - unspecified if not found
130 ssize_t cx_linked_list_find( 126 */
127 cx_attr_nonnull_arg(1, 4, 5)
128 cx_attr_export
129 void *cx_linked_list_find(
131 const void *start, 130 const void *start,
132 ptrdiff_t loc_advance, 131 ptrdiff_t loc_advance,
133 ptrdiff_t loc_data, 132 ptrdiff_t loc_data,
134 cx_compare_func cmp_func, 133 cx_compare_func cmp_func,
135 const void *elem 134 const void *elem,
136 ); 135 size_t *found_index
137
138 /**
139 * Finds the node containing an element within a linked list.
140 *
141 * @param result a pointer to the memory where the node pointer (or \c NULL if the element
142 * could not be found) shall be stored to
143 * @param start a pointer to the start node
144 * @param loc_advance the location of the pointer to advance
145 * @param loc_data the location of the \c data pointer within your node struct
146 * @param cmp_func a compare function to compare \p elem against the node data
147 * @param elem a pointer to the element to find
148 * @return the index of the element or a negative value if it could not be found
149 */
150 cx_attr_nonnull
151 ssize_t cx_linked_list_find_node(
152 void **result,
153 const void *start,
154 ptrdiff_t loc_advance,
155 ptrdiff_t loc_data,
156 cx_compare_func cmp_func,
157 const void *elem
158 ); 136 );
159 137
160 /** 138 /**
161 * Finds the first node in a linked list. 139 * Finds the first node in a linked list.
162 * 140 *
163 * The function starts with the pointer denoted by \p node and traverses the list 141 * The function starts with the pointer denoted by @p node and traverses the list
164 * along a prev pointer whose location within the node struct is 142 * along a prev pointer whose location within the node struct is
165 * denoted by \p loc_prev. 143 * denoted by @p loc_prev.
166 * 144 *
167 * @param node a pointer to a node in the list 145 * @param node a pointer to a node in the list
168 * @param loc_prev the location of the \c prev pointer 146 * @param loc_prev the location of the @c prev pointer
169 * @return a pointer to the first node 147 * @return a pointer to the first node
170 */ 148 */
171 cx_attr_nonnull 149 cx_attr_nonnull
172 cx_attr_returns_nonnull 150 cx_attr_returns_nonnull
151 cx_attr_export
173 void *cx_linked_list_first( 152 void *cx_linked_list_first(
174 const void *node, 153 const void *node,
175 ptrdiff_t loc_prev 154 ptrdiff_t loc_prev
176 ); 155 );
177 156
178 /** 157 /**
179 * Finds the last node in a linked list. 158 * Finds the last node in a linked list.
180 * 159 *
181 * The function starts with the pointer denoted by \p node and traverses the list 160 * The function starts with the pointer denoted by @p node and traverses the list
182 * along a next pointer whose location within the node struct is 161 * along a next pointer whose location within the node struct is
183 * denoted by \p loc_next. 162 * denoted by @p loc_next.
184 * 163 *
185 * @param node a pointer to a node in the list 164 * @param node a pointer to a node in the list
186 * @param loc_next the location of the \c next pointer 165 * @param loc_next the location of the @c next pointer
187 * @return a pointer to the last node 166 * @return a pointer to the last node
188 */ 167 */
189 cx_attr_nonnull 168 cx_attr_nonnull
190 cx_attr_returns_nonnull 169 cx_attr_returns_nonnull
170 cx_attr_export
191 void *cx_linked_list_last( 171 void *cx_linked_list_last(
192 const void *node, 172 const void *node,
193 ptrdiff_t loc_next 173 ptrdiff_t loc_next
194 ); 174 );
195 175
196 /** 176 /**
197 * Finds the predecessor of a node in case it is not linked. 177 * Finds the predecessor of a node in case it is not linked.
198 * 178 *
199 * \remark If \p node is not contained in the list starting with \p begin, the behavior is undefined. 179 * @remark If @p node is not contained in the list starting with @p begin, the behavior is undefined.
200 * 180 *
201 * @param begin the node where to start the search 181 * @param begin the node where to start the search
202 * @param loc_next the location of the \c next pointer 182 * @param loc_next the location of the @c next pointer
203 * @param node the successor of the node to find 183 * @param node the successor of the node to find
204 * @return the node or \c NULL if \p node has no predecessor 184 * @return the node or @c NULL if @p node has no predecessor
205 */ 185 */
206 cx_attr_nonnull 186 cx_attr_nonnull
187 cx_attr_export
207 void *cx_linked_list_prev( 188 void *cx_linked_list_prev(
208 const void *begin, 189 const void *begin,
209 ptrdiff_t loc_next, 190 ptrdiff_t loc_next,
210 const void *node 191 const void *node
211 ); 192 );
212 193
213 /** 194 /**
214 * Adds a new node to a linked list. 195 * Adds a new node to a linked list.
215 * The node must not be part of any list already. 196 * The node must not be part of any list already.
216 * 197 *
217 * \remark One of the pointers \p begin or \p end may be \c NULL, but not both. 198 * @remark One of the pointers @p begin or @p end may be @c NULL, but not both.
218 * 199 *
219 * @param begin a pointer to the begin node pointer (if your list has one) 200 * @param begin a pointer to the beginning node pointer (if your list has one)
220 * @param end a pointer to the end node pointer (if your list has one) 201 * @param end a pointer to the end node pointer (if your list has one)
221 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 202 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
222 * @param loc_next the location of a \c next pointer within your node struct (required) 203 * @param loc_next the location of a @c next pointer within your node struct (required)
223 * @param new_node a pointer to the node that shall be appended 204 * @param new_node a pointer to the node that shall be appended
224 */ 205 */
225 cx_attr_nonnull_arg(5) 206 cx_attr_nonnull_arg(5)
207 cx_attr_export
226 void cx_linked_list_add( 208 void cx_linked_list_add(
227 void **begin, 209 void **begin,
228 void **end, 210 void **end,
229 ptrdiff_t loc_prev, 211 ptrdiff_t loc_prev,
230 ptrdiff_t loc_next, 212 ptrdiff_t loc_next,
233 215
234 /** 216 /**
235 * Prepends a new node to a linked list. 217 * Prepends a new node to a linked list.
236 * The node must not be part of any list already. 218 * The node must not be part of any list already.
237 * 219 *
238 * \remark One of the pointers \p begin or \p end may be \c NULL, but not both. 220 * @remark One of the pointers @p begin or @p end may be @c NULL, but not both.
239 * 221 *
240 * @param begin a pointer to the begin node pointer (if your list has one) 222 * @param begin a pointer to the beginning node pointer (if your list has one)
241 * @param end a pointer to the end node pointer (if your list has one) 223 * @param end a pointer to the end node pointer (if your list has one)
242 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 224 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
243 * @param loc_next the location of a \c next pointer within your node struct (required) 225 * @param loc_next the location of a @c next pointer within your node struct (required)
244 * @param new_node a pointer to the node that shall be prepended 226 * @param new_node a pointer to the node that shall be prepended
245 */ 227 */
246 cx_attr_nonnull_arg(5) 228 cx_attr_nonnull_arg(5)
229 cx_attr_export
247 void cx_linked_list_prepend( 230 void cx_linked_list_prepend(
248 void **begin, 231 void **begin,
249 void **end, 232 void **end,
250 ptrdiff_t loc_prev, 233 ptrdiff_t loc_prev,
251 ptrdiff_t loc_next, 234 ptrdiff_t loc_next,
253 ); 236 );
254 237
255 /** 238 /**
256 * Links two nodes. 239 * Links two nodes.
257 * 240 *
258 * @param left the new predecessor of \p right 241 * @param left the new predecessor of @p right
259 * @param right the new successor of \p left 242 * @param right the new successor of @p left
260 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 243 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
261 * @param loc_next the location of a \c next pointer within your node struct (required) 244 * @param loc_next the location of a @c next pointer within your node struct (required)
262 */ 245 */
263 cx_attr_nonnull 246 cx_attr_nonnull
247 cx_attr_export
264 void cx_linked_list_link( 248 void cx_linked_list_link(
265 void *left, 249 void *left,
266 void *right, 250 void *right,
267 ptrdiff_t loc_prev, 251 ptrdiff_t loc_prev,
268 ptrdiff_t loc_next 252 ptrdiff_t loc_next
271 /** 255 /**
272 * Unlinks two nodes. 256 * Unlinks two nodes.
273 * 257 *
274 * If right is not the successor of left, the behavior is undefined. 258 * If right is not the successor of left, the behavior is undefined.
275 * 259 *
276 * @param left the predecessor of \p right 260 * @param left the predecessor of @p right
277 * @param right the successor of \p left 261 * @param right the successor of @p left
278 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 262 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
279 * @param loc_next the location of a \c next pointer within your node struct (required) 263 * @param loc_next the location of a @c next pointer within your node struct (required)
280 */ 264 */
281 cx_attr_nonnull 265 cx_attr_nonnull
266 cx_attr_export
282 void cx_linked_list_unlink( 267 void cx_linked_list_unlink(
283 void *left, 268 void *left,
284 void *right, 269 void *right,
285 ptrdiff_t loc_prev, 270 ptrdiff_t loc_prev,
286 ptrdiff_t loc_next 271 ptrdiff_t loc_next
288 273
289 /** 274 /**
290 * Inserts a new node after a given node of a linked list. 275 * Inserts a new node after a given node of a linked list.
291 * The new node must not be part of any list already. 276 * The new node must not be part of any list already.
292 * 277 *
293 * \note If you specify \c NULL as the \p node to insert after, this function needs either the \p begin or 278 * @note If you specify @c NULL as the @p node to insert after, this function needs either the @p begin or
294 * the \p end pointer to determine the start of the list. Then the new node will be prepended to the list. 279 * the @p end pointer to determine the start of the list. Then the new node will be prepended to the list.
295 * 280 *
296 * @param begin a pointer to the begin node pointer (if your list has one) 281 * @param begin a pointer to the beginning node pointer (if your list has one)
297 * @param end a pointer to the end node pointer (if your list has one) 282 * @param end a pointer to the end node pointer (if your list has one)
298 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 283 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
299 * @param loc_next the location of a \c next pointer within your node struct (required) 284 * @param loc_next the location of a @c next pointer within your node struct (required)
300 * @param node the node after which to insert (\c NULL if you want to prepend the node to the list) 285 * @param node the node after which to insert (@c NULL if you want to prepend the node to the list)
301 * @param new_node a pointer to the node that shall be inserted 286 * @param new_node a pointer to the node that shall be inserted
302 */ 287 */
303 cx_attr_nonnull_arg(6) 288 cx_attr_nonnull_arg(6)
289 cx_attr_export
304 void cx_linked_list_insert( 290 void cx_linked_list_insert(
305 void **begin, 291 void **begin,
306 void **end, 292 void **end,
307 ptrdiff_t loc_prev, 293 ptrdiff_t loc_prev,
308 ptrdiff_t loc_next, 294 ptrdiff_t loc_next,
313 /** 299 /**
314 * Inserts a chain of nodes after a given node of a linked list. 300 * Inserts a chain of nodes after a given node of a linked list.
315 * The chain must not be part of any list already. 301 * The chain must not be part of any list already.
316 * 302 *
317 * If you do not explicitly specify the end of the chain, it will be determined by traversing 303 * If you do not explicitly specify the end of the chain, it will be determined by traversing
318 * the \c next pointer. 304 * the @c next pointer.
319 * 305 *
320 * \note If you specify \c NULL as the \p node to insert after, this function needs either the \p begin or 306 * @note If you specify @c NULL as the @p node to insert after, this function needs either the @p begin or
321 * the \p end pointer to determine the start of the list. If only the \p end pointer is specified, you also need 307 * the @p end pointer to determine the start of the list. If only the @p end pointer is specified, you also need
322 * to provide a valid \p loc_prev location. 308 * to provide a valid @p loc_prev location.
323 * Then the chain will be prepended to the list. 309 * Then the chain will be prepended to the list.
324 * 310 *
325 * @param begin a pointer to the begin node pointer (if your list has one) 311 * @param begin a pointer to the beginning node pointer (if your list has one)
326 * @param end a pointer to the end node pointer (if your list has one) 312 * @param end a pointer to the end node pointer (if your list has one)
327 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 313 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
328 * @param loc_next the location of a \c next pointer within your node struct (required) 314 * @param loc_next the location of a @c next pointer within your node struct (required)
329 * @param node the node after which to insert (\c NULL to prepend the chain to the list) 315 * @param node the node after which to insert (@c NULL to prepend the chain to the list)
330 * @param insert_begin a pointer to the first node of the chain that shall be inserted 316 * @param insert_begin a pointer to the first node of the chain that shall be inserted
331 * @param insert_end a pointer to the last node of the chain (or NULL if the last node shall be determined) 317 * @param insert_end a pointer to the last node of the chain (or NULL if the last node shall be determined)
332 */ 318 */
333 cx_attr_nonnull_arg(6) 319 cx_attr_nonnull_arg(6)
320 cx_attr_export
334 void cx_linked_list_insert_chain( 321 void cx_linked_list_insert_chain(
335 void **begin, 322 void **begin,
336 void **end, 323 void **end,
337 ptrdiff_t loc_prev, 324 ptrdiff_t loc_prev,
338 ptrdiff_t loc_next, 325 ptrdiff_t loc_next,
343 330
344 /** 331 /**
345 * Inserts a node into a sorted linked list. 332 * Inserts a node into a sorted linked list.
346 * The new node must not be part of any list already. 333 * The new node must not be part of any list already.
347 * 334 *
348 * If the list starting with the node pointed to by \p begin is not sorted 335 * If the list starting with the node pointed to by @p begin is not sorted
349 * already, the behavior is undefined. 336 * already, the behavior is undefined.
350 * 337 *
351 * @param begin a pointer to the begin node pointer (required) 338 * @param begin a pointer to the beginning node pointer (required)
352 * @param end a pointer to the end node pointer (if your list has one) 339 * @param end a pointer to the end node pointer (if your list has one)
353 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 340 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
354 * @param loc_next the location of a \c next pointer within your node struct (required) 341 * @param loc_next the location of a @c next pointer within your node struct (required)
355 * @param new_node a pointer to the node that shall be inserted 342 * @param new_node a pointer to the node that shall be inserted
356 * @param cmp_func a compare function that will receive the node pointers 343 * @param cmp_func a compare function that will receive the node pointers
357 */ 344 */
358 cx_attr_nonnull_arg(1, 5, 6) 345 cx_attr_nonnull_arg(1, 5, 6)
346 cx_attr_export
359 void cx_linked_list_insert_sorted( 347 void cx_linked_list_insert_sorted(
360 void **begin, 348 void **begin,
361 void **end, 349 void **end,
362 ptrdiff_t loc_prev, 350 ptrdiff_t loc_prev,
363 ptrdiff_t loc_next, 351 ptrdiff_t loc_next,
367 355
368 /** 356 /**
369 * Inserts a chain of nodes into a sorted linked list. 357 * Inserts a chain of nodes into a sorted linked list.
370 * The chain must not be part of any list already. 358 * The chain must not be part of any list already.
371 * 359 *
372 * If either the list starting with the node pointed to by \p begin or the list 360 * If either the list starting with the node pointed to by @p begin or the list
373 * starting with \p insert_begin is not sorted, the behavior is undefined. 361 * starting with @p insert_begin is not sorted, the behavior is undefined.
374 * 362 *
375 * \attention In contrast to cx_linked_list_insert_chain(), the source chain 363 * @attention In contrast to cx_linked_list_insert_chain(), the source chain
376 * will be broken and inserted into the target list so that the resulting list 364 * will be broken and inserted into the target list so that the resulting list
377 * will be sorted according to \p cmp_func. That means, each node in the source 365 * will be sorted according to @p cmp_func. That means, each node in the source
378 * chain may be re-linked with nodes from the target list. 366 * chain may be re-linked with nodes from the target list.
379 * 367 *
380 * @param begin a pointer to the begin node pointer (required) 368 * @param begin a pointer to the beginning node pointer (required)
381 * @param end a pointer to the end node pointer (if your list has one) 369 * @param end a pointer to the end node pointer (if your list has one)
382 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 370 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
383 * @param loc_next the location of a \c next pointer within your node struct (required) 371 * @param loc_next the location of a @c next pointer within your node struct (required)
384 * @param insert_begin a pointer to the first node of the chain that shall be inserted 372 * @param insert_begin a pointer to the first node of the chain that shall be inserted
385 * @param cmp_func a compare function that will receive the node pointers 373 * @param cmp_func a compare function that will receive the node pointers
386 */ 374 */
387 cx_attr_nonnull_arg(1, 5, 6) 375 cx_attr_nonnull_arg(1, 5, 6)
376 cx_attr_export
388 void cx_linked_list_insert_sorted_chain( 377 void cx_linked_list_insert_sorted_chain(
389 void **begin, 378 void **begin,
390 void **end, 379 void **end,
391 ptrdiff_t loc_prev, 380 ptrdiff_t loc_prev,
392 ptrdiff_t loc_next, 381 ptrdiff_t loc_next,
395 ); 384 );
396 385
397 /** 386 /**
398 * Removes a chain of nodes from the linked list. 387 * Removes a chain of nodes from the linked list.
399 * 388 *
400 * If one of the nodes to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end) 389 * If one of the nodes to remove is the beginning (resp. end) node of the list and if @p begin (resp. @p end)
401 * addresses are provided, the pointers are adjusted accordingly. 390 * addresses are provided, the pointers are adjusted accordingly.
402 * 391 *
403 * The following combinations of arguments are valid (more arguments are optional): 392 * The following combinations of arguments are valid (more arguments are optional):
404 * \li \p loc_next and \p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance) 393 * @li @p loc_next and @p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance)
405 * \li \p loc_next and \p begin (ancestor node is determined by list traversal, overall O(n) performance) 394 * @li @p loc_next and @p begin (ancestor node is determined by list traversal, overall O(n) performance)
406 * 395 *
407 * \remark The \c next and \c prev pointers of the removed node are not cleared by this function and may still be used 396 * @remark The @c next and @c prev pointers of the removed node are not cleared by this function and may still be used
408 * to traverse to a former adjacent node in the list, or within the chain. 397 * to traverse to a former adjacent node in the list, or within the chain.
409 * 398 *
410 * @param begin a pointer to the begin node pointer (optional) 399 * @param begin a pointer to the beginning node pointer (optional)
411 * @param end a pointer to the end node pointer (optional) 400 * @param end a pointer to the end node pointer (optional)
412 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 401 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
413 * @param loc_next the location of a \c next pointer within your node struct (required) 402 * @param loc_next the location of a @c next pointer within your node struct (required)
414 * @param node the start node of the chain 403 * @param node the start node of the chain
415 * @param num the number of nodes to remove 404 * @param num the number of nodes to remove
416 * @return the actual number of nodes that were removed (may be less when the list did not have enough nodes) 405 * @return the actual number of nodes that were removed (can be less when the list did not have enough nodes)
417 */ 406 */
418 cx_attr_nonnull_arg(5) 407 cx_attr_nonnull_arg(5)
408 cx_attr_export
419 size_t cx_linked_list_remove_chain( 409 size_t cx_linked_list_remove_chain(
420 void **begin, 410 void **begin,
421 void **end, 411 void **end,
422 ptrdiff_t loc_prev, 412 ptrdiff_t loc_prev,
423 ptrdiff_t loc_next, 413 ptrdiff_t loc_next,
426 ); 416 );
427 417
428 /** 418 /**
429 * Removes a node from the linked list. 419 * Removes a node from the linked list.
430 * 420 *
431 * If the node to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end) 421 * If the node to remove is the beginning (resp. end) node of the list and if @p begin (resp. @p end)
432 * addresses are provided, the pointers are adjusted accordingly. 422 * addresses are provided, the pointers are adjusted accordingly.
433 * 423 *
434 * The following combinations of arguments are valid (more arguments are optional): 424 * The following combinations of arguments are valid (more arguments are optional):
435 * \li \p loc_next and \p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance) 425 * @li @p loc_next and @p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance)
436 * \li \p loc_next and \p begin (ancestor node is determined by list traversal, overall O(n) performance) 426 * @li @p loc_next and @p begin (ancestor node is determined by list traversal, overall O(n) performance)
437 * 427 *
438 * \remark The \c next and \c prev pointers of the removed node are not cleared by this function and may still be used 428 * @remark The @c next and @c prev pointers of the removed node are not cleared by this function and may still be used
439 * to traverse to a former adjacent node in the list. 429 * to traverse to a former adjacent node in the list.
440 * 430 *
441 * @param begin a pointer to the begin node pointer (optional) 431 * @param begin a pointer to the beginning node pointer (optional)
442 * @param end a pointer to the end node pointer (optional) 432 * @param end a pointer to the end node pointer (optional)
443 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 433 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
444 * @param loc_next the location of a \c next pointer within your node struct (required) 434 * @param loc_next the location of a @c next pointer within your node struct (required)
445 * @param node the node to remove 435 * @param node the node to remove
446 */ 436 */
447 cx_attr_nonnull_arg(5) 437 cx_attr_nonnull_arg(5)
448 static inline void cx_linked_list_remove( 438 static inline void cx_linked_list_remove(
449 void **begin, 439 void **begin,
454 ) { 444 ) {
455 cx_linked_list_remove_chain(begin, end, loc_prev, loc_next, node, 1); 445 cx_linked_list_remove_chain(begin, end, loc_prev, loc_next, node, 1);
456 } 446 }
457 447
458 /** 448 /**
459 * Determines the size of a linked list starting with \p node. 449 * Determines the size of a linked list starting with @p node.
450 *
460 * @param node the first node 451 * @param node the first node
461 * @param loc_next the location of the \c next pointer within the node struct 452 * @param loc_next the location of the @c next pointer within the node struct
462 * @return the size of the list or zero if \p node is \c NULL 453 * @return the size of the list or zero if @p node is @c NULL
463 */ 454 */
455 cx_attr_nodiscard
456 cx_attr_export
464 size_t cx_linked_list_size( 457 size_t cx_linked_list_size(
465 const void *node, 458 const void *node,
466 ptrdiff_t loc_next 459 ptrdiff_t loc_next
467 ); 460 );
468 461
469 /** 462 /**
470 * Sorts a linked list based on a comparison function. 463 * Sorts a linked list based on a comparison function.
471 * 464 *
472 * This function can work with linked lists of the following structure: 465 * This function can work with linked lists of the following structure:
473 * \code 466 * @code
474 * typedef struct node node; 467 * typedef struct node node;
475 * struct node { 468 * struct node {
476 * node* prev; 469 * node* prev;
477 * node* next; 470 * node* next;
478 * my_payload data; 471 * my_payload data;
479 * } 472 * }
480 * \endcode 473 * @endcode
481 * 474 *
482 * @note This is a recursive function with at most logarithmic recursion depth. 475 * @note This is a recursive function with at most logarithmic recursion depth.
483 * 476 *
484 * @param begin a pointer to the begin node pointer (required) 477 * @param begin a pointer to the beginning node pointer (required)
485 * @param end a pointer to the end node pointer (optional) 478 * @param end a pointer to the end node pointer (optional)
486 * @param loc_prev the location of a \c prev pointer within your node struct (negative if not present) 479 * @param loc_prev the location of a @c prev pointer within your node struct (negative if not present)
487 * @param loc_next the location of a \c next pointer within your node struct (required) 480 * @param loc_next the location of a @c next pointer within your node struct (required)
488 * @param loc_data the location of the \c data pointer within your node struct 481 * @param loc_data the location of the @c data pointer within your node struct
489 * @param cmp_func the compare function defining the sort order 482 * @param cmp_func the compare function defining the sort order
490 */ 483 */
491 cx_attr_nonnull_arg(1, 6) 484 cx_attr_nonnull_arg(1, 6)
485 cx_attr_export
492 void cx_linked_list_sort( 486 void cx_linked_list_sort(
493 void **begin, 487 void **begin,
494 void **end, 488 void **end,
495 ptrdiff_t loc_prev, 489 ptrdiff_t loc_prev,
496 ptrdiff_t loc_next, 490 ptrdiff_t loc_next,
500 494
501 495
502 /** 496 /**
503 * Compares two lists element wise. 497 * Compares two lists element wise.
504 * 498 *
505 * \note Both list must have the same structure. 499 * @attention Both list must have the same structure.
506 * 500 *
507 * @param begin_left the begin of the left list (\c NULL denotes an empty list) 501 * @param begin_left the beginning of the left list (@c NULL denotes an empty list)
508 * @param begin_right the begin of the right list (\c NULL denotes an empty list) 502 * @param begin_right the beginning of the right list (@c NULL denotes an empty list)
509 * @param loc_advance the location of the pointer to advance 503 * @param loc_advance the location of the pointer to advance
510 * @param loc_data the location of the \c data pointer within your node struct 504 * @param loc_data the location of the @c data pointer within your node struct
511 * @param cmp_func the function to compare the elements 505 * @param cmp_func the function to compare the elements
512 * @return the first non-zero result of invoking \p cmp_func or: negative if the left list is smaller than the 506 * @return the first non-zero result of invoking @p cmp_func or: negative if the left list is smaller than the
513 * right list, positive if the left list is larger than the right list, zero if both lists are equal. 507 * right list, positive if the left list is larger than the right list, zero if both lists are equal.
514 */ 508 */
515 cx_attr_nonnull_arg(5) 509 cx_attr_nonnull_arg(5)
510 cx_attr_export
516 int cx_linked_list_compare( 511 int cx_linked_list_compare(
517 const void *begin_left, 512 const void *begin_left,
518 const void *begin_right, 513 const void *begin_right,
519 ptrdiff_t loc_advance, 514 ptrdiff_t loc_advance,
520 ptrdiff_t loc_data, 515 ptrdiff_t loc_data,
522 ); 517 );
523 518
524 /** 519 /**
525 * Reverses the order of the nodes in a linked list. 520 * Reverses the order of the nodes in a linked list.
526 * 521 *
527 * @param begin a pointer to the begin node pointer (required) 522 * @param begin a pointer to the beginning node pointer (required)
528 * @param end a pointer to the end node pointer (optional) 523 * @param end a pointer to the end node pointer (optional)
529 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) 524 * @param loc_prev the location of a @c prev pointer within your node struct (negative if your struct does not have one)
530 * @param loc_next the location of a \c next pointer within your node struct (required) 525 * @param loc_next the location of a @c next pointer within your node struct (required)
531 */ 526 */
532 cx_attr_nonnull_arg(1) 527 cx_attr_nonnull_arg(1)
528 cx_attr_export
533 void cx_linked_list_reverse( 529 void cx_linked_list_reverse(
534 void **begin, 530 void **begin,
535 void **end, 531 void **end,
536 ptrdiff_t loc_prev, 532 ptrdiff_t loc_prev,
537 ptrdiff_t loc_next 533 ptrdiff_t loc_next

Mercurial Repository: dbutils

mercurial