Mercurial > code
annotate array.c @ 98:b1a084c030c8
Happy new year
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 13 Jan 2012 19:43:02 +0100 |
parents | 9ebea85c7765 |
children | d534fdcbb319 |
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 | |
27 static int array_grow(struct array *); | |
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) |
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 * t -> type of array of type enum array_type |
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': |
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->type = va_arg(ap, enum array_type); |
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 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
|
78 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
|
79 } |
62 | 80 } |
81 | |
82 /* | |
83 * Add to the head of array. NOTE: this may be very slow when adding a lot | |
84 * of object (about 100000). If you need to add a lot of data please consider | |
85 * using linked list instead. | |
86 */ | |
87 | |
88 int | |
89 array_push(struct array *arr, const void *data) | |
90 { | |
91 if (array_grow(arr) < 0) | |
92 return -1; | |
93 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
94 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
|
95 memcpy((char *)arr->data, data, arr->unit); |
62 | 96 |
97 return 0; | |
98 } | |
99 | |
100 /* | |
101 * Insert the data at the specified index. The function returns -1 on | |
102 * allocation failure or when the index is outof bounds otherwise 0 is returned. | |
103 */ | |
104 | |
105 int | |
106 array_insert(struct array *arr, const void *data, int index) | |
107 { | |
108 if (index > arr->length - 1 || index < 0 || array_grow(arr) < 0) | |
109 return -1; | |
110 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
111 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
|
112 (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
|
113 memcpy((char *)arr->data + OFFSET(index), data, arr->unit); |
62 | 114 |
115 return 0; | |
116 } | |
117 | |
118 /* | |
119 * Append the data to the end of array. | |
120 */ | |
121 | |
122 int | |
123 array_append(struct array *arr, const void *data) | |
124 { | |
125 if (array_grow(arr) < 0) | |
126 return -1; | |
127 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
128 memcpy((char *)arr->data + OFFSET(arr->length++), data, arr->unit); |
62 | 129 |
130 return 0; | |
131 } | |
132 | |
133 /* | |
134 * Remove the array's head. | |
135 */ | |
136 | |
137 void | |
138 array_pop(struct array *arr) | |
139 { | |
140 if (arr->length > 0) { | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
141 memmove((char *)arr->data, (char *)arr->data + OFFSET(1), |
62 | 142 OFFSET(--arr->length)); |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
143 memset((char *)arr->data + OFFSET(arr->length), 0, arr->unit); |
62 | 144 } |
145 } | |
146 | |
147 /* | |
148 * Remove the array's tail. | |
149 */ | |
150 | |
151 void | |
152 array_unqueue(struct array *arr) | |
153 { | |
154 if (arr->length > 0) | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
155 memset((char *)arr->data + OFFSET(--arr->length), 0, arr->unit); |
62 | 156 } |
157 | |
158 /* | |
159 * Remove the data at the specified index. Bounds are checked. | |
160 */ | |
161 | |
162 void | |
163 array_remove(struct array *arr, int index) | |
164 { | |
165 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
|
166 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
|
167 (char *)arr->data + OFFSET(index + 1), |
62 | 168 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
|
169 memset((char *)arr->data + OFFSET(--arr->length), 0, arr->unit); |
62 | 170 } |
171 } | |
172 | |
173 /* | |
174 * Remove the object referenced by the `data' argument. Useful when you | |
175 * don't know the index. | |
176 */ | |
177 | |
178 void | |
179 array_unref(struct array *arr, const void *data) | |
180 { | |
181 void *elm; | |
182 int i; | |
183 | |
184 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
|
185 elm = (char *)arr->data + OFFSET(i); |
62 | 186 |
187 if (memcmp(elm, data, arr->unit) == 0) | |
188 array_remove(arr, i); | |
189 } | |
190 } | |
191 | |
192 /* | |
193 * Swap the two elements referenced by index `i1' and `i2'. This function needs | |
194 * to allocate data to swap elements thus if the functions fails it returns -1 | |
195 * otherwise 0 is returned. | |
196 */ | |
197 | |
198 int | |
199 array_iswap(struct array *arr, int i1, int i2) | |
200 { | |
201 void *tmp; | |
202 | |
203 /* Out of bounds */ | |
204 if (i1 >= arr->length || i1 < 0 || i2 >= arr->length || i2 < 0) | |
205 return -1; | |
206 | |
207 /* | |
208 * Only allocate at this time, the user may do not want to use this | |
209 * function. | |
210 */ | |
211 | |
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
|
212 if ((tmp = arr->malloc(arr->unit)) == NULL) |
62 | 213 return -1; |
214 | |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
215 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
|
216 memcpy((char *)arr->data + OFFSET(i1), (char *)arr->data + OFFSET(i2), |
62 | 217 arr->unit); |
64
9cc5d6d0563e
Add more cast for old gcc and other cc
David Demelier <markand@malikania.fr>
parents:
62
diff
changeset
|
218 memcpy((char *)arr->data + OFFSET(i2), (char *)tmp, arr->unit); |
62 | 219 |
220 /* | |
221 * Clear bytes for safety you probably don't want a password or | |
222 * secure data to be left somewhere in the memory. | |
223 */ | |
224 | |
225 memset(tmp, 0, arr->unit); | |
226 free(tmp); | |
227 | |
228 return 0; | |
229 } | |
230 | |
231 /* | |
232 * Swap the two elements referenced by data `o1' and `o2'. This function | |
233 * may be slow on large arrays since it must travel all the object | |
234 * to find the indexes. | |
235 */ | |
236 | |
237 int | |
238 array_pswap(struct array *arr, const void *o1, const void *o2) | |
239 { | |
240 int found, i1, i2; | |
241 | |
242 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
|
243 found = memcmp((char *)arr->data + OFFSET(i1), o1, arr->unit) == 0; |
62 | 244 |
245 if (!found) | |
246 return -1; | |
247 | |
248 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
|
249 found = memcmp((char *)arr->data + OFFSET(i2), o2, arr->unit) == 0; |
62 | 250 |
251 if (!found) | |
252 return -1; | |
253 | |
254 return array_iswap(arr, --i1, --i2); | |
255 } | |
256 | |
257 /* | |
258 * Apply the function `fn' on each object and give the optional `udata' | |
259 * argument to the function too. | |
260 */ | |
261 | |
262 void | |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
263 array_map(const struct array *arr, array_map_fn fn, void *udata) |
62 | 264 { |
265 int i; | |
266 | |
267 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
|
268 fn((char *)arr->data + OFFSET(i), udata); |
62 | 269 } |
270 | |
271 /* | |
272 * Compare each object with the user supplied function. If the `fn' function | |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
273 * returns 1 then the index of the data position is returned and the parameter |
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
274 * data is filled with the array data at the correct index. If the comparison |
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
275 * function nevers returns 1, array_find returns -1. |
62 | 276 */ |
277 | |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
278 int |
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
279 array_find(const struct array *arr, array_cmp_fn fn, void *data, void *u) |
62 | 280 { |
281 int st, i; | |
282 | |
283 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
|
284 st = fn((char *)arr->data + OFFSET(i), u); |
62 | 285 |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
286 if (st) |
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
287 memcpy(data, (char *)arr->data + OFFSET(--i), arr->unit); |
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
288 else |
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
289 i = -1; |
62 | 290 |
67
cff6869fbc94
Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
291 return i; |
62 | 292 } |
293 | |
294 /* | |
295 * Erase every bytes and set the length to 0. | |
296 */ | |
297 | |
298 void | |
299 array_clear(struct array *arr) | |
300 { | |
301 memset(arr->data, 0, arr->size); | |
302 arr->length = 0; | |
303 } | |
304 | |
305 /* | |
306 * Same as array_clear except it also free the array object. | |
307 */ | |
308 | |
309 void | |
310 array_free(struct array *arr) | |
311 { | |
312 array_clear(arr); | |
313 | |
314 if (arr->data) | |
315 free(arr->data); | |
316 } | |
317 | |
318 /* | |
319 * Increate the array storage when it is full. If the buffer is fixed size | |
320 * it returns -1 on full buffer otherwise 0 is returned if allocation | |
321 * succeeded. | |
322 */ | |
323 | |
324 static int | |
325 array_grow(struct array *arr) | |
326 { | |
327 if ((arr->size / arr->unit) > (size_t) arr->length) | |
328 return 0; | |
329 | |
330 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
|
331 if ((arr->data = arr->realloc(arr->data, arr->size + |
62 | 332 OFFSET(arr->bsize))) == NULL) |
333 return -1; | |
334 | |
335 arr->size += OFFSET(arr->bsize); | |
336 } else | |
337 return -1; | |
338 | |
339 return 0; | |
340 } |