annotate array.h @ 163:66d317ba4b80

Added a new _qsort function for array and parray
author David Demelier <markand@malikania.fr>
date Mon, 03 Sep 2012 21:40:54 +0200
parents 1558251b2cf2
children 654f32079cdc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * array.h -- manipulate dynamic arrays
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
98
b1a084c030c8 Happy new year
David Demelier <markand@malikania.fr>
parents: 94
diff changeset
4 * Copyright (c) 2011, 2012, David Demelier <markand@malikania.fr>
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _ARRAY_H_
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _ARRAY_H_
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
135
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
22 #include <stdarg.h>
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
23
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
24 #ifndef ARRAY_DEFAULT_CHKSIZE
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
25 #define ARRAY_DEFAULT_CHKSIZE 128
91
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
26 #endif
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
28 #define ARRAY_AUTO 0, /* array grows automatically */
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
29 #define ARRAY_FIXED (1 << 0) /* fixed size length */
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
30 #define ARRAY_FASTREMOVE (1 << 1) /* use last object when removing */
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
31 #define ARRAY_CLEARBITS (1 << 2) /* clear data when inserting/removing */
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
32 #define ARRAY_INSERTSAFE (1 << 3) /* insertion must have valid indexes */
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 struct array {
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
35 int flags; /* (ro) array flags (default AUTO) */
148
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
36 void *data; /* (rw) array of data */
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
37 int length; /* (ro) number of element inside */
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
38 size_t size; /* (ro) current buffer size (allocated memory) */
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
39 size_t unit; /* (ro) unit size (sizeof the object) */
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
40 int chksize; /* (rw) chunk size (used when growing array) */
91
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
41
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 91
diff changeset
42 /* Own allocation functions */
91
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
43 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: 69
diff changeset
44 void * (*realloc)(void *, size_t);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 };
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
47 typedef void (*array_map_t)(void *, void *);
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
48 typedef int (*array_cmp_t)(const void *, const void *);
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
49
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
50 #ifdef __cplusplus
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
51 extern "C" {
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
52 #endif
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
54 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
55 array_init(struct array *, size_t);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
56
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
57 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
58 array_set(struct array *, const char *, ...);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
59
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
60 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
61 array_push(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
62
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
63 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
64 array_insert(struct array *, const void *, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
65
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
66 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
67 array_append(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
68
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
69 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
70 array_pop(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
71
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
72 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
73 array_unqueue(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
74
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
75 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
76 array_iremove(struct array *, int);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
77
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
78 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
79 array_premove(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
80
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
81 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
82 array_iswap(struct array *, int, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
83
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
84 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
85 array_pswap(struct array *, const void *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
86
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
87 void
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
88 array_map(const struct array *, array_map_t, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
89
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
90 void
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
91 array_sort(struct array *, array_cmp_t);
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
92
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
93 int
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
94 array_find(const struct array *, array_cmp_t, void *, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
95
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
96 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
97 array_first(const struct array *);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
98
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
99 void *
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
100 array_get(const struct array *, int);
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
101
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
102 void *
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
103 array_last(const struct array *);
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
104
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
105 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
106 array_clear(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
107
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
108 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
109 array_free(struct array *);
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
110
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
111 #define ARRAY_FOREACH(a, var, i) \
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
112 for (i = 0, (var) = array_first((a)); \
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
113 i < (a)->length; \
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
114 (var) = array_get(a, ++i))
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
115
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
116 #ifdef __cplusplus
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
117 }
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
118 #endif
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
119
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 #endif /* _ARRAY_H_ */