Mercurial > code
annotate array.c @ 136:c6d9eb5702e8
array:
o add ARRAY_FASTREMOVE, use last object when removing,
o add ARRAY_CLEARBITS, set to 0 the bytes when removing
parray:
o add PARRAY_FASTREMOVE, use last object when removing,
o add PARRAY_NULLEND, always has a last NULL entry
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 26 Mar 2012 10:24:49 +0200 |
parents | 5917096facb9 |
children | e3cf5ac9a5aa |
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 |
136 | 46 if (arr->flags & ARRAY_CLEARBITS) |
47 memset(arr->data, 0, arr->size); | |
48 | |
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
|
49 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
|
50 } |
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 |
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 /* |
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 * 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
|
54 * 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
|
55 * 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
|
56 * r -> realloc function that must matches void * (*realloc)(void *, size_t) |
136 | 57 * f -> array flags 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
|
58 */ |
62 | 59 |
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
|
60 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
|
61 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
|
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_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
|
64 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
|
65 |
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 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
|
67 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
|
68 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
|
69 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
|
70 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
|
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 '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
|
73 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
|
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 '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
|
76 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
|
77 break; |
136 | 78 case 'f': |
79 arr->flags = va_arg(ap, int); | |
99
d534fdcbb319
Remove #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
98
diff
changeset
|
80 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
|
81 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
|
82 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
|
83 } |
62 | 84 } |
85 | |
86 /* | |
87 * Add to the head of array. NOTE: this may be very slow when adding a lot | |
88 * of object (about 100000). If you need to add a lot of data please consider | |
89 * using linked list instead. | |
90 */ | |
91 | |
92 int | |
93 array_push(struct array *arr, const void *data) | |
94 { | |
124
5917096facb9
Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
123
diff
changeset
|
95 if (grow(arr) < 0) |
62 | 96 return -1; |
97 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
98 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
|
99 memcpy((char *)arr->data, data, arr->unit); |
62 | 100 |
101 return 0; | |
102 } | |
103 | |
104 /* | |
105 * Insert the data at the specified index. The function returns -1 on | |
106 * allocation failure or when the index is outof bounds otherwise 0 is returned. | |
107 */ | |
108 | |
109 int | |
110 array_insert(struct array *arr, const void *data, int index) | |
111 { | |
118 | 112 if (index < 0) |
113 return array_push(arr, data); | |
114 if (index >= arr->length) | |
115 return array_append(arr, data); | |
62 | 116 |
118 | 117 /* Good place */ |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
118 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
|
119 (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
|
120 memcpy((char *)arr->data + OFFSET(index), data, arr->unit); |
62 | 121 |
122 return 0; | |
123 } | |
124 | |
125 /* | |
126 * Append the data to the end of array. | |
127 */ | |
128 | |
129 int | |
130 array_append(struct array *arr, const void *data) | |
131 { | |
124
5917096facb9
Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
123
diff
changeset
|
132 if (grow(arr) < 0) |
62 | 133 return -1; |
134 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
135 memcpy((char *)arr->data + OFFSET(arr->length++), data, arr->unit); |
62 | 136 |
137 return 0; | |
138 } | |
139 | |
140 /* | |
141 * Remove the array's head. | |
142 */ | |
143 | |
144 void | |
145 array_pop(struct array *arr) | |
146 { | |
136 | 147 array_iremove(arr, 0); |
62 | 148 } |
149 | |
150 /* | |
151 * Remove the array's tail. | |
152 */ | |
153 | |
154 void | |
155 array_unqueue(struct array *arr) | |
156 { | |
136 | 157 array_iremove(arr, arr->length - 1); |
62 | 158 } |
159 | |
160 /* | |
161 * Remove the data at the specified index. Bounds are checked. | |
162 */ | |
163 | |
164 void | |
119 | 165 array_iremove(struct array *arr, int index) |
62 | 166 { |
167 if (arr->length > 0 && index >= 0 && index < arr->length) { | |
136 | 168 if (arr->flags & ARRAY_FASTREMOVE) |
169 memmove((char *)arr->data + OFFSET(index), | |
170 (char *)arr->data + OFFSET(--arr->length), | |
171 arr->unit); | |
172 else | |
173 memmove((char *)arr->data + OFFSET(index), | |
174 (char *)arr->data + OFFSET(index + 1), | |
175 OFFSET(arr->length-- - index - 1)); | |
62 | 176 } |
136 | 177 |
178 if (arr->flags & ARRAY_CLEARBITS) | |
179 memset((char *)arr->data + OFFSET(arr->length), 0, arr->unit); | |
62 | 180 } |
181 | |
182 /* | |
183 * Remove the object referenced by the `data' argument. Useful when you | |
184 * don't know the index. | |
185 */ | |
186 | |
187 void | |
119 | 188 array_premove(struct array *arr, const void *data) |
62 | 189 { |
190 void *elm; | |
191 int i; | |
192 | |
193 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
|
194 elm = (char *)arr->data + OFFSET(i); |
62 | 195 |
136 | 196 if (memcmp(elm, data, arr->unit) == 0) { |
123 | 197 array_iremove(arr, i); |
136 | 198 break; |
199 } | |
62 | 200 } |
201 } | |
202 | |
203 /* | |
204 * Swap the two elements referenced by index `i1' and `i2'. This function needs | |
205 * to allocate data to swap elements thus if the functions fails it returns -1 | |
206 * otherwise 0 is returned. | |
207 */ | |
208 | |
209 int | |
210 array_iswap(struct array *arr, int i1, int i2) | |
211 { | |
212 void *tmp; | |
213 | |
214 /* Out of bounds */ | |
215 if (i1 >= arr->length || i1 < 0 || i2 >= arr->length || i2 < 0) | |
216 return -1; | |
217 | |
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
|
218 if ((tmp = arr->malloc(arr->unit)) == NULL) |
62 | 219 return -1; |
220 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
221 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
|
222 memcpy((char *)arr->data + OFFSET(i1), (char *)arr->data + OFFSET(i2), |
62 | 223 arr->unit); |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
224 memcpy((char *)arr->data + OFFSET(i2), (char *)tmp, arr->unit); |
62 | 225 |
226 /* | |
227 * Clear bytes for safety you probably don't want a password or | |
228 * secure data to be left somewhere in the memory. | |
229 */ | |
230 | |
136 | 231 if (arr->flags & ARRAY_CLEARBITS) |
232 memset(tmp, 0, arr->unit); | |
62 | 233 free(tmp); |
234 | |
235 return 0; | |
236 } | |
237 | |
238 /* | |
239 * Swap the two elements referenced by data `o1' and `o2'. This function | |
240 * may be slow on large arrays since it must travel all the object | |
241 * to find the indexes. | |
242 */ | |
243 | |
244 int | |
245 array_pswap(struct array *arr, const void *o1, const void *o2) | |
246 { | |
247 int found, i1, i2; | |
248 | |
249 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
|
250 found = memcmp((char *)arr->data + OFFSET(i1), o1, arr->unit) == 0; |
62 | 251 |
252 if (!found) | |
253 return -1; | |
254 | |
255 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
|
256 found = memcmp((char *)arr->data + OFFSET(i2), o2, arr->unit) == 0; |
62 | 257 |
258 if (!found) | |
259 return -1; | |
260 | |
261 return array_iswap(arr, --i1, --i2); | |
262 } | |
263 | |
264 /* | |
265 * Apply the function `fn' on each object and give the optional `udata' | |
266 * argument to the function too. | |
267 */ | |
268 | |
269 void | |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
270 array_map(const struct array *arr, array_map_fn fn, void *udata) |
62 | 271 { |
272 int i; | |
273 | |
274 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
|
275 fn((char *)arr->data + OFFSET(i), udata); |
62 | 276 } |
277 | |
278 /* | |
279 * 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
|
280 * 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
|
281 * be a pointer to a pointer of object, like (int **) for a array of int. |
62 | 282 */ |
283 | |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
284 int |
106
06c968b92090
Use pointer to pointer in array_find, better to reuse
David Demelier <markand@malikania.fr>
parents:
99
diff
changeset
|
285 array_find(const struct array *arr, array_cmp_fn fn, void *dst, void *u) |
62 | 286 { |
287 int st, i; | |
288 | |
120 | 289 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
|
290 st = fn((char *)arr->data + OFFSET(i), u); |
62 | 291 |
120 | 292 if (st && dst) |
293 *(char **)dst = (char *)arr->data + OFFSET(i - 1); | |
62 | 294 |
120 | 295 return (st) ? i - 1 : -1; |
62 | 296 } |
297 | |
136 | 298 void * |
299 array_first(const struct array *arr) | |
300 { | |
301 return arr->data; | |
302 } | |
303 | |
304 void * | |
305 array_last(const struct array *arr) | |
306 { | |
307 if (arr->length == 0) | |
308 return array_first(arr); | |
309 | |
310 return (char *)arr->data + OFFSET(arr->length - 1); | |
311 | |
312 } | |
313 | |
314 void * | |
315 array_index(const struct array *arr, int idx) | |
316 { | |
317 if (idx < 0) | |
318 return array_first(arr); | |
319 if (idx >= arr->length) | |
320 return array_last(arr); | |
321 | |
322 return (char *)arr->data + OFFSET(idx); | |
323 } | |
324 | |
62 | 325 /* |
326 * Erase every bytes and set the length to 0. | |
327 */ | |
328 | |
329 void | |
330 array_clear(struct array *arr) | |
331 { | |
136 | 332 if (arr->flags & ARRAY_CLEARBITS) |
333 memset(arr->data, 0, arr->size); | |
334 | |
62 | 335 arr->length = 0; |
336 } | |
337 | |
338 /* | |
339 * Same as array_clear except it also free the array object. | |
340 */ | |
341 | |
342 void | |
343 array_free(struct array *arr) | |
344 { | |
136 | 345 array_clear(arr); |
109
4efd3873a457
Remove useless bits in _free()
David Demelier <markand@malikania.fr>
parents:
106
diff
changeset
|
346 free(arr->data); |
136 | 347 |
348 arr->data = NULL; | |
349 arr->size = 0; | |
62 | 350 } |
351 | |
352 /* | |
353 * Increate the array storage when it is full. If the buffer is fixed size | |
354 * it returns -1 on full buffer otherwise 0 is returned if allocation | |
355 * succeeded. | |
356 */ | |
357 | |
358 static int | |
124
5917096facb9
Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents:
123
diff
changeset
|
359 grow(struct array *arr) |
62 | 360 { |
136 | 361 if ((arr->size / arr->unit) > (size_t)arr->length) |
62 | 362 return 0; |
363 | |
136 | 364 if (!(arr->flags & ARRAY_FIXED)) { |
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
|
365 if ((arr->data = arr->realloc(arr->data, arr->size + |
136 | 366 OFFSET(arr->bsize))) == NULL) { |
367 arr->size = arr->length = 0; | |
62 | 368 return -1; |
136 | 369 } |
62 | 370 |
371 arr->size += OFFSET(arr->bsize); | |
372 } else | |
373 return -1; | |
374 | |
375 return 0; | |
376 } |