Fri, 08 Oct 2021 19:47:31 +0200
add cx_linked_list_{prev, remove, reverse}
changes assertions for some low level methods (loc_next is now always mandatory)
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@400 | 41 | #include <stddef.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@466 | 49 | * Allocates a linked list for storing elements with \p item_size bytes each. |
universe@466 | 50 | * |
universe@466 | 51 | * Elements added to the list are copied. |
universe@466 | 52 | * |
universe@466 | 53 | * @param allocator the allocator for allocating the list nodes |
universe@466 | 54 | * @param comparator the comparator for the elements |
universe@466 | 55 | * @param item_size the size of each element in bytes |
universe@466 | 56 | * @return the created list |
universe@466 | 57 | */ |
universe@453 | 58 | CxList cxLinkedListCreate(CxAllocator allocator, CxListComparator comparator, size_t item_size); |
universe@453 | 59 | |
universe@466 | 60 | /** |
universe@466 | 61 | * Allocates a linked list for storing pointers. |
universe@466 | 62 | * |
universe@466 | 63 | * If you want to store the elements directly in this list, use cxLinkedListCreate(). |
universe@466 | 64 | * |
universe@466 | 65 | * @param allocator the allocator for allocating the list nodes |
universe@466 | 66 | * @param comparator the comparator for the elements |
universe@466 | 67 | * @return the created list |
universe@466 | 68 | */ |
universe@466 | 69 | CxList cxPointerLinkedListCreate(CxAllocator allocator, CxListComparator comparator); |
universe@466 | 70 | |
universe@466 | 71 | /** |
universe@466 | 72 | * Deallocates the memory of the entire list. |
universe@466 | 73 | * |
universe@466 | 74 | * \attention If this is a pointer list, the memory the pointers are referring to is \em not freed. |
universe@466 | 75 | * |
universe@466 | 76 | * @param list the list |
universe@466 | 77 | */ |
universe@453 | 78 | void cxLinkedListDestroy(CxList list); |
universe@453 | 79 | |
universe@438 | 80 | /** |
universe@438 | 81 | * Finds the node at a certain index. |
universe@438 | 82 | * |
universe@438 | 83 | * This function can be used to start at an arbitrary position within the list. |
universe@438 | 84 | * If the search index is large than the start index, \p loc_advance must denote |
universe@438 | 85 | * the location of some sort of \c next pointer (i.e. a pointer to the next node). |
universe@438 | 86 | * But it is also possible that the search index is smaller than the start index |
universe@438 | 87 | * (e.g. in cases where traversing a list backwards is faster) in which case |
universe@438 | 88 | * \p loc_advance must denote the location of some sort of \c prev pointer |
universe@438 | 89 | * (i.e. a pointer to the previous node). |
universe@438 | 90 | * |
universe@438 | 91 | * @param start a pointer to the start node |
universe@438 | 92 | * @param start_index the start index |
universe@438 | 93 | * @param loc_advance the location of the pointer to advance |
universe@438 | 94 | * @param index the search index |
universe@438 | 95 | * @return the node found at the specified index |
universe@438 | 96 | */ |
universe@438 | 97 | void *cx_linked_list_at(void *start, size_t start_index, ptrdiff_t loc_advance, size_t index); |
universe@438 | 98 | |
universe@453 | 99 | /** |
universe@453 | 100 | * Finds the last node in a linked list. |
universe@453 | 101 | * |
universe@456 | 102 | * The function starts with the pointer denoted by \p begin and traverses the list |
universe@456 | 103 | * along a next pointer whose location within the node struct is |
universe@453 | 104 | * denoted by \p loc_next. |
universe@453 | 105 | * |
universe@456 | 106 | * @param begin a pointer to the begin node |
universe@456 | 107 | * @param loc_next the location of the \c next pointer |
universe@456 | 108 | * @return a pointer to the last node or \c NULL if \p begin is \c NULL |
universe@453 | 109 | */ |
universe@456 | 110 | void *cx_linked_list_last(void *begin, ptrdiff_t loc_next); |
universe@398 | 111 | |
universe@453 | 112 | /** |
universe@473 | 113 | * Finds the predecessor of a node in case it is not linked. |
universe@473 | 114 | * |
universe@473 | 115 | * \remark If \p node is not contained in the list starting with \p begin, the behavior is undefined. |
universe@473 | 116 | * |
universe@473 | 117 | * @param begin the node where to start the search |
universe@473 | 118 | * @param loc_next the location of the \c next pointer |
universe@473 | 119 | * @param node the successor of the node to find |
universe@473 | 120 | * @return the node or \c NULL if \p node has no predecessor |
universe@473 | 121 | */ |
universe@473 | 122 | void *cx_linked_list_prev(void *begin, ptrdiff_t loc_next, void *node); |
universe@473 | 123 | |
universe@473 | 124 | /** |
universe@453 | 125 | * Adds a new node to a linked list. |
universe@453 | 126 | * |
universe@453 | 127 | * \remark One of the pointers \p begin and \p end may be \c NULL, but not both. |
universe@453 | 128 | * |
universe@453 | 129 | * @param begin a pointer to the begin node pointer (if your list has one) |
universe@453 | 130 | * @param end a pointer to the end node pointer (if your list has one) |
universe@453 | 131 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 132 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@453 | 133 | * @param new_node a pointer to the node that shall be appended |
universe@453 | 134 | */ |
universe@453 | 135 | void cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node); |
universe@406 | 136 | |
universe@468 | 137 | /** |
universe@473 | 138 | * Removes a node from the linked list. |
universe@473 | 139 | * |
universe@473 | 140 | * If the node to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end) |
universe@473 | 141 | * addresses are provided, the pointers are adjusted accordingly. |
universe@473 | 142 | * |
universe@473 | 143 | * The following combinations of arguments are valid (more arguments are optional): |
universe@473 | 144 | * \li \p loc_next and \p loc_prev |
universe@473 | 145 | * \li \p loc_next and \p begin |
universe@473 | 146 | * |
universe@473 | 147 | * This function returns an adjacent node according to the following rules: |
universe@473 | 148 | * \li if the node has only one adjacent node, that one is returned |
universe@473 | 149 | * \li otherwise, the former \c prev node is returned |
universe@473 | 150 | * |
universe@473 | 151 | * \remark The \c next and \c prev pointers of the removed node are cleared by this function. |
universe@473 | 152 | * |
universe@473 | 153 | * @param begin a pointer to the begin node pointer (optional) |
universe@473 | 154 | * @param end a pointer to the end node pointer (optional) |
universe@473 | 155 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 156 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@473 | 157 | * @param node the node to remove |
universe@473 | 158 | * @return an adjacent node or \c NULL, if this was the last node |
universe@473 | 159 | */ |
universe@473 | 160 | void *cx_linked_list_remove(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node); |
universe@473 | 161 | |
universe@473 | 162 | |
universe@473 | 163 | /** |
universe@468 | 164 | * Determines the size of a linked list starting with \p node. |
universe@468 | 165 | * @param node the first node |
universe@468 | 166 | * @param loc_next the location of the \c next pointer within the node struct |
universe@468 | 167 | * @return the size of the list or zero if \p node is \c NULL |
universe@468 | 168 | */ |
universe@468 | 169 | size_t cx_linked_list_size(void *node, ptrdiff_t loc_next); |
universe@468 | 170 | |
universe@468 | 171 | /** |
universe@468 | 172 | * Sorts a linked list based on a comparison function. |
universe@468 | 173 | * |
universe@468 | 174 | * This function can work with linked lists of the following structures: |
universe@468 | 175 | * \code |
universe@468 | 176 | * typedef struct node node; |
universe@468 | 177 | * struct node { |
universe@468 | 178 | * node* prev; |
universe@468 | 179 | * node* next; |
universe@468 | 180 | * my_payload data; // in this case set follow_ptr = 0 |
universe@468 | 181 | * } |
universe@468 | 182 | * |
universe@468 | 183 | * typedef struct ptr_node ptr_node; |
universe@468 | 184 | * struct ptr_node { |
universe@468 | 185 | * ptr_node* prev; |
universe@468 | 186 | * ptr_node* next; |
universe@468 | 187 | * my_payload* data; // in this case set follow_ptr = 1 |
universe@468 | 188 | * } |
universe@468 | 189 | * \endcode |
universe@468 | 190 | * |
universe@468 | 191 | * @param begin a pointer to the begin node pointer (required) |
universe@468 | 192 | * @param end a pointer to the end node pointer (optional) |
universe@468 | 193 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if not present) |
universe@468 | 194 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@468 | 195 | * @param loc_data the location of the \c data pointer within your node struct |
universe@468 | 196 | * @param follow_ptr \c false if the pointer denoted by \p loc_data shall be passed to the \p cmp_func. |
universe@468 | 197 | * If \c true, the data at \p loc_data is dereferenced, assuming to be a pointer, and then passed to \p cmp_func. |
universe@468 | 198 | * @param cmp_func the compare function defining the sort order |
universe@468 | 199 | */ |
universe@468 | 200 | void cx_linked_list_sort(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, |
universe@468 | 201 | ptrdiff_t loc_data, int follow_ptr, CxListComparator cmp_func); |
universe@468 | 202 | |
universe@473 | 203 | |
universe@473 | 204 | /** |
universe@473 | 205 | * Reverses the order of the nodes in a linked list. |
universe@473 | 206 | * |
universe@473 | 207 | * @param begin a pointer to the begin node pointer (required) |
universe@473 | 208 | * @param end a pointer to the end node pointer (optional) |
universe@473 | 209 | * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one) |
universe@473 | 210 | * @param loc_next the location of a \c next pointer within your node struct (required) |
universe@473 | 211 | */ |
universe@473 | 212 | void cx_linked_list_reverse(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next); |
universe@473 | 213 | |
universe@415 | 214 | #ifdef __cplusplus |
universe@415 | 215 | } /* extern "C" */ |
universe@415 | 216 | #endif |
universe@415 | 217 | |
universe@398 | 218 | #endif /* UCX_LINKED_LIST_H */ |