annotate parray.h @ 62:d10ab6bc555d

HG self failure
author David Demelier <markand@malikania.fr>
date Wed, 09 Nov 2011 19:26:09 +0100
parents
children f773c76b1f3c
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
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 /* Add some nonnull attributes for gcc/clang */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #ifdef __GNUC__
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 # define __at_malloc __attribute__ ((malloc))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 # define __at_nonnull(...) __attribute__ ((nonnull (__VA_ARGS__)))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 #else
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 # define __at_malloc
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 # define __at_nonnull(...)
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #endif
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 #define PARRAY_DEFAULT_BSIZE 128
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 enum parray_type {
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 PARRAY_FIXED = 0,
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 PARRAY_AUTO = 1
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 };
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 struct parray {
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 enum parray_type type; /* array type (default FIXED) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 void **datas; /* array of data */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 int length; /* number of element inside */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 size_t size; /* current buffer size (allocated memory) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 int bsize; /* block size (used when growing array) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 int i; /* only for PARRAY_FOREACH(_R) */
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
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 typedef void (*parray_map_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 typedef int (*parray_cmp_fn)(void *, void *);
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 struct parray *parray_new(enum parray_type, int) __at_malloc;
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 int parray_push(struct parray *, void *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 int parray_insert(struct parray *, void *, int) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 int parray_append(struct parray *, void *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 void parray_pop(struct parray *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 void parray_unqueue(struct parray *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 void parray_remove(struct parray *, int) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 void parray_unref(struct parray *, const void *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 int parray_iswap(struct parray *, int, int) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 int parray_pswap(struct parray *, const void *, const void *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 void parray_map(const struct parray *, parray_map_fn, void *) __at_nonnull(1, 2);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 void *parray_find(const struct parray *, parray_cmp_fn, int *, void *) __at_nonnull(1, 2);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 void parray_clear(struct parray *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 void parray_free(struct parray *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 #define PARRAY_HEAD(a) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 (a->datas[0])
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 #define PARRAY_TAIL(a) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 (a->datas[(a->length == 0) ? 0 : a->length - 1])
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 #define PARRAY_INDEX(a, i) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 (((i) < 0 || (a)->length == 0) ? (PARRAY_HEAD((a))) /* < 0 head */ \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 : ((i) >= (a)->length) ? (PARRAY_TAIL((a))) /* > l tail */ \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 : ((a)->datas[i])) /* correct */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
73
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 #define PARRAY_FOREACH_R(a, var) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 for ((a)->i = 0, var = PARRAY_TAIL((a)); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 (a)->i < (a)->length; ++(a)->i, var = PARRAY_INDEX((a), (a)->i))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
77
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 #define PARRAY_FOREACH(a, var) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 for ((a)->i = 0, var = PARRAY_INDEX((a), (a)->i); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 (a)->i < (a)->length; ++(a)->i, var = PARRAY_INDEX((a), (a)->i))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
81
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 #define PARRAY_FLUSH(a) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 do { \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 void *i; \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 PARRAY_FOREACH_R(a, i) { \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 free(i); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 parray_unqueue((a)); \
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 \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 (a)->length = 0; \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 } while (/* CONSTCOND */ 0);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
93
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 #endif /* _PARRAY_H_ */