universe@398: /*
universe@398:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@398:  *
universe@398:  * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
universe@398:  *
universe@398:  * Redistribution and use in source and binary forms, with or without
universe@398:  * modification, are permitted provided that the following conditions are met:
universe@398:  *
universe@398:  *   1. Redistributions of source code must retain the above copyright
universe@398:  *      notice, this list of conditions and the following disclaimer.
universe@398:  *
universe@398:  *   2. Redistributions in binary form must reproduce the above copyright
universe@398:  *      notice, this list of conditions and the following disclaimer in the
universe@398:  *      documentation and/or other materials provided with the distribution.
universe@398:  *
universe@398:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@398:  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@398:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@398:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@398:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@398:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@398:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@398:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@398:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@398:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@398:  * POSSIBILITY OF SUCH DAMAGE.
universe@398:  */
universe@398: 
universe@398: #ifndef UCX_LINKED_LIST_H
universe@398: #define UCX_LINKED_LIST_H
universe@398: 
universe@400: #include <stddef.h>
universe@398: #include "list.h"
universe@398: 
universe@415: #ifdef __cplusplus
universe@415: extern "C" {
universe@415: #endif
universe@415: 
universe@438: /**
universe@438:  * Finds the node at a certain index.
universe@438:  *
universe@438:  * This function can be used to start at an arbitrary position within the list.
universe@438:  * If the search index is large than the start index, \p loc_advance must denote
universe@438:  * the location of some sort of \c next pointer (i.e. a pointer to the next node).
universe@438:  * But it is also possible that the search index is smaller than the start index
universe@438:  * (e.g. in cases where traversing a list backwards is faster) in which case
universe@438:  * \p loc_advance must denote the location of some sort of \c prev pointer
universe@438:  * (i.e. a pointer to the previous node).
universe@438:  *
universe@438:  * @param start a pointer to the start node
universe@438:  * @param start_index the start index
universe@438:  * @param loc_advance the location of the pointer to advance
universe@438:  * @param index the search index
universe@438:  * @return the node found at the specified index
universe@438:  */
universe@438: void *cx_linked_list_at(void *start, size_t start_index, ptrdiff_t loc_advance, size_t index);
universe@438: 
universe@400: void *cx_linked_list_last(void **begin, void **end, ptrdiff_t loc_next);
universe@398: 
universe@406: int cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
universe@398: 
universe@398: extern cx_list_class cx_linked_list_class;
universe@398: 
universe@406: CxList cxLinkedListCreate(CxAllocator allocator, CxListComparator comparator, size_t item_size);
universe@406: 
universe@409: void cxLinkedListDestroy(CxList list);
universe@409: 
universe@406: size_t cxLinkedListRecalculateSize(CxList list);
universe@406: 
universe@415: #ifdef __cplusplus
universe@415: } /* extern "C" */
universe@415: #endif
universe@415: 
universe@398: #endif /* UCX_LINKED_LIST_H */