annotate array.h @ 6:25cc379de564

Added array.c and array.h: Various function to manipulate dynamic array. This let you adding as much as you want object into the array. You may add object to the head, end or at a specified index.
author David Demelier <markand@malikania.fr>
date Tue, 06 Sep 2011 22:19:18 +0200
parents
children 127254037b30
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * array.h -- manipulate dymanic array
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2011, David Demelier <markand@malikania.fr>
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _ARRAY_H_
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _ARRAY_H_
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #define ARRAY_DEFAULT_BSIZE 128
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 struct array {
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 void **data; /* array of data */
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 size_t length; /* number of element in array */
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 #define ARRAY_FIXED 0x00000000
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #define ARRAY_AUTO 0x00000001
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 int flags; /* array's flags (default FIXED) */
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 /* Private should not be modified by user */
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 size_t size; /* current buffer size */
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 size_t bsize; /* block size */
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 };
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 struct array *array_new(const void *, size_t, int);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 #define array_new_auto(size) array_new(NULL, size, ARRAY_AUTO)
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 #define array_new_fixed(max) array_new(NULL, max, ARRAY_FIXED)
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 int array_push(struct array *, const void *);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 int array_insert(struct array *, const void *, int);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 int array_append(struct array *, const void *);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 void *array_pop(struct array *);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 void *array_unqueue(struct array *);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 void *array_remove(struct array *, int);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 void array_map(struct array *, void (*fn)(void *, void *), void *);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 void *array_find(struct array *, int (*fn)(void *, void *), void *, int *);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 void array_clear(struct array *, int);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 void array_free(struct array *, int);
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 #define ARRAY_FOREACH(array, entry, tmp, type) \
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 for ((tmp) = (type **) (array)->data, entry = *tmp; \
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 (entry) != NULL; \
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 ++(tmp), (entry) = (*tmp))
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
25cc379de564 Added array.c and array.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 #endif /* _ARRAY_H */