annotate array.h @ 134:195cdc5f4a32

Cosmetic
author David Demelier <markand@malikania.fr>
date Mon, 12 Mar 2012 21:49:59 +0100
parents 5917096facb9
children 07800b7af208
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 *
98
b1a084c030c8 Happy new year
David Demelier <markand@malikania.fr>
parents: 94
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 _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
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
22 #ifdef __cplusplus
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
23 extern "C" {
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
24 #endif
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
25
91
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
26 #include <stdarg.h>
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
27
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
28 #ifndef ARRAY_DEFAULT_BSIZE
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #define ARRAY_DEFAULT_BSIZE 128
91
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
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: 118
diff changeset
32 enum {
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
33 ARRAY_AUTO = 0,
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
34 ARRAY_FIXED = 1
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
35 };
62
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 struct array {
118
3c51b1f2974e Same for array
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
38 int type; /* array's type (default FIXED) */
3c51b1f2974e Same for array
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
39 void *data; /* array of data */
3c51b1f2974e Same for array
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
40 int length; /* number of element inside */
3c51b1f2974e Same for array
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
41 size_t size; /* current buffer size (allocated memory) */
3c51b1f2974e Same for array
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
42 size_t unit; /* unit size (sizeof the object) */
3c51b1f2974e Same for array
David Demelier <markand@malikania.fr>
parents: 99
diff changeset
43 int bsize; /* block size (used when growing array) */
91
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
44
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 91
diff changeset
45 /* Own allocation functions */
91
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
46 void * (*malloc)(size_t);
b3ba5f5df3b9 New style for array.c and array.h, no pointer to these object thus
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
47 void * (*realloc)(void *, size_t);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 };
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 typedef void (*array_map_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 typedef int (*array_cmp_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
53 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
54 array_init(struct array *, size_t);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
55
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
56 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
57 array_set(struct array *, const char *, ...);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
58
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
59 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
60 array_push(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
61
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
62 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
63 array_insert(struct array *, const void *, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
64
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
65 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
66 array_append(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
67
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
68 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
69 array_pop(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
70
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
71 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
72 array_unqueue(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
73
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
74 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
75 array_iremove(struct array *, int);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
134
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
77 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
78 array_premove(struct array *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
79
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
80 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
81 array_iswap(struct array *, int, int);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
82
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
83 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
84 array_pswap(struct array *, const void *, const void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
85
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
86 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
87 array_map(const struct array *, array_map_fn, void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
88
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
89 int
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
90 array_find(const struct array *, array_cmp_fn, void *, void *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
91
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
92 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
93 array_clear(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
94
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
95 void
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
96 array_free(struct array *);
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
97
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
98 #define ARRAY_FOREACH(a, var, i) \
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
99 for (i = 0, (var) = (a)->data; \
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
100 i < (a)->length; \
195cdc5f4a32 Cosmetic
David Demelier <markand@malikania.fr>
parents: 124
diff changeset
101 ++i, ++(var))
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
102
124
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
103 #ifdef __cplusplus
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
104 }
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
105 #endif
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 118
diff changeset
106
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 #endif /* _ARRAY_H_ */