Add array framework that works with any type.
[apps/pfixtools.git] / common / array.h
1 /******************************************************************************/
2 /*          pfixtools: a collection of postfix related tools                  */
3 /*          ~~~~~~~~~                                                         */
4 /*  ________________________________________________________________________  */
5 /*                                                                            */
6 /*  Redistribution and use in source and binary forms, with or without        */
7 /*  modification, are permitted provided that the following conditions        */
8 /*  are met:                                                                  */
9 /*                                                                            */
10 /*  1. Redistributions of source code must retain the above copyright         */
11 /*     notice, this list of conditions and the following disclaimer.          */
12 /*  2. Redistributions in binary form must reproduce the above copyright      */
13 /*     notice, this list of conditions and the following disclaimer in the    */
14 /*     documentation and/or other materials provided with the distribution.   */
15 /*  3. The names of its contributors may not be used to endorse or promote    */
16 /*     products derived from this software without specific prior written     */
17 /*     permission.                                                            */
18 /*                                                                            */
19 /*  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND   */
20 /*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     */
21 /*  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR        */
22 /*  PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS    */
23 /*  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR    */
24 /*  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF      */
25 /*  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS  */
26 /*  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN   */
27 /*  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)   */
28 /*  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF    */
29 /*  THE POSSIBILITY OF SUCH DAMAGE.                                           */
30 /******************************************************************************/
31
32 /*
33  * Copyright © 2008 Florent Bruneau
34  */
35
36 #ifndef PFIXTOOLS_ARRAY_H
37 #define PFIXTOOLS_ARRAY_H
38
39 #include "common.h"
40 #include "mem.h"
41
42 #define PRIV_ARRAY(Type)                                                       \
43     struct {                                                                   \
44         Type    *data;                                                         \
45         ssize_t len;                                                           \
46         ssize_t size;                                                          \
47     }
48 #define ARRAY(Type)                                                            \
49     typedef PRIV_ARRAY(Type) Type ## _array_t;                                 \
50                                                                                \
51     static inline Type ## _array_t *Type ## _array_new(void)                   \
52     {                                                                          \
53         return p_new(Type ## _array_t, 1);                                     \
54     }                                                                          \
55                                                                                \
56     static inline void Type ## _array_delete(Type ## _array_t **array)         \
57     {                                                                          \
58         if (*array) {                                                          \
59             array_wipe(**array);                                               \
60             p_delete(array);                                                   \
61         }                                                                      \
62     }
63
64 #define ARRAY_INIT { NULL, 0, 0 }
65
66 #define array_init(array) (array) = ARRAY_INIT
67 #define array_wipe(array)                                                      \
68     do {                                                                       \
69         p_delete(&(array).data);                                               \
70         (array).len  = 0;                                                      \
71         (array).size = 0;                                                      \
72     } while (0)
73 #define array_add(array, obj)                                                  \
74     do {                                                                       \
75         array_ensure_capacity_delta(array, 1);                                 \
76         (array).data[(array).len++] = (obj);                                   \
77     } while (0)
78 #define array_append(array, objs, len)                                         \
79     do {                                                                       \
80         const ssize_t __len = (len);                                           \
81         array_ensure_capacity_delta(array, __len);                             \
82         memcpy((array).data + (array).len, objs,                               \
83                __len * sizeof(*(array).data));                                 \
84         (array).len += __len;                                                  \
85     } while (0)
86 #define array_ensure_capacity(array, goal)                                     \
87     do {                                                                       \
88         if ((array).size < (goal)) {                                           \
89             const ssize_t required_size = (goal);                              \
90             ssize_t next_size = (array).size;                                  \
91             do {                                                               \
92                 next_size = p_alloc_nr(next_size);                             \
93             } while (next_size < required_size);                               \
94             p_allocgrow(&(array).data, next_size, &(array).size);              \
95         }                                                                      \
96     } while (0)
97 #define array_ensure_capacity_delta(array, delta)                              \
98     array_ensure_capacity(array, (array).len + (delta))
99 #define array_ensure_exact_capacity(array, goal)                               \
100     if (array_size(array) < (goal)) {                                          \
101         p_allocgrow(&(array).data, (goal), &(array).size);                     \
102     }
103 #define array_adjust(array)                                                    \
104     do {                                                                       \
105         p_shrink(&(array).data, (array).len, &(array).size);                   \
106     } while (0)
107 #define array_elt(array, n) (array).data[(n)]
108 #define array_ptr(array, n) (array).data + (n)
109
110 ARRAY(char)
111 ARRAY(int)
112
113 #endif