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