annotate parray.h @ 166:7f214f26a4c0

Added a macro for pack.c
author David Demelier <markand@malikania.fr>
date Mon, 24 Sep 2012 23:04:25 +0200
parents 970e491d93cb
children
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 /*
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
2 * parray.h -- manipulate dynamic pointer arrays
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
98
b1a084c030c8 Happy new year
David Demelier <markand@malikania.fr>
parents: 93
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 _PARRAY_H_
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _PARRAY_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
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
24 #ifndef PARRAY_DEFAULT_BSIZE
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 #define PARRAY_DEFAULT_BSIZE 128
92
4d723e81b685 Same thing for parray
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
148
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
28 enum parray_flags {
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
29 PARRAY_AUTO = 0, /* array grows automatically */
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
30 PARRAY_FIXED = (1 << 0), /* fixed size length */
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
31 PARRAY_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
32 PARRAY_NULLEND = (1 << 2), /* always has a NULL pointer at end */
535f12e0a5af Add a flag to prevent insertions at out of bounds
David Demelier <markand@malikania.fr>
parents: 142
diff changeset
33 PARRAY_INSERTSAFE = (1 << 3) /* insertion must have valid indexes */
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 117
diff changeset
34 };
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 struct parray {
148
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
37 enum parray_flags flags; /* (ro) array flags (default AUTO) */
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
38 void **data; /* (rw) array of data */
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
39 int length; /* (ro) number of element inside */
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
40 size_t size; /* (ro) current buffer size (allocated memory) */
1558251b2cf2 Use enum decl
David Demelier <markand@malikania.fr>
parents: 147
diff changeset
41 int bsize; /* (rw) block size (used when growing array) */
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
42
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
43 /* Own allocation functions */
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
44 void * (*malloc)(size_t);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
45 void * (*realloc)(void *, size_t);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 };
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
48 typedef void (*parray_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
49 typedef int (*parray_cmp_t)(void *, void *);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
51 #ifdef __cplusplus
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
52 extern "C" {
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
53 #endif
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
54
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
55 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
56 parray_init(struct parray *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
57
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
58 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
59 parray_set(struct parray *, const char *, ...);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
60
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
61 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
62 parray_push(struct parray *, void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
63
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
64 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
65 parray_insert(struct parray *, void *, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
66
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
67 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
68 parray_append(struct parray *, void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
69
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
70 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
71 parray_pop(struct parray *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
72
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
73 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
74 parray_unqueue(struct parray *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
75
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
76 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
77 parray_iremove(struct parray *, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
78
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
79 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
80 parray_premove(struct parray *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
81
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
82 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
83 parray_iswap(struct parray *, int, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
84
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
85 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
86 parray_pswap(struct parray *, const void *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
87
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
88 void
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
89 parray_map(const struct parray *, parray_map_t, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
90
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
91 int
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
92 parray_find(const struct parray *, parray_cmp_t, void *, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
93
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
94 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
95 parray_first(const struct parray *);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
96
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
97 void *
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
98 parray_get(const struct parray *, int);
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
99
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
100 void *
163
66d317ba4b80 Added a new _qsort function for array and parray
David Demelier <markand@malikania.fr>
parents: 148
diff changeset
101 parray_last(const struct parray *);
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
102
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
103 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
104 parray_clear(struct parray *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
105
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
106 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
107 parray_free(struct parray *);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
108
165
970e491d93cb Add _trim function to realloc to the needed size
David Demelier <markand@malikania.fr>
parents: 163
diff changeset
109 void *
970e491d93cb Add _trim function to realloc to the needed size
David Demelier <markand@malikania.fr>
parents: 163
diff changeset
110 parray_trim(struct parray *);
970e491d93cb Add _trim function to realloc to the needed size
David Demelier <markand@malikania.fr>
parents: 163
diff changeset
111
117
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
112 #define PARRAY_FOREACH(a, o, i) \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
113 for (i = 0, o = (a)->data[i]; \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
114 i < (a)->length; \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
115 ++i, o = (a)->data[i])
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
116
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
117 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
118 }
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
119 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
120
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 #endif /* _PARRAY_H_ */