Cleanup: comment line length (blenlib)
[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 #include "BLI_utildefines_variadic.h"
43
44 /* We could remove in future. */
45 #include "BLI_assert.h"
46
47 /* useful for finding bad use of min/max */
48 #if 0
49 /* gcc only */
50 #  define _TYPECHECK(a, b)  ((void)(((typeof(a) *)0) == ((typeof(b) *)0)))
51 #  define MIN2(x, y)          (_TYPECHECK(x, y), (((x) < (y) ? (x) : (y))))
52 #  define MAX2(x, y)          (_TYPECHECK(x, y), (((x) > (y) ? (x) : (y))))
53 #endif
54
55 /* include after _VA_NARGS macro */
56 #include "BLI_compiler_typecheck.h"
57
58 /* min/max */
59 #if defined(__GNUC__) || defined(__clang__)
60
61 #define MIN2(a, b) __extension__ ({  \
62         typeof(a) a_ = (a); typeof(b) b_ = (b); \
63         ((a_) < (b_) ? (a_) : (b_)); })
64
65 #define MAX2(a, b) __extension__ ({  \
66         typeof(a) a_ = (a); typeof(b) b_ = (b); \
67         ((a_) > (b_) ? (a_) : (b_)); })
68
69 #define MIN3(a, b, c) __extension__ ({  \
70         typeof(a) a_ = (a); typeof(b) b_ = (b); typeof(c) c_ = (c); \
71         ((a_ < b_) ? ((a_ < c_) ? a_ : c_) : ((b_ < c_) ? b_ : c_)); })
72
73 #define MAX3(a, b, c) __extension__ ({  \
74         typeof(a) a_ = (a); typeof(b) b_ = (b);  typeof(c) c_ = (c); \
75         ((a_ > b_) ? ((a_ > c_) ? a_ : c_) : ((b_ > c_) ? b_ : c_)); })
76
77 #define MIN4(a, b, c, d) __extension__ ({  \
78         typeof(a) a_ = (a); typeof(b) b_ = (b); typeof(c) c_ = (c); typeof(d) d_ = (d); \
79         ((a_ < b_) ? ((a_ < c_) ? ((a_ < d_) ? a_ : d_) : ((c_ < d_) ? c_ : d_)) : \
80                      ((b_ < c_) ? ((b_ < d_) ? b_ : d_) : ((c_ < d_) ? c_ : d_))); })
81
82 #define MAX4(a, b, c, d) __extension__ ({  \
83         typeof(a) a_ = (a); typeof(b) b_ = (b); typeof(c) c_ = (c); typeof(d) d_ = (d); \
84         ((a_ > b_) ? ((a_ > c_) ? ((a_ > d_) ? a_ : d_) : ((c_ > d_) ? c_ : d_)) : \
85                      ((b_ > c_) ? ((b_ > d_) ? b_ : d_) : ((c_ > d_) ? c_ : d_))); })
86
87 #else
88 #define MIN2(a, b)  ((a) < (b) ? (a) : (b))
89 #define MAX2(a, b)  ((a) > (b) ? (a) : (b))
90
91 #define MIN3(a, b, c)       (MIN2(MIN2((a), (b)), (c)))
92 #define MIN4(a, b, c, d)    (MIN2(MIN2((a), (b)), MIN2((c), (d))))
93
94 #define MAX3(a, b, c)       (MAX2(MAX2((a), (b)), (c)))
95 #define MAX4(a, b, c, d)    (MAX2(MAX2((a), (b)), MAX2((c), (d))))
96 #endif
97
98 /* min/max that return a value of our choice */
99 #define MAX3_PAIR(cmp_a, cmp_b, cmp_c, ret_a, ret_b, ret_c) \
100         ((cmp_a > cmp_b) ? ((cmp_a > cmp_c) ? ret_a : ret_c) : \
101                            ((cmp_b > cmp_c) ? ret_b : ret_c))
102
103 #define MIN3_PAIR(cmp_a, cmp_b, cmp_c, ret_a, ret_b, ret_c) \
104         ((cmp_a < cmp_b) ? ((cmp_a < cmp_c) ? ret_a : ret_c) : \
105                            ((cmp_b < cmp_c) ? ret_b : ret_c))
106
107 #define INIT_MINMAX(min, max) {                                               \
108                 (min)[0] = (min)[1] = (min)[2] =  1.0e30f;                            \
109                 (max)[0] = (max)[1] = (max)[2] = -1.0e30f;                            \
110         } (void)0
111 #define INIT_MINMAX2(min, max) {                                              \
112                 (min)[0] = (min)[1] = 1.0e30f;                                        \
113                 (max)[0] = (max)[1] = -1.0e30f;                                       \
114         } (void)0
115 #define DO_MIN(vec, min) {                                                    \
116                 if ((min)[0] > (vec)[0]) (min)[0] = (vec)[0];                         \
117                 if ((min)[1] > (vec)[1]) (min)[1] = (vec)[1];                         \
118                 if ((min)[2] > (vec)[2]) (min)[2] = (vec)[2];                         \
119         } (void)0
120 #define DO_MAX(vec, max) {                                                    \
121                 if ((max)[0] < (vec)[0]) (max)[0] = (vec)[0];                         \
122                 if ((max)[1] < (vec)[1]) (max)[1] = (vec)[1];                         \
123                 if ((max)[2] < (vec)[2]) (max)[2] = (vec)[2];                         \
124         } (void)0
125 #define DO_MINMAX(vec, min, max) {                                            \
126                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
127                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
128                 if ((min)[2] > (vec)[2] ) (min)[2] = (vec)[2];                        \
129                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
130                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
131                 if ((max)[2] < (vec)[2] ) (max)[2] = (vec)[2];                        \
132         } (void)0
133 #define DO_MINMAX2(vec, min, max) {                                           \
134                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
135                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
136                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
137                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
138         } (void)0
139
140 /* some math and copy defines */
141
142
143 #define SWAP(type, a, b)  {    \
144         type sw_ap;                \
145         CHECK_TYPE(a, type);       \
146         CHECK_TYPE(b, type);       \
147         sw_ap = (a);               \
148         (a) = (b);                 \
149         (b) = sw_ap;               \
150 } (void)0
151
152 /* swap with a temp value */
153 #define SWAP_TVAL(tval, a, b)  {  \
154         CHECK_TYPE_PAIR(tval, a);     \
155         CHECK_TYPE_PAIR(tval, b);     \
156         (tval) = (a);                 \
157         (a) = (b);                    \
158         (b) = (tval);                 \
159 } (void)0
160
161 /* ELEM#(v, ...): is the first arg equal any others? */
162 /* internal helpers*/
163 #define _VA_ELEM2(v, a) \
164        ((v) == (a))
165 #define _VA_ELEM3(v, a, b) \
166        (_VA_ELEM2(v, a) || ((v) == (b)))
167 #define _VA_ELEM4(v, a, b, c) \
168        (_VA_ELEM3(v, a, b) || ((v) == (c)))
169 #define _VA_ELEM5(v, a, b, c, d) \
170        (_VA_ELEM4(v, a, b, c) || ((v) == (d)))
171 #define _VA_ELEM6(v, a, b, c, d, e) \
172        (_VA_ELEM5(v, a, b, c, d) || ((v) == (e)))
173 #define _VA_ELEM7(v, a, b, c, d, e, f) \
174        (_VA_ELEM6(v, a, b, c, d, e) || ((v) == (f)))
175 #define _VA_ELEM8(v, a, b, c, d, e, f, g) \
176        (_VA_ELEM7(v, a, b, c, d, e, f) || ((v) == (g)))
177 #define _VA_ELEM9(v, a, b, c, d, e, f, g, h) \
178        (_VA_ELEM8(v, a, b, c, d, e, f, g) || ((v) == (h)))
179 #define _VA_ELEM10(v, a, b, c, d, e, f, g, h, i) \
180        (_VA_ELEM9(v, a, b, c, d, e, f, g, h) || ((v) == (i)))
181 #define _VA_ELEM11(v, a, b, c, d, e, f, g, h, i, j) \
182        (_VA_ELEM10(v, a, b, c, d, e, f, g, h, i) || ((v) == (j)))
183 #define _VA_ELEM12(v, a, b, c, d, e, f, g, h, i, j, k) \
184        (_VA_ELEM11(v, a, b, c, d, e, f, g, h, i, j) || ((v) == (k)))
185 #define _VA_ELEM13(v, a, b, c, d, e, f, g, h, i, j, k, l) \
186        (_VA_ELEM12(v, a, b, c, d, e, f, g, h, i, j, k) || ((v) == (l)))
187 #define _VA_ELEM14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) \
188        (_VA_ELEM13(v, a, b, c, d, e, f, g, h, i, j, k, l) || ((v) == (m)))
189 #define _VA_ELEM15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) \
190        (_VA_ELEM14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) || ((v) == (n)))
191 #define _VA_ELEM16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) \
192        (_VA_ELEM15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) || ((v) == (o)))
193 #define _VA_ELEM17(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) \
194        (_VA_ELEM16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) || ((v) == (p)))
195
196 /* reusable ELEM macro */
197 #define ELEM(...) VA_NARGS_CALL_OVERLOAD(_VA_ELEM, __VA_ARGS__)
198
199 /* no-op for expressions we don't want to instansiate, but must remian valid */
200 #define EXPR_NOP(expr) (void)(0 ? ((void)(expr), 1) : 0)
201
202 /* shift around elements */
203 #define SHIFT3(type, a, b, c)  {                                              \
204         type tmp;                                                                 \
205         CHECK_TYPE(a, type);                                                      \
206         CHECK_TYPE(b, type);                                                      \
207         CHECK_TYPE(c, type);                                                      \
208         tmp = a;                                                                  \
209         a = c;                                                                    \
210         c = b;                                                                    \
211         b = tmp;                                                                  \
212 } (void)0
213
214 #define SHIFT4(type, a, b, c, d)  {                                           \
215         type tmp;                                                                 \
216         CHECK_TYPE(a, type);                                                      \
217         CHECK_TYPE(b, type);                                                      \
218         CHECK_TYPE(c, type);                                                      \
219         CHECK_TYPE(d, type);                                                      \
220         tmp = a;                                                                  \
221         a = d;                                                                    \
222         d = c;                                                                    \
223         c = b;                                                                    \
224         b = tmp;                                                                  \
225 } (void)0
226
227 #define VECCOPY(v1, v2) {                                                     \
228                 *(v1) =   *(v2);                                                      \
229                 *(v1 + 1) = *(v2 + 1);                                                \
230                 *(v1 + 2) = *(v2 + 2);                                                \
231 } (void)0
232 #define VECCOPY2D(v1, v2) {                                                   \
233                 *(v1) =   *(v2);                                                      \
234                 *(v1 + 1) = *(v2 + 1);                                                \
235 } (void)0
236 #define VECADD(v1, v2, v3) {                                                  \
237                 *(v1) =   *(v2)   + *(v3);                                            \
238                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1);                                    \
239                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2);                                    \
240 } (void)0
241 #define VECSUB(v1, v2, v3) {                                                  \
242                 *(v1) =   *(v2)   - *(v3);                                            \
243                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
244                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2);                                    \
245 } (void)0
246 #define VECSUB2D(v1, v2, v3)     {                                            \
247                 *(v1) =   *(v2)   - *(v3);                                            \
248                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
249 } (void)0
250 #define VECADDFAC(v1, v2, v3, fac) {                                          \
251                 *(v1) =   *(v2)   + *(v3) * (fac);                                    \
252                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1) * (fac);                            \
253                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2) * (fac);                            \
254 } (void)0
255 #define VECMADD(v1, v2, v3, v4) {                                             \
256                 *(v1) =   *(v2)   + *(v3) * (*(v4));                                  \
257                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1) * (*(v4 + 1));                      \
258                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2) * (*(v4 + 2));                      \
259 } (void)0
260 #define VECSUBFAC(v1, v2, v3, fac) {                                          \
261                 *(v1) =   *(v2)   - *(v3) * (fac);                                    \
262                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1) * (fac);                            \
263                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2) * (fac);                            \
264 } (void)0
265
266 /* some misc stuff.... */
267
268 /* avoid multiple access for supported compilers */
269 #if defined(__GNUC__) || defined(__clang__)
270
271 #define ABS(a)  ({ \
272         typeof(a) a_ = (a); \
273         ((a_) < 0 ? (-(a_)) : (a_)); })
274 #define SQUARE(a)  ({ \
275         typeof(a) a_ = (a); \
276         ((a_) * (a_)); })
277 #define CUBE(a)  ({ \
278         typeof(a) a_ = (a); \
279         ((a_) * (a_) * (a_)); })
280
281 #else
282
283 #define ABS(a)  ((a) < 0 ? (-(a)) : (a))
284 #define SQUARE(a)  ((a) * (a))
285 #define CUBE(a)  ((a) * (a) * (a))
286
287 #endif
288
289 #define CLAMPIS(a, b, c)  ((a) < (b) ? (b) : (a) > (c) ? (c) : (a))
290
291 #define CLAMP(a, b, c)  {           \
292         if      ((a) < (b)) (a) = (b);  \
293         else if ((a) > (c)) (a) = (c);  \
294 } (void)0
295
296 #define CLAMP_MAX(a, c)  {          \
297         if ((a) > (c)) (a) = (c);       \
298 } (void)0
299
300 #define CLAMP_MIN(a, b)  {          \
301         if      ((a) < (b)) (a) = (b);  \
302 } (void)0
303
304 #define CLAMP2(vec, b, c) { \
305         CLAMP((vec)[0], b, c); \
306         CLAMP((vec)[1], b, c); \
307 } (void)0
308
309 #define CLAMP2_MIN(vec, b) { \
310         CLAMP_MIN((vec)[0], b); \
311         CLAMP_MIN((vec)[1], b); \
312 } (void)0
313
314 #define CLAMP2_MAX(vec, b) { \
315         CLAMP_MAX((vec)[0], b); \
316         CLAMP_MAX((vec)[1], b); \
317 } (void)0
318
319 #define CLAMP3(vec, b, c) { \
320         CLAMP((vec)[0], b, c); \
321         CLAMP((vec)[1], b, c); \
322         CLAMP((vec)[2], b, c); \
323 } (void)0
324
325 #define CLAMP3_MIN(vec, b) { \
326         CLAMP_MIN((vec)[0], b); \
327         CLAMP_MIN((vec)[1], b); \
328         CLAMP_MIN((vec)[2], b); \
329 } (void)0
330
331 #define CLAMP3_MAX(vec, b) { \
332         CLAMP_MAX((vec)[0], b); \
333         CLAMP_MAX((vec)[1], b); \
334         CLAMP_MAX((vec)[2], b); \
335 } (void)0
336
337 #define CLAMP4(vec, b, c) { \
338         CLAMP((vec)[0], b, c); \
339         CLAMP((vec)[1], b, c); \
340         CLAMP((vec)[2], b, c); \
341         CLAMP((vec)[3], b, c); \
342 } (void)0
343
344 #define CLAMP4_MIN(vec, b) { \
345         CLAMP_MIN((vec)[0], b); \
346         CLAMP_MIN((vec)[1], b); \
347         CLAMP_MIN((vec)[2], b); \
348         CLAMP_MIN((vec)[3], b); \
349 } (void)0
350
351 #define CLAMP4_MAX(vec, b) { \
352         CLAMP_MAX((vec)[0], b); \
353         CLAMP_MAX((vec)[1], b); \
354         CLAMP_MAX((vec)[2], b); \
355         CLAMP_MAX((vec)[3], b); \
356 } (void)0
357
358 #define IS_EQ(a, b)  ( \
359         CHECK_TYPE_INLINE(a, double), CHECK_TYPE_INLINE(b, double), \
360         ((fabs((double)((a) - (b))) >= (double) FLT_EPSILON) ? false : true))
361
362 #define IS_EQF(a, b)  ( \
363         CHECK_TYPE_INLINE(a, float), CHECK_TYPE_INLINE(b, float), \
364         ((fabsf((float)((a) - (b))) >= (float) FLT_EPSILON) ? false : true))
365
366 #define IS_EQT(a, b, c)        (((a) > (b)) ? ((((a) - (b)) <= (c))) : (((((b) - (a)) <= (c)))))
367 #define IN_RANGE(a, b, c)      (((b) < (c)) ? (((b) <  (a) && (a) <  (c))) : (((c) <  (a) && (a) <  (b))))
368 #define IN_RANGE_INCL(a, b, c) (((b) < (c)) ? (((b) <= (a) && (a) <= (c))) : (((c) <= (a) && (a) <= (b))))
369
370 /* unpack vector for args */
371 #define UNPACK2(a)  ((a)[0]),   ((a)[1])
372 #define UNPACK3(a)  UNPACK2(a), ((a)[2])
373 #define UNPACK4(a)  UNPACK3(a), ((a)[3])
374 /* pre may be '&', '*' or func, post may be '->member' */
375 #define UNPACK2_EX(pre, a, post)  (pre((a)[0])post),        (pre((a)[1])post)
376 #define UNPACK3_EX(pre, a, post)  UNPACK2_EX(pre, a, post), (pre((a)[2])post)
377 #define UNPACK4_EX(pre, a, post)  UNPACK3_EX(pre, a, post), (pre((a)[3])post)
378
379 /* array helpers */
380 #define ARRAY_LAST_ITEM(arr_start, arr_dtype, arr_len) \
381         (arr_dtype *)((char *)(arr_start) + (sizeof(*((arr_dtype *)NULL)) * (size_t)(arr_len - 1)))
382
383 #define ARRAY_HAS_ITEM(arr_item, arr_start, arr_len)  ( \
384         CHECK_TYPE_PAIR_INLINE(arr_start, arr_item), \
385         ((unsigned int)((arr_item) - (arr_start)) < (unsigned int)(arr_len)))
386
387 /**
388  * \note use faster #ARRAY_DELETE_REORDER_LAST when we can re-order.
389  */
390 #define ARRAY_DELETE(arr, index, delete_len, arr_len) \
391         { \
392                 BLI_assert((&arr[index] >= arr) && ((index) + delete_len <= arr_len));  \
393                 memmove(&(arr)[index], \
394                         &(arr)[(index) + (delete_len)], \
395                          (((arr_len) - (index)) - (delete_len)) * sizeof(*(arr))); \
396         } ((void)0)
397
398 /**
399  * Re-ordering array removal.
400  *
401  * When removing single items this compiles down to:
402  * `if (index + 1 != arr_len) { arr[index] = arr[arr_len - 1]; }` (typical reordering removal),
403  * with removing multiple items, overlap is detected to avoid memcpy errors.
404  */
405 #define ARRAY_DELETE_REORDER_LAST(arr, index, delete_len, arr_len) \
406         { \
407                 BLI_assert((&arr[index] >= arr) && ((index) + delete_len <= arr_len));  \
408                 if ((index) + (delete_len) != (arr_len)) { \
409                         if (((delete_len) == 1) || ((delete_len) <= ((arr_len) - ((index) + (delete_len))))) { \
410                                 memcpy(&(arr)[index], \
411                                        &(arr)[(arr_len) - (delete_len)], \
412                                        (delete_len) * sizeof(*(arr))); \
413                         } \
414                         else { \
415                                 memcpy(&(arr)[index], \
416                                        &(arr)[(arr_len) - ((arr_len) - ((index) + (delete_len)))], \
417                                        ((arr_len) - ((index) + (delete_len))) * sizeof(*(arr))); \
418                         } \
419                 } \
420         } ((void)0)
421
422
423 /* assuming a static array */
424 #if defined(__GNUC__) && !defined(__cplusplus) && !defined(__clang__) && !defined(__INTEL_COMPILER)
425 #  define ARRAY_SIZE(arr) \
426         ((sizeof(struct {int isnt_array : ((const void *)&(arr) == &(arr)[0]);}) * 0) + \
427          (sizeof(arr) / sizeof(*(arr))))
428 #else
429 #  define ARRAY_SIZE(arr)  (sizeof(arr) / sizeof(*(arr)))
430 #endif
431
432 /* ARRAY_SET_ITEMS#(v, ...): set indices of array 'v'  */
433 /* internal helpers */
434 #define _VA_ARRAY_SET_ITEMS2(v, a) \
435         ((v)[0] = (a))
436 #define _VA_ARRAY_SET_ITEMS3(v, a, b) \
437         _VA_ARRAY_SET_ITEMS2(v, a); ((v)[1] = (b))
438 #define _VA_ARRAY_SET_ITEMS4(v, a, b, c) \
439         _VA_ARRAY_SET_ITEMS3(v, a, b); ((v)[2] = (c))
440 #define _VA_ARRAY_SET_ITEMS5(v, a, b, c, d) \
441         _VA_ARRAY_SET_ITEMS4(v, a, b, c); ((v)[3] = (d))
442 #define _VA_ARRAY_SET_ITEMS6(v, a, b, c, d, e) \
443         _VA_ARRAY_SET_ITEMS5(v, a, b, c, d); ((v)[4] = (e))
444 #define _VA_ARRAY_SET_ITEMS7(v, a, b, c, d, e, f) \
445         _VA_ARRAY_SET_ITEMS6(v, a, b, c, d, e); ((v)[5] = (f))
446 #define _VA_ARRAY_SET_ITEMS8(v, a, b, c, d, e, f, g) \
447         _VA_ARRAY_SET_ITEMS7(v, a, b, c, d, e, f); ((v)[6] = (g))
448 #define _VA_ARRAY_SET_ITEMS9(v, a, b, c, d, e, f, g, h) \
449         _VA_ARRAY_SET_ITEMS8(v, a, b, c, d, e, f, g); ((v)[7] = (h))
450 #define _VA_ARRAY_SET_ITEMS10(v, a, b, c, d, e, f, g, h, i) \
451         _VA_ARRAY_SET_ITEMS9(v, a, b, c, d, e, f, g, h); ((v)[8] = (i))
452 #define _VA_ARRAY_SET_ITEMS11(v, a, b, c, d, e, f, g, h, i, j) \
453         _VA_ARRAY_SET_ITEMS10(v, a, b, c, d, e, f, g, h, i); ((v)[9] = (j))
454 #define _VA_ARRAY_SET_ITEMS12(v, a, b, c, d, e, f, g, h, i, j, k) \
455         _VA_ARRAY_SET_ITEMS11(v, a, b, c, d, e, f, g, h, i, j); ((v)[10] = (k))
456 #define _VA_ARRAY_SET_ITEMS13(v, a, b, c, d, e, f, g, h, i, j, k, l) \
457         _VA_ARRAY_SET_ITEMS12(v, a, b, c, d, e, f, g, h, i, j, k); ((v)[11] = (l))
458 #define _VA_ARRAY_SET_ITEMS14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) \
459         _VA_ARRAY_SET_ITEMS13(v, a, b, c, d, e, f, g, h, i, j, k, l); ((v)[12] = (m))
460 #define _VA_ARRAY_SET_ITEMS15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) \
461         _VA_ARRAY_SET_ITEMS14(v, a, b, c, d, e, f, g, h, i, j, k, l, m); ((v)[13] = (n))
462 #define _VA_ARRAY_SET_ITEMS16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) \
463         _VA_ARRAY_SET_ITEMS15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n); ((v)[14] = (o))
464 #define _VA_ARRAY_SET_ITEMS17(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) \
465         _VA_ARRAY_SET_ITEMS16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o); ((v)[15] = (p))
466
467 /* reusable ARRAY_SET_ITEMS macro */
468 #define ARRAY_SET_ITEMS(...) { VA_NARGS_CALL_OVERLOAD(_VA_ARRAY_SET_ITEMS, __VA_ARGS__); } (void)0
469
470 #if defined(__GNUC__) || defined(__clang__)
471 #define POINTER_OFFSET(v, ofs) \
472         ((typeof(v))((char *)(v) + (ofs)))
473 #else
474 #define POINTER_OFFSET(v, ofs) \
475         ((void *)((char *)(v) + (ofs)))
476 #endif
477
478 /* Like offsetof(typeof(), member), for non-gcc compilers */
479 #define OFFSETOF_STRUCT(_struct, _member) \
480         ((((char *)&((_struct)->_member)) - ((char *)(_struct))) + sizeof((_struct)->_member))
481
482 /**
483  * memcpy helper, skipping the first part of a struct,
484  * ensures 'struct_dst' isn't const and the offset can be computed at compile time.
485  * This isn't inclusive, the value of \a member isn't copied.
486  */
487 #define MEMCPY_STRUCT_OFS(struct_dst, struct_src, member)  { \
488         CHECK_TYPE_NONCONST(struct_dst); \
489         ((void)(struct_dst == struct_src), \
490          memcpy((char *)(struct_dst)  + OFFSETOF_STRUCT(struct_dst, member), \
491                 (char *)(struct_src)  + OFFSETOF_STRUCT(struct_dst, member), \
492                 sizeof(*(struct_dst)) - OFFSETOF_STRUCT(struct_dst, member))); \
493 } (void)0
494
495 #define MEMSET_STRUCT_OFS(struct_var, value, member)  { \
496         CHECK_TYPE_NONCONST(struct_var); \
497         memset((char *)(struct_var)  + OFFSETOF_STRUCT(struct_var, member), \
498                value, \
499                sizeof(*(struct_var)) - OFFSETOF_STRUCT(struct_var, member)); \
500 } (void)0
501
502 /* defined
503  * in memory_utils.c for now. I do not know where we should put it actually... */
504 #ifndef __BLI_MEMORY_UTILS_H__
505 extern bool BLI_memory_is_zero(const void *arr, const size_t arr_size);
506 #endif
507
508 #define MEMCMP_STRUCT_OFS_IS_ZERO(struct_var, member) \
509         (BLI_memory_is_zero( \
510                (char *)(struct_var)  + OFFSETOF_STRUCT(struct_var, member), \
511                sizeof(*(struct_var)) - OFFSETOF_STRUCT(struct_var, member)))
512
513 /* Warning-free macros for storing ints in pointers. Use these _only_
514  * for storing an int in a pointer, not a pointer in an int (64bit)! */
515 #define POINTER_FROM_INT(i)    ((void *)(intptr_t)(i))
516 #define POINTER_AS_INT(i)  ((void)0, ((int)(intptr_t)(i)))
517
518 #define POINTER_FROM_UINT(i)    ((void *)(uintptr_t)(i))
519 #define POINTER_AS_UINT(i)  ((void)0, ((unsigned int)(uintptr_t)(i)))
520
521 /* Set flag from a single test */
522 #define SET_FLAG_FROM_TEST(value, test, flag) \
523 { \
524         if (test) { \
525                 (value) |=  (flag); \
526         } \
527         else { \
528                 (value) &= ~(flag); \
529         } \
530 } ((void)0)
531
532 /* Macro to convert a value to string in the preprocessor
533  * STRINGIFY_ARG: gives the argument as a string
534  * STRINGIFY_APPEND: appends any argument 'b' onto the string argument 'a',
535  *   used by STRINGIFY because some preprocessors warn about zero arguments
536  * STRINGIFY: gives the argument's value as a string */
537 #define STRINGIFY_ARG(x) "" #x
538 #define STRINGIFY_APPEND(a, b) "" a #b
539 #define STRINGIFY(x) STRINGIFY_APPEND("", x)
540
541
542 /* generic strcmp macros */
543 #if defined(_MSC_VER)
544 #  define strcasecmp _stricmp
545 #  define strncasecmp _strnicmp
546 #endif
547
548 #define STREQ(a, b) (strcmp(a, b) == 0)
549 #define STRCASEEQ(a, b) (strcasecmp(a, b) == 0)
550 #define STREQLEN(a, b, n) (strncmp(a, b, n) == 0)
551 #define STRCASEEQLEN(a, b, n) (strncasecmp(a, b, n) == 0)
552
553 #define STRPREFIX(a, b) (strncmp((a), (b), strlen(b)) == 0)
554 /* useful for debugging */
555 #define AT __FILE__ ":" STRINGIFY(__LINE__)
556
557
558 /* UNUSED macro, for function argument */
559 #if defined(__GNUC__) || defined(__clang__)
560 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
561 #else
562 #  define UNUSED(x) UNUSED_ ## x
563 #endif
564
565 #if defined(__GNUC__) || defined(__clang__)
566 #  define UNUSED_FUNCTION(x) __attribute__((__unused__)) UNUSED_ ## x
567 #else
568 #  define UNUSED_FUNCTION(x) UNUSED_ ## x
569 #endif
570
571 /**
572  * UNUSED_VARS#(a, ...): quiet unused warnings
573  *
574  * \code{.py}
575  * for i in range(16):
576  *     args = [(chr(ord('a') + (c % 26)) + (chr(ord('0') + (c // 26)))) for c in range(i + 1)]
577  *     print("#define _VA_UNUSED_VARS_%d(%s) \\" % (i + 1, ", ".join(args)))
578  *     print("\t((void)(%s)%s)" %
579  *             (args[0], ((", _VA_UNUSED_VARS_" + str(i) + "(%s)") if i else "%s") % ", ".join((args[1:]))))
580  * \endcode
581  */
582
583 #define _VA_UNUSED_VARS_1(a0) \
584         ((void)(a0))
585 #define _VA_UNUSED_VARS_2(a0, b0) \
586         ((void)(a0), _VA_UNUSED_VARS_1(b0))
587 #define _VA_UNUSED_VARS_3(a0, b0, c0) \
588         ((void)(a0), _VA_UNUSED_VARS_2(b0, c0))
589 #define _VA_UNUSED_VARS_4(a0, b0, c0, d0) \
590         ((void)(a0), _VA_UNUSED_VARS_3(b0, c0, d0))
591 #define _VA_UNUSED_VARS_5(a0, b0, c0, d0, e0) \
592         ((void)(a0), _VA_UNUSED_VARS_4(b0, c0, d0, e0))
593 #define _VA_UNUSED_VARS_6(a0, b0, c0, d0, e0, f0) \
594         ((void)(a0), _VA_UNUSED_VARS_5(b0, c0, d0, e0, f0))
595 #define _VA_UNUSED_VARS_7(a0, b0, c0, d0, e0, f0, g0) \
596         ((void)(a0), _VA_UNUSED_VARS_6(b0, c0, d0, e0, f0, g0))
597 #define _VA_UNUSED_VARS_8(a0, b0, c0, d0, e0, f0, g0, h0) \
598         ((void)(a0), _VA_UNUSED_VARS_7(b0, c0, d0, e0, f0, g0, h0))
599 #define _VA_UNUSED_VARS_9(a0, b0, c0, d0, e0, f0, g0, h0, i0) \
600         ((void)(a0), _VA_UNUSED_VARS_8(b0, c0, d0, e0, f0, g0, h0, i0))
601 #define _VA_UNUSED_VARS_10(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0) \
602         ((void)(a0), _VA_UNUSED_VARS_9(b0, c0, d0, e0, f0, g0, h0, i0, j0))
603 #define _VA_UNUSED_VARS_11(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0) \
604         ((void)(a0), _VA_UNUSED_VARS_10(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0))
605 #define _VA_UNUSED_VARS_12(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0) \
606         ((void)(a0), _VA_UNUSED_VARS_11(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0))
607 #define _VA_UNUSED_VARS_13(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0) \
608         ((void)(a0), _VA_UNUSED_VARS_12(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0))
609 #define _VA_UNUSED_VARS_14(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0) \
610         ((void)(a0), _VA_UNUSED_VARS_13(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0))
611 #define _VA_UNUSED_VARS_15(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0) \
612         ((void)(a0), _VA_UNUSED_VARS_14(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0))
613 #define _VA_UNUSED_VARS_16(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0, p0) \
614         ((void)(a0), _VA_UNUSED_VARS_15(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0, p0))
615
616
617 /* reusable ELEM macro */
618 #define UNUSED_VARS(...) VA_NARGS_CALL_OVERLOAD(_VA_UNUSED_VARS_, __VA_ARGS__)
619
620 /* for debug-only variables */
621 #ifndef NDEBUG
622 #  define UNUSED_VARS_NDEBUG(...)
623 #else
624 #  define UNUSED_VARS_NDEBUG UNUSED_VARS
625 #endif
626
627 /* hints for branch prediction, only use in code that runs a _lot_ where */
628 #ifdef __GNUC__
629 #  define LIKELY(x)       __builtin_expect(!!(x), 1)
630 #  define UNLIKELY(x)     __builtin_expect(!!(x), 0)
631 #else
632 #  define LIKELY(x)       (x)
633 #  define UNLIKELY(x)     (x)
634 #endif
635
636 /* Expands to an integer constant expression evaluating to a close upper bound
637  * on the number the number of decimal digits in a value expressible in the
638  * integer type given by the argument (if it is a type name) or the the integer
639  * type of the argument (if it is an expression). The meaning of the resulting
640  * expression is unspecified for other arguments.
641  * i.e: DECIMAL_DIGITS_BOUND(uchar) is equal to 3. */
642 #define DECIMAL_DIGITS_BOUND(t) (241 * sizeof(t) / 100 + 1)
643
644 #ifdef __cplusplus
645 }
646 #endif
647
648 #endif  /* __BLI_UTILDEFINES_H__ */