annotate parray.h @ 69:8f6d3850fac1

Remove useless attributes and add [P]ARRAY_FULL
author David Demelier <markand@malikania.fr>
date Fri, 11 Nov 2011 02:21:59 +0100
parents cff6869fbc94
children 4d723e81b685
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 pointer arrays
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2011, David Demelier <markand@malikania.fr>
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
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
22 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
23 extern "C" {
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
24 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
25
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 #define PARRAY_DEFAULT_BSIZE 128
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 enum parray_type {
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 PARRAY_FIXED = 0,
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 PARRAY_AUTO = 1
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 };
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 struct parray {
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 enum parray_type type; /* array type (default FIXED) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 void **datas; /* array of data */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 int length; /* number of element inside */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 size_t size; /* current buffer size (allocated memory) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 int bsize; /* block size (used when growing array) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 int i; /* only for PARRAY_FOREACH(_R) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 };
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 typedef void (*parray_map_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 typedef int (*parray_cmp_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
69
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
45 struct parray *parray_new(enum parray_type, int);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
46 int parray_push(struct parray *, void *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
47 int parray_insert(struct parray *, void *, int);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
48 int parray_append(struct parray *, void *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
49 void parray_pop(struct parray *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
50 void parray_unqueue(struct parray *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
51 void parray_remove(struct parray *, int);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
52 void parray_unref(struct parray *, const void *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
53 int parray_iswap(struct parray *, int, int);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
54 int parray_pswap(struct parray *, const void *, const void *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
55 void parray_map(const struct parray *, parray_map_fn, void *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
56 int parray_find(const struct parray *, parray_cmp_fn, void **, void *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
57 void parray_clear(struct parray *);
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
58 void parray_free(struct parray *);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 #define PARRAY_HEAD(a) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 (a->datas[0])
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 #define PARRAY_TAIL(a) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 (a->datas[(a->length == 0) ? 0 : a->length - 1])
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 #define PARRAY_INDEX(a, i) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 (((i) < 0 || (a)->length == 0) ? (PARRAY_HEAD((a))) /* < 0 head */ \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 : ((i) >= (a)->length) ? (PARRAY_TAIL((a))) /* > l tail */ \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 : ((a)->datas[i])) /* correct */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
68
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 #define PARRAY_FOREACH_R(a, var) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 for ((a)->i = 0, var = PARRAY_TAIL((a)); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 (a)->i < (a)->length; ++(a)->i, var = PARRAY_INDEX((a), (a)->i))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
72
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 #define PARRAY_FOREACH(a, var) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 for ((a)->i = 0, var = PARRAY_INDEX((a), (a)->i); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 (a)->i < (a)->length; ++(a)->i, var = PARRAY_INDEX((a), (a)->i))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
69
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
77 /* Only for PARRAY_FIXED */
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
78 #define PARRAY_FULL(a) \
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
79 ((a)->length == (a)->bsize)
8f6d3850fac1 Remove useless attributes and add [P]ARRAY_FULL
David Demelier <markand@malikania.fr>
parents: 67
diff changeset
80
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 #define PARRAY_FLUSH(a) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 do { \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 void *i; \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 PARRAY_FOREACH_R(a, i) { \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 free(i); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 parray_unqueue((a)); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 } \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 (a)->length = 0; \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 } while (/* CONSTCOND */ 0);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
92
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
93 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
94 }
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
95 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
96
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 #endif /* _PARRAY_H_ */