annotate parray.h @ 129:2f71e113be63

Remove copy and ncopy and putc/puts
author David Demelier <markand@malikania.fr>
date Thu, 08 Mar 2012 23:48:36 +0100
parents 5917096facb9
children 195cdc5f4a32
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 *
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
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
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
26 #include <stdarg.h>
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
27
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 {
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 117
diff changeset
33 PARRAY_AUTO = 0,
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 117
diff changeset
34 PARRAY_FIXED = 1
5917096facb9 Use enum and add #ifdef __cplusplus
David Demelier <markand@malikania.fr>
parents: 117
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 parray {
117
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
38 int type; /* array type (default FIXED) */
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
39 void **data; /* array of data */
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
40 int length; /* number of element inside */
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
41 size_t size; /* current buffer size (allocated memory) */
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
42 int bsize; /* block size (used when growing array) */
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
43
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
44 /* Own allocation functions */
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
45 void * (*malloc)(size_t);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
46 void * (*realloc)(void *, size_t);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 };
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 typedef void (*parray_map_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 typedef int (*parray_cmp_fn)(void *, void *);
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
93
9ebea85c7765 Use pointer instead of copying variable in ARRAY_FOREACH, then you can modify it
David Demelier <markand@malikania.fr>
parents: 92
diff changeset
52 int parray_init(struct parray *);
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
53 void parray_set(struct parray *, const char *, ...);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
54 int parray_push(struct parray *, void *);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
55 int parray_insert(struct parray *, void *, int);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
56 int parray_append(struct parray *, void *);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
57 void parray_pop(struct parray *);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
58 void parray_unqueue(struct parray *);
117
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
59 void parray_iremove(struct parray *, int);
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
60 void parray_premove(struct parray *, const void *);
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
61 int parray_iswap(struct parray *, int, int);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
62 int parray_pswap(struct parray *, const void *, const void *);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
63 void parray_map(const struct parray *, parray_map_fn, void *);
108
d5ea329ba28e Use same semantic as array.c for _find
David Demelier <markand@malikania.fr>
parents: 98
diff changeset
64 int parray_find(const struct parray *, parray_cmp_fn, void *, void *);
92
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
65 void parray_clear(struct parray *);
4d723e81b685 Same thing for parray
David Demelier <markand@malikania.fr>
parents: 69
diff changeset
66 void parray_free(struct parray *);
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
67
117
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
68 #define PARRAY_FOREACH(a, o, i) \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
69 for (i = 0, o = (a)->data[i]; \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
70 i < (a)->length; \
bbe86bdb55da Update parray for a lot of things
David Demelier <markand@malikania.fr>
parents: 108
diff changeset
71 ++i, o = (a)->data[i])
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
72
66
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
73 #ifdef __cplusplus
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
74 }
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
75 #endif
f773c76b1f3c Added extern C tests
David Demelier <markand@malikania.fr>
parents: 62
diff changeset
76
62
d10ab6bc555d HG self failure
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 #endif /* _PARRAY_H_ */