Merge branch 'blender2.7'
[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 /* some misc stuff.... */
228
229 /* avoid multiple access for supported compilers */
230 #if defined(__GNUC__) || defined(__clang__)
231
232 #define ABS(a)  ({ \
233         typeof(a) a_ = (a); \
234         ((a_) < 0 ? (-(a_)) : (a_)); })
235 #define SQUARE(a)  ({ \
236         typeof(a) a_ = (a); \
237         ((a_) * (a_)); })
238 #define CUBE(a)  ({ \
239         typeof(a) a_ = (a); \
240         ((a_) * (a_) * (a_)); })
241
242 #else
243
244 #define ABS(a)  ((a) < 0 ? (-(a)) : (a))
245 #define SQUARE(a)  ((a) * (a))
246 #define CUBE(a)  ((a) * (a) * (a))
247
248 #endif
249
250 #define CLAMPIS(a, b, c)  ((a) < (b) ? (b) : (a) > (c) ? (c) : (a))
251
252 #define CLAMP(a, b, c)  {           \
253         if      ((a) < (b)) (a) = (b);  \
254         else if ((a) > (c)) (a) = (c);  \
255 } (void)0
256
257 #define CLAMP_MAX(a, c)  {          \
258         if ((a) > (c)) (a) = (c);       \
259 } (void)0
260
261 #define CLAMP_MIN(a, b)  {          \
262         if      ((a) < (b)) (a) = (b);  \
263 } (void)0
264
265 #define CLAMP2(vec, b, c) { \
266         CLAMP((vec)[0], b, c); \
267         CLAMP((vec)[1], b, c); \
268 } (void)0
269
270 #define CLAMP2_MIN(vec, b) { \
271         CLAMP_MIN((vec)[0], b); \
272         CLAMP_MIN((vec)[1], b); \
273 } (void)0
274
275 #define CLAMP2_MAX(vec, b) { \
276         CLAMP_MAX((vec)[0], b); \
277         CLAMP_MAX((vec)[1], b); \
278 } (void)0
279
280 #define CLAMP3(vec, b, c) { \
281         CLAMP((vec)[0], b, c); \
282         CLAMP((vec)[1], b, c); \
283         CLAMP((vec)[2], b, c); \
284 } (void)0
285
286 #define CLAMP3_MIN(vec, b) { \
287         CLAMP_MIN((vec)[0], b); \
288         CLAMP_MIN((vec)[1], b); \
289         CLAMP_MIN((vec)[2], b); \
290 } (void)0
291
292 #define CLAMP3_MAX(vec, b) { \
293         CLAMP_MAX((vec)[0], b); \
294         CLAMP_MAX((vec)[1], b); \
295         CLAMP_MAX((vec)[2], b); \
296 } (void)0
297
298 #define CLAMP4(vec, b, c) { \
299         CLAMP((vec)[0], b, c); \
300         CLAMP((vec)[1], b, c); \
301         CLAMP((vec)[2], b, c); \
302         CLAMP((vec)[3], b, c); \
303 } (void)0
304
305 #define CLAMP4_MIN(vec, b) { \
306         CLAMP_MIN((vec)[0], b); \
307         CLAMP_MIN((vec)[1], b); \
308         CLAMP_MIN((vec)[2], b); \
309         CLAMP_MIN((vec)[3], b); \
310 } (void)0
311
312 #define CLAMP4_MAX(vec, b) { \
313         CLAMP_MAX((vec)[0], b); \
314         CLAMP_MAX((vec)[1], b); \
315         CLAMP_MAX((vec)[2], b); \
316         CLAMP_MAX((vec)[3], b); \
317 } (void)0
318
319 #define IS_EQ(a, b)  ( \
320         CHECK_TYPE_INLINE(a, double), CHECK_TYPE_INLINE(b, double), \
321         ((fabs((double)((a) - (b))) >= (double) FLT_EPSILON) ? false : true))
322
323 #define IS_EQF(a, b)  ( \
324         CHECK_TYPE_INLINE(a, float), CHECK_TYPE_INLINE(b, float), \
325         ((fabsf((float)((a) - (b))) >= (float) FLT_EPSILON) ? false : true))
326
327 #define IS_EQT(a, b, c)        (((a) > (b)) ? ((((a) - (b)) <= (c))) : (((((b) - (a)) <= (c)))))
328 #define IN_RANGE(a, b, c)      (((b) < (c)) ? (((b) <  (a) && (a) <  (c))) : (((c) <  (a) && (a) <  (b))))
329 #define IN_RANGE_INCL(a, b, c) (((b) < (c)) ? (((b) <= (a) && (a) <= (c))) : (((c) <= (a) && (a) <= (b))))
330
331 /* unpack vector for args */
332 #define UNPACK2(a)  ((a)[0]),   ((a)[1])
333 #define UNPACK3(a)  UNPACK2(a), ((a)[2])
334 #define UNPACK4(a)  UNPACK3(a), ((a)[3])
335 /* pre may be '&', '*' or func, post may be '->member' */
336 #define UNPACK2_EX(pre, a, post)  (pre((a)[0])post),        (pre((a)[1])post)
337 #define UNPACK3_EX(pre, a, post)  UNPACK2_EX(pre, a, post), (pre((a)[2])post)
338 #define UNPACK4_EX(pre, a, post)  UNPACK3_EX(pre, a, post), (pre((a)[3])post)
339
340 /* array helpers */
341 #define ARRAY_LAST_ITEM(arr_start, arr_dtype, arr_len) \
342         (arr_dtype *)((char *)(arr_start) + (sizeof(*((arr_dtype *)NULL)) * (size_t)(arr_len - 1)))
343
344 #define ARRAY_HAS_ITEM(arr_item, arr_start, arr_len)  ( \
345         CHECK_TYPE_PAIR_INLINE(arr_start, arr_item), \
346         ((unsigned int)((arr_item) - (arr_start)) < (unsigned int)(arr_len)))
347
348 /**
349  * \note use faster #ARRAY_DELETE_REORDER_LAST when we can re-order.
350  */
351 #define ARRAY_DELETE(arr, index, delete_len, arr_len) \
352         { \
353                 BLI_assert((&arr[index] >= arr) && ((index) + delete_len <= arr_len));  \
354                 memmove(&(arr)[index], \
355                         &(arr)[(index) + (delete_len)], \
356                          (((arr_len) - (index)) - (delete_len)) * sizeof(*(arr))); \
357         } ((void)0)
358
359 /**
360  * Re-ordering array removal.
361  *
362  * When removing single items this compiles down to:
363  * `if (index + 1 != arr_len) { arr[index] = arr[arr_len - 1]; }` (typical reordering removal),
364  * with removing multiple items, overlap is detected to avoid memcpy errors.
365  */
366 #define ARRAY_DELETE_REORDER_LAST(arr, index, delete_len, arr_len) \
367         { \
368                 BLI_assert((&arr[index] >= arr) && ((index) + delete_len <= arr_len));  \
369                 if ((index) + (delete_len) != (arr_len)) { \
370                         if (((delete_len) == 1) || ((delete_len) <= ((arr_len) - ((index) + (delete_len))))) { \
371                                 memcpy(&(arr)[index], \
372                                        &(arr)[(arr_len) - (delete_len)], \
373                                        (delete_len) * sizeof(*(arr))); \
374                         } \
375                         else { \
376                                 memcpy(&(arr)[index], \
377                                        &(arr)[(arr_len) - ((arr_len) - ((index) + (delete_len)))], \
378                                        ((arr_len) - ((index) + (delete_len))) * sizeof(*(arr))); \
379                         } \
380                 } \
381         } ((void)0)
382
383
384 /* assuming a static array */
385 #if defined(__GNUC__) && !defined(__cplusplus) && !defined(__clang__) && !defined(__INTEL_COMPILER)
386 #  define ARRAY_SIZE(arr) \
387         ((sizeof(struct {int isnt_array : ((const void *)&(arr) == &(arr)[0]);}) * 0) + \
388          (sizeof(arr) / sizeof(*(arr))))
389 #else
390 #  define ARRAY_SIZE(arr)  (sizeof(arr) / sizeof(*(arr)))
391 #endif
392
393 /* ARRAY_SET_ITEMS#(v, ...): set indices of array 'v'  */
394 /* internal helpers */
395 #define _VA_ARRAY_SET_ITEMS2(v, a) \
396         ((v)[0] = (a))
397 #define _VA_ARRAY_SET_ITEMS3(v, a, b) \
398         _VA_ARRAY_SET_ITEMS2(v, a); ((v)[1] = (b))
399 #define _VA_ARRAY_SET_ITEMS4(v, a, b, c) \
400         _VA_ARRAY_SET_ITEMS3(v, a, b); ((v)[2] = (c))
401 #define _VA_ARRAY_SET_ITEMS5(v, a, b, c, d) \
402         _VA_ARRAY_SET_ITEMS4(v, a, b, c); ((v)[3] = (d))
403 #define _VA_ARRAY_SET_ITEMS6(v, a, b, c, d, e) \
404         _VA_ARRAY_SET_ITEMS5(v, a, b, c, d); ((v)[4] = (e))
405 #define _VA_ARRAY_SET_ITEMS7(v, a, b, c, d, e, f) \
406         _VA_ARRAY_SET_ITEMS6(v, a, b, c, d, e); ((v)[5] = (f))
407 #define _VA_ARRAY_SET_ITEMS8(v, a, b, c, d, e, f, g) \
408         _VA_ARRAY_SET_ITEMS7(v, a, b, c, d, e, f); ((v)[6] = (g))
409 #define _VA_ARRAY_SET_ITEMS9(v, a, b, c, d, e, f, g, h) \
410         _VA_ARRAY_SET_ITEMS8(v, a, b, c, d, e, f, g); ((v)[7] = (h))
411 #define _VA_ARRAY_SET_ITEMS10(v, a, b, c, d, e, f, g, h, i) \
412         _VA_ARRAY_SET_ITEMS9(v, a, b, c, d, e, f, g, h); ((v)[8] = (i))
413 #define _VA_ARRAY_SET_ITEMS11(v, a, b, c, d, e, f, g, h, i, j) \
414         _VA_ARRAY_SET_ITEMS10(v, a, b, c, d, e, f, g, h, i); ((v)[9] = (j))
415 #define _VA_ARRAY_SET_ITEMS12(v, a, b, c, d, e, f, g, h, i, j, k) \
416         _VA_ARRAY_SET_ITEMS11(v, a, b, c, d, e, f, g, h, i, j); ((v)[10] = (k))
417 #define _VA_ARRAY_SET_ITEMS13(v, a, b, c, d, e, f, g, h, i, j, k, l) \
418         _VA_ARRAY_SET_ITEMS12(v, a, b, c, d, e, f, g, h, i, j, k); ((v)[11] = (l))
419 #define _VA_ARRAY_SET_ITEMS14(v, a, b, c, d, e, f, g, h, i, j, k, l, m) \
420         _VA_ARRAY_SET_ITEMS13(v, a, b, c, d, e, f, g, h, i, j, k, l); ((v)[12] = (m))
421 #define _VA_ARRAY_SET_ITEMS15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n) \
422         _VA_ARRAY_SET_ITEMS14(v, a, b, c, d, e, f, g, h, i, j, k, l, m); ((v)[13] = (n))
423 #define _VA_ARRAY_SET_ITEMS16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) \
424         _VA_ARRAY_SET_ITEMS15(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n); ((v)[14] = (o))
425 #define _VA_ARRAY_SET_ITEMS17(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) \
426         _VA_ARRAY_SET_ITEMS16(v, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o); ((v)[15] = (p))
427
428 /* reusable ARRAY_SET_ITEMS macro */
429 #define ARRAY_SET_ITEMS(...) { VA_NARGS_CALL_OVERLOAD(_VA_ARRAY_SET_ITEMS, __VA_ARGS__); } (void)0
430
431 #if defined(__GNUC__) || defined(__clang__)
432 #define POINTER_OFFSET(v, ofs) \
433         ((typeof(v))((char *)(v) + (ofs)))
434 #else
435 #define POINTER_OFFSET(v, ofs) \
436         ((void *)((char *)(v) + (ofs)))
437 #endif
438
439 /* Like offsetof(typeof(), member), for non-gcc compilers */
440 #define OFFSETOF_STRUCT(_struct, _member) \
441         ((((char *)&((_struct)->_member)) - ((char *)(_struct))) + sizeof((_struct)->_member))
442
443 /**
444  * memcpy helper, skipping the first part of a struct,
445  * ensures 'struct_dst' isn't const and the offset can be computed at compile time.
446  * This isn't inclusive, the value of \a member isn't copied.
447  */
448 #define MEMCPY_STRUCT_OFS(struct_dst, struct_src, member)  { \
449         CHECK_TYPE_NONCONST(struct_dst); \
450         ((void)(struct_dst == struct_src), \
451          memcpy((char *)(struct_dst)  + OFFSETOF_STRUCT(struct_dst, member), \
452                 (char *)(struct_src)  + OFFSETOF_STRUCT(struct_dst, member), \
453                 sizeof(*(struct_dst)) - OFFSETOF_STRUCT(struct_dst, member))); \
454 } (void)0
455
456 #define MEMSET_STRUCT_OFS(struct_var, value, member)  { \
457         CHECK_TYPE_NONCONST(struct_var); \
458         memset((char *)(struct_var)  + OFFSETOF_STRUCT(struct_var, member), \
459                value, \
460                sizeof(*(struct_var)) - OFFSETOF_STRUCT(struct_var, member)); \
461 } (void)0
462
463 /* defined
464  * in memory_utils.c for now. I do not know where we should put it actually... */
465 #ifndef __BLI_MEMORY_UTILS_H__
466 extern bool BLI_memory_is_zero(const void *arr, const size_t arr_size);
467 #endif
468
469 #define MEMCMP_STRUCT_OFS_IS_ZERO(struct_var, member) \
470         (BLI_memory_is_zero( \
471                (char *)(struct_var)  + OFFSETOF_STRUCT(struct_var, member), \
472                sizeof(*(struct_var)) - OFFSETOF_STRUCT(struct_var, member)))
473
474 /* Warning-free macros for storing ints in pointers. Use these _only_
475  * for storing an int in a pointer, not a pointer in an int (64bit)! */
476 #define POINTER_FROM_INT(i)    ((void *)(intptr_t)(i))
477 #define POINTER_AS_INT(i)  ((void)0, ((int)(intptr_t)(i)))
478
479 #define POINTER_FROM_UINT(i)    ((void *)(uintptr_t)(i))
480 #define POINTER_AS_UINT(i)  ((void)0, ((unsigned int)(uintptr_t)(i)))
481
482 /* Set flag from a single test */
483 #define SET_FLAG_FROM_TEST(value, test, flag) \
484 { \
485         if (test) { \
486                 (value) |=  (flag); \
487         } \
488         else { \
489                 (value) &= ~(flag); \
490         } \
491 } ((void)0)
492
493 /* Macro to convert a value to string in the preprocessor
494  * STRINGIFY_ARG: gives the argument as a string
495  * STRINGIFY_APPEND: appends any argument 'b' onto the string argument 'a',
496  *   used by STRINGIFY because some preprocessors warn about zero arguments
497  * STRINGIFY: gives the argument's value as a string */
498 #define STRINGIFY_ARG(x) "" #x
499 #define STRINGIFY_APPEND(a, b) "" a #b
500 #define STRINGIFY(x) STRINGIFY_APPEND("", x)
501
502
503 /* generic strcmp macros */
504 #if defined(_MSC_VER)
505 #  define strcasecmp _stricmp
506 #  define strncasecmp _strnicmp
507 #endif
508
509 #define STREQ(a, b) (strcmp(a, b) == 0)
510 #define STRCASEEQ(a, b) (strcasecmp(a, b) == 0)
511 #define STREQLEN(a, b, n) (strncmp(a, b, n) == 0)
512 #define STRCASEEQLEN(a, b, n) (strncasecmp(a, b, n) == 0)
513
514 #define STRPREFIX(a, b) (strncmp((a), (b), strlen(b)) == 0)
515 /* useful for debugging */
516 #define AT __FILE__ ":" STRINGIFY(__LINE__)
517
518
519 /* UNUSED macro, for function argument */
520 #if defined(__GNUC__) || defined(__clang__)
521 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
522 #else
523 #  define UNUSED(x) UNUSED_ ## x
524 #endif
525
526 #if defined(__GNUC__) || defined(__clang__)
527 #  define UNUSED_FUNCTION(x) __attribute__((__unused__)) UNUSED_ ## x
528 #else
529 #  define UNUSED_FUNCTION(x) UNUSED_ ## x
530 #endif
531
532 /**
533  * UNUSED_VARS#(a, ...): quiet unused warnings
534  *
535  * \code{.py}
536  * for i in range(16):
537  *     args = [(chr(ord('a') + (c % 26)) + (chr(ord('0') + (c // 26)))) for c in range(i + 1)]
538  *     print("#define _VA_UNUSED_VARS_%d(%s) \\" % (i + 1, ", ".join(args)))
539  *     print("\t((void)(%s)%s)" %
540  *             (args[0], ((", _VA_UNUSED_VARS_" + str(i) + "(%s)") if i else "%s") % ", ".join((args[1:]))))
541  * \endcode
542  */
543
544 #define _VA_UNUSED_VARS_1(a0) \
545         ((void)(a0))
546 #define _VA_UNUSED_VARS_2(a0, b0) \
547         ((void)(a0), _VA_UNUSED_VARS_1(b0))
548 #define _VA_UNUSED_VARS_3(a0, b0, c0) \
549         ((void)(a0), _VA_UNUSED_VARS_2(b0, c0))
550 #define _VA_UNUSED_VARS_4(a0, b0, c0, d0) \
551         ((void)(a0), _VA_UNUSED_VARS_3(b0, c0, d0))
552 #define _VA_UNUSED_VARS_5(a0, b0, c0, d0, e0) \
553         ((void)(a0), _VA_UNUSED_VARS_4(b0, c0, d0, e0))
554 #define _VA_UNUSED_VARS_6(a0, b0, c0, d0, e0, f0) \
555         ((void)(a0), _VA_UNUSED_VARS_5(b0, c0, d0, e0, f0))
556 #define _VA_UNUSED_VARS_7(a0, b0, c0, d0, e0, f0, g0) \
557         ((void)(a0), _VA_UNUSED_VARS_6(b0, c0, d0, e0, f0, g0))
558 #define _VA_UNUSED_VARS_8(a0, b0, c0, d0, e0, f0, g0, h0) \
559         ((void)(a0), _VA_UNUSED_VARS_7(b0, c0, d0, e0, f0, g0, h0))
560 #define _VA_UNUSED_VARS_9(a0, b0, c0, d0, e0, f0, g0, h0, i0) \
561         ((void)(a0), _VA_UNUSED_VARS_8(b0, c0, d0, e0, f0, g0, h0, i0))
562 #define _VA_UNUSED_VARS_10(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0) \
563         ((void)(a0), _VA_UNUSED_VARS_9(b0, c0, d0, e0, f0, g0, h0, i0, j0))
564 #define _VA_UNUSED_VARS_11(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0) \
565         ((void)(a0), _VA_UNUSED_VARS_10(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0))
566 #define _VA_UNUSED_VARS_12(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0) \
567         ((void)(a0), _VA_UNUSED_VARS_11(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0))
568 #define _VA_UNUSED_VARS_13(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0) \
569         ((void)(a0), _VA_UNUSED_VARS_12(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0))
570 #define _VA_UNUSED_VARS_14(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0) \
571         ((void)(a0), _VA_UNUSED_VARS_13(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0))
572 #define _VA_UNUSED_VARS_15(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0) \
573         ((void)(a0), _VA_UNUSED_VARS_14(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0))
574 #define _VA_UNUSED_VARS_16(a0, b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0, p0) \
575         ((void)(a0), _VA_UNUSED_VARS_15(b0, c0, d0, e0, f0, g0, h0, i0, j0, k0, l0, m0, n0, o0, p0))
576
577
578 /* reusable ELEM macro */
579 #define UNUSED_VARS(...) VA_NARGS_CALL_OVERLOAD(_VA_UNUSED_VARS_, __VA_ARGS__)
580
581 /* for debug-only variables */
582 #ifndef NDEBUG
583 #  define UNUSED_VARS_NDEBUG(...)
584 #else
585 #  define UNUSED_VARS_NDEBUG UNUSED_VARS
586 #endif
587
588 /* hints for branch prediction, only use in code that runs a _lot_ where */
589 #ifdef __GNUC__
590 #  define LIKELY(x)       __builtin_expect(!!(x), 1)
591 #  define UNLIKELY(x)     __builtin_expect(!!(x), 0)
592 #else
593 #  define LIKELY(x)       (x)
594 #  define UNLIKELY(x)     (x)
595 #endif
596
597 /* Expands to an integer constant expression evaluating to a close upper bound
598  * on the number the number of decimal digits in a value expressible in the
599  * integer type given by the argument (if it is a type name) or the the integer
600  * type of the argument (if it is an expression). The meaning of the resulting
601  * expression is unspecified for other arguments.
602  * i.e: DECIMAL_DIGITS_BOUND(uchar) is equal to 3. */
603 #define DECIMAL_DIGITS_BOUND(t) (241 * sizeof(t) / 100 + 1)
604
605 #ifdef __cplusplus
606 }
607 #endif
608
609 #endif  /* __BLI_UTILDEFINES_H__ */