annotate parray.h @ 142:e3cf5ac9a5aa

[p]array_insert now returns -1 or index of added element
author David Demelier <markand@malikania.fr>
date Tue, 08 May 2012 15:02:17 +0200
parents c6d9eb5702e8
children 535f12e0a5af
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
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
24 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
25 extern "C" {
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
26 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
27
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
28 #ifndef PARRAY_DEFAULT_BSIZE
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #define PARRAY_DEFAULT_BSIZE 128
92
4d723e81b685 Same thing for parray
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: 117
diff changeset
32 enum {
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
33 PARRAY_AUTO = 0, /* array grows automatically */
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
34 PARRAY_FIXED = (1 << 0), /* fixed size length */
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
35 PARRAY_FASTREMOVE = (1 << 1), /* use last object when removing */
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
36 PARRAY_NULLEND = (1 << 2) /* always has a NULL pointer at end */
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 117
diff changeset
37 };
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 struct parray {
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
40 int flags; /* (ro) array flags (default AUTO) */
135
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
41 void **data; /* (rw) array of data */
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
42 int length; /* (ro) number of element inside */
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
43 size_t size; /* (ro) current buffer size (allocated memory) */
07800b7af208 Huge cosmetic, no breakage
David Demelier <markand@malikania.fr>
parents: 134
diff changeset
44 int bsize; /* (rw) block size (used when growing array) */
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
45
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
46 /* Own allocation functions */
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
47 void * (*malloc)(size_t);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
48 void * (*realloc)(void *, size_t);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 };
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
51 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
52 typedef int (*parray_cmp_t)(void *, void *);
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 parray_init(struct parray *);
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 parray_set(struct parray *, 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 parray_push(struct parray *, 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 parray_insert(struct parray *, 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 parray_append(struct parray *, 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 parray_pop(struct parray *);
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 parray_unqueue(struct parray *);
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 parray_iremove(struct parray *, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
77
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 parray_premove(struct parray *, 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 parray_iswap(struct parray *, 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 parray_pswap(struct parray *, 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 parray_map(const struct parray *, parray_map_t, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
89
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
90 int
142
e3cf5ac9a5aa [p]array_insert now returns -1 or index of added element
David Demelier <markand@malikania.fr>
parents: 136
diff changeset
91 parray_find(const struct parray *, parray_cmp_t, void *, void *);
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
92
136
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
93 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
94 parray_first(const struct parray *);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
95
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
96 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
97 parray_last(const struct parray *);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
98
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
99 void *
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
100 parray_index(const struct parray *, int);
David Demelier <markand@malikania.fr>
parents: 135
diff changeset
101
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
102 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
103 parray_clear(struct parray *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
104
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 parray_free(struct parray *);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
107
117
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
108 #define PARRAY_FOREACH(a, o, i) \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
109 for (i = 0, o = (a)->data[i]; \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
110 i < (a)->length; \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
111 ++i, o = (a)->data[i])
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
112
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
113 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
114 }
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
115 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
116
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 #endif /* _PARRAY_H_ */