Thu, 28 Dec 2023 19:17:45 +0100
fix accidental generation of cxListIterator() symbol
universe@398 | 1 | /* |
universe@398 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@398 | 3 | * |
universe@398 | 4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
universe@398 | 5 | * |
universe@398 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@398 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@398 | 8 | * |
universe@398 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@398 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@398 | 11 | * |
universe@398 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@398 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@398 | 14 | * documentation and/or other materials provided with the distribution. |
universe@398 | 15 | * |
universe@398 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@398 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@398 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@398 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@398 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@398 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@398 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@398 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@398 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@398 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@398 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@398 | 27 | */ |
universe@453 | 28 | /** |
universe@453 | 29 | * \file linked_list.h |
universe@453 | 30 | * \brief Linked list implementation. |
universe@453 | 31 | * \details Also provides several low-level functions for custom linked list implementations. |
universe@453 | 32 | * \author Mike Becker |
universe@453 | 33 | * \author Olaf Wintermann |
universe@453 | 34 | * \copyright 2-Clause BSD License |
universe@453 | 35 | */ |
universe@398 | 36 | |
universe@398 | 37 | #ifndef UCX_LINKED_LIST_H |
universe@398 | 38 | #define UCX_LINKED_LIST_H |
universe@398 | 39 | |
universe@484 | 40 | #include "common.h" |
universe@398 | 41 | #include "list.h" |
universe@398 | 42 | |
universe@415 | 43 | #ifdef __cplusplus |
universe@415 | 44 | extern "C" { |
universe@415 | 45 | #endif |
universe@415 | 46 | |
universe@466 | 47 | /** |
universe@647 | 48 | * Set this flag to true, if you want to disable the use of SBO for |
universe@647 | 49 | * linked list swap operations. |
universe@647 | 50 | */ |
universe@647 | 51 | extern bool CX_DISABLE_LINKED_LIST_SWAP_SBO; |
universe@647 | 52 | |
universe@647 | 53 | /** |
universe@466 | 54 | * Allocates a linked list for storing elements with \p item_size bytes each. |
universe@466 | 55 | * |
universe@669 | 56 | * If \p item_size is CX_STORE_POINTERS, the created list will be created as if |
universe@763 | 57 | * cxListStorePointers() was called immediately after creation and the compare |
universe@763 | 58 | * function will be automatically set to cx_cmp_ptr(), if none is given. |
universe@669 | 59 | * |
universe@466 | 60 | * @param allocator the allocator for allocating the list nodes |
universe@670 | 61 | * (if \c NULL the cxDefaultAllocator will be used) |
universe@466 | 62 | * @param comparator the comparator for the elements |
universe@763 | 63 | * (if \c NULL, and the list is not storing pointers, sort and find |
universe@763 | 64 | * functions will not work) |
universe@466 | 65 | * @param item_size the size of each element in bytes |
universe@466 | 66 | * @return the created list |
universe@466 | 67 | */ |
universe@500 | 68 | CxList *cxLinkedListCreate( |
universe@508 | 69 | CxAllocator const *allocator, |
universe@677 | 70 | cx_compare_func comparator, |
universe@481 | 71 | size_t item_size |
universe@670 | 72 | ); |
universe@453 | 73 | |
universe@466 | 74 | /** |
universe@662 | 75 | * Allocates a linked list for storing elements with \p item_size bytes each. |
universe@662 | 76 | * |
universe@662 | 77 | * The list will use cxDefaultAllocator and no comparator function. If you want |
universe@662 | 78 | * to call functions that need a comparator, you must either set one immediately |
universe@662 | 79 | * after list creation or use cxLinkedListCreate(). |
universe@662 | 80 | * |
universe@669 | 81 | * If \p item_size is CX_STORE_POINTERS, the created list will be created as if |
universe@763 | 82 | * cxListStorePointers() was called immediately after creation and the compare |
universe@763 | 83 | * function will be automatically set to cx_cmp_ptr(). |
universe@669 | 84 | * |
universe@662 | 85 | * @param item_size the size of each element in bytes |
universe@662 | 86 | * @return the created list |
universe@662 | 87 | */ |
universe@670 | 88 | #define cxLinkedListCreateSimple(item_size) \ |
universe@670 | 89 | cxLinkedListCreate(NULL, NULL, item_size) |
universe@662 | 90 | |
universe@662 | 91 | /** |
universe@438 | 92 | * Finds the node at a certain index. |
universe@438 | 93 | * |
universe@438 | 94 | * This function can be used to start at an arbitrary position within the list. |
universe@438 | 95 | * If the search index is large than the start index, \p loc_advance must denote |
universe@438 | 96 | * the location of some sort of \c next pointer (i.e. a pointer to the next node). |
universe@438 | 97 | * But it is also possible that the search index is smaller than the start index |
universe@438 | 98 | * (e.g. in cases where traversing a list backwards is faster) in which case |
universe@438 | 99 | * \p loc_advance must denote the location of some sort of \c prev pointer |
universe@438 | 100 | * (i.e. a pointer to the previous node). |
universe@438 | 101 | * |
universe@438 | 102 | * @param start a pointer to the start node |
universe@438 | 103 | * @param start_index the start index |
universe@438 | 104 | * @param loc_advance the location of the pointer to advance |
universe@438 | 105 | * @param index the search index |
universe@438 | 106 | * @return the node found at the specified index |
universe@438 | 107 | */ |
universe@481 | 108 | void *cx_linked_list_at( |
universe@508 | 109 | void const *start, |
universe@481 | 110 | size_t start_index, |
universe@481 | 111 | ptrdiff_t loc_advance, |
universe@481 | 112 | size_t index |
universe@481 | 113 | ) __attribute__((__nonnull__)); |
universe@438 | 114 | |
universe@453 | 115 | /** |
universe@480 | 116 | * Finds the index of an element within a linked list. |
universe@480 | 117 | * |
universe@480 | 118 | * @param start a pointer to the start node |
universe@480 | 119 | * @param loc_advance the location of the pointer to advance |
universe@480 | 120 | * @param loc_data the location of the \c data pointer within your node struct |
universe@480 | 121 | * @param cmp_func a compare function to compare \p elem against the node data |
universe@480 | 122 | * @param elem a pointer to the element to find |
universe@699 | 123 | * @return the index of the element or a negative value if it could not be found |
universe@480 | 124 | */ |
universe@699 | 125 | ssize_t cx_linked_list_find( |
universe@489 | 126 | void const *start, |
universe@481 | 127 | ptrdiff_t loc_advance, |
universe@481 | 128 | ptrdiff_t loc_data, |
universe@677 | 129 | cx_compare_func cmp_func, |
universe@489 | 130 | void const *elem |
universe@481 | 131 | ) __attribute__((__nonnull__)); |
universe@480 | 132 | |
universe@480 | 133 | /** |
universe@764 | 134 | * Finds the node containing an element within a linked list. |
universe@764 | 135 | * |
universe@764 | 136 | * @param result a pointer to the memory where the node pointer (or \c NULL if the element |
universe@764 | 137 | * could not be found) shall be stored to |
universe@764 | 138 | * @param start a pointer to the start node |
universe@764 | 139 | * @param loc_advance the location of the pointer to advance |
universe@764 | 140 | * @param loc_data the location of the \c data pointer within your node struct |
universe@764 | 141 | * @param cmp_func a compare function to compare \p elem against the node data |
universe@764 | 142 | * @param elem a pointer to the element to find |
universe@764 | 143 | * @return the index of the element or a negative value if it could not be found |
universe@764 | 144 | */ |
universe@764 | 145 | ssize_t cx_linked_list_find_node( |
universe@764 | 146 | void **result, |
universe@764 | 147 | void const *start, |
universe@764 | 148 | ptrdiff_t loc_advance, |
universe@764 | 149 | ptrdiff_t loc_data, |
universe@764 | 150 | cx_compare_func cmp_func, |
universe@764 | 151 | void const *elem |
universe@764 | 152 | ) __attribute__((__nonnull__)); |
universe@764 | 153 | |
universe@764 | 154 | /** |
universe@475 | 155 | * Finds the first node in a linked list. |
universe@475 | 156 | * |
universe@475 | 157 | * The function starts with the pointer denoted by \p node and traverses the list |
universe@475 | 158 | * along a prev pointer whose location within the node struct is |
universe@475 | 159 | * denoted by \p loc_prev. |
universe@475 | 160 | * |
universe@475 | 161 | * @param node a pointer to a node in the list |
universe@475 | 162 | * @param loc_prev the location of the \c prev pointer |
universe@485 | 163 | * @return a pointer to the first node |
universe@475 | 164 | */ |
universe@481 | 165 | void *cx_linked_list_first( |
universe@508 | 166 | void const *node, |
universe@481 | 167 | ptrdiff_t loc_prev |
universe@481 | 168 | ) __attribute__((__nonnull__)); |
universe@475 | 169 | |
universe@475 | 170 | /** |
universe@453 | 171 | * Finds the last node in a linked list. |
universe@453 | 172 | * |
universe@475 | 173 | * The function starts with the pointer denoted by \p node and traverses the list |
universe@456 | 174 | * along a next pointer whose location within the node struct is |
universe@453 | 175 | * denoted by \p loc_next. |
universe@453 | 176 | * |
universe@475 | 177 | * @param node a pointer to a node in the list |
universe@456 | 178 | * @param loc_next the location of the \c next pointer |
universe@478 | 179 | * @return a pointer to the last node |
universe@453 | 180 | */ |
universe@481 | 181 | void *cx_linked_list_last( |
universe@508 | 182 | void const *node, |
universe@481 | 183 | ptrdiff_t loc_next |
universe@481 | 184 | ) __attribute__((__nonnull__)); |
universe@398 | 185 | |
universe@453 | 186 | /** |
universe@473 | 187 | * Finds the predecessor of a node in case it is not linked. |
universe@473 | 188 | * |
universe@473 | 189 | * \remark If \p node is not contained in the list starting with \p begin, the behavior is undefined. |
universe@473 | 190 | * |
universe@473 | 191 | * @param begin the node where to start the search |
universe@473 | 192 | * @param loc_next the location of the \c next pointer |
universe@473 | 193 | * @param node the successor of the node to find |
universe@473 | 194 | * @return the node or \c NULL if \p node has no predecessor |
universe@473 | 195 | */ |
universe@481 | 196 | void *cx_linked_list_prev( |
universe@508 | 197 | void const *begin, |
universe@481 | 198 | ptrdiff_t loc_next, |
universe@508 | 199 | void const *node |
universe@481 | 200 | ) __attribute__((__nonnull__)); |
universe@473 | 201 | |
universe@473 | 202 | /** |
universe@453 | 203 | * Adds a new node to a linked list. |
universe@475 | 204 | * The node must not be part of any list already. |
universe@453 | 205 | * |
universe@478 | 206 | * \remark One of the pointers \p begin or \p end may be \c NULL, but not both. |
universe@453 | 207 | * |
universe@453 | 208 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@453 | 209 | * @param end a pointer to the end node pointer (if your list has one) |
universe@453 | 210 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 211 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@453 | 212 | * @param new_node a pointer to the node that shall be appended |
universe@453 | 213 | */ |
universe@481 | 214 | void cx_linked_list_add( |
universe@481 | 215 | void **begin, |
universe@481 | 216 | void **end, |
universe@481 | 217 | ptrdiff_t loc_prev, |
universe@481 | 218 | ptrdiff_t loc_next, |
universe@481 | 219 | void *new_node |
universe@481 | 220 | ) __attribute__((__nonnull__(5))); |
universe@406 | 221 | |
universe@468 | 222 | /** |
universe@475 | 223 | * Prepends a new node to a linked list. |
universe@475 | 224 | * The node must not be part of any list already. |
universe@475 | 225 | * |
universe@478 | 226 | * \remark One of the pointers \p begin or \p end may be \c NULL, but not both. |
universe@475 | 227 | * |
universe@475 | 228 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@475 | 229 | * @param end a pointer to the end node pointer (if your list has one) |
universe@475 | 230 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@475 | 231 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@475 | 232 | * @param new_node a pointer to the node that shall be prepended |
universe@475 | 233 | */ |
universe@481 | 234 | void cx_linked_list_prepend( |
universe@481 | 235 | void **begin, |
universe@481 | 236 | void **end, |
universe@481 | 237 | ptrdiff_t loc_prev, |
universe@481 | 238 | ptrdiff_t loc_next, |
universe@481 | 239 | void *new_node |
universe@481 | 240 | ) __attribute__((__nonnull__(5))); |
universe@481 | 241 | |
universe@481 | 242 | /** |
universe@481 | 243 | * Links two nodes. |
universe@481 | 244 | * |
universe@481 | 245 | * @param left the new predecessor of \p right |
universe@481 | 246 | * @param right the new successor of \p left |
universe@481 | 247 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 248 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 249 | */ |
universe@481 | 250 | void cx_linked_list_link( |
universe@481 | 251 | void *left, |
universe@481 | 252 | void *right, |
universe@481 | 253 | ptrdiff_t loc_prev, |
universe@481 | 254 | ptrdiff_t loc_next |
universe@481 | 255 | ) __attribute__((__nonnull__)); |
universe@481 | 256 | |
universe@481 | 257 | /** |
universe@481 | 258 | * Unlinks two nodes. |
universe@481 | 259 | * |
universe@481 | 260 | * If right is not the successor of left, the behavior is undefined. |
universe@481 | 261 | * |
universe@481 | 262 | * @param left the predecessor of \p right |
universe@481 | 263 | * @param right the successor of \p left |
universe@481 | 264 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 265 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 266 | */ |
universe@481 | 267 | void cx_linked_list_unlink( |
universe@481 | 268 | void *left, |
universe@481 | 269 | void *right, |
universe@481 | 270 | ptrdiff_t loc_prev, |
universe@481 | 271 | ptrdiff_t loc_next |
universe@481 | 272 | ) __attribute__((__nonnull__)); |
universe@481 | 273 | |
universe@481 | 274 | /** |
universe@481 | 275 | * Inserts a new node after a given node of a linked list. |
universe@481 | 276 | * The new node must not be part of any list already. |
universe@481 | 277 | * |
universe@481 | 278 | * \note If you specify \c NULL as the \p node to insert after, this function needs either the \p begin or |
universe@481 | 279 | * the \p end pointer to determine the start of the list. Then the new node will be prepended to the list. |
universe@481 | 280 | * |
universe@481 | 281 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@481 | 282 | * @param end a pointer to the end node pointer (if your list has one) |
universe@481 | 283 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 284 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 285 | * @param node the node after which to insert (\c NULL if you want to prepend the node to the list) |
universe@481 | 286 | * @param new_node a pointer to the node that shall be prepended |
universe@481 | 287 | */ |
universe@481 | 288 | void cx_linked_list_insert( |
universe@481 | 289 | void **begin, |
universe@481 | 290 | void **end, |
universe@481 | 291 | ptrdiff_t loc_prev, |
universe@481 | 292 | ptrdiff_t loc_next, |
universe@481 | 293 | void *node, |
universe@481 | 294 | void *new_node |
universe@481 | 295 | ) __attribute__((__nonnull__(6))); |
universe@481 | 296 | |
universe@481 | 297 | /** |
universe@481 | 298 | * Inserts a chain of nodes after a given node of a linked list. |
universe@481 | 299 | * The chain must not be part of any list already. |
universe@481 | 300 | * |
universe@481 | 301 | * If you do not explicitly specify the end of the chain, it will be determined by traversing |
universe@481 | 302 | * the \c next pointer. |
universe@481 | 303 | * |
universe@481 | 304 | * \note If you specify \c NULL as the \p node to insert after, this function needs either the \p begin or |
universe@481 | 305 | * the \p end pointer to determine the start of the list. If only the \p end pointer is specified, you also need |
universe@481 | 306 | * to provide a valid \p loc_prev location. |
universe@481 | 307 | * Then the chain will be prepended to the list. |
universe@481 | 308 | * |
universe@481 | 309 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@481 | 310 | * @param end a pointer to the end node pointer (if your list has one) |
universe@481 | 311 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 312 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 313 | * @param node the node after which to insert (\c NULL to prepend the chain to the list) |
universe@481 | 314 | * @param insert_begin a pointer to the first node of the chain that shall be inserted |
universe@481 | 315 | * @param insert_end a pointer to the last node of the chain (or NULL if the last node shall be determined) |
universe@481 | 316 | */ |
universe@481 | 317 | void cx_linked_list_insert_chain( |
universe@481 | 318 | void **begin, |
universe@481 | 319 | void **end, |
universe@481 | 320 | ptrdiff_t loc_prev, |
universe@481 | 321 | ptrdiff_t loc_next, |
universe@481 | 322 | void *node, |
universe@481 | 323 | void *insert_begin, |
universe@481 | 324 | void *insert_end |
universe@481 | 325 | ) __attribute__((__nonnull__(6))); |
universe@475 | 326 | |
universe@475 | 327 | /** |
universe@473 | 328 | * Removes a node from the linked list. |
universe@473 | 329 | * |
universe@473 | 330 | * If the node to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end) |
universe@473 | 331 | * addresses are provided, the pointers are adjusted accordingly. |
universe@473 | 332 | * |
universe@473 | 333 | * The following combinations of arguments are valid (more arguments are optional): |
universe@477 | 334 | * \li \p loc_next and \p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance) |
universe@477 | 335 | * \li \p loc_next and \p begin (ancestor node is determined by list traversal, overall O(n) performance) |
universe@473 | 336 | * |
universe@476 | 337 | * \remark The \c next and \c prev pointers of the removed node are not cleared by this function and may still be used |
universe@476 | 338 | * to traverse to a former adjacent node in the list. |
universe@473 | 339 | * |
universe@473 | 340 | * @param begin a pointer to the begin node pointer (optional) |
universe@473 | 341 | * @param end a pointer to the end node pointer (optional) |
universe@473 | 342 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 343 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@473 | 344 | * @param node the node to remove |
universe@473 | 345 | */ |
universe@481 | 346 | void cx_linked_list_remove( |
universe@481 | 347 | void **begin, |
universe@481 | 348 | void **end, |
universe@481 | 349 | ptrdiff_t loc_prev, |
universe@481 | 350 | ptrdiff_t loc_next, |
universe@481 | 351 | void *node |
universe@481 | 352 | ) __attribute__((__nonnull__(5))); |
universe@473 | 353 | |
universe@473 | 354 | |
universe@473 | 355 | /** |
universe@468 | 356 | * Determines the size of a linked list starting with \p node. |
universe@468 | 357 | * @param node the first node |
universe@468 | 358 | * @param loc_next the location of the \c next pointer within the node struct |
universe@468 | 359 | * @return the size of the list or zero if \p node is \c NULL |
universe@468 | 360 | */ |
universe@481 | 361 | size_t cx_linked_list_size( |
universe@489 | 362 | void const *node, |
universe@481 | 363 | ptrdiff_t loc_next |
universe@481 | 364 | ); |
universe@468 | 365 | |
universe@468 | 366 | /** |
universe@468 | 367 | * Sorts a linked list based on a comparison function. |
universe@468 | 368 | * |
universe@639 | 369 | * This function can work with linked lists of the following structure: |
universe@468 | 370 | * \code |
universe@468 | 371 | * typedef struct node node; |
universe@468 | 372 | * struct node { |
universe@468 | 373 | * node* prev; |
universe@468 | 374 | * node* next; |
universe@639 | 375 | * my_payload data; |
universe@468 | 376 | * } |
universe@468 | 377 | * \endcode |
universe@468 | 378 | * |
universe@476 | 379 | * @note This is a recursive function with at most logarithmic recursion depth. |
universe@476 | 380 | * |
universe@468 | 381 | * @param begin a pointer to the begin node pointer (required) |
universe@468 | 382 | * @param end a pointer to the end node pointer (optional) |
universe@468 | 383 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if not present) |
universe@468 | 384 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@468 | 385 | * @param loc_data the location of the \c data pointer within your node struct |
universe@468 | 386 | * @param cmp_func the compare function defining the sort order |
universe@468 | 387 | */ |
universe@481 | 388 | void cx_linked_list_sort( |
universe@481 | 389 | void **begin, |
universe@481 | 390 | void **end, |
universe@481 | 391 | ptrdiff_t loc_prev, |
universe@481 | 392 | ptrdiff_t loc_next, |
universe@481 | 393 | ptrdiff_t loc_data, |
universe@677 | 394 | cx_compare_func cmp_func |
universe@639 | 395 | ) __attribute__((__nonnull__(1, 6))); |
universe@473 | 396 | |
universe@486 | 397 | |
universe@486 | 398 | /** |
universe@486 | 399 | * Compares two lists element wise. |
universe@486 | 400 | * |
universe@488 | 401 | * \note Both list must have the same structure. |
universe@488 | 402 | * |
universe@486 | 403 | * @param begin_left the begin of the left list (\c NULL denotes an empty list) |
universe@486 | 404 | * @param begin_right the begin of the right list (\c NULL denotes an empty list) |
universe@486 | 405 | * @param loc_advance the location of the pointer to advance |
universe@486 | 406 | * @param loc_data the location of the \c data pointer within your node struct |
universe@486 | 407 | * @param cmp_func the function to compare the elements |
universe@552 | 408 | * @return the first non-zero result of invoking \p cmp_func or: negative if the left list is smaller than the |
universe@552 | 409 | * right list, positive if the left list is larger than the right list, zero if both lists are equal. |
universe@486 | 410 | */ |
universe@486 | 411 | int cx_linked_list_compare( |
universe@489 | 412 | void const *begin_left, |
universe@489 | 413 | void const *begin_right, |
universe@486 | 414 | ptrdiff_t loc_advance, |
universe@486 | 415 | ptrdiff_t loc_data, |
universe@677 | 416 | cx_compare_func cmp_func |
universe@639 | 417 | ) __attribute__((__nonnull__(5))); |
universe@486 | 418 | |
universe@473 | 419 | /** |
universe@473 | 420 | * Reverses the order of the nodes in a linked list. |
universe@473 | 421 | * |
universe@473 | 422 | * @param begin a pointer to the begin node pointer (required) |
universe@473 | 423 | * @param end a pointer to the end node pointer (optional) |
universe@473 | 424 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 425 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@473 | 426 | */ |
universe@481 | 427 | void cx_linked_list_reverse( |
universe@481 | 428 | void **begin, |
universe@481 | 429 | void **end, |
universe@481 | 430 | ptrdiff_t loc_prev, |
universe@481 | 431 | ptrdiff_t loc_next |
universe@481 | 432 | ) __attribute__((__nonnull__(1))); |
universe@473 | 433 | |
universe@415 | 434 | #ifdef __cplusplus |
universe@628 | 435 | } // extern "C" |
universe@415 | 436 | #endif |
universe@415 | 437 | |
universe@628 | 438 | #endif // UCX_LINKED_LIST_H |