ucx: src/cx/linked_list.h@cd3069757010

     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  */

    29 #ifndef UCX_LINKED_LIST_H

    30 #define UCX_LINKED_LIST_H

    32 #include <stddef.h>

    33 #include "list.h"

    35 #ifdef __cplusplus

    36 extern "C" {

    37 #endif

    39 /**

    40  * Finds the node at a certain index.

    41  *

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

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

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

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

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

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

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

    49  *

    50  * @param start a pointer to the start node

    51  * @param start_index the start index

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

    53  * @param index the search index

    54  * @return the node found at the specified index

    55  */

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

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

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

    62 extern cx_list_class cx_linked_list_class;

    64 CxList cxLinkedListCreate(CxAllocator allocator, CxListComparator comparator, size_t item_size);

    66 void cxLinkedListDestroy(CxList list);

    68 size_t cxLinkedListRecalculateSize(CxList list);

    70 #ifdef __cplusplus

    71 } /* extern "C" */

    72 #endif

    74 #endif /* UCX_LINKED_LIST_H */

Mercurial > hg > ucx / file revision