src/cx/linked_list.h

Mon, 27 Sep 2021 18:33:30 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 27 Sep 2021 18:33:30 +0200
changeset 438
cd3069757010
parent 415
067aa769796a
child 453
bb144d08cd44
permissions
-rw-r--r--

add function cx_linked_list_at()

This commit also makes glue functions static.

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@398 28
universe@398 29 #ifndef UCX_LINKED_LIST_H
universe@398 30 #define UCX_LINKED_LIST_H
universe@398 31
universe@400 32 #include <stddef.h>
universe@398 33 #include "list.h"
universe@398 34
universe@415 35 #ifdef __cplusplus
universe@415 36 extern "C" {
universe@415 37 #endif
universe@415 38
universe@438 39 /**
universe@438 40 * Finds the node at a certain index.
universe@438 41 *
universe@438 42 * This function can be used to start at an arbitrary position within the list.
universe@438 43 * If the search index is large than the start index, \p loc_advance must denote
universe@438 44 * the location of some sort of \c next pointer (i.e. a pointer to the next node).
universe@438 45 * But it is also possible that the search index is smaller than the start index
universe@438 46 * (e.g. in cases where traversing a list backwards is faster) in which case
universe@438 47 * \p loc_advance must denote the location of some sort of \c prev pointer
universe@438 48 * (i.e. a pointer to the previous node).
universe@438 49 *
universe@438 50 * @param start a pointer to the start node
universe@438 51 * @param start_index the start index
universe@438 52 * @param loc_advance the location of the pointer to advance
universe@438 53 * @param index the search index
universe@438 54 * @return the node found at the specified index
universe@438 55 */
universe@438 56 void *cx_linked_list_at(void *start, size_t start_index, ptrdiff_t loc_advance, size_t index);
universe@438 57
universe@400 58 void *cx_linked_list_last(void **begin, void **end, ptrdiff_t loc_next);
universe@398 59
universe@406 60 int cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
universe@398 61
universe@398 62 extern cx_list_class cx_linked_list_class;
universe@398 63
universe@406 64 CxList cxLinkedListCreate(CxAllocator allocator, CxListComparator comparator, size_t item_size);
universe@406 65
universe@409 66 void cxLinkedListDestroy(CxList list);
universe@409 67
universe@406 68 size_t cxLinkedListRecalculateSize(CxList list);
universe@406 69
universe@415 70 #ifdef __cplusplus
universe@415 71 } /* extern "C" */
universe@415 72 #endif
universe@415 73
universe@398 74 #endif /* UCX_LINKED_LIST_H */

mercurial