check_type: fix incorrect documentation.
[ccan] / ccan / darray / darray.h
1 /*
2  * Copyright (C) 2011 Joseph Adams <joeyadams3.14159@gmail.com>
3  *
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:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
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
20  * THE SOFTWARE.
21  */
22
23 #ifndef CCAN_DARRAY_H
24 #define CCAN_DARRAY_H
25
26 #include <stdlib.h>
27 #include <string.h>
28 #include "config.h"
29
30 /*
31  * SYNOPSIS
32  *
33  * Life cycle of a darray (dynamically-allocated array):
34  *
35  *     darray(int) a = darray_new();
36  *     darray_free(a);
37  *
38  *     struct {darray(int) a;} foo;
39  *     darray_init(foo.a);
40  *     darray_free(foo.a);
41  *
42  * Typedefs for darrays of common types:
43  *
44  *     darray_char, darray_schar, darray_uchar
45  *     darray_short, darray_int, darray_long
46  *     darray_ushort, darray_uint, darray_ulong
47  *
48  * Access:
49  *
50  *     T      darray_item(darray(T) arr, size_t index);
51  *     size_t darray_size(darray(T) arr);
52  *     size_t darray_alloc(darray(T) arr);
53  *     bool   darray_empty(darray(T) arr);
54  *
55  * Insertion (single item):
56  *
57  *     void   darray_append(darray(T) arr, T item);
58  *     void   darray_prepend(darray(T) arr, T item);
59  *     void   darray_push(darray(T) arr, T item); // same as darray_append
60  *
61  * Insertion (multiple items):
62  *
63  *     void   darray_append_items(darray(T) arr, T *items, size_t count);
64  *     void   darray_prepend_items(darray(T) arr, T *items, size_t count);
65  *
66  *     void   darray_appends(darray(T) arr, [T item, [...]]);
67  *     void   darray_prepends(darray(T) arr, [T item, [...]]);
68  *
69  *     // Same functionality as above, but does not require typeof.
70  *     void   darray_appends_t(darray(T) arr, #T, [T item, [...]]);
71  *     void   darray_prepends_t(darray(T) arr, #T, [T item, [...]]);
72  *
73  * Removal:
74  *
75  *     T      darray_pop(darray(T) arr | darray_size(arr) != 0);
76  *     T*     darray_pop_check(darray(T*) arr);
77  *
78  * Replacement:
79  *
80  *     void   darray_from_items(darray(T) arr, T *items, size_t count);
81  *     void   darray_from_c(darray(T) arr, T c_array[N]);
82  *
83  * String buffer:
84  *
85  *     void   darray_append_string(darray(char) arr, const char *str);
86  *     void   darray_append_lit(darray(char) arr, char stringLiteral[N+1]);
87  *
88  *     void   darray_prepend_string(darray(char) arr, const char *str);
89  *     void   darray_prepend_lit(darray(char) arr, char stringLiteral[N+1]);
90  *
91  *     void   darray_from_string(darray(T) arr, const char *str);
92  *     void   darray_from_lit(darray(char) arr, char stringLiteral[N+1]);
93  *
94  * Size management:
95  *
96  *     void   darray_resize(darray(T) arr, size_t newSize);
97  *     void   darray_resize0(darray(T) arr, size_t newSize);
98  *
99  *     void   darray_realloc(darray(T) arr, size_t newAlloc);
100  *     void   darray_growalloc(darray(T) arr, size_t newAlloc);
101  *
102  *     void   darray_make_room(darray(T) arr, size_t room);
103  *
104  * Traversal:
105  *
106  *     darray_foreach(T *&i, darray(T) arr) {...}
107  *     darray_foreach_reverse(T *&i, darray(T) arr) {...}
108  *
109  * Except for darray_foreach and darray_foreach_reverse,
110  * all macros evaluate their non-darray arguments only once.
111  */
112
113 /*** Life cycle ***/
114
115 #define darray(type) struct {type *item; size_t size; size_t alloc;}
116
117 #define darray_new() {0,0,0}
118 #define darray_init(arr) do {(arr).item=0; (arr).size=0; (arr).alloc=0;} while(0)
119 #define darray_free(arr) do {free((arr).item);} while(0)
120
121
122 /*
123  * Typedefs for darrays of common types.  These are useful
124  * when you want to pass a pointer to an darray(T) around.
125  *
126  * The following will produce an incompatible pointer warning:
127  *
128  *     void foo(darray(int) *arr);
129  *     darray(int) arr = darray_new();
130  *     foo(&arr);
131  *
132  * The workaround:
133  *
134  *     void foo(darray_int *arr);
135  *     darray_int arr = darray_new();
136  *     foo(&arr);
137  */
138
139 typedef darray(char)           darray_char;
140 typedef darray(signed char)    darray_schar;
141 typedef darray(unsigned char)  darray_uchar;
142
143 typedef darray(short)          darray_short;
144 typedef darray(int)            darray_int;
145 typedef darray(long)           darray_long;
146
147 typedef darray(unsigned short) darray_ushort;
148 typedef darray(unsigned int)   darray_uint;
149 typedef darray(unsigned long)  darray_ulong;
150
151
152 /*** Access ***/
153
154 #define darray_item(arr, i) ((arr).item[i])
155 #define darray_size(arr)    ((arr).size)
156 #define darray_alloc(arr)   ((arr).alloc)
157 #define darray_empty(arr)   ((arr).size == 0)
158
159
160 /*** Insertion (single item) ***/
161
162 #define darray_append(arr, ...) do { \
163                 darray_resize(arr, (arr).size+1); \
164                 (arr).item[(arr).size-1] = (__VA_ARGS__); \
165         } while(0)
166 #define darray_prepend(arr, ...) do { \
167                 darray_resize(arr, (arr).size+1); \
168                 memmove((arr).item+1, (arr).item, ((arr).size-1)*sizeof(*(arr).item)); \
169                 (arr).item[0] = (__VA_ARGS__); \
170         } while(0)
171 #define darray_push(arr, ...) darray_append(arr, __VA_ARGS__)
172
173
174 /*** Insertion (multiple items) ***/
175
176 #define darray_append_items(arr, items, count) do { \
177                 size_t __count = (count), __oldSize = (arr).size; \
178                 darray_resize(arr, __oldSize + __count); \
179                 memcpy((arr).item + __oldSize, items, __count * sizeof(*(arr).item)); \
180         } while(0)
181
182 #define darray_prepend_items(arr, items, count) do { \
183                 size_t __count = (count), __oldSize = (arr).size; \
184                 darray_resize(arr, __count + __oldSize); \
185                 memmove((arr).item + __count, (arr).item, __oldSize * sizeof(*(arr).item)); \
186                 memcpy((arr).item, items, __count * sizeof(*(arr).item)); \
187         } while(0)
188
189 #define darray_append_items_nullterminate(arr, items, count) do { \
190                 size_t __count = (count), __oldSize = (arr).size; \
191                 darray_resize(arr, __oldSize + __count + 1); \
192                 memcpy((arr).item + __oldSize, items, __count * sizeof(*(arr).item)); \
193                 (arr).item[--(arr).size] = 0; \
194         } while(0)
195
196 #define darray_prepend_items_nullterminate(arr, items, count) do { \
197                 size_t __count = (count), __oldSize = (arr).size; \
198                 darray_resize(arr, __count + __oldSize + 1); \
199                 memmove((arr).item + __count, (arr).item, __oldSize * sizeof(*(arr).item)); \
200                 memcpy((arr).item, items, __count * sizeof(*(arr).item)); \
201                 (arr).item[--(arr).size] = 0; \
202         } while(0)
203
204 #if HAVE_TYPEOF
205 #define darray_appends(arr, ...) darray_appends_t(arr, typeof((*(arr).item)), __VA_ARGS__)
206 #define darray_prepends(arr, ...) darray_prepends_t(arr, typeof((*(arr).item)), __VA_ARGS__)
207 #endif
208
209 #define darray_appends_t(arr, type, ...) do { \
210                 type __src[] = {__VA_ARGS__}; \
211                 darray_append_items(arr, __src, sizeof(__src)/sizeof(*__src)); \
212         } while(0)
213 #define darray_prepends_t(arr, type, ...) do { \
214                 type __src[] = {__VA_ARGS__}; \
215                 darray_prepend_items(arr, __src, sizeof(__src)/sizeof(*__src)); \
216         } while(0)
217
218
219 /*** Removal ***/
220
221 /* Warning: Do not call darray_pop on an empty darray. */
222 #define darray_pop(arr) ((arr).item[--(arr).size])
223 #define darray_pop_check(arr) ((arr).size ? darray_pop(arr) : NULL)
224
225
226 /*** Replacement ***/
227
228 #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)
229 #define darray_from_c(arr, c_array) darray_from_items(arr, c_array, sizeof(c_array)/sizeof(*(c_array)))
230
231
232 /*** String buffer ***/
233
234 #define darray_append_string(arr, str) do {const char *__str = (str); darray_append_items(arr, __str, strlen(__str)+1); (arr).size--;} while(0)
235 #define darray_append_lit(arr, stringLiteral) do {darray_append_items(arr, stringLiteral, sizeof(stringLiteral)); (arr).size--;} while(0)
236
237 #define darray_prepend_string(arr, str) do { \
238                 const char *__str = (str); \
239                 darray_prepend_items_nullterminate(arr, __str, strlen(__str)); \
240         } while(0)
241 #define darray_prepend_lit(arr, stringLiteral) \
242         darray_prepend_items_nullterminate(arr, stringLiteral, sizeof(stringLiteral) - 1)
243
244 #define darray_from_string(arr, str) do {const char *__str = (str); darray_from_items(arr, __str, strlen(__str)+1); (arr).size--;} while(0)
245 #define darray_from_lit(arr, stringLiteral) do {darray_from_items(arr, stringLiteral, sizeof(stringLiteral)); (arr).size--;} while(0)
246
247
248 /*** Size management ***/
249
250 #define darray_resize(arr, newSize) darray_growalloc(arr, (arr).size = (newSize))
251 #define darray_resize0(arr, newSize) do { \
252                 size_t __oldSize = (arr).size, __newSize = (newSize); \
253                 (arr).size = __newSize; \
254                 if (__newSize > __oldSize) { \
255                         darray_growalloc(arr, __newSize); \
256                         memset(&(arr).item[__oldSize], 0, (__newSize - __oldSize) * sizeof(*(arr).item)); \
257                 } \
258         } while(0)
259
260 #define darray_realloc(arr, newAlloc) do { \
261                 (arr).item = realloc((arr).item, ((arr).alloc = (newAlloc)) * sizeof(*(arr).item)); \
262         } while(0)
263 #define darray_growalloc(arr, need) do { \
264                 size_t __need = (need); \
265                 if (__need > (arr).alloc) \
266                         darray_realloc(arr, darray_next_alloc((arr).alloc, __need)); \
267         } while(0)
268
269 #if HAVE_STATEMENT_EXPR==1
270 #define darray_make_room(arr, room) ({size_t newAlloc = (arr).size+(room); if ((arr).alloc<newAlloc) darray_realloc(arr, newAlloc); (arr).item+(arr).size; })
271 #endif
272
273 static inline size_t darray_next_alloc(size_t alloc, size_t need)
274 {
275         if (alloc == 0)
276                 alloc = 1;
277         while (alloc < need)
278                 alloc *= 2;
279         return alloc;
280 }
281
282
283 /*** Traversal ***/
284
285 /*
286  * darray_foreach(T *&i, darray(T) arr) {...}
287  *
288  * Traverse a darray.  `i` must be declared in advance as a pointer to an item.
289  */
290 #define darray_foreach(i, arr) \
291         for ((i) = &(arr).item[0]; (i) < &(arr).item[(arr).size]; (i)++)
292
293 /*
294  * darray_foreach_reverse(T *&i, darray(T) arr) {...}
295  *
296  * Like darray_foreach, but traverse in reverse order.
297  */
298 #define darray_foreach_reverse(i, arr) \
299         for ((i) = &(arr).item[(arr).size]; (i)-- > &(arr).item[0]; )
300
301
302 #endif /* CCAN_DARRAY_H */
303
304 /*
305
306 darray_growalloc(arr, newAlloc) sees if the darray can currently hold newAlloc items;
307         if not, it increases the alloc to satisfy this requirement, allocating slack
308         space to avoid having to reallocate for every size increment.
309
310 darray_from_string(arr, str) copies a string to an darray_char.
311
312 darray_push(arr, item) pushes an item to the end of the darray.
313 darray_pop(arr) pops it back out.  Be sure there is at least one item in the darray before calling.
314 darray_pop_check(arr) does the same as darray_pop, but returns NULL if there are no more items left in the darray.
315
316 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.
317 Currently requires HAVE_STATEMENT_EXPR, but I plan to remove this dependency by creating an inline function.
318
319 The following require HAVE_TYPEOF==1 :
320
321 darray_appends(arr, item0, item1...) appends a collection of comma-delimited items to the darray.
322 darray_prepends(arr, item0, item1...) prepends a collection of comma-delimited items to the darray.\
323
324
325 Examples:
326
327         darray(int)  arr;
328         int        *i;
329         
330         darray_appends(arr, 0,1,2,3,4);
331         darray_appends(arr, -5,-4,-3,-2,-1);
332         darray_foreach(i, arr)
333                 printf("%d ", *i);
334         printf("\n");
335         
336         darray_free(arr);
337         
338
339         typedef struct {int n,d;} Fraction;
340         darray(Fraction) fractions;
341         Fraction        *i;
342         
343         darray_appends(fractions, {3,4}, {3,5}, {2,1});
344         darray_foreach(i, fractions)
345                 printf("%d/%d\n", i->n, i->d);
346         
347         darray_free(fractions);
348 */