2 * Copyright (c) 2009 The NetBSD Foundation, Inc.
5 * This code is derived from software contributed to The NetBSD Foundation
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
33 #define ARRAYS_CHECKED
37 #define arrayassert assert
39 #define arrayassert(x) ((void)(x))
42 ////////////////////////////////////////////////////////////
43 // type and base operations
50 struct array
*array_create(void);
51 void array_destroy(struct array
*);
52 void array_init(struct array
*);
53 void array_cleanup(struct array
*);
54 unsigned array_num(const struct array
*);
55 void *array_get(const struct array
*, unsigned index_
);
56 void array_set(const struct array
*, unsigned index_
, void *val
);
57 int array_setsize(struct array
*, unsigned num
);
58 int array_add(struct array
*, void *val
, unsigned *index_ret
);
59 int array_insert(struct array
*a
, unsigned index_
);
60 void array_remove(struct array
*a
, unsigned index_
);
62 ////////////////////////////////////////////////////////////
63 // inlining for base operations
66 #define ARRAYINLINE extern __attribute__((__gnu_inline__)) __inline
70 array_num(const struct array
*a
)
76 array_get(const struct array
*a
, unsigned index_
)
78 arrayassert(index_
< a
->num
);
83 array_set(const struct array
*a
, unsigned index_
, void *val
)
85 arrayassert(index_
< a
->num
);
90 array_add(struct array
*a
, void *val
, unsigned *index_ret
)
92 unsigned index_
= a
->num
;
93 if (array_setsize(a
, index_
+1)) {
97 if (index_ret
!= NULL
) {
103 ////////////////////////////////////////////////////////////
104 // bits for declaring and defining typed arrays
109 * DECLARRAY_BYTYPE(foo, bar) declares "struct foo", which is
110 * an array of pointers to "bar", plus the operations on it.
112 * DECLARRAY(foo) is equivalent to DECLARRAY_BYTYPE(fooarray, struct foo).
114 * DEFARRAY_BYTYPE and DEFARRAY are the same as DECLARRAY except that
115 * they define the operations, and both take an extra argument INLINE.
116 * For C99 this should be INLINE in header files and empty in the
117 * master source file, the same as the usage of ARRAYINLINE above and
120 * Example usage in e.g. item.h of some game:
122 * DECLARRAY_BYTYPE(stringarray, char);
127 * #define ITEMINLINE INLINE
130 * DEFARRAY_BYTYPE(stringarray, char, ITEMINLINE);
131 * DEFARRAY(potion, ITEMINLINE);
132 * DEFARRAY(sword, ITEMINLINE);
134 * Then item.c would do "#define ITEMINLINE" before including item.h.
137 #define DECLARRAY_BYTYPE(ARRAY, T) \
142 struct ARRAY *ARRAY##_create(void); \
143 void ARRAY##_destroy(struct ARRAY *a); \
144 void ARRAY##_init(struct ARRAY *a); \
145 void ARRAY##_cleanup(struct ARRAY *a); \
146 unsigned ARRAY##_num(const struct ARRAY *a); \
147 T *ARRAY##_get(const struct ARRAY *a, unsigned index_); \
148 void ARRAY##_set(struct ARRAY *a, unsigned index_, T *val); \
149 int ARRAY##_setsize(struct ARRAY *a, unsigned num); \
150 int ARRAY##_add(struct ARRAY *a, T *val, unsigned *index_ret); \
151 int ARRAY##_insert(struct ARRAY *a, unsigned index_); \
152 void ARRAY##_remove(struct ARRAY *a, unsigned index_)
155 #define DEFARRAY_BYTYPE(ARRAY, T, INLINE) \
157 ARRAY##_init(struct ARRAY *a) \
159 array_init(&a->arr); \
163 ARRAY##_cleanup(struct ARRAY *a) \
165 array_cleanup(&a->arr); \
169 ARRAY *ARRAY##_create(void) \
173 a = malloc(sizeof(*a)); \
182 ARRAY##_destroy(struct ARRAY *a) \
184 ARRAY##_cleanup(a); \
189 ARRAY##_num(const struct ARRAY *a) \
191 return array_num(&a->arr); \
195 ARRAY##_get(const struct ARRAY *a, unsigned index_) \
197 return (T *)array_get(&a->arr, index_); \
201 ARRAY##_set(struct ARRAY *a, unsigned index_, T *val) \
203 array_set(&a->arr, index_, (void *)val); \
207 ARRAY##_setsize(struct ARRAY *a, unsigned num) \
209 return array_setsize(&a->arr, num); \
213 ARRAY##_add(struct ARRAY *a, T *val, unsigned *ret) \
215 return array_add(&a->arr, (void *)val, ret); \
219 ARRAY##_insert(struct ARRAY *a, unsigned index_) \
221 return array_insert(&a->arr, index_); \
225 ARRAY##_remove(struct ARRAY *a, unsigned index_) \
227 return array_remove(&a->arr, index_); \
230 #define DECLARRAY(T) DECLARRAY_BYTYPE(T##array, struct T)
231 #define DEFARRAY(T, INLINE) DEFARRAY_BYTYPE(T##array, struct T, INLINE)
233 ////////////////////////////////////////////////////////////
236 DECLARRAY_BYTYPE(stringarray
, char);
237 DEFARRAY_BYTYPE(stringarray
, char, ARRAYINLINE
);