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