annotate parray.h @ 57:311eaa9d004c

Renamed pack_* fonction for our guidelines
author David Demelier <markand@malikania.fr>
date Wed, 09 Nov 2011 18:35:35 +0100
parents 82bbd3b869e3
children 8a8db17c02a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * array.h -- manipulate dynamic pointer arrays
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2011, David Demelier <markand@malikania.fr>
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _PARRAY_H_
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _PARRAY_H_
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #define PARRAY_DEFAULT_BSIZE 128
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
50
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
24 enum parray_type {
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
25 PARRAY_FIXED = 0,
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
26 PARRAY_AUTO = 1
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
27 };
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 struct parray {
50
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
30 enum parray_type type; /* array type (default FIXED) */
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
31 void **datas; /* array of data */
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
32 int length; /* number of element inside */
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
33 size_t size; /* current buffer size (allocated memory) */
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
34 int bsize; /* block size (used when growing array) */
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
35 int i; /* only for PARRAY_FOREACH(_R) */
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 };
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
50
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
38 typedef void (*parray_map_fn)(void *, void *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
39 typedef int (*parray_cmp_fn)(void *, void *);
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
50
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
41 struct parray *parray_new(enum parray_type, int);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
42 int parray_push(struct parray *, void *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
43 int parray_insert(struct parray *, void *, int);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
44 int parray_append(struct parray *, void *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
45 void parray_pop(struct parray *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
46 void parray_unqueue(struct parray *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
47 void parray_remove(struct parray *, int);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
48 void parray_unref(struct parray *, const void *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
49 int parray_iswap(struct parray *, int, int);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
50 int parray_pswap(struct parray *, const void *, const void *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
51 void parray_map(const struct parray *, parray_map_fn, void *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
52 void *parray_find(const struct parray *, parray_cmp_fn, int *, void *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
53 void parray_clear(struct parray *);
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
54 void parray_free(struct parray *);
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
55
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 #define PARRAY_HEAD(a) \
51
82bbd3b869e3 Fix some problem with ()
David Demelier <markand@malikania.fr>
parents: 50
diff changeset
57 (a->datas[0])
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 #define PARRAY_TAIL(a) \
51
82bbd3b869e3 Fix some problem with ()
David Demelier <markand@malikania.fr>
parents: 50
diff changeset
59 (a->datas[(a->length == 0) ? 0 : a->length - 1])
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 #define PARRAY_INDEX(a, i) \
51
82bbd3b869e3 Fix some problem with ()
David Demelier <markand@malikania.fr>
parents: 50
diff changeset
61 (((i) < 0 || (a)->length == 0) ? (PARRAY_HEAD((a))) /* < 0 head */ \
82bbd3b869e3 Fix some problem with ()
David Demelier <markand@malikania.fr>
parents: 50
diff changeset
62 : ((i) >= (a)->length) ? (PARRAY_TAIL((a))) /* > l tail */ \
82bbd3b869e3 Fix some problem with ()
David Demelier <markand@malikania.fr>
parents: 50
diff changeset
63 : ((a)->datas[i])) /* correct */
38
f69408c0441a Modified FOREACH function for more security
David Demelier <markand@malikania.fr>
parents: 36
diff changeset
64
f69408c0441a Modified FOREACH function for more security
David Demelier <markand@malikania.fr>
parents: 36
diff changeset
65 #define PARRAY_FOREACH_R(a, var) \
51
82bbd3b869e3 Fix some problem with ()
David Demelier <markand@malikania.fr>
parents: 50
diff changeset
66 for ((a)->i = 0, var = PARRAY_TAIL((a)); \
82bbd3b869e3 Fix some problem with ()
David Demelier <markand@malikania.fr>
parents: 50
diff changeset
67 (a)->i < (a)->length; ++(a)->i, var = PARRAY_INDEX((a), (a)->i))
38
f69408c0441a Modified FOREACH function for more security
David Demelier <markand@malikania.fr>
parents: 36
diff changeset
68
f69408c0441a Modified FOREACH function for more security
David Demelier <markand@malikania.fr>
parents: 36
diff changeset
69 #define PARRAY_FOREACH(a, var) \
50
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
70 for ((a)->i = 0, var = PARRAY_INDEX((a), (a)->i); \
2901c594eaef And last commit applied to parray too
David Demelier <markand@malikania.fr>
parents: 44
diff changeset
71 (a)->i < (a)->length; ++(a)->i, var = PARRAY_INDEX((a), (a)->i))
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
72
40
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
73 #define PARRAY_FLUSH(a) \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
74 do { \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
75 void *i; \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
76 \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
77 PARRAY_FOREACH_R(a, i) { \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
78 free(i); \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
79 parray_unqueue((a)); \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
80 } \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
81 \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
82 (a)->length = 0; \
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
83 } while (/* CONSTCOND */ 0);
d741c948de89 Added a convenient macro PARRAY_FLUSH to free all objects
David Demelier <markand@malikania.fr>
parents: 38
diff changeset
84
36
fdc3736ff806 Added parray.c and parray.h:
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 #endif /* _PARRAY_H_ */