patch [#33331] Time To Start Moving To Stdbool
[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 /* note: use of (int, TRUE / FALSE) is deprecated,
36  * use (bool, true / false) instead */
37 #ifdef HAVE_STDBOOL_H
38 # include <stdbool.h>
39 #else
40 # ifndef HAVE__BOOL
41 #  ifdef __cplusplus
42 typedef bool _Bool;
43 #  else
44 #   define _Bool signed char
45 #  endif
46 # endif
47 # define bool _Bool
48 # define false 0
49 # define true 1
50 # define __bool_true_false_are_defined 1
51 #endif
52
53 /* remove this when we're ready to remove TRUE/FALSE completely */
54 #ifdef WITH_BOOL_COMPAT
55 /* interim until all occurrences of these can be updated to stdbool */
56 # ifndef FALSE
57 #   define FALSE 0
58 # endif
59
60 # ifndef TRUE
61 #   define TRUE 1
62 # endif
63 #endif
64
65 /* useful for finding bad use of min/max */
66 #if 0
67 /* gcc only */
68 #  define _TYPECHECK(a, b)  ((void)(((typeof(a) *)0) == ((typeof(b) *)0)))
69 #  define MIN2(x, y)          (_TYPECHECK(x, y), (((x) < (y) ? (x) : (y))))
70 #  define MAX2(x, y)          (_TYPECHECK(x, y), (((x) > (y) ? (x) : (y))))
71 #endif
72
73 /* min/max */
74 #define MIN2(x, y)          ((x) < (y) ? (x) : (y))
75 #define MIN3(x, y, z)       (MIN2(MIN2((x), (y)), (z)))
76 #define MIN4(x, y, z, a)    (MIN2(MIN2((x), (y)), MIN2((z), (a))))
77
78 #define MAX2(x, y)          ((x) > (y) ? (x) : (y))
79 #define MAX3(x, y, z)       (MAX2(MAX2((x), (y)), (z)))
80 #define MAX4(x, y, z, a)    (MAX2(MAX2((x), (y)), MAX2((z), (a))))
81
82 #define INIT_MINMAX(min, max) {                                               \
83                 (min)[0] = (min)[1] = (min)[2] =  1.0e30f;                            \
84                 (max)[0] = (max)[1] = (max)[2] = -1.0e30f;                            \
85         } (void)0
86 #define INIT_MINMAX2(min, max) {                                              \
87                 (min)[0] = (min)[1] = 1.0e30f;                                        \
88                 (max)[0] = (max)[1] = -1.0e30f;                                       \
89         } (void)0
90 #define DO_MIN(vec, min) {                                                    \
91                 if ((min)[0] > (vec)[0]) (min)[0] = (vec)[0];                         \
92                 if ((min)[1] > (vec)[1]) (min)[1] = (vec)[1];                         \
93                 if ((min)[2] > (vec)[2]) (min)[2] = (vec)[2];                         \
94         } (void)0
95 #define DO_MAX(vec, max) {                                                    \
96                 if ((max)[0] < (vec)[0]) (max)[0] = (vec)[0];                         \
97                 if ((max)[1] < (vec)[1]) (max)[1] = (vec)[1];                         \
98                 if ((max)[2] < (vec)[2]) (max)[2] = (vec)[2];                         \
99         } (void)0
100 #define DO_MINMAX(vec, min, max) {                                            \
101                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
102                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
103                 if ((min)[2] > (vec)[2] ) (min)[2] = (vec)[2];                        \
104                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
105                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
106                 if ((max)[2] < (vec)[2] ) (max)[2] = (vec)[2];                        \
107         } (void)0
108 #define DO_MINMAX2(vec, min, max) {                                           \
109                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
110                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
111                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
112                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
113         } (void)0
114
115 /* some math and copy defines */
116
117 /* Causes warning:
118  * incompatible types when assigning to type 'Foo' from type 'Bar'
119  * ... the compiler optimizes away the temp var */
120 #ifdef __GNUC__
121 #define CHECK_TYPE(var, type)  {  \
122         __typeof(var) *__tmp;         \
123         __tmp = (type *)NULL;         \
124         (void)__tmp;                  \
125 } (void)0
126
127 #define CHECK_TYPE_PAIR(var_a, var_b)  {  \
128         __typeof(var_a) *__tmp;               \
129         __tmp = (__typeof(var_b) *)NULL;      \
130         (void)__tmp;                          \
131 } (void)0
132 #else
133 #  define CHECK_TYPE(var, type)
134 #  define CHECK_TYPE_PAIR(var_a, var_b)
135 #endif
136
137 /* can be used in simple macros */
138 #define CHECK_TYPE_INLINE(val, type) \
139         ((void)(((type *)0) != (val)))
140
141 #define SWAP(type, a, b)  {    \
142         type sw_ap;                \
143         CHECK_TYPE(a, type);       \
144         CHECK_TYPE(b, type);       \
145         sw_ap = (a);               \
146         (a) = (b);                 \
147         (b) = sw_ap;               \
148 } (void)0
149
150 /* swap with a temp value */
151 #define SWAP_TVAL(tval, a, b)  {  \
152         CHECK_TYPE_PAIR(tval, a);     \
153         CHECK_TYPE_PAIR(tval, b);     \
154         (tval) = (a);                 \
155         (a) = (b);                    \
156         (b) = (tval);                 \
157 } (void)0
158
159
160 #define ELEM(a, b, c)           ((a) == (b) || (a) == (c))
161 #define ELEM3(a, b, c, d)       (ELEM(a, b, c) || (a) == (d) )
162 #define ELEM4(a, b, c, d, e)    (ELEM(a, b, c) || ELEM(a, d, e) )
163 #define ELEM5(a, b, c, d, e, f) (ELEM(a, b, c) || ELEM3(a, d, e, f) )
164 #define ELEM6(a, b, c, d, e, f, g)      (ELEM(a, b, c) || ELEM4(a, d, e, f, g) )
165 #define ELEM7(a, b, c, d, e, f, g, h)   (ELEM3(a, b, c, d) || ELEM4(a, e, f, g, h) )
166 #define ELEM8(a, b, c, d, e, f, g, h, i)        (ELEM4(a, b, c, d, e) || ELEM4(a, f, g, h, i) )
167 #define ELEM9(a, b, c, d, e, f, g, h, i, j)        (ELEM4(a, b, c, d, e) || ELEM5(a, f, g, h, i, j) )
168 #define ELEM10(a, b, c, d, e, f, g, h, i, j, k)        (ELEM4(a, b, c, d, e) || ELEM6(a, f, g, h, i, j, k) )
169 #define ELEM11(a, b, c, d, e, f, g, h, i, j, k, l)        (ELEM4(a, b, c, d, e) || ELEM7(a, f, g, h, i, j, k, l) )
170
171 /* shift around elements */
172 #define SHIFT3(type, a, b, c)  {                                              \
173         type tmp;                                                                 \
174         CHECK_TYPE(a, type);                                                      \
175         CHECK_TYPE(b, type);                                                      \
176         CHECK_TYPE(c, type);                                                      \
177         tmp = a;                                                                  \
178         a = c;                                                                    \
179         c = b;                                                                    \
180         b = tmp;                                                                  \
181 } (void)0
182
183 #define SHIFT4(type, a, b, c, d)  {                                           \
184         type tmp;                                                                 \
185         CHECK_TYPE(a, type);                                                      \
186         CHECK_TYPE(b, type);                                                      \
187         CHECK_TYPE(c, type);                                                      \
188         CHECK_TYPE(d, type);                                                      \
189         tmp = a;                                                                  \
190         a = d;                                                                    \
191         d = c;                                                                    \
192         c = b;                                                                    \
193         b = tmp;                                                                  \
194 } (void)0
195
196
197 #define ABS(a)          ( (a) < 0 ? (-(a)) : (a) )
198
199 #define FTOCHAR(val) ((val) <= 0.0f) ? 0 : (((val) > (1.0f - 0.5f / 255.0f)) ? 255 : (char)((255.0f * (val)) + 0.5f))
200 #define FTOUSHORT(val) ((val >= 1.0f - 0.5f / 65535) ? 65535 : (val <= 0.0f) ? 0 : (unsigned short)(val * 65535.0f + 0.5f))
201 #define USHORTTOUCHAR(val) ((unsigned char)(((val) >= 65535 - 128) ? 255 : ((val) + 128) >> 8))
202 #define F3TOCHAR3(v2, v1) {                                                   \
203                 (v1)[0] = FTOCHAR((v2[0]));                                           \
204                 (v1)[1] = FTOCHAR((v2[1]));                                           \
205                 (v1)[2] = FTOCHAR((v2[2]));                                           \
206 } (void)0
207 #define F3TOCHAR4(v2, v1) {                                                   \
208                 (v1)[0] = FTOCHAR((v2[0]));                                           \
209                 (v1)[1] = FTOCHAR((v2[1]));                                           \
210                 (v1)[2] = FTOCHAR((v2[2]));                                           \
211                 (v1)[3] = 255;                                                        \
212 } (void)0
213 #define F4TOCHAR4(v2, v1) {                                                   \
214                 (v1)[0] = FTOCHAR((v2[0]));                                           \
215                 (v1)[1] = FTOCHAR((v2[1]));                                           \
216                 (v1)[2] = FTOCHAR((v2[2]));                                           \
217                 (v1)[3] = FTOCHAR((v2[3]));                                           \
218 } (void)0
219 #define VECCOPY(v1, v2) {                                                     \
220                 *(v1) =   *(v2);                                                      \
221                 *(v1 + 1) = *(v2 + 1);                                                \
222                 *(v1 + 2) = *(v2 + 2);                                                \
223 } (void)0
224 #define VECCOPY2D(v1, v2) {                                                   \
225                 *(v1) =   *(v2);                                                      \
226                 *(v1 + 1) = *(v2 + 1);                                                \
227 } (void)0
228 #define VECADD(v1, v2, v3) {                                                  \
229                 *(v1) =   *(v2)   + *(v3);                                            \
230                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1);                                    \
231                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2);                                    \
232 } (void)0
233 #define VECSUB(v1, v2, v3) {                                                  \
234                 *(v1) =   *(v2)   - *(v3);                                            \
235                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
236                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2);                                    \
237 } (void)0
238 #define VECSUB2D(v1, v2, v3)     {                                            \
239                 *(v1) =   *(v2)   - *(v3);                                            \
240                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
241 } (void)0
242 #define VECADDFAC(v1, v2, v3, fac) {                                          \
243                 *(v1) =   *(v2)   + *(v3) * (fac);                                    \
244                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1) * (fac);                            \
245                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2) * (fac);                            \
246 } (void)0
247 #define VECMADD(v1, v2, v3, v4) {                                             \
248                 *(v1) =   *(v2)   + *(v3) * (*(v4));                                     \
249                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1) * (*(v4 + 1));                         \
250                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2) * (*(v4 + 2));                         \
251 } (void)0
252 #define VECSUBFAC(v1, v2, v3, fac) {                                          \
253                 *(v1) =   *(v2)   - *(v3) * (fac);                                    \
254                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1) * (fac);                            \
255                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2) * (fac);                            \
256 } (void)0
257
258 #define INPR(v1, v2) ( (v1)[0] * (v2)[0] + (v1)[1] * (v2)[1] + (v1)[2] * (v2)[2])
259
260 /* some misc stuff.... */
261 #define CLAMP(a, b, c)  {           \
262         if ((a) < (b)) (a) = (b);       \
263         else if ((a) > (c)) (a) = (c);  \
264 } (void)0
265
266 #define CLAMPIS(a, b, c) ((a) < (b) ? (b) : (a) > (c) ? (c) : (a))
267 #define CLAMPTEST(a, b, c)                                                    \
268         if ((b) < (c)) {                                                          \
269                 CLAMP(a, b, c);                                                       \
270         }                                                                         \
271         else {                                                                    \
272                 CLAMP(a, c, b);                                                       \
273         } (void)0
274
275 #define IS_EQ(a, b) ((fabs((double)(a) - (b)) >= (double) FLT_EPSILON) ? 0 : 1)
276 #define IS_EQF(a, b) ((fabsf((float)(a) - (b)) >= (float) FLT_EPSILON) ? 0 : 1)
277
278 #define IS_EQT(a, b, c) ((a > b) ? (((a - b) <= c) ? 1 : 0) : ((((b - a) <= c) ? 1 : 0)))
279 #define IN_RANGE(a, b, c) ((b < c) ? ((b < a && a < c) ? 1 : 0) : ((c < a && a < b) ? 1 : 0))
280 #define IN_RANGE_INCL(a, b, c) ((b < c) ? ((b <= a && a <= c) ? 1 : 0) : ((c <= a && a <= b) ? 1 : 0))
281
282 /* unpack vector for args */
283 #define UNPACK2(a)  ((a)[0]), ((a)[1])
284 #define UNPACK3(a)  ((a)[0]), ((a)[1]), ((a)[2])
285 #define UNPACK4(a)  ((a)[0]), ((a)[1]), ((a)[2]), ((a)[3])
286 /* op may be '&' or '*' */
287 #define UNPACK2OP(a, op)  op((a)[0]), op((a)[1])
288 #define UNPACK3OP(a, op)  op((a)[0]), op((a)[1]), op((a)[2])
289 #define UNPACK4OP(a, op)  op((a)[0]), op((a)[1]), op((a)[2]), op((a)[3])
290
291 /* array helpers */
292 #define ARRAY_LAST_ITEM(arr_start, arr_dtype, elem_size, tot)                 \
293         (arr_dtype *)((char *)arr_start + (elem_size * (tot - 1)))
294
295 #define ARRAY_HAS_ITEM(item, arr_start, arr_dtype, elem_size, tot) (          \
296                 (item >= arr_start) &&                                                \
297                 (item <= ARRAY_LAST_ITEM(arr_start, arr_dtype, elem_size, tot))       \
298         )
299
300 /* Warning-free macros for storing ints in pointers. Use these _only_
301  * for storing an int in a pointer, not a pointer in an int (64bit)! */
302 #define SET_INT_IN_POINTER(i)    ((void *)(intptr_t)(i))
303 #define GET_INT_FROM_POINTER(i)  ((int)(intptr_t)(i))
304
305 #define SET_UINT_IN_POINTER(i)    ((void *)(uintptr_t)(i))
306 #define GET_UINT_FROM_POINTER(i)  ((unsigned int)(uintptr_t)(i))
307
308
309 /* Macro to convert a value to string in the preprocessor
310  * STRINGIFY_ARG: gives the argument as a string
311  * STRINGIFY_APPEND: appends any argument 'b' onto the string argument 'a',
312  *   used by STRINGIFY because some preprocessors warn about zero arguments
313  * STRINGIFY: gives the argument's value as a string */
314 #define STRINGIFY_ARG(x) "" #x
315 #define STRINGIFY_APPEND(a, b) "" a #b
316 #define STRINGIFY(x) STRINGIFY_APPEND("", x)
317
318 /* useful for debugging */
319 #define AT __FILE__ ":" STRINGIFY(__LINE__)
320
321 /* so we can use __func__ everywhere */
322 #if defined(_MSC_VER)
323 #  define __func__ __FUNCTION__
324 #endif
325
326
327 /* UNUSED macro, for function argument */
328 #ifdef __GNUC__
329 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
330 #else
331 #  define UNUSED(x) UNUSED_ ## x
332 #endif
333
334 #ifdef __GNUC__
335 #  define UNUSED_FUNCTION(x) __attribute__((__unused__)) UNUSED_ ## x
336 #else
337 #  define UNUSED_FUNCTION(x) UNUSED_ ## x
338 #endif
339
340 #ifdef __GNUC__
341 #  define WARN_UNUSED  __attribute__((warn_unused_result))
342 #else
343 #  define WARN_UNUSED
344 #endif
345
346 /*little macro so inline keyword works*/
347 #if defined(_MSC_VER)
348 #  define BLI_INLINE static __forceinline
349 #else
350 #  if (defined(__APPLE__) && defined(__ppc__))
351 /* static inline __attribute__ here breaks osx ppc gcc42 build */
352 #    define BLI_INLINE static __attribute__((always_inline))
353 #  else
354 #    define BLI_INLINE static inline __attribute__((always_inline))
355 #  endif
356 #endif
357
358
359 /* BLI_assert(), default only to print
360  * for aborting need to define WITH_ASSERT_ABORT
361  */
362 #ifndef NDEBUG
363 #  ifdef WITH_ASSERT_ABORT
364 #    define _BLI_DUMMY_ABORT abort
365 #  else
366 #    define _BLI_DUMMY_ABORT() (void)0
367 #  endif
368 #  if defined(__GNUC__) || defined(_MSC_VER) /* check __func__ is available */
369 #    define BLI_assert(a)                                                     \
370         (void)((!(a)) ?  (                                                        \
371                 (                                                                     \
372                 fprintf(stderr,                                                       \
373                         "BLI_assert failed: %s:%d, %s(), at \'%s\'\n",                    \
374                         __FILE__, __LINE__, __func__, STRINGIFY(a)),                      \
375                 _BLI_DUMMY_ABORT(),                                                   \
376                 NULL)) : NULL)
377 #  else
378 #    define BLI_assert(a)                                                     \
379         (void)((!(a)) ?  (                                                        \
380                 (                                                                     \
381                 fprintf(stderr,                                                       \
382                         "BLI_assert failed: %s:%d, at \'%s\'\n",                          \
383                         __FILE__, __LINE__, STRINGIFY(a)),                                \
384                 _BLI_DUMMY_ABORT(),                                                   \
385                 NULL)) : NULL)
386 #  endif
387 #else
388 #  define BLI_assert(a) (void)0
389 #endif
390
391 #if (defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 406))  /* gcc4.6+ only */
392 #  define BLI_STATIC_ASSERT(a, msg) _Static_assert(a, msg);
393 #else
394    /* TODO msvc, clang */
395 #  define BLI_STATIC_ASSERT(a, msg)
396 #endif
397
398 /* hints for branch pradiction, only use in code that runs a _lot_ where */
399 #ifdef __GNUC__
400 #  define LIKELY(x)       __builtin_expect(!!(x), 1)
401 #  define UNLIKELY(x)     __builtin_expect(!!(x), 0)
402 #else
403 #  define LIKELY(x)       (x)
404 #  define UNLIKELY(x)     (x)
405 #endif
406
407 #endif  /* __BLI_UTILDEFINES_H__ */