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