src/cx/array_list.h

Mon, 23 Dec 2024 00:34:05 +0100

author
Mike Becker <universe@uap-core.de>
date
Mon, 23 Dec 2024 00:34:05 +0100
changeset 1052
e997862a57d8
parent 1010
2d252c1c1d5d
permissions
-rw-r--r--

add temporary implementations for string to number and first test cases

issue #532

606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 /*
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
3 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
11 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 *
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
27 */
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28 /**
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29 * \file array_list.h
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30 * \brief Array list implementation.
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
31 * \author Mike Becker
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
32 * \author Olaf Wintermann
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
33 * \copyright 2-Clause BSD License
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
34 */
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
35
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
36
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
37 #ifndef UCX_ARRAY_LIST_H
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
38 #define UCX_ARRAY_LIST_H
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
39
617
cec11387c1be fix include in array_list.h
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 612
diff changeset
40 #include "list.h"
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
41
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
42 #ifdef __cplusplus
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
43 extern "C" {
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
44 #endif
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
45
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
46 /**
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
47 * The maximum item size in an array list that fits into stack buffer
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
48 * when swapped.
804
5136f2fc32ec add CX_DISABLE_ARRAY_LIST_SWAP_SBO flag
Mike Becker <universe@uap-core.de>
parents: 795
diff changeset
49 */
926
8fdd8d78c14b fix several survivors of east-const and some missing consts
Mike Becker <universe@uap-core.de>
parents: 891
diff changeset
50 extern const unsigned cx_array_swap_sbo_size;
804
5136f2fc32ec add CX_DISABLE_ARRAY_LIST_SWAP_SBO flag
Mike Becker <universe@uap-core.de>
parents: 795
diff changeset
51
5136f2fc32ec add CX_DISABLE_ARRAY_LIST_SWAP_SBO flag
Mike Becker <universe@uap-core.de>
parents: 795
diff changeset
52 /**
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
53 * Declares variables for an array that can be used with the convenience macros.
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
54 *
998
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
55 * @param type the type of the data
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
56 * @param name the name of the array
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
57 * @param size_type the type of the size (should be uint8_t, uint16_t, uint32_t, or size_t)
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
58 *
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
59 * @see cx_array_simple_add()
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
60 * @see cx_array_simple_copy()
834
04c53b3c8378 capitalize cx_array_declare()
Mike Becker <universe@uap-core.de>
parents: 832
diff changeset
61 * @see cx_array_initialize()
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
62 * @see cx_array_simple_add_sorted()
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
63 * @see cx_array_simple_insert_sorted()
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
64 */
998
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
65 #define CX_ARRAY_DECLARE_SIZED(type, name, size_type) \
1010
2d252c1c1d5d add fake doc to mute doxygen complaints
Mike Becker <universe@uap-core.de>
parents: 999
diff changeset
66 type * name; \
2d252c1c1d5d add fake doc to mute doxygen complaints
Mike Becker <universe@uap-core.de>
parents: 999
diff changeset
67 /** Array size. */ size_type name##_size; \
2d252c1c1d5d add fake doc to mute doxygen complaints
Mike Becker <universe@uap-core.de>
parents: 999
diff changeset
68 /** Array capacity. */ size_type name##_capacity
998
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
69
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
70 /**
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
71 * Declares variables for an array that can be used with the convenience macros.
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
72 *
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
73 * The size and capacity variables will have `size_t` type.
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
74 * Use #CX_ARRAY_DECLARE_SIZED() to specify a different type.
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
75 *
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
76 * @param type the type of the data
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
77 * @param name the name of the array
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
78 *
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
79 * @see cx_array_simple_add()
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
80 * @see cx_array_simple_copy()
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
81 * @see cx_array_initialize()
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
82 * @see cx_array_simple_add_sorted()
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
83 * @see cx_array_simple_insert_sorted()
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
84 */
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
85 #define CX_ARRAY_DECLARE(type, name) CX_ARRAY_DECLARE_SIZED(type, name, size_t)
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
86
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
87 /**
834
04c53b3c8378 capitalize cx_array_declare()
Mike Becker <universe@uap-core.de>
parents: 832
diff changeset
88 * Initializes an array declared with CX_ARRAY_DECLARE().
832
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
89 *
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
90 * The memory for the array is allocated with stdlib malloc().
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
91 * @param array the array
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
92 * @param capacity the initial capacity
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
93 */
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
94 #define cx_array_initialize(array, capacity) \
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
95 array##_capacity = capacity; \
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
96 array##_size = 0; \
843
7d2959b7fff2 fix superfluous semicolon
Mike Becker <universe@uap-core.de>
parents: 834
diff changeset
97 array = malloc(sizeof(array[0]) * capacity)
832
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
98
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
99 /**
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
100 * Initializes an array declared with CX_ARRAY_DECLARE().
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
101 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
102 * The memory for the array is allocated with the specified allocator.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
103 * @param allocator the allocator
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
104 * @param array the array
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
105 * @param capacity the initial capacity
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
106 */
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
107 #define cx_array_initialize_a(allocator, array, capacity) \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
108 array##_capacity = capacity; \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
109 array##_size = 0; \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
110 array = cxMalloc(allocator, sizeof(array[0]) * capacity)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
111
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
112 /**
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
113 * Defines a reallocation mechanism for arrays.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
114 */
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
115 struct cx_array_reallocator_s {
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
116 /**
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
117 * Reallocates space for the given array.
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
118 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
119 * Implementations are not required to free the original array.
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
120 * This allows reallocation of static memory by allocating heap memory
795
00ba1bfa4ab4 fix documentation of reallocator struct
Mike Becker <universe@uap-core.de>
parents: 763
diff changeset
121 * and copying the array contents. The information in the custom fields of
00ba1bfa4ab4 fix documentation of reallocator struct
Mike Becker <universe@uap-core.de>
parents: 763
diff changeset
122 * the referenced allocator can be used to track the state of the memory
00ba1bfa4ab4 fix documentation of reallocator struct
Mike Becker <universe@uap-core.de>
parents: 763
diff changeset
123 * or to transport other additional data.
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
124 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
125 * @param array the array to reallocate
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
126 * @param capacity the new capacity (number of elements)
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
127 * @param elem_size the size of each element
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
128 * @param alloc a reference to this allocator
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
129 * @return a pointer to the reallocated memory or \c NULL on failure
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
130 */
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
131 cx_attr_nodiscard
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
132 cx_attr_nonnull_arg(4)
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
133 cx_attr_allocsize(2, 3)
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
134 void *(*realloc)(
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
135 void *array,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
136 size_t capacity,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
137 size_t elem_size,
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
138 struct cx_array_reallocator_s *alloc
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
139 );
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
140
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
141 /**
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
142 * Custom data pointer.
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
143 */
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
144 void *ptr1;
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
145 /**
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
146 * Custom data pointer.
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
147 */
609
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
148 void *ptr2;
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
149 /**
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
150 * Custom data integer.
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
151 */
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
152 size_t int1;
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
153 /**
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
154 * Custom data integer.
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
155 */
6ae8146d9f62 more custom data for array re-allocator
Mike Becker <universe@uap-core.de>
parents: 608
diff changeset
156 size_t int2;
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
157 };
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
158
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
159 /**
953
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
160 * Typedef for the array reallocator struct.
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
161 */
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
162 typedef struct cx_array_reallocator_s CxArrayReallocator;
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
163
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
164 /**
817
949908c97474 add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 807
diff changeset
165 * A default stdlib-based array reallocator.
949908c97474 add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 807
diff changeset
166 */
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
167 extern struct cx_array_reallocator_s *cx_array_default_reallocator;
817
949908c97474 add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 807
diff changeset
168
949908c97474 add cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 807
diff changeset
169 /**
953
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
170 * Creates a new array reallocator.
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
171 *
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
172 * When \p allocator is \c NULL, the stdlib default allocator will be used.
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
173 *
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
174 * When \p stackmem is not \c NULL, the reallocator is supposed to be used
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
175 * \em only for the specific array that is initially located at \p stackmem.
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
176 * When reallocation is needed, the reallocator checks, if the array is
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
177 * still located at \p stackmem and copies the contents to the heap.
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
178 *
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
179 * @param allocator the allocator this reallocator shall be based on
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
180 * @param stackmem the address of the array when the array is initially located
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
181 * on the stack
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
182 * @return an array reallocator
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
183 */
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
184 struct cx_array_reallocator_s cx_array_reallocator(
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
185 const struct cx_allocator_s *allocator,
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
186 const void *stackmem
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
187 );
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
188
581ad4fd01e9 add function to create array reallocator that can move arrays from stack to heap
Mike Becker <universe@uap-core.de>
parents: 926
diff changeset
189 /**
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
190 * Reserves memory for additional elements.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
191 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
192 * This function checks if the \p capacity of the array is sufficient to hold
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
193 * at least \p size plus \p elem_count elements. If not, a reallocation is
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
194 * performed with the specified \p reallocator.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
195 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
196 * This function can be useful to replace subsequent calls to cx_array_copy()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
197 * with one single cx_array_reserve() and then - after guaranteeing a
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
198 * sufficient capacity - use simple memmove() or memcpy().
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
199 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
200 * The \p width refers to the size and capacity. Both must have the same width.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
201 * Supported are 0, 8, 16, and 32, as well as 64 if running on a 64 bit
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
202 * architecture. If set to zero, the native word width is used.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
203 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
204 * @param array a pointer to the target array
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
205 * @param size a pointer to the size of the array
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
206 * @param capacity a pointer to the capacity of the array
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
207 * @param width the width in bytes for the \p size and \p capacity or zero for default
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
208 * @param elem_size the size of one element
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
209 * @param elem_count the number of expected additional elements
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
210 * @param reallocator the array reallocator to use
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
211 * @return zero on success, non-zero on failure
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
212 */
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
213 cx_attr_nonnull
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
214 int cx_array_reserve(
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
215 void **array,
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
216 void *size,
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
217 void *capacity,
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
218 unsigned width,
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
219 size_t elem_size,
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
220 size_t elem_count,
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
221 struct cx_array_reallocator_s *reallocator
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
222 );
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
223
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
224 /**
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
225 * Copies elements from one array to another.
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
226 *
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
227 * The elements are copied to the \p target array at the specified \p index,
637
ceadf0792ded remove the untrue restriction for the index parameter of cx_array_copy() from the documentation
Mike Becker <universe@uap-core.de>
parents: 628
diff changeset
228 * overwriting possible elements. The \p index does not need to be in range of
ceadf0792ded remove the untrue restriction for the index parameter of cx_array_copy() from the documentation
Mike Becker <universe@uap-core.de>
parents: 628
diff changeset
229 * the current array \p size. If the new index plus the number of elements added
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
230 * would extend the array's size, the remaining \p capacity is used.
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
231 *
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
232 * If the \p capacity is also insufficient to hold the new data, a reallocation
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
233 * attempt is made with the specified \p reallocator.
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
234 *
998
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
235 * The \p width refers to the size and capacity. Both must have the same width.
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
236 * Supported are 0, 8, 16, and 32, as well as 64 if running on a 64 bit
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
237 * architecture. If set to zero, the native word width is used.
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
238 *
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
239 * @param target a pointer to the target array
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
240 * @param size a pointer to the size of the target array
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
241 * @param capacity a pointer to the capacity of the target array
998
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
242 * @param width the width in bytes for the \p size and \p capacity or zero for default
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
243 * @param index the index where the copied elements shall be placed
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
244 * @param src the source array
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
245 * @param elem_size the size of one element
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
246 * @param elem_count the number of elements to copy
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
247 * @param reallocator the array reallocator to use
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
248 * @return zero on success, non-zero on failure
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
249 */
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
250 cx_attr_nonnull
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
251 int cx_array_copy(
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
252 void **target,
998
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
253 void *size,
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
254 void *capacity,
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
255 unsigned width,
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
256 size_t index,
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
257 const void *src,
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
258 size_t elem_size,
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
259 size_t elem_count,
610
de5d3ee6435f #219 array list: implement add and at
Mike Becker <universe@uap-core.de>
parents: 609
diff changeset
260 struct cx_array_reallocator_s *reallocator
891
49d8cff6f0ee make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents: 890
diff changeset
261 );
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
262
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
263 /**
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
264 * Convenience macro that uses cx_array_copy() with a default layout and
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
265 * the specified reallocator.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
266 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
267 * @param reallocator the array reallocator to use
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
268 * @param array the name of the array (NOT a pointer to the array)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
269 * @param index the index where the copied elements shall be placed
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
270 * @param src the source array
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
271 * @param count the number of elements to copy
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
272 * @return zero on success, non-zero on failure
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
273 * @see CX_ARRAY_DECLARE()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
274 * @see cx_array_simple_copy()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
275 */
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
276 #define cx_array_simple_copy_a(reallocator, array, index, src, count) \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
277 cx_array_copy((void**)&(array), &(array##_size), &(array##_capacity), \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
278 8*sizeof(array##_size), index, src, sizeof((array)[0]), count, \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
279 reallocator)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
280
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
281 /**
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
282 * Convenience macro that uses cx_array_copy() with a default layout and
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
283 * the default reallocator.
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
284 *
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
285 * @param array the name of the array (NOT a pointer to the array)
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
286 * @param index the index where the copied elements shall be placed
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
287 * @param src the source array
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
288 * @param count the number of elements to copy
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
289 * @return zero on success, non-zero on failure
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
290 * @see CX_ARRAY_DECLARE()
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
291 * @see cx_array_simple_copy_a()
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
292 */
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
293 #define cx_array_simple_copy(array, index, src, count) \
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
294 cx_array_simple_copy_a(cx_array_default_reallocator, \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
295 array, index, src, count)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
296
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
297 /**
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
298 * Convenience macro that uses cx_array_reserve() with a default layout and
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
299 * the specified reallocator.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
300 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
301 * @param reallocator the array reallocator to use
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
302 * @param array the name of the array (NOT a pointer to the array)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
303 * @param count the number of expected additional elements
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
304 * @return zero on success, non-zero on failure
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
305 * @see CX_ARRAY_DECLARE()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
306 * @see cx_array_simple_reserve()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
307 */
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
308 #define cx_array_simple_reserve_a(reallocator, array, count) \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
309 cx_array_reserve((void**)&(array), &(array##_size), &(array##_capacity), \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
310 8*sizeof(array##_size), sizeof((array)[0]), count, \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
311 reallocator)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
312
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
313 /**
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
314 * Convenience macro that uses cx_array_reserve() with a default layout and
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
315 * the default reallocator.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
316 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
317 * @param array the name of the array (NOT a pointer to the array)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
318 * @param count the number of expected additional elements
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
319 * @return zero on success, non-zero on failure
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
320 * @see CX_ARRAY_DECLARE()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
321 * @see cx_array_simple_reserve_a()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
322 */
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
323 #define cx_array_simple_reserve(array, count) \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
324 cx_array_simple_reserve_a(cx_array_default_reallocator, \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
325 array, count)
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
326
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
327 /**
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
328 * Adds an element to an array with the possibility of allocating more space.
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
329 *
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
330 * The element \p elem is added to the end of the \p target array which contains
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
331 * \p size elements, already. The \p capacity must point to a variable denoting
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
332 * the current maximum number of elements the array can hold.
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
333 *
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
334 * If the capacity is insufficient to hold the new element, an attempt to
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
335 * increase the \p capacity is made and the new capacity is written back.
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
336 *
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
337 * @param target a pointer to the target array
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
338 * @param size a pointer to the size of the target array
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
339 * @param capacity a pointer to the capacity of the target array
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
340 * @param elem_size the size of one element
832
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
341 * @param elem a pointer to the element to add
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
342 * @param reallocator the array reallocator to use
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
343 * @return zero on success, non-zero on failure
818
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
344 */
2be8fe3d5a2d add cx_array_add() + fix type of cx_array_default_reallocator
Mike Becker <universe@uap-core.de>
parents: 817
diff changeset
345 #define cx_array_add(target, size, capacity, elem_size, elem, reallocator) \
998
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
346 cx_array_copy((void**)(target), size, capacity, 8*sizeof(*(size)), \
bb196054f3fd make cx_array_copy() support different types for size/capacity - fixes #492
Mike Becker <universe@uap-core.de>
parents: 993
diff changeset
347 *(size), elem, elem_size, 1, reallocator)
623
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
348
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
349 /**
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
350 * Convenience macro that uses cx_array_add() with a default layout and
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
351 * the specified reallocator.
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
352 *
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
353 * @param reallocator the array reallocator to use
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
354 * @param array the name of the array (NOT a pointer to the array)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
355 * @param elem the element to add (NOT a pointer, address is automatically taken)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
356 * @return zero on success, non-zero on failure
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
357 * @see CX_ARRAY_DECLARE()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
358 * @see cx_array_simple_add()
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
359 */
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
360 #define cx_array_simple_add_a(reallocator, array, elem) \
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
361 cx_array_simple_copy_a(reallocator, array, array##_size, &(elem), 1)
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
362
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
363 /**
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
364 * Convenience macro that uses cx_array_add() with a default layout and
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
365 * the default reallocator.
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
366 *
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
367 * @param array the name of the array (NOT a pointer to the array)
832
97df2e4c68fb make cx_array_simple_add() automatically take the address of the element
Mike Becker <universe@uap-core.de>
parents: 831
diff changeset
368 * @param elem the element to add (NOT a pointer, address is automatically taken)
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
369 * @return zero on success, non-zero on failure
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
370 * @see CX_ARRAY_DECLARE()
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
371 * @see cx_array_simple_add_a()
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
372 */
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
373 #define cx_array_simple_add(array, elem) \
999
84fc42b04d3b add cx_array_reserve() and several more array convenience functions
Mike Becker <universe@uap-core.de>
parents: 998
diff changeset
374 cx_array_simple_add_a(cx_array_default_reallocator, array, elem)
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
375
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
376 /**
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
377 * Inserts a sorted array into another sorted array.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
378 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
379 * If either the target or the source array is not already sorted with respect
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
380 * to the specified \p cmp_func, the behavior is undefined.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
381 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
382 * If the capacity is insufficient to hold the new data, a reallocation
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
383 * attempt is made.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
384 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
385 * @param target a pointer to the target array
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
386 * @param size a pointer to the size of the target array
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
387 * @param capacity a pointer to the capacity of the target array
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
388 * @param cmp_func the compare function for the elements
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
389 * @param src the source array
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
390 * @param elem_size the size of one element
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
391 * @param elem_count the number of elements to insert
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
392 * @param reallocator the array reallocator to use
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
393 * @return zero on success, non-zero on failure
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
394 */
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
395 cx_attr_nonnull
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
396 int cx_array_insert_sorted(
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
397 void **target,
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
398 size_t *size,
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
399 size_t *capacity,
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
400 cx_compare_func cmp_func,
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
401 const void *src,
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
402 size_t elem_size,
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
403 size_t elem_count,
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
404 struct cx_array_reallocator_s *reallocator
891
49d8cff6f0ee make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents: 890
diff changeset
405 );
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
406
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
407 /**
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
408 * Inserts an element into a sorted array.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
409 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
410 * If the target array is not already sorted with respect
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
411 * to the specified \p cmp_func, the behavior is undefined.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
412 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
413 * If the capacity is insufficient to hold the new data, a reallocation
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
414 * attempt is made.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
415 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
416 * @param target a pointer to the target array
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
417 * @param size a pointer to the size of the target array
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
418 * @param capacity a pointer to the capacity of the target array
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
419 * @param elem_size the size of one element
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
420 * @param elem a pointer to the element to add
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
421 * @param reallocator the array reallocator to use
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
422 * @return zero on success, non-zero on failure
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
423 */
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
424 #define cx_array_add_sorted(target, size, capacity, elem_size, elem, cmp_func, reallocator) \
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
425 cx_array_insert_sorted((void**)(target), size, capacity, cmp_func, elem, elem_size, 1, reallocator)
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
426
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
427 /**
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
428 * Convenience macro for cx_array_add_sorted() with a default
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
429 * layout and the default reallocator.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
430 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
431 * @param array the name of the array (NOT a pointer to the array)
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
432 * @param elem the element to add (NOT a pointer, address is automatically taken)
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
433 * @param cmp_func the compare function for the elements
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
434 * @return zero on success, non-zero on failure
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
435 * @see CX_ARRAY_DECLARE()
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
436 */
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
437 #define cx_array_simple_add_sorted(array, elem, cmp_func) \
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
438 cx_array_add_sorted(&array, &(array##_size), &(array##_capacity), \
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
439 sizeof((array)[0]), &(elem), cmp_func, cx_array_default_reallocator)
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
440
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
441 /**
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
442 * Convenience macro for cx_array_insert_sorted() with a default
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
443 * layout and the default reallocator.
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
444 *
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
445 * @param array the name of the array (NOT a pointer to the array)
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
446 * @param src pointer to the source array
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
447 * @param n number of elements in the source array
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
448 * @param cmp_func the compare function for the elements
986
38fa7e41194c simplify cx_array_copy() - fixes #474
Mike Becker <universe@uap-core.de>
parents: 985
diff changeset
449 * @return zero on success, non-zero on failure
883
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
450 * @see CX_ARRAY_DECLARE()
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
451 */
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
452 #define cx_array_simple_insert_sorted(array, src, n, cmp_func) \
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
453 cx_array_insert_sorted((void**)(&array), &(array##_size), &(array##_capacity), \
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
454 cmp_func, src, sizeof((array)[0]), n, cx_array_default_reallocator)
3012e9b4214e add low level cx_array_insert_sorted() and convenience macros
Mike Becker <universe@uap-core.de>
parents: 855
diff changeset
455
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
456
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
457 /**
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
458 * Searches the largest lower bound in a sorted array.
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
459 *
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
460 * In other words, this function returns the index of the largest element
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
461 * in \p arr that is less or equal to \p elem with respect to \p cmp_func.
885
878a450e79bd fixes incorrect result from cx_array_binary_search() when searched element is smaller than the entire array
Mike Becker <universe@uap-core.de>
parents: 884
diff changeset
462 * When no such element exists, \p size is returned.
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
463 *
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
464 * If \p elem is contained in the array, this is identical to
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
465 * #cx_array_binary_search().
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
466 *
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
467 * If the array is not sorted with respect to the \p cmp_func, the behavior
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
468 * is undefined.
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
469 *
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
470 * @param arr the array to search
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
471 * @param size the size of the array
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
472 * @param elem_size the size of one element
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
473 * @param elem the element to find
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
474 * @param cmp_func the compare function
887
e5181fe13b9c fix documentation
Mike Becker <universe@uap-core.de>
parents: 886
diff changeset
475 * @return the index of the largest lower bound, or \p size
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
476 */
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
477 cx_attr_nonnull
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
478 size_t cx_array_binary_search_inf(
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
479 const void *arr,
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
480 size_t size,
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
481 size_t elem_size,
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
482 const void *elem,
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
483 cx_compare_func cmp_func
891
49d8cff6f0ee make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents: 890
diff changeset
484 );
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
485
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
486 /**
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
487 * Searches an item in a sorted array.
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
488 *
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
489 * If the array is not sorted with respect to the \p cmp_func, the behavior
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
490 * is undefined.
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
491 *
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
492 * @param arr the array to search
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
493 * @param size the size of the array
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
494 * @param elem_size the size of one element
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
495 * @param elem the element to find
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
496 * @param cmp_func the compare function
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
497 * @return the index of the element in the array, or \p size if the element
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
498 * cannot be found
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
499 */
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
500 cx_attr_nonnull
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
501 size_t cx_array_binary_search(
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
502 const void *arr,
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
503 size_t size,
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
504 size_t elem_size,
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
505 const void *elem,
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
506 cx_compare_func cmp_func
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
507 );
884
d375d8056262 add cx_array_binary_search() - fixes #424
Mike Becker <universe@uap-core.de>
parents: 883
diff changeset
508
831
7970eac1c598 add convenience macros for cx_array_*
Mike Becker <universe@uap-core.de>
parents: 819
diff changeset
509 /**
886
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
510 * Searches the smallest upper bound in a sorted array.
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
511 *
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
512 * In other words, this function returns the index of the smallest element
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
513 * in \p arr that is greater or equal to \p elem with respect to \p cmp_func.
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
514 * When no such element exists, \p size is returned.
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
515 *
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
516 * If \p elem is contained in the array, this is identical to
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
517 * #cx_array_binary_search().
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
518 *
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
519 * If the array is not sorted with respect to the \p cmp_func, the behavior
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
520 * is undefined.
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
521 *
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
522 * @param arr the array to search
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
523 * @param size the size of the array
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
524 * @param elem_size the size of one element
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
525 * @param elem the element to find
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
526 * @param cmp_func the compare function
887
e5181fe13b9c fix documentation
Mike Becker <universe@uap-core.de>
parents: 886
diff changeset
527 * @return the index of the smallest upper bound, or \p size
886
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
528 */
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
529 cx_attr_nonnull
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
530 size_t cx_array_binary_search_sup(
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
531 const void *arr,
886
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
532 size_t size,
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
533 size_t elem_size,
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
534 const void *elem,
886
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
535 cx_compare_func cmp_func
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
536 );
886
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
537
5f5514bb104b also add a binary search for the supremum
Mike Becker <universe@uap-core.de>
parents: 885
diff changeset
538 /**
623
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
539 * Swaps two array elements.
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
540 *
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
541 * @param arr the array
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
542 * @param elem_size the element size
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
543 * @param idx1 index of first element
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
544 * @param idx2 index of second element
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
545 */
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
546 cx_attr_nonnull
623
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
547 void cx_array_swap(
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
548 void *arr,
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
549 size_t elem_size,
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
550 size_t idx1,
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
551 size_t idx2
891
49d8cff6f0ee make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents: 890
diff changeset
552 );
623
21082350a590 #219 array list: implement reverse
Mike Becker <universe@uap-core.de>
parents: 617
diff changeset
553
608
2e93521145ac proposal for a low level array copy
Mike Becker <universe@uap-core.de>
parents: 606
diff changeset
554 /**
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
555 * Allocates an array list for storing elements with \p elem_size bytes each.
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
556 *
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
557 * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
763
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
558 * cxListStorePointers() was called immediately after creation and the compare
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
559 * function will be automatically set to cx_cmp_ptr(), if none is given.
669
dce9b8450656 add docs for CX_STORE_POINTERS and remove cxHashMapCreateForPointers()
Mike Becker <universe@uap-core.de>
parents: 662
diff changeset
560 *
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
561 * @param allocator the allocator for allocating the list memory
989
8aa57a7fecc4 improve consistency for allocator arguments - fixes #485
Mike Becker <universe@uap-core.de>
parents: 986
diff changeset
562 * (if \c NULL, a default stdlib allocator will be used)
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
563 * @param comparator the comparator for the elements
763
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
564 * (if \c NULL, and the list is not storing pointers, sort and find
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
565 * functions will not work)
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
566 * @param elem_size the size of each element in bytes
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
567 * @param initial_capacity the initial number of elements the array can store
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
568 * @return the created list
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
569 */
985
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
570 cx_attr_nodiscard
68754c7de906 major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents: 953
diff changeset
571 cx_attr_malloc
993
b642eca4b956 make names of destroy and free functions consistent - fixes #484
Mike Becker <universe@uap-core.de>
parents: 989
diff changeset
572 cx_attr_dealloc(cxListFree, 1)
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
573 CxList *cxArrayListCreate(
890
54565fd74e74 move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents: 887
diff changeset
574 const CxAllocator *allocator,
677
b09aae58bba4 refactoring of collections to make use of destructors in map implementations
Mike Becker <universe@uap-core.de>
parents: 670
diff changeset
575 cx_compare_func comparator,
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
576 size_t elem_size,
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
577 size_t initial_capacity
670
4ad8ea3aee49 allow NULL for allocator and comparator
Mike Becker <universe@uap-core.de>
parents: 669
diff changeset
578 );
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
579
662
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
580 /**
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
581 * Allocates an array list for storing elements with \p elem_size bytes each.
662
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
582 *
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
583 * The list will use the cxDefaultAllocator and \em NO compare function.
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
584 * If you want to call functions that need a compare function, you have to
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
585 * set it immediately after creation or use cxArrayListCreate().
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
586 *
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
587 * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
763
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
588 * cxListStorePointers() was called immediately after creation and the compare
741a2040fa33 make cx_cmp_ptr default comparator for pointer lists - relates to #340
Mike Becker <universe@uap-core.de>
parents: 759
diff changeset
589 * function will be automatically set to cx_cmp_ptr().
669
dce9b8450656 add docs for CX_STORE_POINTERS and remove cxHashMapCreateForPointers()
Mike Becker <universe@uap-core.de>
parents: 662
diff changeset
590 *
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
591 * @param elem_size the size of each element in bytes
662
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
592 * @param initial_capacity the initial number of elements the array can store
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
593 * @return the created list
d0d95740071b add simple functions for creating lists
Mike Becker <universe@uap-core.de>
parents: 637
diff changeset
594 */
855
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
595 #define cxArrayListCreateSimple(elem_size, initial_capacity) \
35bcb3216c0d fix inconsistent use of item_size and elem_size
Mike Becker <universe@uap-core.de>
parents: 844
diff changeset
596 cxArrayListCreate(NULL, NULL, elem_size, initial_capacity)
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
597
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
598 #ifdef __cplusplus
628
1e2be40f0cb5 use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents: 623
diff changeset
599 } // extern "C"
606
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
600 #endif
314e9288af2f add array list tests
Mike Becker <universe@uap-core.de>
parents:
diff changeset
601
628
1e2be40f0cb5 use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents: 623
diff changeset
602 #endif // UCX_ARRAY_LIST_H

mercurial