53896bb31b62a164c4f2b89c57a599f0aea65927
[blender.git] / source / blender / blenlib / BLI_utildefines.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BLI_UTILDEFINES_H__
29 #define __BLI_UTILDEFINES_H__
30
31 /** \file BLI_utildefines.h
32  *  \ingroup bli
33  */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /* avoid many includes for now */
40 #include "BLI_sys_types.h"
41 #include "BLI_compiler_compat.h"
42
43 #ifndef NDEBUG /* for BLI_assert */
44 #include <stdio.h>
45 #endif
46
47
48 /* varargs macros (keep first so others can use) */
49 /* --- internal helpers --- */
50 #define _VA_NARGS_GLUE(x, y) x y
51 #define _VA_NARGS_RETURN_COUNT(\
52         _1_, _2_, _3_, _4_, _5_, _6_, _7_, _8_, _9_, _10_, _11_, _12_, _13_, _14_, _15_, _16_, \
53         _17_, _18_, _19_, _20_, _21_, _22_, _23_, _24_, _25_, _26_, _27_, _28_, _29_, _30_, _31_, _32_, \
54         _33_, _34_, _35_, _36_, _37_, _38_, _39_, _40_, _41_, _42_, _43_, _44_, _45_, _46_, _47_, _48_, \
55         _49_, _50_, _51_, _52_, _53_, _54_, _55_, _56_, _57_, _58_, _59_, _60_, _61_, _62_, _63_, _64_, \
56         count, ...) count
57 #define _VA_NARGS_EXPAND(args) _VA_NARGS_RETURN_COUNT args
58 #define _VA_NARGS_COUNT_MAX64(...) _VA_NARGS_EXPAND((__VA_ARGS__, \
59         64, 63, 62, 61, 60, 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, 49, \
60         48, 47, 46, 45, 44, 43, 42, 41, 40, 39, 38, 37, 36, 35, 34, 33, \
61         32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, \
62         16, 15, 14, 13, 12, 11, 10,  9,  8,  7,  6,  5,  4,  3,  2, 1, 0))
63 #define _VA_NARGS_OVERLOAD_MACRO2(name, count) name##count
64 #define _VA_NARGS_OVERLOAD_MACRO1(name, count) _VA_NARGS_OVERLOAD_MACRO2(name, count)
65 #define _VA_NARGS_OVERLOAD_MACRO(name,  count) _VA_NARGS_OVERLOAD_MACRO1(name, count)
66 /* --- expose for re-use --- */
67 #define VA_NARGS_CALL_OVERLOAD(name, ...) \
68         _VA_NARGS_GLUE(_VA_NARGS_OVERLOAD_MACRO(name, _VA_NARGS_COUNT_MAX64(__VA_ARGS__)), (__VA_ARGS__))
69
70 /* useful for finding bad use of min/max */
71 #if 0
72 /* gcc only */
73 #  define _TYPECHECK(a, b)  ((void)(((typeof(a) *)0) == ((typeof(b) *)0)))
74 #  define MIN2(x, y)          (_TYPECHECK(x, y), (((x) < (y) ? (x) : (y))))
75 #  define MAX2(x, y)          (_TYPECHECK(x, y), (((x) > (y) ? (x) : (y))))
76 #endif
77
78 /* include after _VA_NARGS macro */
79 #include "BLI_compiler_typecheck.h"
80
81 /* min/max */
82 #if defined(__GNUC__) || defined(__clang__)
83
84 #define MIN2(a, b) __extension__ ({  \
85         typeof(a) a_ = (a); typeof(b) b_ = (b); \
86         ((a_) < (b_) ? (a_) : (b_)); })
87
88 #define MAX2(a, b) __extension__ ({  \
89         typeof(a) a_ = (a); typeof(b) b_ = (b); \
90         ((a_) > (b_) ? (a_) : (b_)); })
91
92 #define MIN3(a, b, c) __extension__ ({  \
93         typeof(a) a_ = (a); typeof(b) b_ = (b); typeof(c) c_ = (c); \
94         ((a_ < b_) ? ((a_ < c_) ? a_ : c_) : ((b_ < c_) ? b_ : c_)); })
95
96 #define MAX3(a, b, c) __extension__ ({  \
97         typeof(a) a_ = (a); typeof(b) b_ = (b);  typeof(c) c_ = (c); \
98         ((a_ > b_) ? ((a_ > c_) ? a_ : c_) : ((b_ > c_) ? b_ : c_)); })
99
100 #define MIN4(a, b, c, d) __extension__ ({  \
101         typeof(a) a_ = (a); typeof(b) b_ = (b); typeof(c) c_ = (c); typeof(d) d_ = (d); \
102         ((a_ < b_) ? ((a_ < c_) ? ((a_ < d_) ? a_ : d_) : ((c_ < d_) ? c_ : d_)) : \
103                      ((b_ < c_) ? ((b_ < d_) ? b_ : d_) : ((c_ < d_) ? c_ : d_))); })
104
105 #define MAX4(a, b, c, d) __extension__ ({  \
106         typeof(a) a_ = (a); typeof(b) b_ = (b); typeof(c) c_ = (c); typeof(d) d_ = (d); \
107         ((a_ > b_) ? ((a_ > c_) ? ((a_ > d_) ? a_ : d_) : ((c_ > d_) ? c_ : d_)) : \
108                      ((b_ > c_) ? ((b_ > d_) ? b_ : d_) : ((c_ > d_) ? c_ : d_))); })
109
110 #else
111 #define MIN2(a, b)  ((a) < (b) ? (a) : (b))
112 #define MAX2(a, b)  ((a) > (b) ? (a) : (b))
113
114 #define MIN3(a, b, c)       (MIN2(MIN2((a), (b)), (c)))
115 #define MIN4(a, b, c, d)    (MIN2(MIN2((a), (b)), MIN2((c), (d))))
116
117 #define MAX3(a, b, c)       (MAX2(MAX2((a), (b)), (c)))
118 #define MAX4(a, b, c, d)    (MAX2(MAX2((a), (b)), MAX2((c), (d))))
119 #endif
120
121 /* min/max that return a value of our choice */
122 #define MAX3_PAIR(cmp_a, cmp_b, cmp_c, ret_a, ret_b, ret_c) \
123         ((cmp_a > cmp_b) ? ((cmp_a > cmp_c) ? ret_a : ret_c) : \
124                            ((cmp_b > cmp_c) ? ret_b : ret_c))
125
126 #define MIN3_PAIR(cmp_a, cmp_b, cmp_c, ret_a, ret_b, ret_c) \
127         ((cmp_a < cmp_b) ? ((cmp_a < cmp_c) ? ret_a : ret_c) : \
128                            ((cmp_b < cmp_c) ? ret_b : ret_c))
129
130 #define INIT_MINMAX(min, max) {                                               \
131                 (min)[0] = (min)[1] = (min)[2] =  1.0e30f;                            \
132                 (max)[0] = (max)[1] = (max)[2] = -1.0e30f;                            \
133         } (void)0
134 #define INIT_MINMAX2(min, max) {                                              \
135                 (min)[0] = (min)[1] = 1.0e30f;                                        \
136                 (max)[0] = (max)[1] = -1.0e30f;                                       \
137         } (void)0
138 #define DO_MIN(vec, min) {                                                    \
139                 if ((min)[0] > (vec)[0]) (min)[0] = (vec)[0];                         \
140                 if ((min)[1] > (vec)[1]) (min)[1] = (vec)[1];                         \
141                 if ((min)[2] > (vec)[2]) (min)[2] = (vec)[2];                         \
142         } (void)0
143 #define DO_MAX(vec, max) {                                                    \
144                 if ((max)[0] < (vec)[0]) (max)[0] = (vec)[0];                         \
145                 if ((max)[1] < (vec)[1]) (max)[1] = (vec)[1];                         \
146                 if ((max)[2] < (vec)[2]) (max)[2] = (vec)[2];                         \
147         } (void)0
148 #define DO_MINMAX(vec, min, max) {                                            \
149                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
150                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
151                 if ((min)[2] > (vec)[2] ) (min)[2] = (vec)[2];                        \
152                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
153                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
154                 if ((max)[2] < (vec)[2] ) (max)[2] = (vec)[2];                        \
155         } (void)0
156 #define DO_MINMAX2(vec, min, max) {                                           \
157                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
158                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
159                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
160                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
161         } (void)0
162
163 /* some math and copy defines */
164
165
166 #define SWAP(type, a, b)  {    \
167         type sw_ap;                \
168         CHECK_TYPE(a, type);       \
169         CHECK_TYPE(b, type);       \
170         sw_ap = (a);               \
171         (a) = (b);                 \
172         (b) = sw_ap;               \
173 } (void)0
174
175 /* swap with a temp value */
176 #define SWAP_TVAL(tval, a, b)  {  \
177         CHECK_TYPE_PAIR(tval, a);     \
178         CHECK_TYPE_PAIR(tval, b);     \
179         (tval) = (a);                 \
180         (a) = (b);                    \
181         (b) = (tval);                 \
182 } (void)0
183
184 /* ELEM#(v, ...): is the first arg equal any others? */
185 /* internal helpers*/
186 #define _VA_ELEM2(v, a) \
187        ((v) == (a))
188 #define _VA_ELEM3(v, a, b) \
189        (_VA_ELEM2(v, a) || ((v) == (b)))
190 #define _VA_ELEM4(v, a, b, c) \
191        (_VA_ELEM3(v, a, b) || ((v) == (c)))
192 #define _VA_ELEM5(v, a, b, c, d) \
193        (_VA_ELEM4(v, a, b, c) || ((v) == (d)))
194 #define _VA_ELEM6(v, a, b, c, d, e) \
195        (_VA_ELEM5(v, a, b, c, d) || ((v) == (e)))
196 #define _VA_ELEM7(v, a, b, c, d, e, f) \
197        (_VA_ELEM6(v, a, b, c, d, e) || ((v) == (f)))
198 #define _VA_ELEM8(v, a, b, c, d, e, f, g) \
199        (_VA_ELEM7(v, a, b, c, d, e, f) || ((v) == (g)))
200 #define _VA_ELEM9(v, a, b, c, d, e, f, g, h) \
201        (_VA_ELEM8(v, a, b, c, d, e, f, g) || ((v) == (h)))
202 #define _VA_ELEM10(v, a, b, c, d, e, f, g, h, i) \
203        (_VA_ELEM9(v, a, b, c, d, e, f, g, h) || ((v) == (i)))
204 #define _VA_ELEM11(v, a, b, c, d, e, f, g, h, i, j) \
205        (_VA_ELEM10(v, a, b, c, d, e, f, g, h, i) || ((v) == (j)))
206 #define _VA_ELEM12(v, a, b, c, d, e, f, g, h, i, j, k) \
207        (_VA_ELEM11(v, a, b, c, d, e, f, g, h, i, j) || ((v) == (k)))
208 #define _VA_ELEM13(v, a, b, c, d, e, f, g, h, i, j, k, l) \
209        (_VA_ELEM12(v, a, b, c, d, e, f, g, h, i, j, k) || ((v) == (l)))
210 #define _VA_ELEM14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) \
211        (_VA_ELEM13(v, a, b, c, d, e, f, g, h, i, j, k, l) || ((v) == (m)))
212 #define _VA_ELEM15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) \
213        (_VA_ELEM14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) || ((v) == (n)))
214 #define _VA_ELEM16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) \
215        (_VA_ELEM15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) || ((v) == (o)))
216 #define _VA_ELEM17(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) \
217        (_VA_ELEM16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) || ((v) == (p)))
218
219 /* reusable ELEM macro */
220 #define ELEM(...) VA_NARGS_CALL_OVERLOAD(_VA_ELEM, __VA_ARGS__)
221
222 /* no-op for expressions we don't want to instansiate, but must remian valid */
223 #define EXPR_NOP(expr) (void)(0 ? ((void)(expr), 1) : 0)
224
225 /* shift around elements */
226 #define SHIFT3(type, a, b, c)  {                                              \
227         type tmp;                                                                 \
228         CHECK_TYPE(a, type);                                                      \
229         CHECK_TYPE(b, type);                                                      \
230         CHECK_TYPE(c, type);                                                      \
231         tmp = a;                                                                  \
232         a = c;                                                                    \
233         c = b;                                                                    \
234         b = tmp;                                                                  \
235 } (void)0
236
237 #define SHIFT4(type, a, b, c, d)  {                                           \
238         type tmp;                                                                 \
239         CHECK_TYPE(a, type);                                                      \
240         CHECK_TYPE(b, type);                                                      \
241         CHECK_TYPE(c, type);                                                      \
242         CHECK_TYPE(d, type);                                                      \
243         tmp = a;                                                                  \
244         a = d;                                                                    \
245         d = c;                                                                    \
246         c = b;                                                                    \
247         b = tmp;                                                                  \
248 } (void)0
249
250
251 #define FTOCHAR(val) ((CHECK_TYPE_INLINE(val, float)), \
252                 (char)(((val) <= 0.0f) ? 0 : (((val) > (1.0f - 0.5f / 255.0f)) ? 255 : ((255.0f * (val)) + 0.5f))))
253 #define FTOUSHORT(val) ((CHECK_TYPE_INLINE(val, float)), \
254                 ((val >= 1.0f - 0.5f / 65535) ? 65535 : (val <= 0.0f) ? 0 : (unsigned short)(val * 65535.0f + 0.5f)))
255 #define USHORTTOUCHAR(val) ((unsigned char)(((val) >= 65535 - 128) ? 255 : ((val) + 128) >> 8))
256 #define F3TOCHAR3(v2, v1) {                                                   \
257                 (v1)[0] = FTOCHAR((v2[0]));                                           \
258                 (v1)[1] = FTOCHAR((v2[1]));                                           \
259                 (v1)[2] = FTOCHAR((v2[2]));                                           \
260 } (void)0
261 #define F3TOCHAR4(v2, v1) {                                                   \
262                 (v1)[0] = FTOCHAR((v2[0]));                                           \
263                 (v1)[1] = FTOCHAR((v2[1]));                                           \
264                 (v1)[2] = FTOCHAR((v2[2]));                                           \
265                 (v1)[3] = 255;                                                        \
266 } (void)0
267 #define F4TOCHAR4(v2, v1) {                                                   \
268                 (v1)[0] = FTOCHAR((v2[0]));                                           \
269                 (v1)[1] = FTOCHAR((v2[1]));                                           \
270                 (v1)[2] = FTOCHAR((v2[2]));                                           \
271                 (v1)[3] = FTOCHAR((v2[3]));                                           \
272 } (void)0
273 #define VECCOPY(v1, v2) {                                                     \
274                 *(v1) =   *(v2);                                                      \
275                 *(v1 + 1) = *(v2 + 1);                                                \
276                 *(v1 + 2) = *(v2 + 2);                                                \
277 } (void)0
278 #define VECCOPY2D(v1, v2) {                                                   \
279                 *(v1) =   *(v2);                                                      \
280                 *(v1 + 1) = *(v2 + 1);                                                \
281 } (void)0
282 #define VECADD(v1, v2, v3) {                                                  \
283                 *(v1) =   *(v2)   + *(v3);                                            \
284                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1);                                    \
285                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2);                                    \
286 } (void)0
287 #define VECSUB(v1, v2, v3) {                                                  \
288                 *(v1) =   *(v2)   - *(v3);                                            \
289                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
290                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2);                                    \
291 } (void)0
292 #define VECSUB2D(v1, v2, v3)     {                                            \
293                 *(v1) =   *(v2)   - *(v3);                                            \
294                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
295 } (void)0
296 #define VECADDFAC(v1, v2, v3, fac) {                                          \
297                 *(v1) =   *(v2)   + *(v3) * (fac);                                    \
298                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1) * (fac);                            \
299                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2) * (fac);                            \
300 } (void)0
301 #define VECMADD(v1, v2, v3, v4) {                                             \
302                 *(v1) =   *(v2)   + *(v3) * (*(v4));                                  \
303                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1) * (*(v4 + 1));                      \
304                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2) * (*(v4 + 2));                      \
305 } (void)0
306 #define VECSUBFAC(v1, v2, v3, fac) {                                          \
307                 *(v1) =   *(v2)   - *(v3) * (fac);                                    \
308                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1) * (fac);                            \
309                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2) * (fac);                            \
310 } (void)0
311
312 /* some misc stuff.... */
313
314 /* avoid multiple access for supported compilers */
315 #if defined(__GNUC__) || defined(__clang__)
316
317 #define ABS(a)  ({ \
318         typeof(a) a_ = (a); \
319         ((a_) < 0 ? (-(a_)) : (a_)); })
320 #define SQUARE(a)  ({ \
321         typeof(a) a_ = (a); \
322         ((a_) * (a_)); })
323
324 #else
325
326 #define ABS(a)  ((a) < 0 ? (-(a)) : (a))
327 #define SQUARE(a)  ((a) * (a))
328
329 #endif
330
331 #define CLAMPIS(a, b, c)  ((a) < (b) ? (b) : (a) > (c) ? (c) : (a))
332
333 #define CLAMP(a, b, c)  {           \
334         if      ((a) < (b)) (a) = (b);  \
335         else if ((a) > (c)) (a) = (c);  \
336 } (void)0
337
338 #define CLAMP_MAX(a, c)  {          \
339         if ((a) > (c)) (a) = (c);       \
340 } (void)0
341
342 #define CLAMP_MIN(a, b)  {          \
343         if      ((a) < (b)) (a) = (b);  \
344 } (void)0
345
346 #define CLAMP2(vec, b, c) { \
347         CLAMP((vec)[0], b, c); \
348         CLAMP((vec)[1], b, c); \
349 } (void)0
350
351 #define CLAMP2_MIN(vec, b) { \
352         CLAMP_MIN((vec)[0], b); \
353         CLAMP_MIN((vec)[1], b); \
354 } (void)0
355
356 #define CLAMP2_MAX(vec, b) { \
357         CLAMP_MAX((vec)[0], b); \
358         CLAMP_MAX((vec)[1], b); \
359 } (void)0
360
361 #define CLAMP3(vec, b, c) { \
362         CLAMP((vec)[0], b, c); \
363         CLAMP((vec)[1], b, c); \
364         CLAMP((vec)[2], b, c); \
365 } (void)0
366
367 #define CLAMP3_MIN(vec, b) { \
368         CLAMP_MIN((vec)[0], b); \
369         CLAMP_MIN((vec)[1], b); \
370         CLAMP_MIN((vec)[2], b); \
371 } (void)0
372
373 #define CLAMP3_MAX(vec, b) { \
374         CLAMP_MAX((vec)[0], b); \
375         CLAMP_MAX((vec)[1], b); \
376         CLAMP_MAX((vec)[2], b); \
377 } (void)0
378
379 #define CLAMP4(vec, b, c) { \
380         CLAMP((vec)[0], b, c); \
381         CLAMP((vec)[1], b, c); \
382         CLAMP((vec)[2], b, c); \
383         CLAMP((vec)[3], b, c); \
384 } (void)0
385
386 #define CLAMP4_MIN(vec, b) { \
387         CLAMP_MIN((vec)[0], b); \
388         CLAMP_MIN((vec)[1], b); \
389         CLAMP_MIN((vec)[2], b); \
390         CLAMP_MIN((vec)[3], b); \
391 } (void)0
392
393 #define CLAMP4_MAX(vec, b) { \
394         CLAMP_MAX((vec)[0], b); \
395         CLAMP_MAX((vec)[1], b); \
396         CLAMP_MAX((vec)[2], b); \
397         CLAMP_MAX((vec)[3], b); \
398 } (void)0
399
400 #define IS_EQ(a, b)  ( \
401         CHECK_TYPE_INLINE(a, double), CHECK_TYPE_INLINE(b, double), \
402         ((fabs((double)((a) - (b))) >= (double) FLT_EPSILON) ? false : true))
403
404 #define IS_EQF(a, b)  ( \
405         CHECK_TYPE_INLINE(a, float), CHECK_TYPE_INLINE(b, float), \
406         ((fabsf((float)((a) - (b))) >= (float) FLT_EPSILON) ? false : true))
407
408 #define IS_EQT(a, b, c) ((a > b) ? (((a - b) <= c) ? 1 : 0) : ((((b - a) <= c) ? 1 : 0)))
409 #define IN_RANGE(a, b, c) ((b < c) ? ((b < a && a < c) ? 1 : 0) : ((c < a && a < b) ? 1 : 0))
410 #define IN_RANGE_INCL(a, b, c) ((b < c) ? ((b <= a && a <= c) ? 1 : 0) : ((c <= a && a <= b) ? 1 : 0))
411
412 /* unpack vector for args */
413 #define UNPACK2(a)  ((a)[0]),   ((a)[1])
414 #define UNPACK3(a)  UNPACK2(a), ((a)[2])
415 #define UNPACK4(a)  UNPACK3(a), ((a)[3])
416 /* pre may be '&', '*' or func, post may be '->member' */
417 #define UNPACK2_EX(pre, a, post)  (pre((a)[0])post),        (pre((a)[1])post)
418 #define UNPACK3_EX(pre, a, post)  UNPACK2_EX(pre, a, post), (pre((a)[2])post)
419 #define UNPACK4_EX(pre, a, post)  UNPACK3_EX(pre, a, post), (pre((a)[3])post)
420
421 /* array helpers */
422 #define ARRAY_LAST_ITEM(arr_start, arr_dtype, tot) \
423         (arr_dtype *)((char *)arr_start + (sizeof(*((arr_dtype *)NULL)) * (size_t)(tot - 1)))
424
425 #define ARRAY_HAS_ITEM(arr_item, arr_start, tot)  ( \
426         CHECK_TYPE_PAIR_INLINE(arr_start, arr_item), \
427         ((unsigned int)((arr_item) - (arr_start)) < (unsigned int)(tot)))
428
429 #define ARRAY_DELETE(arr, index, tot_delete, tot)  { \
430                 BLI_assert(index + tot_delete <= tot);  \
431                 memmove(&(arr)[(index)], \
432                         &(arr)[(index) + (tot_delete)], \
433                          (((tot) - (index)) - (tot_delete)) * sizeof(*(arr))); \
434         } (void)0
435
436 /* assuming a static array */
437 #if defined(__GNUC__) && !defined(__cplusplus)
438 #  define ARRAY_SIZE(arr)                                                     \
439         ((sizeof(struct {int isnt_array : ((void *)&(arr) == &(arr)[0]);}) * 0) + \
440          (sizeof(arr) / sizeof(*(arr))))
441 #else
442 #  define ARRAY_SIZE(arr)  (sizeof(arr) / sizeof(*(arr)))
443 #endif
444
445 /* Like offsetof(typeof(), member), for non-gcc compilers */
446 #define OFFSETOF_STRUCT(_struct, _member) \
447         ((((char *)&((_struct)->_member)) - ((char *)(_struct))) + sizeof((_struct)->_member))
448
449 /* memcpy, skipping the first part of a struct,
450  * ensures 'struct_dst' isn't const and that the offset can be computed at compile time */
451 #define MEMCPY_STRUCT_OFS(struct_dst, struct_src, member)  { \
452         CHECK_TYPE_NONCONST(struct_dst); \
453         ((void)(struct_dst == struct_src), \
454          memcpy((char *)(struct_dst)  + OFFSETOF_STRUCT(struct_dst, member), \
455                 (char *)(struct_src)  + OFFSETOF_STRUCT(struct_dst, member), \
456                 sizeof(*(struct_dst)) - OFFSETOF_STRUCT(struct_dst, member))); \
457 } (void)0
458
459 /* Warning-free macros for storing ints in pointers. Use these _only_
460  * for storing an int in a pointer, not a pointer in an int (64bit)! */
461 #define SET_INT_IN_POINTER(i)    ((void *)(intptr_t)(i))
462 #define GET_INT_FROM_POINTER(i)  ((void)0, ((int)(intptr_t)(i)))
463
464 #define SET_UINT_IN_POINTER(i)    ((void *)(uintptr_t)(i))
465 #define GET_UINT_FROM_POINTER(i)  ((void)0, ((unsigned int)(uintptr_t)(i)))
466
467
468 /* Macro to convert a value to string in the preprocessor
469  * STRINGIFY_ARG: gives the argument as a string
470  * STRINGIFY_APPEND: appends any argument 'b' onto the string argument 'a',
471  *   used by STRINGIFY because some preprocessors warn about zero arguments
472  * STRINGIFY: gives the argument's value as a string */
473 #define STRINGIFY_ARG(x) "" #x
474 #define STRINGIFY_APPEND(a, b) "" a #b
475 #define STRINGIFY(x) STRINGIFY_APPEND("", x)
476
477
478 /* generic strcmp macros */
479 #define STREQ(a, b) (strcmp(a, b) == 0)
480 #define STRCASEEQ(a, b) (strcasecmp(a, b) == 0)
481 #define STREQLEN(a, b, n) (strncmp(a, b, n) == 0)
482 #define STRCASEEQLEN(a, b, n) (strncasecmp(a, b, n) == 0)
483
484 #define STRPREFIX(a, b) (strncmp((a), (b), strlen(b)) == 0)
485 /* useful for debugging */
486 #define AT __FILE__ ":" STRINGIFY(__LINE__)
487
488
489 /* UNUSED macro, for function argument */
490 #ifdef __GNUC__
491 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
492 #else
493 #  define UNUSED(x) UNUSED_ ## x
494 #endif
495
496 #ifdef __GNUC__
497 #  define UNUSED_FUNCTION(x) __attribute__((__unused__)) UNUSED_ ## x
498 #else
499 #  define UNUSED_FUNCTION(x) UNUSED_ ## x
500 #endif
501
502 /**
503  * UNUSED_VARS#(a, ...): quiet unused warnings
504  *
505  * <pre>
506  * for i in range(16):
507  *     args = [(chr(ord('a') + (c % 26)) + (chr(ord('0') + (c // 26)))) for c in range(i + 1)]
508  *     print("#define _VA_UNUSED_VARS_%d(%s) \\" % (i + 1, ", ".join(args)))
509  *     print("\t((void)(%s)%s)" %
510  *             (args[0], ((", _VA_UNUSED_VARS_" + str(i) + "(%s)") if i else "%s") % ", ".join((args[1:]))))
511  * </pre>
512  *
513  */
514
515 #define _VA_UNUSED_VARS_1(a0) \
516         ((void)(a0))
517 #define _VA_UNUSED_VARS_2(a0, b0) \
518         ((void)(a0), _VA_UNUSED_VARS_1(b0))
519 #define _VA_UNUSED_VARS_3(a0, b0, c0) \
520         ((void)(a0), _VA_UNUSED_VARS_2(b0, c0))
521 #define _VA_UNUSED_VARS_4(a0, b0, c0, d0) \
522         ((void)(a0), _VA_UNUSED_VARS_3(b0, c0, d0))
523 #define _VA_UNUSED_VARS_5(a0, b0, c0, d0, e0) \
524         ((void)(a0), _VA_UNUSED_VARS_4(b0, c0, d0, e0))
525 #define _VA_UNUSED_VARS_6(a0, b0, c0, d0, e0, f0) \
526         ((void)(a0), _VA_UNUSED_VARS_5(b0, c0, d0, e0, f0))
527 #define _VA_UNUSED_VARS_7(a0, b0, c0, d0, e0, f0, g0) \
528         ((void)(a0), _VA_UNUSED_VARS_6(b0, c0, d0, e0, f0, g0))
529 #define _VA_UNUSED_VARS_8(a0, b0, c0, d0, e0, f0, g0, h0) \
530         ((void)(a0), _VA_UNUSED_VARS_7(b0, c0, d0, e0, f0, g0, h0))
531 #define _VA_UNUSED_VARS_9(a0, b0, c0, d0, e0, f0, g0, h0, i0) \
532         ((void)(a0), _VA_UNUSED_VARS_8(b0, c0, d0, e0, f0, g0, h0, i0))
533 #define _VA_UNUSED_VARS_10(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0) \
534         ((void)(a0), _VA_UNUSED_VARS_9(b0, c0, d0, e0, f0, g0, h0, i0, j0))
535 #define _VA_UNUSED_VARS_11(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0) \
536         ((void)(a0), _VA_UNUSED_VARS_10(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0))
537 #define _VA_UNUSED_VARS_12(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0) \
538         ((void)(a0), _VA_UNUSED_VARS_11(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0))
539 #define _VA_UNUSED_VARS_13(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0) \
540         ((void)(a0), _VA_UNUSED_VARS_12(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0))
541 #define _VA_UNUSED_VARS_14(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0) \
542         ((void)(a0), _VA_UNUSED_VARS_13(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0))
543 #define _VA_UNUSED_VARS_15(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0) \
544         ((void)(a0), _VA_UNUSED_VARS_14(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0))
545 #define _VA_UNUSED_VARS_16(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0, p0) \
546         ((void)(a0), _VA_UNUSED_VARS_15(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0, p0))
547
548
549 /* reusable ELEM macro */
550 #define UNUSED_VARS(...) VA_NARGS_CALL_OVERLOAD(_VA_UNUSED_VARS_, __VA_ARGS__)
551
552 /*little macro so inline keyword works*/
553 #if defined(_MSC_VER)
554 #  define BLI_INLINE static __forceinline
555 #else
556 #  if (defined(__APPLE__) && defined(__ppc__))
557 /* static inline __attribute__ here breaks osx ppc gcc42 build */
558 #    define BLI_INLINE static __attribute__((always_inline))
559 #  else
560 #    define BLI_INLINE static inline __attribute__((always_inline))
561 #  endif
562 #endif
563
564
565 /* BLI_assert(), default only to print
566  * for aborting need to define WITH_ASSERT_ABORT
567  */
568 #ifndef NDEBUG
569 extern void BLI_system_backtrace(FILE *fp);
570 #  ifdef WITH_ASSERT_ABORT
571 #    define _BLI_DUMMY_ABORT abort
572 #  else
573 #    define _BLI_DUMMY_ABORT() (void)0
574 #  endif
575 #  if defined(__GNUC__) || defined(_MSC_VER) /* check __func__ is available */
576 #    define BLI_assert(a)                                                     \
577         (void)((!(a)) ?  (                                                        \
578                 (                                                                     \
579                 BLI_system_backtrace(stderr),                                         \
580                 fprintf(stderr,                                                       \
581                         "BLI_assert failed: %s:%d, %s(), at \'%s\'\n",                    \
582                         __FILE__, __LINE__, __func__, STRINGIFY(a)),                      \
583                 _BLI_DUMMY_ABORT(),                                                   \
584                 NULL)) : NULL)
585 #  else
586 #    define BLI_assert(a)                                                     \
587         (void)((!(a)) ?  (                                                        \
588                 (                                                                     \
589                 fprintf(stderr,                                                       \
590                         "BLI_assert failed: %s:%d, at \'%s\'\n",                          \
591                         __FILE__, __LINE__, STRINGIFY(a)),                                \
592                 _BLI_DUMMY_ABORT(),                                                   \
593                 NULL)) : NULL)
594 #  endif
595 #else
596 #  define BLI_assert(a) (void)0
597 #endif
598
599 /* C++ can't use _Static_assert, expects static_assert() but c++0x only,
600  * Coverity also errors out. */
601 #if (!defined(__cplusplus)) && \
602     (!defined(__COVERITY__)) && \
603     (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406))  /* gcc4.6+ only */
604 #  define BLI_STATIC_ASSERT(a, msg) __extension__ _Static_assert(a, msg);
605 #else
606    /* TODO msvc, clang */
607 #  define BLI_STATIC_ASSERT(a, msg)
608 #endif
609
610 /* hints for branch prediction, only use in code that runs a _lot_ where */
611 #ifdef __GNUC__
612 #  define LIKELY(x)       __builtin_expect(!!(x), 1)
613 #  define UNLIKELY(x)     __builtin_expect(!!(x), 0)
614 #else
615 #  define LIKELY(x)       (x)
616 #  define UNLIKELY(x)     (x)
617 #endif
618
619 #ifdef __cplusplus
620 }
621 #endif
622
623 #endif  /* __BLI_UTILDEFINES_H__ */