2 * Copyright (C) 2011 Joseph Adams <joeyadams3.14159@gmail.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
33 * Life cycle of a darray (dynamically-allocated array):
35 * darray(int) a = darray_new();
38 * struct {darray(int) a;} foo;
45 * .a = darray_lit({1, 2, 3})
48 * Typedefs for darrays of common types:
50 * darray_char, darray_schar, darray_uchar
51 * darray_short, darray_int, darray_long
52 * darray_ushort, darray_uint, darray_ulong
56 * T darray_item(darray(T) arr, size_t index);
57 * size_t darray_size(darray(T) arr);
58 * size_t darray_alloc(darray(T) arr);
59 * bool darray_empty(darray(T) arr);
61 * // Access raw memory, starting from the item in offset.
62 * // Not safe, be careful, etc.
63 * T* darray_mem(darray(T) arr, size_t offset);
65 * Insertion (single item):
67 * void darray_append(darray(T) arr, T item);
68 * void darray_prepend(darray(T) arr, T item);
69 * void darray_push(darray(T) arr, T item); // same as darray_append
71 * Insertion (multiple items):
73 * void darray_append_items(darray(T) arr, T *items, size_t count);
74 * void darray_prepend_items(darray(T) arr, T *items, size_t count);
76 * void darray_appends(darray(T) arr, [T item, [...]]);
77 * void darray_prepends(darray(T) arr, [T item, [...]]);
79 * // Same functionality as above, but does not require typeof.
80 * void darray_appends_t(darray(T) arr, #T, [T item, [...]]);
81 * void darray_prepends_t(darray(T) arr, #T, [T item, [...]]);
85 * T darray_pop(darray(T) arr | darray_size(arr) != 0);
86 * T* darray_pop_check(darray(T*) arr);
90 * void darray_from_items(darray(T) arr, T *items, size_t count);
91 * void darray_from_c(darray(T) arr, T c_array[N]);
95 * void darray_append_string(darray(char) arr, const char *str);
96 * void darray_append_lit(darray(char) arr, char stringLiteral[N+1]);
98 * void darray_prepend_string(darray(char) arr, const char *str);
99 * void darray_prepend_lit(darray(char) arr, char stringLiteral[N+1]);
101 * void darray_from_string(darray(T) arr, const char *str);
102 * void darray_from_lit(darray(char) arr, char stringLiteral[N+1]);
106 * void darray_resize(darray(T) arr, size_t newSize);
107 * void darray_resize0(darray(T) arr, size_t newSize);
109 * void darray_realloc(darray(T) arr, size_t newAlloc);
110 * void darray_growalloc(darray(T) arr, size_t newAlloc);
112 * void darray_make_room(darray(T) arr, size_t room);
116 * darray_foreach(T *&i, darray(T) arr) {...}
117 * darray_foreach_reverse(T *&i, darray(T) arr) {...}
119 * Except for darray_foreach and darray_foreach_reverse,
120 * all macros evaluate their non-darray arguments only once.
125 #define darray(type) struct {type *item; size_t size; size_t alloc;}
127 #define darray_new() {0,0,0}
128 #define darray_init(arr) do {(arr).item=0; (arr).size=0; (arr).alloc=0;} while(0)
129 #define darray_free(arr) do {free((arr).item); darray_init(arr);} while(0)
131 /* Only use for immutable darray - e.g. for static const initialzers. */
132 #define darray_lit(c_array) {(c_array), sizeof(c_array) / sizeof(*(c_array)), 0}
135 * Typedefs for darrays of common types. These are useful
136 * when you want to pass a pointer to an darray(T) around.
138 * The following will produce an incompatible pointer warning:
140 * void foo(darray(int) *arr);
141 * darray(int) arr = darray_new();
146 * void foo(darray_int *arr);
147 * darray_int arr = darray_new();
151 typedef darray(char) darray_char;
152 typedef darray(signed char) darray_schar;
153 typedef darray(unsigned char) darray_uchar;
155 typedef darray(short) darray_short;
156 typedef darray(int) darray_int;
157 typedef darray(long) darray_long;
159 typedef darray(unsigned short) darray_ushort;
160 typedef darray(unsigned int) darray_uint;
161 typedef darray(unsigned long) darray_ulong;
166 #define darray_item(arr, i) ((arr).item[i])
167 #define darray_size(arr) ((arr).size)
168 #define darray_alloc(arr) ((arr).alloc)
169 #define darray_empty(arr) ((arr).size == 0)
171 #define darray_mem(arr, offset) ((arr).item + (offset))
172 #define darray_same(arr1, arr2) ((arr1).item == (arr2).item)
174 /*** Insertion (single item) ***/
176 #define darray_append(arr, ...) do { \
177 darray_resize(arr, (arr).size+1); \
178 (arr).item[(arr).size-1] = (__VA_ARGS__); \
180 #define darray_prepend(arr, ...) do { \
181 darray_resize(arr, (arr).size+1); \
182 memmove((arr).item+1, (arr).item, ((arr).size-1)*sizeof(*(arr).item)); \
183 (arr).item[0] = (__VA_ARGS__); \
185 #define darray_push(arr, ...) darray_append(arr, __VA_ARGS__)
188 /*** Insertion (multiple items) ***/
190 #define darray_append_items(arr, items, count) do { \
191 size_t __count = (count), __oldSize = (arr).size; \
192 darray_resize(arr, __oldSize + __count); \
193 memcpy((arr).item + __oldSize, items, __count * sizeof(*(arr).item)); \
196 #define darray_prepend_items(arr, items, count) do { \
197 size_t __count = (count), __oldSize = (arr).size; \
198 darray_resize(arr, __count + __oldSize); \
199 memmove((arr).item + __count, (arr).item, __oldSize * sizeof(*(arr).item)); \
200 memcpy((arr).item, items, __count * sizeof(*(arr).item)); \
203 #define darray_append_items_nullterminate(arr, items, count) do { \
204 size_t __count = (count), __oldSize = (arr).size; \
205 darray_resize(arr, __oldSize + __count + 1); \
206 memcpy((arr).item + __oldSize, items, __count * sizeof(*(arr).item)); \
207 (arr).item[--(arr).size] = 0; \
210 #define darray_prepend_items_nullterminate(arr, items, count) do { \
211 size_t __count = (count), __oldSize = (arr).size; \
212 darray_resize(arr, __count + __oldSize + 1); \
213 memmove((arr).item + __count, (arr).item, __oldSize * sizeof(*(arr).item)); \
214 memcpy((arr).item, items, __count * sizeof(*(arr).item)); \
215 (arr).item[--(arr).size] = 0; \
219 #define darray_appends(arr, ...) darray_appends_t(arr, typeof((*(arr).item)), __VA_ARGS__)
220 #define darray_prepends(arr, ...) darray_prepends_t(arr, typeof((*(arr).item)), __VA_ARGS__)
223 #define darray_appends_t(arr, type, ...) do { \
224 type __src[] = {__VA_ARGS__}; \
225 darray_append_items(arr, __src, sizeof(__src)/sizeof(*__src)); \
227 #define darray_prepends_t(arr, type, ...) do { \
228 type __src[] = {__VA_ARGS__}; \
229 darray_prepend_items(arr, __src, sizeof(__src)/sizeof(*__src)); \
235 /* Warning: Do not call darray_pop on an empty darray. */
236 #define darray_pop(arr) ((arr).item[--(arr).size])
237 #define darray_pop_check(arr) ((arr).size ? darray_pop(arr) : NULL)
240 /*** Replacement ***/
242 #define darray_from_items(arr, items, count) do {size_t __count = (count); darray_resize(arr, __count); memcpy((arr).item, items, __count*sizeof(*(arr).item));} while(0)
243 #define darray_from_c(arr, c_array) darray_from_items(arr, c_array, sizeof(c_array)/sizeof(*(c_array)))
244 #define darray_copy(arr_to, arr_from) darray_from_items(arr_to, (arr_from).item, (arr_from).size)
247 /*** String buffer ***/
249 #define darray_append_string(arr, str) do {const char *__str = (str); darray_append_items(arr, __str, strlen(__str)+1); (arr).size--;} while(0)
250 #define darray_append_lit(arr, stringLiteral) do {darray_append_items(arr, stringLiteral, sizeof(stringLiteral)); (arr).size--;} while(0)
252 #define darray_prepend_string(arr, str) do { \
253 const char *__str = (str); \
254 darray_prepend_items_nullterminate(arr, __str, strlen(__str)); \
256 #define darray_prepend_lit(arr, stringLiteral) \
257 darray_prepend_items_nullterminate(arr, stringLiteral, sizeof(stringLiteral) - 1)
259 #define darray_from_string(arr, str) do {const char *__str = (str); darray_from_items(arr, __str, strlen(__str)+1); (arr).size--;} while(0)
260 #define darray_from_lit(arr, stringLiteral) do {darray_from_items(arr, stringLiteral, sizeof(stringLiteral)); (arr).size--;} while(0)
263 /*** Size management ***/
265 #define darray_resize(arr, newSize) darray_growalloc(arr, (arr).size = (newSize))
266 #define darray_resize0(arr, newSize) do { \
267 size_t __oldSize = (arr).size, __newSize = (newSize); \
268 (arr).size = __newSize; \
269 if (__newSize > __oldSize) { \
270 darray_growalloc(arr, __newSize); \
271 memset(&(arr).item[__oldSize], 0, (__newSize - __oldSize) * sizeof(*(arr).item)); \
275 #define darray_realloc(arr, newAlloc) do { \
276 (arr).item = realloc((arr).item, ((arr).alloc = (newAlloc)) * sizeof(*(arr).item)); \
278 #define darray_growalloc(arr, need) do { \
279 size_t __need = (need); \
280 if (__need > (arr).alloc) \
281 darray_realloc(arr, darray_next_alloc((arr).alloc, __need)); \
284 #if HAVE_STATEMENT_EXPR==1
285 #define darray_make_room(arr, room) ({size_t newAlloc = (arr).size+(room); if ((arr).alloc<newAlloc) darray_realloc(arr, newAlloc); (arr).item+(arr).size; })
288 static inline size_t darray_next_alloc(size_t alloc, size_t need)
301 * darray_foreach(T *&i, darray(T) arr) {...}
303 * Traverse a darray. `i` must be declared in advance as a pointer to an item.
305 #define darray_foreach(i, arr) \
306 for ((i) = &(arr).item[0]; (i) < &(arr).item[(arr).size]; (i)++)
309 * darray_foreach_reverse(T *&i, darray(T) arr) {...}
311 * Like darray_foreach, but traverse in reverse order.
313 #define darray_foreach_reverse(i, arr) \
314 for ((i) = &(arr).item[(arr).size]; (i)-- > &(arr).item[0]; )
317 #endif /* CCAN_DARRAY_H */
321 darray_growalloc(arr, newAlloc) sees if the darray can currently hold newAlloc items;
322 if not, it increases the alloc to satisfy this requirement, allocating slack
323 space to avoid having to reallocate for every size increment.
325 darray_from_string(arr, str) copies a string to an darray_char.
327 darray_push(arr, item) pushes an item to the end of the darray.
328 darray_pop(arr) pops it back out. Be sure there is at least one item in the darray before calling.
329 darray_pop_check(arr) does the same as darray_pop, but returns NULL if there are no more items left in the darray.
331 darray_make_room(arr, room) ensures there's 'room' elements of space after the end of the darray, and it returns a pointer to this space.
332 Currently requires HAVE_STATEMENT_EXPR, but I plan to remove this dependency by creating an inline function.
334 The following require HAVE_TYPEOF==1 :
336 darray_appends(arr, item0, item1...) appends a collection of comma-delimited items to the darray.
337 darray_prepends(arr, item0, item1...) prepends a collection of comma-delimited items to the darray.\
345 darray_appends(arr, 0,1,2,3,4);
346 darray_appends(arr, -5,-4,-3,-2,-1);
347 darray_foreach(i, arr)
354 typedef struct {int n,d;} Fraction;
355 darray(Fraction) fractions;
358 darray_appends(fractions, {3,4}, {3,5}, {2,1});
359 darray_foreach(i, fractions)
360 printf("%d/%d\n", i->n, i->d);
362 darray_free(fractions);