src/cx/array_list.h@6ae8146d9f62
src/cx/array_list.h
Sun, 13 Nov 2022 13:29:15 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Sun, 13 Nov 2022 13:29:15 +0100
- changeset 609
- 6ae8146d9f62
- parent 608
- 2e93521145ac
- child 610
- de5d3ee6435f
- permissions
- -rw-r--r--
more custom data for array re-allocator
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 * \version 3.0
35 * \copyright 2-Clause BSD License
36 */
39 #ifndef UCX_ARRAY_LIST_H
40 #define UCX_ARRAY_LIST_H
42 #include "cx/list.h"
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
48 /**
49 * Defines a reallocation mechanism for arrays.
50 */
51 struct cx_array_reallocator_s {
52 /**
53 * Re-allocates space for the given array.
54 *
55 * Implementations are not required to free the original array.
56 * This allows re-allocation of static memory by allocating heap memory
57 * and copying the array contents. The information in \p data can keep
58 * track of the state of the memory or other additional allocator info.
59 *
60 * @param array the array to reallocate
61 * @param capacity the new capacity (number of elements)
62 * @param elem_size the size of each element
63 * @param alloc a reference to this allocator
64 * @return a pointer to the reallocated memory or \c NULL on failure
65 */
66 void *(*realloc)(
67 void *array,
68 size_t capacity,
69 size_t elem_size,
70 struct cx_array_reallocator_s *alloc
71 );
73 /**
74 * Custom data pointer.
75 */
76 void *ptr1;
77 /**
78 * Custom data pointer.
79 */
80 void *ptr2;
81 /**
82 * Custom data integer.
83 */
84 size_t int1;
85 /**
86 * Custom data integer.
87 */
88 size_t int2;
89 };
91 /**
92 * Copies elements from one array to another.
93 *
94 * The elements are copied to the \p target array at the specified \p index,
95 * overwriting possible elements. The index must be in range of the current
96 * array \p size. If the number of elements added would extend the array's size,
97 * and \p capacity is not \c NULL, the remaining capacity is used.
98 *
99 * If the capacity is insufficient to hold the new data, a reallocation
100 * attempt is made, unless the allocator is set to \c NULL, in which case
101 * this function ultimately returns a failure.
102 *
103 * @param target the target array
104 * @param size a pointer to the size of the target array
105 * @param capacity a pointer to the target array's capacity -
106 * \c NULL if only the size shall be used to bound the array
107 * @param index the index where the copied elements shall be placed
108 * @param src the source array
109 * @param elem_size the size of one element
110 * @param elem_count the number of elements to copy
111 * @param reallocator the array re-allocator to use, or \c NULL
112 * if re-allocation shall not happen
113 * @return zero on success, non-zero on failure
114 */
115 int cx_array_copy(
116 void **target,
117 size_t *size,
118 size_t *capacity,
119 size_t index,
120 void const *src,
121 size_t elem_size,
122 size_t elem_count,
123 struct cx_array_reallocator_s const *reallocator
124 ) __attribute__((__nonnull__(1, 2, 5)));
126 /**
127 * Allocates an array list for storing elements with \p item_size bytes each.
128 *
129 * @param allocator the allocator for allocating the list memory
130 * @param comparator the comparator for the elements
131 * @param item_size the size of each element in bytes
132 * @param initial_capacity the initial number of elements the array can store
133 * @return the created list
134 */
135 CxList *cxArrayListCreate(
136 CxAllocator const *allocator,
137 CxListComparator comparator,
138 size_t item_size,
139 size_t initial_capacity
140 ) __attribute__((__nonnull__));
143 #ifdef __cplusplus
144 } /* extern "C" */
145 #endif
147 #endif /* UCX_ARRAY_LIST_H */
