src/cx/linked_list.h

Sat, 04 Dec 2021 17:38:23 +0100

author
Mike Becker <universe@uap-core.de>
date
Sat, 04 Dec 2021 17:38:23 +0100
changeset 475
31bf97fdbf71
parent 473
1bd4b8c28722
child 476
60ff4561dc04
permissions
-rw-r--r--

add cx_linked_list_first() + cx_linked_list_prepend()

removes concatenating behavior of cx_linked_list_add()

     1 /*
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
     5  *
     6  * Redistribution and use in source and binary forms, with or without
     7  * modification, are permitted provided that the following conditions are met:
     8  *
     9  *   1. Redistributions of source code must retain the above copyright
    10  *      notice, this list of conditions and the following disclaimer.
    11  *
    12  *   2. Redistributions in binary form must reproduce the above copyright
    13  *      notice, this list of conditions and the following disclaimer in the
    14  *      documentation and/or other materials provided with the distribution.
    15  *
    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    26  * POSSIBILITY OF SUCH DAMAGE.
    27  */
    28 /**
    29  * \file linked_list.h
    30  * \brief Linked list implementation.
    31  * \details Also provides several low-level functions for custom linked list implementations.
    32  * \author Mike Becker
    33  * \author Olaf Wintermann
    34  * \version 3.0
    35  * \copyright 2-Clause BSD License
    36  */
    38 #ifndef UCX_LINKED_LIST_H
    39 #define UCX_LINKED_LIST_H
    41 #include <stddef.h>
    42 #include "list.h"
    44 #ifdef __cplusplus
    45 extern "C" {
    46 #endif
    48 /**
    49  * Allocates a linked list for storing elements with \p item_size bytes each.
    50  *
    51  * Elements added to the list are copied.
    52  *
    53  * @param allocator the allocator for allocating the list nodes
    54  * @param comparator the comparator for the elements
    55  * @param item_size the size of each element in bytes
    56  * @return the created list
    57  */
    58 CxList cxLinkedListCreate(CxAllocator allocator, CxListComparator comparator, size_t item_size);
    60 /**
    61  * Allocates a linked list for storing pointers.
    62  *
    63  * If you want to store the elements directly in this list, use cxLinkedListCreate().
    64  *
    65  * @param allocator the allocator for allocating the list nodes
    66  * @param comparator the comparator for the elements
    67  * @return the created list
    68  */
    69 CxList cxPointerLinkedListCreate(CxAllocator allocator, CxListComparator comparator);
    71 /**
    72  * Deallocates the memory of the entire list.
    73  *
    74  * \attention If this is a pointer list, the memory the pointers are referring to is \em not freed.
    75  *
    76  * @param list the list
    77  */
    78 void cxLinkedListDestroy(CxList list);
    80 /**
    81  * Finds the node at a certain index.
    82  *
    83  * This function can be used to start at an arbitrary position within the list.
    84  * If the search index is large than the start index, \p loc_advance must denote
    85  * the location of some sort of \c next pointer (i.e. a pointer to the next node).
    86  * But it is also possible that the search index is smaller than the start index
    87  * (e.g. in cases where traversing a list backwards is faster) in which case
    88  * \p loc_advance must denote the location of some sort of \c prev pointer
    89  * (i.e. a pointer to the previous node).
    90  *
    91  * @param start a pointer to the start node
    92  * @param start_index the start index
    93  * @param loc_advance the location of the pointer to advance
    94  * @param index the search index
    95  * @return the node found at the specified index
    96  */
    97 void *cx_linked_list_at(void *start, size_t start_index, ptrdiff_t loc_advance, size_t index);
    99 /**
   100  * Finds the first node in a linked list.
   101  *
   102  * The function starts with the pointer denoted by \p node and traverses the list
   103  * along a prev pointer whose location within the node struct is
   104  * denoted by \p loc_prev.
   105  *
   106  * @param node a pointer to a node in the list
   107  * @param loc_prev the location of the \c prev pointer
   108  * @return a pointer to the first node or \c NULL if \p node is \c NULL
   109  */
   110 void *cx_linked_list_first(void *node, ptrdiff_t loc_prev);
   112 /**
   113  * Finds the last node in a linked list.
   114  *
   115  * The function starts with the pointer denoted by \p node and traverses the list
   116  * along a next pointer whose location within the node struct is
   117  * denoted by \p loc_next.
   118  *
   119  * @param node a pointer to a node in the list
   120  * @param loc_next the location of the \c next pointer
   121  * @return a pointer to the last node or \c NULL if \p begin is \c NULL
   122  */
   123 void *cx_linked_list_last(void *node, ptrdiff_t loc_next);
   125 /**
   126  * Finds the predecessor of a node in case it is not linked.
   127  *
   128  * \remark If \p node is not contained in the list starting with \p begin, the behavior is undefined.
   129  *
   130  * @param begin the node where to start the search
   131  * @param loc_next the location of the \c next pointer
   132  * @param node the successor of the node to find
   133  * @return the node or \c NULL if \p node has no predecessor
   134  */
   135 void *cx_linked_list_prev(void *begin, ptrdiff_t loc_next, void *node);
   137 /**
   138  * Adds a new node to a linked list.
   139  * The node must not be part of any list already.
   140  *
   141  * \remark One of the pointers \p begin and \p end may be \c NULL, but not both.
   142  *
   143  * @param begin a pointer to the begin node pointer (if your list has one)
   144  * @param end a pointer to the end node pointer (if your list has one)
   145  * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
   146  * @param loc_next the location of a \c next pointer within your node struct (required)
   147  * @param new_node a pointer to the node that shall be appended
   148  */
   149 void cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
   151 /**
   152  * Prepends a new node to a linked list.
   153  * The node must not be part of any list already.
   154  *
   155  * \remark One of the pointers \p begin and \p end may be \c NULL, but not both.
   156  *
   157  * @param begin a pointer to the begin node pointer (if your list has one)
   158  * @param end a pointer to the end node pointer (if your list has one)
   159  * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
   160  * @param loc_next the location of a \c next pointer within your node struct (required)
   161  * @param new_node a pointer to the node that shall be prepended
   162  */
   163 void cx_linked_list_prepend(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
   165 /**
   166  * Removes a node from the linked list.
   167  *
   168  * If the node to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end)
   169  * addresses are provided, the pointers are adjusted accordingly.
   170  *
   171  * The following combinations of arguments are valid (more arguments are optional):
   172  * \li \p loc_next and \p loc_prev
   173  * \li \p loc_next and \p begin
   174  *
   175  * This function returns an adjacent node according to the following rules:
   176  * \li if the node has only one adjacent node, that one is returned
   177  * \li otherwise, the former \c prev node is returned
   178  *
   179  * \remark The \c next and \c prev pointers of the removed node are cleared by this function.
   180  *
   181  * @param begin a pointer to the begin node pointer (optional)
   182  * @param end a pointer to the end node pointer (optional)
   183  * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
   184  * @param loc_next the location of a \c next pointer within your node struct (required)
   185  * @param node the node to remove
   186  * @return an adjacent node or \c NULL, if this was the last node
   187  */
   188 void *cx_linked_list_remove(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node);
   191 /**
   192  * Determines the size of a linked list starting with \p node.
   193  * @param node the first node
   194  * @param loc_next the location of the \c next pointer within the node struct
   195  * @return the size of the list or zero if \p node is \c NULL
   196  */
   197 size_t cx_linked_list_size(void *node, ptrdiff_t loc_next);
   199 /**
   200  * Sorts a linked list based on a comparison function.
   201  *
   202  * This function can work with linked lists of the following structures:
   203  * \code
   204  * typedef struct node node;
   205  * struct node {
   206  *   node* prev;
   207  *   node* next;
   208  *   my_payload data; // in this case set follow_ptr = 0
   209  * }
   210  *
   211  * typedef struct ptr_node ptr_node;
   212  * struct ptr_node {
   213  *   ptr_node* prev;
   214  *   ptr_node* next;
   215  *   my_payload* data; // in this case set follow_ptr = 1
   216  * }
   217  * \endcode
   218  *
   219  * @param begin a pointer to the begin node pointer (required)
   220  * @param end a pointer to the end node pointer (optional)
   221  * @param loc_prev the location of a \c prev pointer within your node struct (negative if not present)
   222  * @param loc_next the location of a \c next pointer within your node struct (required)
   223  * @param loc_data the location of the \c data pointer within your node struct
   224  * @param follow_ptr \c false if the pointer denoted by \p loc_data shall be passed to the \p cmp_func.
   225  * If \c true, the data at \p loc_data is dereferenced, assuming to be a pointer, and then passed to \p cmp_func.
   226  * @param cmp_func the compare function defining the sort order
   227  */
   228 void cx_linked_list_sort(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next,
   229                          ptrdiff_t loc_data, int follow_ptr, CxListComparator cmp_func);
   232 /**
   233  * Reverses the order of the nodes in a linked list.
   234  *
   235  * @param begin a pointer to the begin node pointer (required)
   236  * @param end a pointer to the end node pointer (optional)
   237  * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
   238  * @param loc_next the location of a \c next pointer within your node struct (required)
   239  */
   240 void cx_linked_list_reverse(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next);
   242 #ifdef __cplusplus
   243 } /* extern "C" */
   244 #endif
   246 #endif /* UCX_LINKED_LIST_H */

mercurial