annotate array.h @ 67:cff6869fbc94

Modified [p]array_find to return the index for a better usage
author David Demelier <markand@malikania.fr>
date Thu, 10 Nov 2011 18:27:04 +0100
parents f773c76b1f3c
children 8f6d3850fac1
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 *
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 _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
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 /* Add some nonnull attributes for gcc/clang */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 #ifdef __GNUC__
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 # define __at_malloc __attribute__ ((malloc))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 # define __at_nonnull(...) __attribute__ ((nonnull (__VA_ARGS__)))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 #else
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 # define __at_malloc
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 # define __at_nonnull(...)
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 #endif
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 #define ARRAY_DEFAULT_BSIZE 128
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 enum array_type {
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 ARRAY_FIXED = 0,
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 ARRAY_AUTO = 1
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 struct array {
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 enum array_type type; /* array's type (default FIXED) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 void *data; /* array of data */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 int length; /* number of element inside */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 size_t size; /* current buffer size (allocated memory) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 size_t unit; /* unit size (sizeof the object) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 int bsize; /* block size (used when growing array) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 int i; /* only for ARRAY_FOREACH(_R) */
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 };
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 typedef void (*array_map_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 typedef int (*array_cmp_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 struct array *array_new(enum array_type, size_t, int) __at_malloc;
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 int array_push(struct array *, const void *) __at_nonnull(1, 2);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 int array_insert(struct array *, const void *, int) __at_nonnull(1, 2);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 int array_append(struct array *, const void *) __at_nonnull(1, 2);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 void array_pop(struct array *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 void array_unqueue(struct array *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 void array_remove(struct array *, int) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 void array_unref(struct array *, const void *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 int array_iswap(struct array *, int, int) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 int array_pswap(struct array *, const void *, const void *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 void array_map(const struct array *, array_map_fn, void *) __at_nonnull(1, 2);
67
cff6869fbc94 Modified [p]array_find to return the index for a better usage
David Demelier <markand@malikania.fr>
parents: 66
diff changeset
66 int array_find(const struct array *, array_cmp_fn, void *, void *) __at_nonnull(1, 2);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 void array_clear(struct array *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 void array_free(struct array *) __at_nonnull(1);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 #define ARRAY_HEAD(a, type) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 (((type *)a->data)[0])
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 #define ARRAY_TAIL(a, type) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 (((type *)a->data)[(a->length == 0) ? 0 : a->length - 1])
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 #define ARRAY_INDEX(a, i, type) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 ((type *)(a)->data)[((i) < 0) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 ? 0 : ((i) >= (a)->length) ? (a)->length - 1 : (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 ARRAY_FOREACH_R(a, var) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 for ((a)->i = 0, var = ARRAY_TAIL((a)); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 (a)->i < (a)->length; ++(a)->i, --var)
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 ARRAY_FOREACH(a, var, type) \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 for ((a)->i = 0, var = ARRAY_HEAD((a), type); \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 (a)->i < (a)->length; \
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 ++(a)->i, var = ARRAY_INDEX((a), (a)->i, type))
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
87 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
88 }
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
89 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
90
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 #endif /* _ARRAY_H_ */