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