c11d8ed55be52626fd9cf8784b90b8e21b323872
[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 #ifndef FALSE
36 #  define FALSE 0
37 #endif
38
39 #ifndef TRUE
40 #  define TRUE 1
41 #endif
42
43
44 #define ELEM(a, b, c)           ((a) == (b) || (a) == (c))
45 #define ELEM3(a, b, c, d)       (ELEM(a, b, c) || (a) == (d) )
46 #define ELEM4(a, b, c, d, e)    (ELEM(a, b, c) || ELEM(a, d, e) )
47 #define ELEM5(a, b, c, d, e, f) (ELEM(a, b, c) || ELEM3(a, d, e, f) )
48 #define ELEM6(a, b, c, d, e, f, g)      (ELEM(a, b, c) || ELEM4(a, d, e, f, g) )
49 #define ELEM7(a, b, c, d, e, f, g, h)   (ELEM3(a, b, c, d) || ELEM4(a, e, f, g, h) )
50 #define ELEM8(a, b, c, d, e, f, g, h, i)        (ELEM4(a, b, c, d, e) || ELEM4(a, f, g, h, i) )
51 #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) )
52 #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) )
53 #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) )
54
55 /* shift around elements */
56 #define SHIFT3(type, a, b, c)  {                                              \
57                 type tmp;                                                             \
58                 tmp = a;                                                              \
59                 a = c;                                                                \
60                 c = b;                                                                \
61                 b = tmp;                                                              \
62 } (void)0
63 #define SHIFT4(type, a, b, c, d)  {                                           \
64                 type tmp;                                                             \
65                 tmp = a;                                                              \
66                 a = d;                                                                \
67                 d = c;                                                                \
68                 c = b;                                                                \
69                 b = tmp;                                                              \
70 } (void)0
71
72 /* min/max */
73 #define MIN2(x, y)               ( (x) < (y) ? (x) : (y) )
74 #define MIN3(x, y, z)             MIN2(MIN2((x), (y)), (z) )
75 #define MIN4(x, y, z, a)           MIN2(MIN2((x), (y)), MIN2((z), (a)) )
76
77 #define MAX2(x, y)               ( (x) > (y) ? (x) : (y) )
78 #define MAX3(x, y, z)             MAX2(MAX2((x), (y)), (z) )
79 #define MAX4(x, y, z, a)           MAX2(MAX2((x), (y)), MAX2((z), (a)) )
80
81 #define INIT_MINMAX(min, max) {                                               \
82                 (min)[0] = (min)[1] = (min)[2] =  1.0e30f;                            \
83                 (max)[0] = (max)[1] = (max)[2] = -1.0e30f;                            \
84         } (void)0
85 #define INIT_MINMAX2(min, max) {                                              \
86                 (min)[0] = (min)[1] = 1.0e30f;                                        \
87                 (max)[0] = (max)[1] = -1.0e30f;                                       \
88         } (void)0
89 #define DO_MIN(vec, min) {                                                    \
90                 if ((min)[0] > (vec)[0]) (min)[0] = (vec)[0];                         \
91                 if ((min)[1] > (vec)[1]) (min)[1] = (vec)[1];                         \
92                 if ((min)[2] > (vec)[2]) (min)[2] = (vec)[2];                         \
93         } (void)0
94 #define DO_MAX(vec, max) {                                                    \
95                 if ((max)[0] < (vec)[0]) (max)[0] = (vec)[0];                         \
96                 if ((max)[1] < (vec)[1]) (max)[1] = (vec)[1];                         \
97                 if ((max)[2] < (vec)[2]) (max)[2] = (vec)[2];                         \
98         } (void)0
99 #define DO_MINMAX(vec, min, max) {                                            \
100                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
101                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
102                 if ((min)[2] > (vec)[2] ) (min)[2] = (vec)[2];                        \
103                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
104                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
105                 if ((max)[2] < (vec)[2] ) (max)[2] = (vec)[2];                        \
106         } (void)0
107 #define DO_MINMAX2(vec, min, max) {                                           \
108                 if ((min)[0] > (vec)[0] ) (min)[0] = (vec)[0];                        \
109                 if ((min)[1] > (vec)[1] ) (min)[1] = (vec)[1];                        \
110                 if ((max)[0] < (vec)[0] ) (max)[0] = (vec)[0];                        \
111                 if ((max)[1] < (vec)[1] ) (max)[1] = (vec)[1];                        \
112         } (void)0
113
114 /* some math and copy defines */
115
116 /* Causes warning:
117  * incompatible types when assigning to type 'Foo' from type 'Bar'
118  * ... the compiler optimizes away the temp var */
119 #ifndef CHECK_TYPE
120 #ifdef __GNUC__
121 #define CHECK_TYPE(var, type)  {  \
122         __typeof(var) *__tmp;         \
123         __tmp = (type *)NULL;         \
124         (void)__tmp;                  \
125 } (void)0
126 #else
127 #define CHECK_TYPE(var, type)
128 #endif
129 #endif
130
131 #ifndef SWAP
132 #  define SWAP(type, a, b)  {  \
133         type sw_ap;                \
134         CHECK_TYPE(a, type);       \
135         CHECK_TYPE(b, type);       \
136         sw_ap = (a);               \
137         (a) = (b);                 \
138         (b) = sw_ap;               \
139 } (void)0
140 #endif
141
142 #define ABS(a)          ( (a) < 0 ? (-(a)) : (a) )
143
144 #define FTOCHAR(val) ((val) <= 0.0f) ? 0 : (((val) > (1.0f - 0.5f / 255.0f)) ? 255 : (char)((255.0f * (val)) + 0.5f))
145 #define FTOUSHORT(val) ((val >= 1.0f - 0.5f / 65535) ? 65535 : (val <= 0.0f) ? 0 : (unsigned short)(val * 65535.0f + 0.5f))
146 #define USHORTTOUCHAR(val) ((unsigned char)(((val) >= 65535 - 128) ? 255 : ((val) + 128) >> 8))
147 #define F3TOCHAR3(v2, v1) {                                                   \
148                 (v1)[0] = FTOCHAR((v2[0]));                                           \
149                 (v1)[1] = FTOCHAR((v2[1]));                                           \
150                 (v1)[2] = FTOCHAR((v2[2]));                                           \
151 } (void)0
152 #define F3TOCHAR4(v2, v1) {                                                   \
153                 (v1)[0] = FTOCHAR((v2[0]));                                           \
154                 (v1)[1] = FTOCHAR((v2[1]));                                           \
155                 (v1)[2] = FTOCHAR((v2[2]));                                           \
156                 (v1)[3] = 255;                                                        \
157 } (void)0
158 #define F4TOCHAR4(v2, v1) {                                                   \
159                 (v1)[0] = FTOCHAR((v2[0]));                                           \
160                 (v1)[1] = FTOCHAR((v2[1]));                                           \
161                 (v1)[2] = FTOCHAR((v2[2]));                                           \
162                 (v1)[3] = FTOCHAR((v2[3]));                                           \
163 } (void)0
164 #define VECCOPY(v1, v2) {                                                     \
165                 *(v1) =   *(v2);                                                      \
166                 *(v1 + 1) = *(v2 + 1);                                                \
167                 *(v1 + 2) = *(v2 + 2);                                                \
168 } (void)0
169 #define VECCOPY2D(v1, v2) {                                                   \
170                 *(v1) =   *(v2);                                                      \
171                 *(v1 + 1) = *(v2 + 1);                                                \
172 } (void)0
173 #define VECADD(v1, v2, v3) {                                                  \
174                 *(v1) =   *(v2)   + *(v3);                                            \
175                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1);                                    \
176                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2);                                    \
177 } (void)0
178 #define VECSUB(v1, v2, v3) {                                                  \
179                 *(v1) =   *(v2)   - *(v3);                                            \
180                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
181                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2);                                    \
182 } (void)0
183 #define VECSUB2D(v1, v2, v3)     {                                            \
184                 *(v1) =   *(v2)   - *(v3);                                            \
185                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1);                                    \
186 } (void)0
187 #define VECADDFAC(v1, v2, v3, fac) {                                          \
188                 *(v1) =   *(v2)   + *(v3) * (fac);                                    \
189                 *(v1 + 1) = *(v2 + 1) + *(v3 + 1) * (fac);                            \
190                 *(v1 + 2) = *(v2 + 2) + *(v3 + 2) * (fac);                            \
191 } (void)0
192 #define VECSUBFAC(v1, v2, v3, fac) {                                          \
193                 *(v1) =   *(v2)   - *(v3) * (fac);                                    \
194                 *(v1 + 1) = *(v2 + 1) - *(v3 + 1) * (fac);                            \
195                 *(v1 + 2) = *(v2 + 2) - *(v3 + 2) * (fac);                            \
196 } (void)0
197
198 #define INPR(v1, v2) ( (v1)[0] * (v2)[0] + (v1)[1] * (v2)[1] + (v1)[2] * (v2)[2])
199
200 /* some misc stuff.... */
201 #define CLAMP(a, b, c)  if ((a) < (b)) (a) = (b); else if ((a) > (c)) (a) = (c)
202
203 #define CLAMPIS(a, b, c) ((a) < (b) ? (b) : (a) > (c) ? (c) : (a))
204 #define CLAMPTEST(a, b, c)                                                    \
205         if ((b) < (c)) {                                                          \
206                 CLAMP(a, b, c);                                                       \
207         }                                                                         \
208         else {                                                                    \
209                 CLAMP(a, c, b);                                                       \
210         } (void)0
211
212 #define IS_EQ(a, b) ((fabs((double)(a) - (b)) >= (double) FLT_EPSILON) ? 0 : 1)
213 #define IS_EQF(a, b) ((fabsf((float)(a) - (b)) >= (float) FLT_EPSILON) ? 0 : 1)
214
215 #define IS_EQT(a, b, c) ((a > b) ? (((a - b) <= c) ? 1 : 0) : ((((b - a) <= c) ? 1 : 0)))
216 #define IN_RANGE(a, b, c) ((b < c) ? ((b < a && a < c) ? 1 : 0) : ((c < a && a < b) ? 1 : 0))
217 #define IN_RANGE_INCL(a, b, c) ((b < c) ? ((b <= a && a <= c) ? 1 : 0) : ((c <= a && a <= b) ? 1 : 0))
218
219 /* array helpers */
220 #define ARRAY_LAST_ITEM(arr_start, arr_dtype, elem_size, tot)                 \
221         (arr_dtype *)((char *)arr_start + (elem_size * (tot - 1)))
222
223 #define ARRAY_HAS_ITEM(item, arr_start, arr_dtype, elem_size, tot) (          \
224                 (item >= arr_start) &&                                                \
225                 (item <= ARRAY_LAST_ITEM(arr_start, arr_dtype, elem_size, tot))       \
226         )
227
228 /* Warning-free macros for storing ints in pointers. Use these _only_
229  * for storing an int in a pointer, not a pointer in an int (64bit)! */
230 #define SET_INT_IN_POINTER(i)    ((void *)(intptr_t)(i))
231 #define GET_INT_FROM_POINTER(i)  ((int)(intptr_t)(i))
232
233 #define SET_UINT_IN_POINTER(i)    ((void *)(uintptr_t)(i))
234 #define GET_UINT_FROM_POINTER(i)  ((unsigned int)(uintptr_t)(i))
235
236
237 /* Macro to convert a value to string in the preprocessor
238  * STRINGIFY_ARG: gives the argument as a string
239  * STRINGIFY_APPEND: appends any argument 'b' onto the string argument 'a',
240  *   used by STRINGIFY because some preprocessors warn about zero arguments
241  * STRINGIFY: gives the argument's value as a string */
242 #define STRINGIFY_ARG(x) "" #x
243 #define STRINGIFY_APPEND(a, b) "" a #b
244 #define STRINGIFY(x) STRINGIFY_APPEND("", x)
245
246 /* useful for debugging */
247 #define AT __FILE__ ":" STRINGIFY(__LINE__)
248
249 /* so we can use __func__ everywhere */
250 #if defined(_MSC_VER)
251 #  define __func__ __FUNCTION__
252 #endif
253
254
255 /* UNUSED macro, for function argument */
256 #ifdef __GNUC__
257 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
258 #else
259 #  define UNUSED(x) UNUSED_ ## x
260 #endif
261
262 #ifdef __GNUC__
263 #  define UNUSED_FUNCTION(x) __attribute__((__unused__)) UNUSED_ ## x
264 #else
265 #  define UNUSED_FUNCTION(x) UNUSED_ ## x
266 #endif
267
268 #ifdef __GNUC__
269 #  define WARN_UNUSED  __attribute__((warn_unused_result))
270 #else
271 #  define WARN_UNUSED
272 #endif
273
274 /*little macro so inline keyword works*/
275 #if defined(_MSC_VER)
276 #  define BLI_INLINE static __forceinline
277 #elif defined(__GNUC__)
278 #  define BLI_INLINE static inline __attribute((always_inline))
279 #else
280 /* #warning "MSC/GNUC defines not found, inline non-functional" */
281 #  define BLI_INLINE static
282 #endif
283
284
285 /* BLI_assert(), default only to print
286  * for aborting need to define WITH_ASSERT_ABORT
287  */
288 #ifndef NDEBUG
289 #  ifdef WITH_ASSERT_ABORT
290 #    define _BLI_DUMMY_ABORT abort
291 #  else
292 #    define _BLI_DUMMY_ABORT() (void)0
293 #  endif
294 #  if defined(__GNUC__) || defined(_MSC_VER) /* check __func__ is available */
295 #    define BLI_assert(a)                                                     \
296         (void)((!(a)) ?  (                                                        \
297                 (                                                                     \
298                 fprintf(stderr,                                                       \
299                         "BLI_assert failed: %s:%d, %s(), at \'%s\'\n",                    \
300                         __FILE__, __LINE__, __func__, STRINGIFY(a)),                      \
301                 _BLI_DUMMY_ABORT(),                                                   \
302                 NULL)) : NULL)
303 #  else
304 #    define BLI_assert(a)                                                     \
305         (void)((!(a)) ?  (                                                        \
306                 (                                                                     \
307                 fprintf(stderr,                                                       \
308                         "BLI_assert failed: %s:%d, at \'%s\'\n",                          \
309                         __FILE__, __LINE__, STRINGIFY(a)),                                \
310                 _BLI_DUMMY_ABORT(),                                                   \
311                 NULL)) : NULL)
312 #  endif
313 #else
314 #  define BLI_assert(a) (void)0
315 #endif
316
317 /* hints for branch pradiction, only use in code that runs a _lot_ where */
318 #ifdef __GNUC__
319 #  define LIKELY(x)       __builtin_expect(!!(x), 1)
320 #  define UNLIKELY(x)     __builtin_expect(!!(x), 0)
321 #else
322 #  define LIKELY(x)       (x)
323 #  define UNLIKELY(x)     (x)
324 #endif
325
326 #endif // __BLI_UTILDEFINES_H__