Use -O not -O3: reduces ccan/tdb test time from 24 to 18 seconds.
[ccan] / ccan / array / array.h
1 /*
2         Copyright (c) 2009  Joseph A. Adams
3         All rights reserved.
4         
5         Redistribution and use in source and binary forms, with or without
6         modification, are permitted provided that the following conditions
7         are met:
8         1. Redistributions of source code must retain the above copyright
9            notice, this list of conditions and the following disclaimer.
10         2. Redistributions in binary form must reproduce the above copyright
11            notice, this list of conditions and the following disclaimer in the
12            documentation and/or other materials provided with the distribution.
13         3. The name of the author may not be used to endorse or promote products
14            derived from this software without specific prior written permission.
15         
16         THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17         IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18         OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19         IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20         INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21         NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22         DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23         THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24         (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25         THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifndef CCAN_ARRAY_H
29 #define CCAN_ARRAY_H
30
31 #define ARRAY_USE_TALLOC
32
33 #include <stdlib.h>
34 #include <string.h>
35 #include "config.h"
36
37 #ifdef ARRAY_USE_TALLOC
38 #include <ccan/talloc/talloc.h>
39 #endif
40
41 #ifndef HAVE_ATTRIBUTE_MAY_ALIAS
42 #define HAVE_ATTRIBUTE_MAY_ALIAS 1
43 #endif
44
45 //Use the array_alias macro to indicate that a pointer has changed but strict aliasing rules are too stupid to know it
46 #if HAVE_ATTRIBUTE_MAY_ALIAS==1
47 #define array_alias(ptr) /* nothing */
48 #define array(type) struct {type *item; size_t size; size_t alloc;} __attribute__((__may_alias__))
49 #else
50 #define array_alias(ptr) qsort(ptr, 0, 1, array_alias_helper) //hack
51 #define array(type) struct {type *item; size_t size; size_t alloc;}
52 #endif
53
54 //We call allocator functions directly
55 #ifndef ARRAY_USE_TALLOC
56
57 #define array_new() {0,0,0}
58 #define array_init(array) do {(array).item=0; (array).size=0; (array).alloc=0;} while(0)
59 #define array_realloc(array, newAlloc) do {(array).item = realloc((array).item, ((array).alloc = (newAlloc))*sizeof(*(array).item));} while(0)
60 #define array_free(array) do {free((array).item);} while(0)
61
62 #else
63
64 //note:  the allocations are given an extra byte to prevent free (and thus loss of ctx) on realloc to size 0
65
66 #define array_new(ctx) {talloc_size(ctx,1), 0,0}
67 #define array_init(array, ctx) do {(array).item=talloc_size(ctx,1); (array).size=0; (array).alloc=0;} while(0)
68 #define array_realloc(array, newAlloc) do {(array).item = talloc_realloc_size(NULL, (array).item, ((array).alloc = (newAlloc))*sizeof(*(array).item) +1);} while(0)
69 #define array_free(array) do {talloc_free((array).item);} while(0)
70
71 #endif
72
73
74 //We call helper functions
75 #define array_resize(array, newSize) do {(array).size = (newSize); if ((array).size > (array).alloc) { array_resize_helper((array_char*)&(array), sizeof(*(array).item)); array_alias(&(array));}} while(0)
76 #define array_resize0(array, newSize) do {array_resize0_helper((array_char*)&(array), sizeof(*(array).item), newSize);} while(0)
77 #define array_prepend_lit(array, stringLiteral) do {array_insert_items_helper((array_char*)&(array), sizeof(*(array).item), 0, stringLiteral, sizeof(stringLiteral)-1, 1); array_alias(&(array)); (array).item[--(array).size] = 0;} while(0)
78 #define array_prepend_string(array, str) do {const char *__str = (str); size_t __len = strlen(__str); array_insert_items_helper((array_char*)&(array), sizeof(*(array).item), 0, __str, __len, 1); array_alias(&(array)); (array).item[--(array).size] = 0;} while(0)
79 #define array_prepend_items(array, items, count) do {array_insert_items_helper((array_char*)&(array), sizeof(*(array).item), 0, items, count, 0); array_alias(&(array));} while(0)
80
81
82 //We call other array_* macros
83 #define array_from_c(array, c_array) array_from_items(array, c_array, sizeof(c_array)/sizeof(*(c_array)))
84 #define array_from_lit(array, stringLiteral) do {array_from_items(array, stringLiteral, sizeof(stringLiteral)); (array).size--;} while(0)
85 #define array_from_string(array, str) do {const char *__str = (str); array_from_items(array, __str, strlen(__str)+1); (array).size--;} while(0)
86 #define array_from_items(array, items, count) do {size_t __count = (count); array_resize(array, __count); memcpy((array).item, items, __count*sizeof(*(array).item));} while(0)
87 #define array_append(array, ...) do {array_resize(array, (array).size+1); (array).item[(array).size-1] = (__VA_ARGS__);} while(0)
88 #define array_append_string(array, str) do {const char *__str = (str); array_append_items(array, __str, strlen(__str)+1); (array).size--;} while(0)
89 #define array_append_lit(array, stringLiteral) do {array_append_items(array, stringLiteral, sizeof(stringLiteral)); (array).size--;} while(0)
90 #define array_append_items(array, items, count) do {size_t __count = (count); array_resize(array, (array).size+__count); memcpy((array).item+(array).size-__count, items, __count*sizeof(*(array).item));} while(0)
91 #define array_prepend(array, ...) do {array_resize(array, (array).size+1); memmove((array).item+1, (array).item, ((array).size-1)*sizeof(*(array).item)); *(array).item = (__VA_ARGS__);} while(0)
92 #define array_push(array, ...) array_append(array, __VA_ARGS__)
93 #define array_pop_check(array) ((array).size ? array_pop(array) : NULL)
94
95 #define array_growalloc(array, newAlloc) do {size_t __newAlloc=(newAlloc); if (__newAlloc > (array).alloc) array_realloc(array, (__newAlloc+63)&~63); } while(0)
96 #if HAVE_STATEMENT_EXPR==1
97 #define array_make_room(array, room) ({size_t newAlloc = (array).size+(room); if ((array).alloc<newAlloc) array_realloc(array, newAlloc); (array).item+(array).size; })
98 #endif
99
100
101 //We do just fine by ourselves
102 #define array_pop(array) ((array).item[--(array).size])
103
104
105 #if HAVE_TYPEOF==1
106 #define array_appends(array, ...) do {typeof((*(array).item)) __src[] = {__VA_ARGS__}; array_append_items(array, __src, sizeof(__src)/sizeof(*__src));} while(0)
107 #define array_prepends(array, ...) do {typeof((*(array).item)) __src[] = {__VA_ARGS__}; array_prepend_items(array, __src, sizeof(__src)/sizeof(*__src));} while(0)
108 #define array_for(var, array, ...) do {typeof(*(array).item) *var=(void*)(array).item; size_t _r=(array).size, _i=0; for (;_r--;_i++, var++) { __VA_ARGS__ ;} } while(0)
109 #define array_rof(var, array, ...) do {typeof(*(array).item) *var=(void*)(array).item; size_t _i=(array).size, _r=0; var += _i; for (;_i--;_r++) { var--; __VA_ARGS__ ;} } while(0)
110 #endif
111
112
113 typedef array(char) array_char;
114
115 void array_resize_helper(array_char *a, size_t itemSize);
116 void array_resize0_helper(array_char *a, size_t itemSize, size_t newSize);
117 void array_insert_items_helper(array_char *a, size_t itemSize, size_t pos, const void *items, size_t count, size_t tailSize);
118         //Note:  there is no array_insert_items yet, but it wouldn't be too hard to add.
119
120 int array_alias_helper(const void *a, const void *b);
121
122 #endif
123
124 /*
125
126 array_growalloc(array, newAlloc) sees if the array can currently hold newAlloc items;
127         if not, it increases the alloc to satisfy this requirement, allocating slack
128         space to avoid having to reallocate for every size increment.
129
130 array_from_string(array, str) copys a string to an array_char.
131
132 array_push(array, item) pushes an item to the end of the array.
133 array_pop_nocheck(array) pops it back out.  Be sure there is at least one item in the array before calling.
134 array_pop(array) does the same as array_pop_nocheck, but returns NULL if there are no more items left in the array.
135
136 array_make_room(array, room) ensures there's 'room' elements of space after the end of the array, and it returns a pointer to this space.
137 Currently requires HAVE_STATEMENT_EXPR, but I plan to remove this dependency by creating an inline function.
138
139 The following require HAVE_TYPEOF==1 :
140
141 array_appends(array, item0, item1...) appends a collection of comma-delimited items to the array.
142 array_prepends(array, item0, item1...) prepends a collection of comma-delimited items to the array.
143 array_for(var, array, commands...) iterates forward through the items in the array using var.  var is a pointer to an item.
144 array_rof(var, array, commands...) iterates backward through the items in the array using var.  var is a pointer to an item.
145
146 Examples:
147
148 array(int) array;
149 array_appends(array, 0,1,2,3,4);
150 array_appends(array, -5,-4,-3,-2,-1);
151 array_for(i, array, printf("%d ", *i));
152 printf("\n");
153 array_free(array);
154
155 array(struct {int n,d;}) fractions;
156 array_appends(fractions, {3,4}, {3,5}, {2,1});
157 array_for(i, fractions, printf("%d/%d\n", i->n, i->d));
158 array_free(fractions);
159 */
160
161 /*
162
163 Direct tests:
164
165 array_push
166 array_prepend
167 array_from_c
168 array_for
169 array_rof
170 array_from_lit
171 array_append_lit
172 array_prepend_lit
173 array_append_string
174 array_prepend_string
175 array_from_string
176 array_resize0
177 array_pop_nocheck
178 array_realloc
179 array_growalloc
180 array_make_room
181 array_pop
182 array_appends
183 array_prepends
184
185 Indirect tests:
186
187 array_append <- array_push
188 array_resize <- array_append
189 array_from_items <- array_from_c, array_from_lit, array_from_string
190 array_append_items <- array_append_string, array_append_lit
191 array_prepend_items <- array_prepends
192
193 Untested:
194
195 */