src/cx/array_list.h@5da2ead43077
src/cx/array_list.h
Thu, 25 Jan 2024 22:05:48 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Thu, 25 Jan 2024 22:05:48 +0100
- changeset 819
- 5da2ead43077
- parent 818
- 2be8fe3d5a2d
- child 831
- 7970eac1c598
- permissions
- -rw-r--r--
rename cx_array_copy_result to just cx_array_result
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 * The maximum item size in an array list that fits into stack buffer when swapped.
49 */
50 extern unsigned cx_array_swap_sbo_size;
52 /**
53 * Defines a reallocation mechanism for arrays.
54 */
55 struct cx_array_reallocator_s {
56 /**
57 * Re-allocates space for the given array.
58 *
59 * Implementations are not required to free the original array.
60 * This allows re-allocation of static memory by allocating heap memory
61 * and copying the array contents. The information in the custom fields of
62 * the referenced allocator can be used to track the state of the memory
63 * or to transport other additional data.
64 *
65 * @param array the array to reallocate
66 * @param capacity the new capacity (number of elements)
67 * @param elem_size the size of each element
68 * @param alloc a reference to this allocator
69 * @return a pointer to the reallocated memory or \c NULL on failure
70 */
71 void *(*realloc)(
72 void *array,
73 size_t capacity,
74 size_t elem_size,
75 struct cx_array_reallocator_s *alloc
76 );
78 /**
79 * Custom data pointer.
80 */
81 void *ptr1;
82 /**
83 * Custom data pointer.
84 */
85 void *ptr2;
86 /**
87 * Custom data integer.
88 */
89 size_t int1;
90 /**
91 * Custom data integer.
92 */
93 size_t int2;
94 };
96 /**
97 * A default stdlib-based array reallocator.
98 */
99 extern struct cx_array_reallocator_s *cx_array_default_reallocator;
101 /**
102 * Return codes for array functions.
103 */
104 enum cx_array_result {
105 CX_ARRAY_SUCCESS,
106 CX_ARRAY_REALLOC_NOT_SUPPORTED,
107 CX_ARRAY_REALLOC_FAILED,
108 };
110 /**
111 * Copies elements from one array to another.
112 *
113 * The elements are copied to the \p target array at the specified \p index,
114 * overwriting possible elements. The \p index does not need to be in range of
115 * the current array \p size. If the new index plus the number of elements added
116 * would extend the array's size, and \p capacity is not \c NULL, the remaining
117 * capacity is used.
118 *
119 * If the capacity is insufficient to hold the new data, a reallocation
120 * attempt is made, unless the \p reallocator is set to \c NULL, in which case
121 * this function ultimately returns a failure.
122 *
123 * @param target the target array
124 * @param size a pointer to the size of the target array
125 * @param capacity a pointer to the target array's capacity -
126 * \c NULL if only the size shall be used to bound the array
127 * @param index the index where the copied elements shall be placed
128 * @param src the source array
129 * @param elem_size the size of one element
130 * @param elem_count the number of elements to copy
131 * @param reallocator the array re-allocator to use, or \c NULL
132 * if re-allocation shall not happen
133 * @return zero on success, non-zero error code on failure
134 */
135 enum cx_array_result cx_array_copy(
136 void **target,
137 size_t *size,
138 size_t *capacity,
139 size_t index,
140 void const *src,
141 size_t elem_size,
142 size_t elem_count,
143 struct cx_array_reallocator_s *reallocator
144 ) __attribute__((__nonnull__(1, 2, 5)));
146 /**
147 * Adds an element to an array with the possibility of allocating more space.
148 *
149 * The element \p elem is added to the end of the \p target array which containing
150 * \p size elements, already. The \p capacity must not be \c NULL and point a
151 * variable holding the current maximum number of elements the array can hold.
152 *
153 * If the capacity is insufficient to hold the new element, and the optional
154 * \p reallocator is not \c NULL, an attempt increase the \p capacity is made
155 * and the new capacity is written back.
156 *
157 * @param target the target array
158 * @param size a pointer to the size of the target array
159 * @param capacity a pointer to the target array's capacity - must not be \c NULL
160 * @param elem_size the size of one element
161 * @param elem the element to add
162 * @param reallocator the array re-allocator to use, or \c NULL
163 * if re-allocation shall not happen
164 * @return zero on success, non-zero error code on failure
165 */
166 #define cx_array_add(target, size, capacity, elem_size, elem, reallocator) \
167 cx_array_copy((void**)(target), size, capacity, *(size), elem, elem_size, 1, reallocator)
169 /**
170 * Swaps two array elements.
171 *
172 * @param arr the array
173 * @param elem_size the element size
174 * @param idx1 index of first element
175 * @param idx2 index of second element
176 */
177 void cx_array_swap(
178 void *arr,
179 size_t elem_size,
180 size_t idx1,
181 size_t idx2
182 ) __attribute__((__nonnull__));
184 /**
185 * Allocates an array list for storing elements with \p item_size bytes each.
186 *
187 * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
188 * cxListStorePointers() was called immediately after creation and the compare
189 * function will be automatically set to cx_cmp_ptr(), if none is given.
190 *
191 * @param allocator the allocator for allocating the list memory
192 * (if \c NULL the cxDefaultAllocator will be used)
193 * @param comparator the comparator for the elements
194 * (if \c NULL, and the list is not storing pointers, sort and find
195 * functions will not work)
196 * @param item_size the size of each element in bytes
197 * @param initial_capacity the initial number of elements the array can store
198 * @return the created list
199 */
200 CxList *cxArrayListCreate(
201 CxAllocator const *allocator,
202 cx_compare_func comparator,
203 size_t item_size,
204 size_t initial_capacity
205 );
207 /**
208 * Allocates an array list for storing elements with \p item_size bytes each.
209 *
210 * The list will use the cxDefaultAllocator and \em NO compare function.
211 * If you want to call functions that need a compare function, you have to
212 * set it immediately after creation or use cxArrayListCreate().
213 *
214 * If \p item_size is CX_STORE_POINTERS, the created list will be created as if
215 * cxListStorePointers() was called immediately after creation and the compare
216 * function will be automatically set to cx_cmp_ptr().
217 *
218 * @param item_size the size of each element in bytes
219 * @param initial_capacity the initial number of elements the array can store
220 * @return the created list
221 */
222 #define cxArrayListCreateSimple(item_size, initial_capacity) \
223 cxArrayListCreate(NULL, NULL, item_size, initial_capacity)
225 #ifdef __cplusplus
226 } // extern "C"
227 #endif
229 #endif // UCX_ARRAY_LIST_H
