Thu, 23 Feb 2023 22:27:41 +0100
add CX_LINKED_LIST_SORT_SBO_SIZE macro
universe@606 | 1 | /* |
universe@606 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@606 | 3 | * |
universe@606 | 4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
universe@606 | 5 | * |
universe@606 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@606 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@606 | 8 | * |
universe@606 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@606 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@606 | 11 | * |
universe@606 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@606 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@606 | 14 | * documentation and/or other materials provided with the distribution. |
universe@606 | 15 | * |
universe@606 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@606 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@606 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@606 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@606 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@606 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@606 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@606 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@606 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@606 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@606 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@606 | 27 | */ |
universe@606 | 28 | /** |
universe@606 | 29 | * \file array_list.h |
universe@606 | 30 | * \brief Array list implementation. |
universe@606 | 31 | * \details Also provides several low-level functions for custom array list implementations. |
universe@606 | 32 | * \author Mike Becker |
universe@606 | 33 | * \author Olaf Wintermann |
universe@606 | 34 | * \version 3.0 |
universe@606 | 35 | * \copyright 2-Clause BSD License |
universe@606 | 36 | */ |
universe@606 | 37 | |
universe@606 | 38 | |
universe@606 | 39 | #ifndef UCX_ARRAY_LIST_H |
universe@606 | 40 | #define UCX_ARRAY_LIST_H |
universe@606 | 41 | |
olaf@617 | 42 | #include "list.h" |
universe@606 | 43 | |
universe@606 | 44 | #ifdef __cplusplus |
universe@606 | 45 | extern "C" { |
universe@606 | 46 | #endif |
universe@606 | 47 | |
universe@606 | 48 | /** |
universe@608 | 49 | * Defines a reallocation mechanism for arrays. |
universe@608 | 50 | */ |
universe@608 | 51 | struct cx_array_reallocator_s { |
universe@608 | 52 | /** |
universe@608 | 53 | * Re-allocates space for the given array. |
universe@608 | 54 | * |
universe@608 | 55 | * Implementations are not required to free the original array. |
universe@608 | 56 | * This allows re-allocation of static memory by allocating heap memory |
universe@608 | 57 | * and copying the array contents. The information in \p data can keep |
universe@608 | 58 | * track of the state of the memory or other additional allocator info. |
universe@608 | 59 | * |
universe@608 | 60 | * @param array the array to reallocate |
universe@608 | 61 | * @param capacity the new capacity (number of elements) |
universe@608 | 62 | * @param elem_size the size of each element |
universe@609 | 63 | * @param alloc a reference to this allocator |
universe@608 | 64 | * @return a pointer to the reallocated memory or \c NULL on failure |
universe@608 | 65 | */ |
universe@608 | 66 | void *(*realloc)( |
universe@608 | 67 | void *array, |
universe@608 | 68 | size_t capacity, |
universe@608 | 69 | size_t elem_size, |
universe@609 | 70 | struct cx_array_reallocator_s *alloc |
universe@608 | 71 | ); |
universe@608 | 72 | |
universe@608 | 73 | /** |
universe@609 | 74 | * Custom data pointer. |
universe@608 | 75 | */ |
universe@609 | 76 | void *ptr1; |
universe@609 | 77 | /** |
universe@609 | 78 | * Custom data pointer. |
universe@609 | 79 | */ |
universe@609 | 80 | void *ptr2; |
universe@609 | 81 | /** |
universe@609 | 82 | * Custom data integer. |
universe@609 | 83 | */ |
universe@609 | 84 | size_t int1; |
universe@609 | 85 | /** |
universe@609 | 86 | * Custom data integer. |
universe@609 | 87 | */ |
universe@609 | 88 | size_t int2; |
universe@608 | 89 | }; |
universe@608 | 90 | |
universe@608 | 91 | /** |
universe@610 | 92 | * Return codes for cx_array_copy(). |
universe@610 | 93 | */ |
universe@612 | 94 | enum cx_array_copy_result { |
universe@610 | 95 | CX_ARRAY_COPY_SUCCESS, |
universe@610 | 96 | CX_ARRAY_COPY_REALLOC_NOT_SUPPORTED, |
universe@610 | 97 | CX_ARRAY_COPY_REALLOC_FAILED, |
universe@610 | 98 | }; |
universe@610 | 99 | |
universe@610 | 100 | /** |
universe@608 | 101 | * Copies elements from one array to another. |
universe@608 | 102 | * |
universe@608 | 103 | * The elements are copied to the \p target array at the specified \p index, |
universe@637 | 104 | * overwriting possible elements. The \p index does not need to be in range of |
universe@637 | 105 | * the current array \p size. If the new index plus the number of elements added |
universe@637 | 106 | * would extend the array's size, and \p capacity is not \c NULL, the remaining |
universe@637 | 107 | * capacity is used. |
universe@608 | 108 | * |
universe@608 | 109 | * If the capacity is insufficient to hold the new data, a reallocation |
universe@608 | 110 | * attempt is made, unless the allocator is set to \c NULL, in which case |
universe@608 | 111 | * this function ultimately returns a failure. |
universe@608 | 112 | * |
universe@608 | 113 | * @param target the target array |
universe@608 | 114 | * @param size a pointer to the size of the target array |
universe@608 | 115 | * @param capacity a pointer to the target array's capacity - |
universe@608 | 116 | * \c NULL if only the size shall be used to bound the array |
universe@608 | 117 | * @param index the index where the copied elements shall be placed |
universe@608 | 118 | * @param src the source array |
universe@608 | 119 | * @param elem_size the size of one element |
universe@608 | 120 | * @param elem_count the number of elements to copy |
universe@608 | 121 | * @param reallocator the array re-allocator to use, or \c NULL |
universe@608 | 122 | * if re-allocation shall not happen |
universe@610 | 123 | * @return zero on success, non-zero error code on failure |
universe@608 | 124 | */ |
universe@612 | 125 | enum cx_array_copy_result cx_array_copy( |
universe@608 | 126 | void **target, |
universe@608 | 127 | size_t *size, |
universe@608 | 128 | size_t *capacity, |
universe@608 | 129 | size_t index, |
universe@608 | 130 | void const *src, |
universe@608 | 131 | size_t elem_size, |
universe@608 | 132 | size_t elem_count, |
universe@610 | 133 | struct cx_array_reallocator_s *reallocator |
universe@608 | 134 | ) __attribute__((__nonnull__(1, 2, 5))); |
universe@608 | 135 | |
universe@623 | 136 | |
universe@623 | 137 | /** |
universe@623 | 138 | * Swaps two array elements. |
universe@623 | 139 | * |
universe@623 | 140 | * @param arr the array |
universe@623 | 141 | * @param elem_size the element size |
universe@623 | 142 | * @param idx1 index of first element |
universe@623 | 143 | * @param idx2 index of second element |
universe@623 | 144 | */ |
universe@623 | 145 | void cx_array_swap( |
universe@623 | 146 | void *arr, |
universe@623 | 147 | size_t elem_size, |
universe@623 | 148 | size_t idx1, |
universe@623 | 149 | size_t idx2 |
universe@623 | 150 | ) __attribute__((__nonnull__)); |
universe@623 | 151 | |
universe@608 | 152 | /** |
universe@606 | 153 | * Allocates an array list for storing elements with \p item_size bytes each. |
universe@606 | 154 | * |
universe@606 | 155 | * @param allocator the allocator for allocating the list memory |
universe@606 | 156 | * @param comparator the comparator for the elements |
universe@606 | 157 | * @param item_size the size of each element in bytes |
universe@606 | 158 | * @param initial_capacity the initial number of elements the array can store |
universe@606 | 159 | * @return the created list |
universe@606 | 160 | */ |
universe@606 | 161 | CxList *cxArrayListCreate( |
universe@606 | 162 | CxAllocator const *allocator, |
universe@606 | 163 | CxListComparator comparator, |
universe@606 | 164 | size_t item_size, |
universe@606 | 165 | size_t initial_capacity |
universe@606 | 166 | ) __attribute__((__nonnull__)); |
universe@606 | 167 | |
universe@606 | 168 | |
universe@606 | 169 | #ifdef __cplusplus |
universe@628 | 170 | } // extern "C" |
universe@606 | 171 | #endif |
universe@606 | 172 | |
universe@628 | 173 | #endif // UCX_ARRAY_LIST_H |