src/cx/array_list.h@5136f2fc32ec
src/cx/array_list.h
Sat, 13 Jan 2024 17:51:42 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Sat, 13 Jan 2024 17:51:42 +0100
- changeset 804
- 5136f2fc32ec
- parent 795
- 00ba1bfa4ab4
- child 807
- c8d692131b1e
- permissions
- -rw-r--r--
add CX_DISABLE_ARRAY_LIST_SWAP_SBO flag
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 array_list.h
30 * \brief Array list implementation.
31 * \details Also provides several low-level functions for custom array list implementations.
32 * \author Mike Becker
33 * \author Olaf Wintermann
34 * \copyright 2-Clause BSD License
35 */
38 #ifndef UCX_ARRAY_LIST_H
39 #define UCX_ARRAY_LIST_H
41 #include "list.h"
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
47 /**
48 * Set this flag to true, if you want to disable the use of SBO for
49 * array list swap operations.
50 */
51 extern bool CX_DISABLE_ARRAY_LIST_SWAP_SBO;
53 /**
54 * Defines a reallocation mechanism for arrays.
55 */
56 struct cx_array_reallocator_s {
57 /**
58 * Re-allocates space for the given array.
59 *
60 * Implementations are not required to free the original array.
61 * This allows re-allocation of static memory by allocating heap memory
62 * and copying the array contents. The information in the custom fields of
63 * the referenced allocator can be used to track the state of the memory
64 * or to transport other additional data.
65 *
66 * @param array the array to reallocate
67 * @param capacity the new capacity (number of elements)
68 * @param elem_size the size of each element
69 * @param alloc a reference to this allocator
70 * @return a pointer to the reallocated memory or \c NULL on failure
71 */
72 void *(*realloc)(
73 void *array,
74 size_t capacity,
75 size_t elem_size,
76 struct cx_array_reallocator_s *alloc
77 );
79 /**
80 * Custom data pointer.
81 */
82 void *ptr1;
83 /**
84 * Custom data pointer.
85 */
86 void *ptr2;
87 /**
88 * Custom data integer.
89 */
90 size_t int1;
91 /**
92 * Custom data integer.
93 */
94 size_t int2;
95 };
97 /**
98 * Return codes for cx_array_copy().
99 */
100 enum cx_array_copy_result {
101 CX_ARRAY_COPY_SUCCESS,
102 CX_ARRAY_COPY_REALLOC_NOT_SUPPORTED,
103 CX_ARRAY_COPY_REALLOC_FAILED,
104 };
106 /**
107 * Copies elements from one array to another.
108 *
109 * The elements are copied to the \p target array at the specified \p index,
110 * overwriting possible elements. The \p index does not need to be in range of
111 * the current array \p size. If the new index plus the number of elements added
112 * would extend the array's size, and \p capacity is not \c NULL, the remaining
113 * capacity is used.
114 *
115 * If the capacity is insufficient to hold the new data, a reallocation
116 * attempt is made, unless the allocator is set to \c NULL, in which case
117 * this function ultimately returns a failure.
118 *
119 * @param target the target array
120 * @param size a pointer to the size of the target array
121 * @param capacity a pointer to the target array's capacity -
122 * \c NULL if only the size shall be used to bound the array
123 * @param index the index where the copied elements shall be placed
124 * @param src the source array
125 * @param elem_size the size of one element
126 * @param elem_count the number of elements to copy
127 * @param reallocator the array re-allocator to use, or \c NULL
128 * if re-allocation shall not happen
129 * @return zero on success, non-zero error code on failure
130 */
131 enum cx_array_copy_result cx_array_copy(
132 void **target,
133 size_t *size,
134 size_t *capacity,
135 size_t index,
136 void const *src,
137 size_t elem_size,
138 size_t elem_count,
139 struct cx_array_reallocator_s *reallocator
140 ) __attribute__((__nonnull__(1, 2, 5)));
143 /**
144 * Swaps two array elements.
145 *
146 * @param arr the array
147 * @param elem_size the element size
148 * @param idx1 index of first element
149 * @param idx2 index of second element
150 */
151 void cx_array_swap(
152 void *arr,
153 size_t elem_size,
154 size_t idx1,
155 size_t idx2
156 ) __attribute__((__nonnull__));
158 /**
159 * Allocates an array list for storing elements with \p item_size bytes each.
160 *
161 * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
162 * cxListStorePointers() was called immediately after creation and the compare
163 * function will be automatically set to cx_cmp_ptr(), if none is given.
164 *
165 * @param allocator the allocator for allocating the list memory
166 * (if \c NULL the cxDefaultAllocator will be used)
167 * @param comparator the comparator for the elements
168 * (if \c NULL, and the list is not storing pointers, sort and find
169 * functions will not work)
170 * @param item_size the size of each element in bytes
171 * @param initial_capacity the initial number of elements the array can store
172 * @return the created list
173 */
174 CxList *cxArrayListCreate(
175 CxAllocator const *allocator,
176 cx_compare_func comparator,
177 size_t item_size,
178 size_t initial_capacity
179 );
181 /**
182 * Allocates an array list for storing elements with \p item_size bytes each.
183 *
184 * The list will use the cxDefaultAllocator and \em NO compare function.
185 * If you want to call functions that need a compare function, you have to
186 * set it immediately after creation or use cxArrayListCreate().
187 *
188 * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
189 * cxListStorePointers() was called immediately after creation and the compare
190 * function will be automatically set to cx_cmp_ptr().
191 *
192 * @param item_size the size of each element in bytes
193 * @param initial_capacity the initial number of elements the array can store
194 * @return the created list
195 */
196 #define cxArrayListCreateSimple(item_size, initial_capacity) \
197 cxArrayListCreate(NULL, NULL, item_size, initial_capacity)
199 #ifdef __cplusplus
200 } // extern "C"
201 #endif
203 #endif // UCX_ARRAY_LIST_H
