Wed, 08 Feb 2023 20:26:09 +0100
implement swap function for list elements - fixes #218
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 | * \version 3.0 |
universe@453 | 35 | * \copyright 2-Clause BSD License |
universe@453 | 36 | */ |
universe@398 | 37 | |
universe@398 | 38 | #ifndef UCX_LINKED_LIST_H |
universe@398 | 39 | #define UCX_LINKED_LIST_H |
universe@398 | 40 | |
universe@484 | 41 | #include "common.h" |
universe@398 | 42 | #include "list.h" |
universe@398 | 43 | |
universe@415 | 44 | #ifdef __cplusplus |
universe@415 | 45 | extern "C" { |
universe@415 | 46 | #endif |
universe@415 | 47 | |
universe@466 | 48 | /** |
universe@647 | 49 | * Set this flag to true, if you want to disable the use of SBO for |
universe@647 | 50 | * linked list swap operations. |
universe@647 | 51 | */ |
universe@647 | 52 | extern bool CX_DISABLE_LINKED_LIST_SWAP_SBO; |
universe@647 | 53 | |
universe@647 | 54 | /** |
universe@466 | 55 | * Allocates a linked list for storing elements with \p item_size bytes each. |
universe@466 | 56 | * |
universe@528 | 57 | * @remark Elements added to the list are copied, therefore a possible destructor |
universe@526 | 58 | * MUST NOT free the memory pointed to by its argument. |
universe@466 | 59 | * |
universe@466 | 60 | * @param allocator the allocator for allocating the list nodes |
universe@466 | 61 | * @param comparator the comparator for the elements |
universe@466 | 62 | * @param item_size the size of each element in bytes |
universe@466 | 63 | * @return the created list |
universe@466 | 64 | */ |
universe@500 | 65 | CxList *cxLinkedListCreate( |
universe@508 | 66 | CxAllocator const *allocator, |
universe@481 | 67 | CxListComparator comparator, |
universe@481 | 68 | size_t item_size |
universe@488 | 69 | ) __attribute__((__nonnull__)); |
universe@453 | 70 | |
universe@466 | 71 | /** |
universe@438 | 72 | * Finds the node at a certain index. |
universe@438 | 73 | * |
universe@438 | 74 | * This function can be used to start at an arbitrary position within the list. |
universe@438 | 75 | * If the search index is large than the start index, \p loc_advance must denote |
universe@438 | 76 | * the location of some sort of \c next pointer (i.e. a pointer to the next node). |
universe@438 | 77 | * But it is also possible that the search index is smaller than the start index |
universe@438 | 78 | * (e.g. in cases where traversing a list backwards is faster) in which case |
universe@438 | 79 | * \p loc_advance must denote the location of some sort of \c prev pointer |
universe@438 | 80 | * (i.e. a pointer to the previous node). |
universe@438 | 81 | * |
universe@438 | 82 | * @param start a pointer to the start node |
universe@438 | 83 | * @param start_index the start index |
universe@438 | 84 | * @param loc_advance the location of the pointer to advance |
universe@438 | 85 | * @param index the search index |
universe@438 | 86 | * @return the node found at the specified index |
universe@438 | 87 | */ |
universe@481 | 88 | void *cx_linked_list_at( |
universe@508 | 89 | void const *start, |
universe@481 | 90 | size_t start_index, |
universe@481 | 91 | ptrdiff_t loc_advance, |
universe@481 | 92 | size_t index |
universe@481 | 93 | ) __attribute__((__nonnull__)); |
universe@438 | 94 | |
universe@453 | 95 | /** |
universe@480 | 96 | * Finds the index of an element within a linked list. |
universe@480 | 97 | * |
universe@480 | 98 | * @param start a pointer to the start node |
universe@480 | 99 | * @param loc_advance the location of the pointer to advance |
universe@480 | 100 | * @param loc_data the location of the \c data pointer within your node struct |
universe@480 | 101 | * @param cmp_func a compare function to compare \p elem against the node data |
universe@480 | 102 | * @param elem a pointer to the element to find |
universe@480 | 103 | * @return the index of the element or a past-one index if the element could not be found |
universe@480 | 104 | */ |
universe@481 | 105 | size_t cx_linked_list_find( |
universe@489 | 106 | void const *start, |
universe@481 | 107 | ptrdiff_t loc_advance, |
universe@481 | 108 | ptrdiff_t loc_data, |
universe@481 | 109 | CxListComparator cmp_func, |
universe@489 | 110 | void const *elem |
universe@481 | 111 | ) __attribute__((__nonnull__)); |
universe@480 | 112 | |
universe@480 | 113 | /** |
universe@475 | 114 | * Finds the first node in a linked list. |
universe@475 | 115 | * |
universe@475 | 116 | * The function starts with the pointer denoted by \p node and traverses the list |
universe@475 | 117 | * along a prev pointer whose location within the node struct is |
universe@475 | 118 | * denoted by \p loc_prev. |
universe@475 | 119 | * |
universe@475 | 120 | * @param node a pointer to a node in the list |
universe@475 | 121 | * @param loc_prev the location of the \c prev pointer |
universe@485 | 122 | * @return a pointer to the first node |
universe@475 | 123 | */ |
universe@481 | 124 | void *cx_linked_list_first( |
universe@508 | 125 | void const *node, |
universe@481 | 126 | ptrdiff_t loc_prev |
universe@481 | 127 | ) __attribute__((__nonnull__)); |
universe@475 | 128 | |
universe@475 | 129 | /** |
universe@453 | 130 | * Finds the last node in a linked list. |
universe@453 | 131 | * |
universe@475 | 132 | * The function starts with the pointer denoted by \p node and traverses the list |
universe@456 | 133 | * along a next pointer whose location within the node struct is |
universe@453 | 134 | * denoted by \p loc_next. |
universe@453 | 135 | * |
universe@475 | 136 | * @param node a pointer to a node in the list |
universe@456 | 137 | * @param loc_next the location of the \c next pointer |
universe@478 | 138 | * @return a pointer to the last node |
universe@453 | 139 | */ |
universe@481 | 140 | void *cx_linked_list_last( |
universe@508 | 141 | void const *node, |
universe@481 | 142 | ptrdiff_t loc_next |
universe@481 | 143 | ) __attribute__((__nonnull__)); |
universe@398 | 144 | |
universe@453 | 145 | /** |
universe@473 | 146 | * Finds the predecessor of a node in case it is not linked. |
universe@473 | 147 | * |
universe@473 | 148 | * \remark If \p node is not contained in the list starting with \p begin, the behavior is undefined. |
universe@473 | 149 | * |
universe@473 | 150 | * @param begin the node where to start the search |
universe@473 | 151 | * @param loc_next the location of the \c next pointer |
universe@473 | 152 | * @param node the successor of the node to find |
universe@473 | 153 | * @return the node or \c NULL if \p node has no predecessor |
universe@473 | 154 | */ |
universe@481 | 155 | void *cx_linked_list_prev( |
universe@508 | 156 | void const *begin, |
universe@481 | 157 | ptrdiff_t loc_next, |
universe@508 | 158 | void const *node |
universe@481 | 159 | ) __attribute__((__nonnull__)); |
universe@473 | 160 | |
universe@473 | 161 | /** |
universe@453 | 162 | * Adds a new node to a linked list. |
universe@475 | 163 | * The node must not be part of any list already. |
universe@453 | 164 | * |
universe@478 | 165 | * \remark One of the pointers \p begin or \p end may be \c NULL, but not both. |
universe@453 | 166 | * |
universe@453 | 167 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@453 | 168 | * @param end a pointer to the end node pointer (if your list has one) |
universe@453 | 169 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 170 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@453 | 171 | * @param new_node a pointer to the node that shall be appended |
universe@453 | 172 | */ |
universe@481 | 173 | void cx_linked_list_add( |
universe@481 | 174 | void **begin, |
universe@481 | 175 | void **end, |
universe@481 | 176 | ptrdiff_t loc_prev, |
universe@481 | 177 | ptrdiff_t loc_next, |
universe@481 | 178 | void *new_node |
universe@481 | 179 | ) __attribute__((__nonnull__(5))); |
universe@406 | 180 | |
universe@468 | 181 | /** |
universe@475 | 182 | * Prepends a new node to a linked list. |
universe@475 | 183 | * The node must not be part of any list already. |
universe@475 | 184 | * |
universe@478 | 185 | * \remark One of the pointers \p begin or \p end may be \c NULL, but not both. |
universe@475 | 186 | * |
universe@475 | 187 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@475 | 188 | * @param end a pointer to the end node pointer (if your list has one) |
universe@475 | 189 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@475 | 190 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@475 | 191 | * @param new_node a pointer to the node that shall be prepended |
universe@475 | 192 | */ |
universe@481 | 193 | void cx_linked_list_prepend( |
universe@481 | 194 | void **begin, |
universe@481 | 195 | void **end, |
universe@481 | 196 | ptrdiff_t loc_prev, |
universe@481 | 197 | ptrdiff_t loc_next, |
universe@481 | 198 | void *new_node |
universe@481 | 199 | ) __attribute__((__nonnull__(5))); |
universe@481 | 200 | |
universe@481 | 201 | /** |
universe@481 | 202 | * Links two nodes. |
universe@481 | 203 | * |
universe@481 | 204 | * @param left the new predecessor of \p right |
universe@481 | 205 | * @param right the new successor of \p left |
universe@481 | 206 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 207 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 208 | */ |
universe@481 | 209 | void cx_linked_list_link( |
universe@481 | 210 | void *left, |
universe@481 | 211 | void *right, |
universe@481 | 212 | ptrdiff_t loc_prev, |
universe@481 | 213 | ptrdiff_t loc_next |
universe@481 | 214 | ) __attribute__((__nonnull__)); |
universe@481 | 215 | |
universe@481 | 216 | /** |
universe@481 | 217 | * Unlinks two nodes. |
universe@481 | 218 | * |
universe@481 | 219 | * If right is not the successor of left, the behavior is undefined. |
universe@481 | 220 | * |
universe@481 | 221 | * @param left the predecessor of \p right |
universe@481 | 222 | * @param right the successor of \p left |
universe@481 | 223 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 224 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 225 | */ |
universe@481 | 226 | void cx_linked_list_unlink( |
universe@481 | 227 | void *left, |
universe@481 | 228 | void *right, |
universe@481 | 229 | ptrdiff_t loc_prev, |
universe@481 | 230 | ptrdiff_t loc_next |
universe@481 | 231 | ) __attribute__((__nonnull__)); |
universe@481 | 232 | |
universe@481 | 233 | /** |
universe@481 | 234 | * Inserts a new node after a given node of a linked list. |
universe@481 | 235 | * The new node must not be part of any list already. |
universe@481 | 236 | * |
universe@481 | 237 | * \note If you specify \c NULL as the \p node to insert after, this function needs either the \p begin or |
universe@481 | 238 | * the \p end pointer to determine the start of the list. Then the new node will be prepended to the list. |
universe@481 | 239 | * |
universe@481 | 240 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@481 | 241 | * @param end a pointer to the end node pointer (if your list has one) |
universe@481 | 242 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 243 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 244 | * @param node the node after which to insert (\c NULL if you want to prepend the node to the list) |
universe@481 | 245 | * @param new_node a pointer to the node that shall be prepended |
universe@481 | 246 | */ |
universe@481 | 247 | void cx_linked_list_insert( |
universe@481 | 248 | void **begin, |
universe@481 | 249 | void **end, |
universe@481 | 250 | ptrdiff_t loc_prev, |
universe@481 | 251 | ptrdiff_t loc_next, |
universe@481 | 252 | void *node, |
universe@481 | 253 | void *new_node |
universe@481 | 254 | ) __attribute__((__nonnull__(6))); |
universe@481 | 255 | |
universe@481 | 256 | /** |
universe@481 | 257 | * Inserts a chain of nodes after a given node of a linked list. |
universe@481 | 258 | * The chain must not be part of any list already. |
universe@481 | 259 | * |
universe@481 | 260 | * If you do not explicitly specify the end of the chain, it will be determined by traversing |
universe@481 | 261 | * the \c next pointer. |
universe@481 | 262 | * |
universe@481 | 263 | * \note If you specify \c NULL as the \p node to insert after, this function needs either the \p begin or |
universe@481 | 264 | * the \p end pointer to determine the start of the list. If only the \p end pointer is specified, you also need |
universe@481 | 265 | * to provide a valid \p loc_prev location. |
universe@481 | 266 | * Then the chain will be prepended to the list. |
universe@481 | 267 | * |
universe@481 | 268 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@481 | 269 | * @param end a pointer to the end node pointer (if your list has one) |
universe@481 | 270 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@481 | 271 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@481 | 272 | * @param node the node after which to insert (\c NULL to prepend the chain to the list) |
universe@481 | 273 | * @param insert_begin a pointer to the first node of the chain that shall be inserted |
universe@481 | 274 | * @param insert_end a pointer to the last node of the chain (or NULL if the last node shall be determined) |
universe@481 | 275 | */ |
universe@481 | 276 | void cx_linked_list_insert_chain( |
universe@481 | 277 | void **begin, |
universe@481 | 278 | void **end, |
universe@481 | 279 | ptrdiff_t loc_prev, |
universe@481 | 280 | ptrdiff_t loc_next, |
universe@481 | 281 | void *node, |
universe@481 | 282 | void *insert_begin, |
universe@481 | 283 | void *insert_end |
universe@481 | 284 | ) __attribute__((__nonnull__(6))); |
universe@475 | 285 | |
universe@475 | 286 | /** |
universe@473 | 287 | * Removes a node from the linked list. |
universe@473 | 288 | * |
universe@473 | 289 | * If the node to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end) |
universe@473 | 290 | * addresses are provided, the pointers are adjusted accordingly. |
universe@473 | 291 | * |
universe@473 | 292 | * The following combinations of arguments are valid (more arguments are optional): |
universe@477 | 293 | * \li \p loc_next and \p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance) |
universe@477 | 294 | * \li \p loc_next and \p begin (ancestor node is determined by list traversal, overall O(n) performance) |
universe@473 | 295 | * |
universe@476 | 296 | * \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 | 297 | * to traverse to a former adjacent node in the list. |
universe@473 | 298 | * |
universe@473 | 299 | * @param begin a pointer to the begin node pointer (optional) |
universe@473 | 300 | * @param end a pointer to the end node pointer (optional) |
universe@473 | 301 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 302 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@473 | 303 | * @param node the node to remove |
universe@473 | 304 | */ |
universe@481 | 305 | void cx_linked_list_remove( |
universe@481 | 306 | void **begin, |
universe@481 | 307 | void **end, |
universe@481 | 308 | ptrdiff_t loc_prev, |
universe@481 | 309 | ptrdiff_t loc_next, |
universe@481 | 310 | void *node |
universe@481 | 311 | ) __attribute__((__nonnull__(5))); |
universe@473 | 312 | |
universe@473 | 313 | |
universe@473 | 314 | /** |
universe@468 | 315 | * Determines the size of a linked list starting with \p node. |
universe@468 | 316 | * @param node the first node |
universe@468 | 317 | * @param loc_next the location of the \c next pointer within the node struct |
universe@468 | 318 | * @return the size of the list or zero if \p node is \c NULL |
universe@468 | 319 | */ |
universe@481 | 320 | size_t cx_linked_list_size( |
universe@489 | 321 | void const *node, |
universe@481 | 322 | ptrdiff_t loc_next |
universe@481 | 323 | ); |
universe@468 | 324 | |
universe@468 | 325 | /** |
universe@468 | 326 | * Sorts a linked list based on a comparison function. |
universe@468 | 327 | * |
universe@639 | 328 | * This function can work with linked lists of the following structure: |
universe@468 | 329 | * \code |
universe@468 | 330 | * typedef struct node node; |
universe@468 | 331 | * struct node { |
universe@468 | 332 | * node* prev; |
universe@468 | 333 | * node* next; |
universe@639 | 334 | * my_payload data; |
universe@468 | 335 | * } |
universe@468 | 336 | * \endcode |
universe@468 | 337 | * |
universe@476 | 338 | * @note This is a recursive function with at most logarithmic recursion depth. |
universe@476 | 339 | * |
universe@468 | 340 | * @param begin a pointer to the begin node pointer (required) |
universe@468 | 341 | * @param end a pointer to the end node pointer (optional) |
universe@468 | 342 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if not present) |
universe@468 | 343 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@468 | 344 | * @param loc_data the location of the \c data pointer within your node struct |
universe@468 | 345 | * @param cmp_func the compare function defining the sort order |
universe@468 | 346 | */ |
universe@481 | 347 | void cx_linked_list_sort( |
universe@481 | 348 | void **begin, |
universe@481 | 349 | void **end, |
universe@481 | 350 | ptrdiff_t loc_prev, |
universe@481 | 351 | ptrdiff_t loc_next, |
universe@481 | 352 | ptrdiff_t loc_data, |
universe@481 | 353 | CxListComparator cmp_func |
universe@639 | 354 | ) __attribute__((__nonnull__(1, 6))); |
universe@473 | 355 | |
universe@486 | 356 | |
universe@486 | 357 | /** |
universe@486 | 358 | * Compares two lists element wise. |
universe@486 | 359 | * |
universe@488 | 360 | * \note Both list must have the same structure. |
universe@488 | 361 | * |
universe@486 | 362 | * @param begin_left the begin of the left list (\c NULL denotes an empty list) |
universe@486 | 363 | * @param begin_right the begin of the right list (\c NULL denotes an empty list) |
universe@486 | 364 | * @param loc_advance the location of the pointer to advance |
universe@486 | 365 | * @param loc_data the location of the \c data pointer within your node struct |
universe@486 | 366 | * @param cmp_func the function to compare the elements |
universe@552 | 367 | * @return the first non-zero result of invoking \p cmp_func or: negative if the left list is smaller than the |
universe@552 | 368 | * right list, positive if the left list is larger than the right list, zero if both lists are equal. |
universe@486 | 369 | */ |
universe@486 | 370 | int cx_linked_list_compare( |
universe@489 | 371 | void const *begin_left, |
universe@489 | 372 | void const *begin_right, |
universe@486 | 373 | ptrdiff_t loc_advance, |
universe@486 | 374 | ptrdiff_t loc_data, |
universe@486 | 375 | CxListComparator cmp_func |
universe@639 | 376 | ) __attribute__((__nonnull__(5))); |
universe@486 | 377 | |
universe@473 | 378 | /** |
universe@473 | 379 | * Reverses the order of the nodes in a linked list. |
universe@473 | 380 | * |
universe@473 | 381 | * @param begin a pointer to the begin node pointer (required) |
universe@473 | 382 | * @param end a pointer to the end node pointer (optional) |
universe@473 | 383 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 384 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@473 | 385 | */ |
universe@481 | 386 | void cx_linked_list_reverse( |
universe@481 | 387 | void **begin, |
universe@481 | 388 | void **end, |
universe@481 | 389 | ptrdiff_t loc_prev, |
universe@481 | 390 | ptrdiff_t loc_next |
universe@481 | 391 | ) __attribute__((__nonnull__(1))); |
universe@473 | 392 | |
universe@415 | 393 | #ifdef __cplusplus |
universe@628 | 394 | } // extern "C" |
universe@415 | 395 | #endif |
universe@415 | 396 | |
universe@628 | 397 | #endif // UCX_LINKED_LIST_H |