Mercurial > code
annotate array.c @ 124:5917096facb9
Use enum and add #ifdef __cplusplus
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 07 Mar 2012 09:50:41 +0100 |
parents | 59745a235d16 |
children | c6d9eb5702e8 |
rev | line source |
---|---|
62 | 1 /* |
2 * array.c -- manipulate dynamic arrays | |
3 * | |
98 | 4 * Copyright (c) 2011, 2012, David Demelier <markand@malikania.fr> |
62 | 5 * |
6 * Permission to use, copy, modify, and/or distribute this software for any | |
7 * purpose with or without fee is hereby granted, provided that the above | |
8 * copyright notice and this permission notice appear in all copies. | |
9 * | |
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
17 */ | |
18 | |
19 #include <stdio.h> | |
20 #include <stdlib.h> | |
21 #include <string.h> | |
22 | |
23 #include "array.h" | |
24 | |
25 #define OFFSET(x) (arr->unit * (x)) | |
26 | |
124
5917096facb9
Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
123
diff
changeset
|
27 static int grow(struct array *); |
62 | 28 |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
29 int |
93
9ebea85c7765
Use pointer instead of copying variable in ARRAY_FOREACH, then you can modify it
David Demelier <markand@malikania.fr>
parents:
92
diff
changeset
|
30 array_init(struct array *arr, size_t unit) |
62 | 31 { |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
32 if (unit == 0) |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
33 return -1; |
62 | 34 |
35 arr->unit = unit; | |
36 arr->size = OFFSET(arr->bsize); | |
37 | |
92 | 38 /* Set defaults if needed */ |
39 arr->bsize = (arr->bsize <= 0) ? ARRAY_DEFAULT_BSIZE : arr->bsize; | |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
40 arr->malloc = (arr->malloc == NULL) ? &malloc : arr->malloc; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
41 arr->realloc = (arr->realloc == NULL) ? &realloc : arr->realloc; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
42 |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
43 if ((arr->data = arr->malloc(arr->size)) == NULL) |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
44 return -1; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
45 |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
46 return 0; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
47 } |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
48 |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
49 /* |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
50 * Valid options that can be set for an array : |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
51 * l -> optional array block size of type int |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
52 * m -> malloc function that must matches void * (*malloc)(size_t) |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
53 * r -> realloc function that must matches void * (*realloc)(void *, size_t) |
118 | 54 * t -> type of array of type int |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
55 */ |
62 | 56 |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
57 void |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
58 array_set(struct array *arr, const char *fmt, ...) |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
59 { |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
60 va_list ap; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
61 const char *p; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
62 |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
63 va_start(ap, fmt); |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
64 for (p = fmt; *p != '\0'; ++p) |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
65 switch (*p) { |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
66 case 'l': |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
67 arr->bsize = va_arg(ap, int); |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
68 break; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
69 case 'm': |
93
9ebea85c7765
Use pointer instead of copying variable in ARRAY_FOREACH, then you can modify it
David Demelier <markand@malikania.fr>
parents:
92
diff
changeset
|
70 arr->malloc = va_arg(ap, void *(*)(size_t)); |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
71 break; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
72 case 'r': |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
73 arr->realloc = va_arg(ap, void *(*)(void *, size_t)); |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
74 break; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
75 case 't': |
99
d534fdcbb319
Remove #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
98
diff
changeset
|
76 arr->type = va_arg(ap, int); |
d534fdcbb319
Remove #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
98
diff
changeset
|
77 break; |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
78 default: |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
79 break; |
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
80 } |
62 | 81 } |
82 | |
83 /* | |
84 * Add to the head of array. NOTE: this may be very slow when adding a lot | |
85 * of object (about 100000). If you need to add a lot of data please consider | |
86 * using linked list instead. | |
87 */ | |
88 | |
89 int | |
90 array_push(struct array *arr, const void *data) | |
91 { | |
124
5917096facb9
Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
123
diff
changeset
|
92 if (grow(arr) < 0) |
62 | 93 return -1; |
94 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
95 memmove((char *)arr->data + arr->unit, arr->data, OFFSET(arr->length++)); |
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
96 memcpy((char *)arr->data, data, arr->unit); |
62 | 97 |
98 return 0; | |
99 } | |
100 | |
101 /* | |
102 * Insert the data at the specified index. The function returns -1 on | |
103 * allocation failure or when the index is outof bounds otherwise 0 is returned. | |
104 */ | |
105 | |
106 int | |
107 array_insert(struct array *arr, const void *data, int index) | |
108 { | |
118 | 109 if (index < 0) |
110 return array_push(arr, data); | |
111 if (index >= arr->length) | |
112 return array_append(arr, data); | |
62 | 113 |
118 | 114 /* Good place */ |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
115 memmove((char *)arr->data + OFFSET(index + 1), |
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
116 (char *)arr->data + OFFSET(index), OFFSET(arr->length++ - index)); |
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
117 memcpy((char *)arr->data + OFFSET(index), data, arr->unit); |
62 | 118 |
119 return 0; | |
120 } | |
121 | |
122 /* | |
123 * Append the data to the end of array. | |
124 */ | |
125 | |
126 int | |
127 array_append(struct array *arr, const void *data) | |
128 { | |
124
5917096facb9
Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
123
diff
changeset
|
129 if (grow(arr) < 0) |
62 | 130 return -1; |
131 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
132 memcpy((char *)arr->data + OFFSET(arr->length++), data, arr->unit); |
62 | 133 |
134 return 0; | |
135 } | |
136 | |
137 /* | |
138 * Remove the array's head. | |
139 */ | |
140 | |
141 void | |
142 array_pop(struct array *arr) | |
143 { | |
144 if (arr->length > 0) { | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
145 memmove((char *)arr->data, (char *)arr->data + OFFSET(1), |
62 | 146 OFFSET(--arr->length)); |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
147 memset((char *)arr->data + OFFSET(arr->length), 0, arr->unit); |
62 | 148 } |
149 } | |
150 | |
151 /* | |
152 * Remove the array's tail. | |
153 */ | |
154 | |
155 void | |
156 array_unqueue(struct array *arr) | |
157 { | |
158 if (arr->length > 0) | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
159 memset((char *)arr->data + OFFSET(--arr->length), 0, arr->unit); |
62 | 160 } |
161 | |
162 /* | |
163 * Remove the data at the specified index. Bounds are checked. | |
164 */ | |
165 | |
166 void | |
119 | 167 array_iremove(struct array *arr, int index) |
62 | 168 { |
169 if (arr->length > 0 && index >= 0 && index < arr->length) { | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
170 memmove((char *)arr->data + OFFSET(index), |
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
171 (char *)arr->data + OFFSET(index + 1), |
62 | 172 OFFSET(arr->length - index - 1)); |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
173 memset((char *)arr->data + OFFSET(--arr->length), 0, arr->unit); |
62 | 174 } |
175 } | |
176 | |
177 /* | |
178 * Remove the object referenced by the `data' argument. Useful when you | |
179 * don't know the index. | |
180 */ | |
181 | |
182 void | |
119 | 183 array_premove(struct array *arr, const void *data) |
62 | 184 { |
185 void *elm; | |
186 int i; | |
187 | |
188 for (i = 0; i < arr->length; ++i) { | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
189 elm = (char *)arr->data + OFFSET(i); |
62 | 190 |
191 if (memcmp(elm, data, arr->unit) == 0) | |
123 | 192 array_iremove(arr, i); |
62 | 193 } |
194 } | |
195 | |
196 /* | |
197 * Swap the two elements referenced by index `i1' and `i2'. This function needs | |
198 * to allocate data to swap elements thus if the functions fails it returns -1 | |
199 * otherwise 0 is returned. | |
200 */ | |
201 | |
202 int | |
203 array_iswap(struct array *arr, int i1, int i2) | |
204 { | |
205 void *tmp; | |
206 | |
207 /* Out of bounds */ | |
208 if (i1 >= arr->length || i1 < 0 || i2 >= arr->length || i2 < 0) | |
209 return -1; | |
210 | |
211 /* | |
212 * Only allocate at this time, the user may do not want to use this | |
213 * function. | |
214 */ | |
215 | |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
216 if ((tmp = arr->malloc(arr->unit)) == NULL) |
62 | 217 return -1; |
218 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
219 memcpy((char *)tmp, (char *)arr->data + OFFSET(i1), arr->unit); |
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
220 memcpy((char *)arr->data + OFFSET(i1), (char *)arr->data + OFFSET(i2), |
62 | 221 arr->unit); |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
222 memcpy((char *)arr->data + OFFSET(i2), (char *)tmp, arr->unit); |
62 | 223 |
224 /* | |
225 * Clear bytes for safety you probably don't want a password or | |
226 * secure data to be left somewhere in the memory. | |
227 */ | |
228 | |
229 memset(tmp, 0, arr->unit); | |
230 free(tmp); | |
231 | |
232 return 0; | |
233 } | |
234 | |
235 /* | |
236 * Swap the two elements referenced by data `o1' and `o2'. This function | |
237 * may be slow on large arrays since it must travel all the object | |
238 * to find the indexes. | |
239 */ | |
240 | |
241 int | |
242 array_pswap(struct array *arr, const void *o1, const void *o2) | |
243 { | |
244 int found, i1, i2; | |
245 | |
246 for (i1 = found = 0; !found && i1 < arr->length; ++i1) | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
247 found = memcmp((char *)arr->data + OFFSET(i1), o1, arr->unit) == 0; |
62 | 248 |
249 if (!found) | |
250 return -1; | |
251 | |
252 for (i2 = found = 0; !found && i2 < arr->length; ++i2) | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
253 found = memcmp((char *)arr->data + OFFSET(i2), o2, arr->unit) == 0; |
62 | 254 |
255 if (!found) | |
256 return -1; | |
257 | |
258 return array_iswap(arr, --i1, --i2); | |
259 } | |
260 | |
261 /* | |
262 * Apply the function `fn' on each object and give the optional `udata' | |
263 * argument to the function too. | |
264 */ | |
265 | |
266 void | |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
267 array_map(const struct array *arr, array_map_fn fn, void *udata) |
62 | 268 { |
269 int i; | |
270 | |
271 for (i = 0; i < arr->length; ++i) | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
272 fn((char *)arr->data + OFFSET(i), udata); |
62 | 273 } |
274 | |
275 /* | |
276 * Compare each object with the user supplied function. If the `fn' function | |
106
06c968b92090
Use pointer to pointer in array_find, better to reuse
David Demelier <markand@malikania.fr>
parents:
99
diff
changeset
|
277 * returns 1, 1 is returned and dst points to the correct object, dst should |
06c968b92090
Use pointer to pointer in array_find, better to reuse
David Demelier <markand@malikania.fr>
parents:
99
diff
changeset
|
278 * be a pointer to a pointer of object, like (int **) for a array of int. |
62 | 279 */ |
280 | |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
281 int |
106
06c968b92090
Use pointer to pointer in array_find, better to reuse
David Demelier <markand@malikania.fr>
parents:
99
diff
changeset
|
282 array_find(const struct array *arr, array_cmp_fn fn, void *dst, void *u) |
62 | 283 { |
284 int st, i; | |
285 | |
120 | 286 for (i = st = 0; i < arr->length && st != 1; ++i) |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
287 st = fn((char *)arr->data + OFFSET(i), u); |
62 | 288 |
120 | 289 if (st && dst) |
290 *(char **)dst = (char *)arr->data + OFFSET(i - 1); | |
62 | 291 |
120 | 292 return (st) ? i - 1 : -1; |
62 | 293 } |
294 | |
295 /* | |
296 * Erase every bytes and set the length to 0. | |
297 */ | |
298 | |
299 void | |
300 array_clear(struct array *arr) | |
301 { | |
302 memset(arr->data, 0, arr->size); | |
303 arr->length = 0; | |
304 } | |
305 | |
306 /* | |
307 * Same as array_clear except it also free the array object. | |
308 */ | |
309 | |
310 void | |
311 array_free(struct array *arr) | |
312 { | |
109
4efd3873a457
Remove useless bits in _free()
David Demelier <markand@malikania.fr>
parents:
106
diff
changeset
|
313 free(arr->data); |
62 | 314 } |
315 | |
316 /* | |
317 * Increate the array storage when it is full. If the buffer is fixed size | |
318 * it returns -1 on full buffer otherwise 0 is returned if allocation | |
319 * succeeded. | |
320 */ | |
321 | |
322 static int | |
124
5917096facb9
Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
123
diff
changeset
|
323 grow(struct array *arr) |
62 | 324 { |
325 if ((arr->size / arr->unit) > (size_t) arr->length) | |
326 return 0; | |
327 | |
328 if (arr->type == ARRAY_AUTO) { | |
91
b3ba5f5df3b9
New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents:
67
diff
changeset
|
329 if ((arr->data = arr->realloc(arr->data, arr->size + |
62 | 330 OFFSET(arr->bsize))) == NULL) |
331 return -1; | |
332 | |
333 arr->size += OFFSET(arr->bsize); | |
334 } else | |
335 return -1; | |
336 | |
337 return 0; | |
338 } |