Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_array.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_ARRAY_H__
21 #define __BLI_ARRAY_H__
22
23 /** \file \ingroup bli
24  *  \brief A (mainly) macro array library.
25  */
26
27 /* -------------------------------------------------------------------- */
28 /** \name Internal defines
29  * \{ */
30
31 /** this returns the entire size of the array, including any buffering. */
32 #define _bli_array_totalsize_dynamic(arr)  (                                  \
33         ((arr) == NULL) ?                                                         \
34             0 :                                                                   \
35             MEM_allocN_len(arr) / sizeof(*(arr))                                  \
36 )
37
38 #define _bli_array_totalsize_static(arr)  \
39         (sizeof(_##arr##_static) / sizeof(*(arr)))
40
41 #define _bli_array_totalsize(arr)  (                                          \
42         (size_t)                                                                  \
43         (((void *)(arr) == (void *)_##arr##_static && (void *)(arr) != NULL) ?    \
44             _bli_array_totalsize_static(arr) :                                    \
45             _bli_array_totalsize_dynamic(arr))                                    \
46 )
47
48 /** \} */
49
50
51 /** BLI_array.c
52  *
53  * Doing the realloc in a macro isn't so simple,
54  * so use a function the macros can use.
55  */
56 void _bli_array_grow_func(
57         void **arr_p, const void *arr_static,
58         const int sizeof_arr_p, const int arr_len, const int num,
59         const char *alloc_str);
60
61
62 /* -------------------------------------------------------------------- */
63 /** \name Public defines
64  * \{ */
65
66 /** use ``sizeof(*(arr))`` to ensure the array exists and is an array */
67 #define BLI_array_declare(arr)                                                \
68         int   _##arr##_len = ((void)(sizeof(*(arr))), 0);                         \
69         void *_##arr##_static = NULL
70
71 /**
72  * this will use stack space, up to maxstatic array elements, before
73  * switching to dynamic heap allocation */
74 #define BLI_array_staticdeclare(arr, maxstatic)                               \
75         int   _##arr##_len = 0;                                                   \
76         char  _##arr##_static[maxstatic * sizeof(*(arr))]
77
78 /** returns the logical size of the array, not including buffering. */
79 #define BLI_array_len(arr) ((void)0, _##arr##_len)
80
81 /**
82  * Grow the array by a fixed number of items.
83  *
84  * Allow for a large 'num' value when the new size is more than double
85  * to allocate the exact sized array. */
86 #define BLI_array_reserve(arr, num)  (void)(                                  \
87         (((void *)(arr) == NULL) &&                                               \
88          ((void *)(_##arr##_static) != NULL) &&                                   \
89         /* don't add _##arr##_len below because it must be zero */                \
90          (_bli_array_totalsize_static(arr) >= _##arr##_len + (num))) ?            \
91         /* we have an empty array and a static var big enough */                  \
92         (void)(arr = (void *)_##arr##_static)                                     \
93             :                                                                     \
94         /* use existing static array or allocate */                               \
95         (LIKELY(_bli_array_totalsize(arr) >= _##arr##_len + (num)) ?              \
96          (void)0 /* do nothing */ :                                               \
97          _bli_array_grow_func((void **)&(arr), _##arr##_static,                   \
98                                sizeof(*(arr)), _##arr##_len, num,                 \
99                                "BLI_array." #arr))                                \
100         )
101
102
103 /** returns length of array */
104 #define BLI_array_grow_items(arr, num) \
105         (BLI_array_reserve(arr, num), (_##arr##_len += num))
106
107 #define BLI_array_grow_one(arr) \
108         BLI_array_grow_items(arr, 1)
109
110 /** appends an item to the array. */
111 #define BLI_array_append(arr, item)  (                                        \
112         (void) BLI_array_grow_one(arr),                                           \
113         (void) (arr[_##arr##_len - 1] = item)                                     \
114 )
115
116 /**
117  * appends an item to the array and returns a pointer to the item in the array.
118  * item is not a pointer, but actual data value.*/
119 #define BLI_array_append_r(arr, item)  (                                      \
120         (void) BLI_array_grow_one(arr),                                           \
121         (void) (arr[_##arr##_len - 1] = item),                                    \
122         (&arr[_##arr##_len - 1])                                                  \
123 )
124
125 /** appends (grows) & returns a pointer to the uninitialized memory */
126 #define BLI_array_append_ret(arr) \
127         (BLI_array_reserve(arr, 1), &arr[(_##arr##_len++)])
128
129 #define BLI_array_free(arr) {                                                 \
130         if (arr && (char *)arr != _##arr##_static) {                              \
131                 BLI_array_fake_user(arr);                                             \
132                 MEM_freeN(arr);                                                       \
133         } \
134 } ((void)0)
135
136 #define BLI_array_pop(arr)  (                                                 \
137         (arr && _##arr##_len) ?                                                   \
138             arr[--_##arr##_len] :                                                 \
139             NULL                                                                  \
140 )
141
142 /**
143  * Resets the logical size of an array to zero, but doesn't
144  * free the memory. */
145 #define BLI_array_clear(arr)                                                  \
146         { _##arr##_len = 0; } ((void)0)
147
148 /**
149  * Set the length of the array, doesn't actually increase the allocated array
150  * size.  don't use this unless you know what you're doing. */
151 #define BLI_array_len_set(arr, len)                                           \
152         { _##arr##_len = (len); } ((void)0)
153
154 /** only to prevent unused warnings */
155 #define BLI_array_fake_user(arr)                                              \
156         ((void)_##arr##_len,                                                      \
157          (void)_##arr##_static)
158
159 /** \} */
160
161
162 /* -------------------------------------------------------------------- */
163 /** \name Generic Array Utils
164  * other useful defines
165  * (unrelated to the main array macros)
166  *
167  * \{ */
168
169 /**
170  * not part of the 'API' but handy funcs,
171  * same purpose as #BLI_array_staticdeclare()
172  * but use when the max size is known ahead of time */
173 #define BLI_array_fixedstack_declare(arr, maxstatic, realsize, allocstr)      \
174         char _##arr##_static[maxstatic * sizeof(*(arr))];                         \
175         const bool _##arr##_is_static = ((void *)_##arr##_static) != (            \
176             arr = ((realsize) <= maxstatic) ?                                     \
177                 (void *)_##arr##_static :                                         \
178                 MEM_mallocN(sizeof(*(arr)) * (realsize), allocstr)                \
179             )                                                                     \
180
181 #define BLI_array_fixedstack_free(arr)                                        \
182         if (_##arr##_is_static) {                                                 \
183                 MEM_freeN(arr);                                                       \
184         } ((void)0)
185
186 /** \} */
187
188 #endif  /* __BLI_ARRAY_H__ */