annotate array.h @ 147:535f12e0a5af

Add a flag to prevent insertions at out of bounds
author David Demelier <markand@malikania.fr>
date Fri, 11 May 2012 20:06:41 +0200
parents e3cf5ac9a5aa
children 1558251b2cf2
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
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
24 #ifdef __cplusplus
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
25 extern "C" {
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
26 #endif
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
27
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
28 #ifndef ARRAY_DEFAULT_BSIZE
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #define ARRAY_DEFAULT_BSIZE 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
30 #endif
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
32 enum {
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
33 ARRAY_AUTO = 0, /* array grows automatically */
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
34 ARRAY_FIXED = (1 << 0), /* fixed size length */
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
35 ARRAY_FASTREMOVE = (1 << 1), /* use last object when removing */
147
535f12e0a5af Add a flag to prevent insertions at out of bounds
David Demelier <markand@malikania.fr>
parents: 142
diff changeset
36 ARRAY_CLEARBITS = (1 << 2), /* clear data when inserting/removing */
535f12e0a5af Add a flag to prevent insertions at out of bounds
David Demelier <markand@malikania.fr>
parents: 142
diff changeset
37 ARRAY_INSERTSAFE = (1 << 3) /* insertion must have valid indexes */
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
38 };
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 struct array {
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
41 int flags; /* (ro) array flags (default AUTO) */
135
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
42 void *data; /* (rw) array of data */
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
43 int length; /* (ro) number of element inside */
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
44 size_t size; /* (ro) current buffer size (allocated memory) */
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
45 size_t unit; /* (ro) unit size (sizeof the object) */
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
46 int bsize; /* (rw) block 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
47
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 91
diff changeset
48 /* 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
49 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
50 void * (*realloc)(void *, size_t);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 };
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
53 typedef void (*array_map_t)(void *, void *);
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
54 typedef int (*array_cmp_t)(void *, void *);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
56 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
57 array_init(struct array *, size_t);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
58
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
59 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
60 array_set(struct array *, const char *, ...);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
61
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
62 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
63 array_push(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
64
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
65 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
66 array_insert(struct array *, const void *, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
67
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
68 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
69 array_append(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
70
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
71 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
72 array_pop(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
73
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
74 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
75 array_unqueue(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
76
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
77 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
78 array_iremove(struct array *, int);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
79
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
80 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
81 array_premove(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
82
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
83 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
84 array_iswap(struct array *, int, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
85
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
86 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
87 array_pswap(struct array *, const void *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
88
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
89 void
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
90 array_map(const struct array *, array_map_t, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
91
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
92 int
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
93 array_find(const struct array *, array_cmp_t, void *, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
94
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
95 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
96 array_first(const struct array *);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
97
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
98 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
99 array_last(const struct array *);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
100
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
101 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
102 array_index(const struct array *, int);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
103
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
104 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
105 array_clear(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
106
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
107 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
108 array_free(struct array *);
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
109
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
110 #define ARRAY_FOREACH(a, var, i) \
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
111 for (i = 0, (var) = array_first((a)); \
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
112 i < (a)->length; \
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
113 (var) = array_index(a, ++i))
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
114
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
115 #ifdef __cplusplus
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
116 }
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
117 #endif
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
118
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 #endif /* _ARRAY_H_ */