ucx: src/cx/linked_list.h@bb144d08cd44

     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 CxList cxLinkedListCreate(CxAllocator allocator, CxListComparator comparator, size_t item_size);

    50 void cxLinkedListDestroy(CxList list);

    52 size_t cxLinkedListRecalculateSize(CxList list);

    55 /**

    56  * Finds the node at a certain index.

    57  *

    58  * This function can be used to start at an arbitrary position within the list.

    59  * If the search index is large than the start index, \p loc_advance must denote

    60  * the location of some sort of \c next pointer (i.e. a pointer to the next node).

    61  * But it is also possible that the search index is smaller than the start index

    62  * (e.g. in cases where traversing a list backwards is faster) in which case

    63  * \p loc_advance must denote the location of some sort of \c prev pointer

    64  * (i.e. a pointer to the previous node).

    65  *

    66  * @param start a pointer to the start node

    67  * @param start_index the start index

    68  * @param loc_advance the location of the pointer to advance

    69  * @param index the search index

    70  * @return the node found at the specified index

    71  */

    72 void *cx_linked_list_at(void *start, size_t start_index, ptrdiff_t loc_advance, size_t index);

    74 /**

    75  * Finds the last node in a linked list.

    76  *

    77  * If a pointer to \p end is provided, the result is just \c *end.

    78  * Otherwise, this function starts with the pointer denoted by \c *begin and

    79  * traverses the list along a next pointer whose location within the node struct is

    80  * denoted by \p loc_next.

    81  *

    82  * If both \p begin and \p end are \c NULL, an empty list is assumed and this function returns \c NULL.

    83  *

    84  * @param begin a pointer to the begin node pointer (optional)

    85  * @param end a pointer to the end node pointer (optional)

    86  * @param loc_next the location of the \c next pointer (only required when \p end is \c NULL)

    87  * @return a pointer to the last node or \c NULL if the list is empty

    88  */

    89 void *cx_linked_list_last(void **begin, void **end, ptrdiff_t loc_next);

    91 /**

    92  * Adds a new node to a linked list.

    93  *

    94  * \remark One of the pointers \p begin and \p end may be \c NULL, but not both.

    95  *

    96  * @param begin a pointer to the begin node pointer (if your list has one)

    97  * @param end a pointer to the end node pointer (if your list has one)

    98  * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)

    99  * @param loc_next the location of a \c next pointer within your node struct (negative if your struct does not have one)

   100  * @param new_node a pointer to the node that shall be appended

   101  */

   102 void cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);

   104 #ifdef __cplusplus

   105 } /* extern "C" */

   106 #endif

   108 #endif /* UCX_LINKED_LIST_H */

Mercurial > hg > ucx / file revision