doxygen: editor entry
[blender.git] / source / blender / blenlib / BLI_utildefines.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28 */
29
30 #ifndef BLI_UTILDEFINES_H
31 #define BLI_UTILDEFINES_H
32
33 /** \file BLI_utildefines.h
34  *  \ingroup bli
35  */
36
37 #ifndef FALSE
38 #define FALSE 0
39 #endif
40
41 #ifndef TRUE
42 #define TRUE 1
43 #endif
44
45
46 #define ELEM(a, b, c)           ( (a)==(b) || (a)==(c) )
47 #define ELEM3(a, b, c, d)       ( ELEM(a, b, c) || (a)==(d) )
48 #define ELEM4(a, b, c, d, e)    ( ELEM(a, b, c) || ELEM(a, d, e) )
49 #define ELEM5(a, b, c, d, e, f) ( ELEM(a, b, c) || ELEM3(a, d, e, f) )
50 #define ELEM6(a, b, c, d, e, f, g)      ( ELEM(a, b, c) || ELEM4(a, d, e, f, g) )
51 #define ELEM7(a, b, c, d, e, f, g, h)   ( ELEM3(a, b, c, d) || ELEM4(a, e, f, g, h) )
52 #define ELEM8(a, b, c, d, e, f, g, h, i)        ( ELEM4(a, b, c, d, e) || ELEM4(a, f, g, h, i) )
53 #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) )
54 #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) )
55 #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) )
56
57 /* shift around elements */
58 #define SHIFT3(type, a, b, c) { type tmp; tmp = a; a = c; c = b; b = tmp; }
59 #define SHIFT4(type, a, b, c, d) { type tmp; tmp = a; a = d; d = c; c = b; b = tmp; }
60
61 /* min/max */
62 #define MIN2(x,y)               ( (x)<(y) ? (x) : (y) )
63 #define MIN3(x,y,z)             MIN2( MIN2((x),(y)) , (z) )
64 #define MIN4(x,y,z,a)           MIN2( MIN2((x),(y)) , MIN2((z),(a)) )
65
66 #define MAX2(x,y)               ( (x)>(y) ? (x) : (y) )
67 #define MAX3(x,y,z)             MAX2( MAX2((x),(y)) , (z) )
68 #define MAX4(x,y,z,a)           MAX2( MAX2((x),(y)) , MAX2((z),(a)) )
69
70 #define INIT_MINMAX(min, max) { (min)[0]= (min)[1]= (min)[2]= 1.0e30f; (max)[0]= (max)[1]= (max)[2]= -1.0e30f; }
71
72 #define INIT_MINMAX2(min, max) { (min)[0]= (min)[1]= 1.0e30f; (max)[0]= (max)[1]= -1.0e30f; }
73
74 #define DO_MIN(vec, min) { if( (min)[0]>(vec)[0] ) (min)[0]= (vec)[0];      \
75                                                           if( (min)[1]>(vec)[1] ) (min)[1]= (vec)[1];   \
76                                                           if( (min)[2]>(vec)[2] ) (min)[2]= (vec)[2]; } \
77
78 #define DO_MAX(vec, max) { if( (max)[0]<(vec)[0] ) (max)[0]= (vec)[0];          \
79                                                           if( (max)[1]<(vec)[1] ) (max)[1]= (vec)[1];   \
80                                                           if( (max)[2]<(vec)[2] ) (max)[2]= (vec)[2]; } \
81
82 #define DO_MINMAX(vec, min, max) { if( (min)[0]>(vec)[0] ) (min)[0]= (vec)[0]; \
83                                                           if( (min)[1]>(vec)[1] ) (min)[1]= (vec)[1]; \
84                                                           if( (min)[2]>(vec)[2] ) (min)[2]= (vec)[2]; \
85                                                           if( (max)[0]<(vec)[0] ) (max)[0]= (vec)[0]; \
86                                                           if( (max)[1]<(vec)[1] ) (max)[1]= (vec)[1]; \
87                                                           if( (max)[2]<(vec)[2] ) (max)[2]= (vec)[2]; } \
88
89 #define DO_MINMAX2(vec, min, max) { if( (min)[0]>(vec)[0] ) (min)[0]= (vec)[0]; \
90                                                           if( (min)[1]>(vec)[1] ) (min)[1]= (vec)[1]; \
91                                                           if( (max)[0]<(vec)[0] ) (max)[0]= (vec)[0]; \
92                                                           if( (max)[1]<(vec)[1] ) (max)[1]= (vec)[1]; }
93
94 /* some math and copy defines */
95
96 #ifndef SWAP
97 #define SWAP(type, a, b)        { type sw_ap; sw_ap=(a); (a)=(b); (b)=sw_ap; }
98 #endif
99
100 #define ABS(a)                                  ( (a)<0 ? (-(a)) : (a) )
101
102 #define AVG2(x, y)              ( 0.5 * ((x) + (y)) )
103
104 #define FTOCHAR(val) ((val)<=0.0f)? 0 : (((val)>(1.0f-0.5f/255.0f))? 255 : (char)((255.0f*(val))+0.5f))
105 #define FTOUSHORT(val) ((val >= 1.0f-0.5f/65535)? 65535: (val <= 0.0f)? 0: (unsigned short)(val*65535.0f + 0.5f))
106
107 #define VECCOPY(v1,v2)          {*(v1)= *(v2); *(v1+1)= *(v2+1); *(v1+2)= *(v2+2);}
108 #define VECCOPY2D(v1,v2)          {*(v1)= *(v2); *(v1+1)= *(v2+1);}
109 #define QUATCOPY(v1,v2)         {*(v1)= *(v2); *(v1+1)= *(v2+1); *(v1+2)= *(v2+2); *(v1+3)= *(v2+3);}
110 #define LONGCOPY(a, b, c)       {int lcpc=c, *lcpa=(int *)a, *lcpb=(int *)b; while(lcpc-->0) *(lcpa++)= *(lcpb++);}
111
112
113 #define VECADD(v1,v2,v3)        {*(v1)= *(v2) + *(v3); *(v1+1)= *(v2+1) + *(v3+1); *(v1+2)= *(v2+2) + *(v3+2);}
114 #define VECSUB(v1,v2,v3)        {*(v1)= *(v2) - *(v3); *(v1+1)= *(v2+1) - *(v3+1); *(v1+2)= *(v2+2) - *(v3+2);}
115 #define VECSUB2D(v1,v2,v3)      {*(v1)= *(v2) - *(v3); *(v1+1)= *(v2+1) - *(v3+1);}
116 #define VECADDFAC(v1,v2,v3,fac) {*(v1)= *(v2) + *(v3)*(fac); *(v1+1)= *(v2+1) + *(v3+1)*(fac); *(v1+2)= *(v2+2) + *(v3+2)*(fac);}
117 #define VECSUBFAC(v1,v2,v3,fac) {*(v1)= *(v2) - *(v3)*(fac); *(v1+1)= *(v2+1) - *(v3+1)*(fac); *(v1+2)= *(v2+2) - *(v3+2)*(fac);}
118 #define QUATADDFAC(v1,v2,v3,fac) {*(v1)= *(v2) + *(v3)*(fac); *(v1+1)= *(v2+1) + *(v3+1)*(fac); *(v1+2)= *(v2+2) + *(v3+2)*(fac); *(v1+3)= *(v2+3) + *(v3+3)*(fac);}
119
120 #define INPR(v1, v2)            ( (v1)[0]*(v2)[0] + (v1)[1]*(v2)[1] + (v1)[2]*(v2)[2] )
121
122 /* some misc stuff.... */
123 #define CLAMP(a, b, c)          if((a)<(b)) (a)=(b); else if((a)>(c)) (a)=(c)
124 #define CLAMPIS(a, b, c) ((a)<(b) ? (b) : (a)>(c) ? (c) : (a))
125 #define CLAMPTEST(a, b, c)      if((b)<(c)) {CLAMP(a, b, c);} else {CLAMP(a, c, b);}
126
127 #define IS_EQ(a,b) ((fabs((double)(a)-(b)) >= (double) FLT_EPSILON) ? 0 : 1)
128
129 #define IS_EQT(a, b, c) ((a > b)? (((a-b) <= c)? 1:0) : ((((b-a) <= c)? 1:0)))
130 #define IN_RANGE(a, b, c) ((b < c)? ((b<a && a<c)? 1:0) : ((c<a && a<b)? 1:0))
131 #define IN_RANGE_INCL(a, b, c) ((b < c)? ((b<=a && a<=c)? 1:0) : ((c<=a && a<=b)? 1:0))
132
133
134 /* This one rotates the bytes in an int64, int (32) and short (16) */
135 #define SWITCH_INT64(a) { \
136         char s_i, *p_i; \
137         p_i= (char *)&(a); \
138         s_i=p_i[0]; p_i[0]=p_i[7]; p_i[7]=s_i; \
139         s_i=p_i[1]; p_i[1]=p_i[6]; p_i[6]=s_i; \
140         s_i=p_i[2]; p_i[2]=p_i[5]; p_i[5]=s_i; \
141         s_i=p_i[3]; p_i[3]=p_i[4]; p_i[4]=s_i; }
142
143                 #define SWITCH_INT(a) { \
144         char s_i, *p_i; \
145         p_i= (char *)&(a); \
146         s_i=p_i[0]; p_i[0]=p_i[3]; p_i[3]=s_i; \
147         s_i=p_i[1]; p_i[1]=p_i[2]; p_i[2]=s_i; }
148
149 #define SWITCH_SHORT(a) { \
150         char s_i, *p_i; \
151         p_i= (char *)&(a); \
152         s_i=p_i[0]; p_i[0]=p_i[1]; p_i[1]=s_i; }
153
154
155 /* Warning-free macros for storing ints in pointers. Use these _only_
156  * for storing an int in a pointer, not a pointer in an int (64bit)! */
157 #define SET_INT_IN_POINTER(i) ((void*)(intptr_t)(i))
158 #define GET_INT_FROM_POINTER(i) ((int)(intptr_t)(i))
159
160 /* Macro to convert a value to string in the preprocessor
161  * STRINGIFY_ARG: gives the defined name in the string
162  * STRINGIFY: gives the defined value. */
163 #define STRINGIFY_ARG(x) #x
164 #define STRINGIFY(x) STRINGIFY_ARG(x)
165
166 /* useful for debugging */
167 #define AT __FILE__ ":" STRINGIFY(__LINE__)
168
169 /* UNUSED macro, for function argument */
170 #ifdef __GNUC__
171 #  define UNUSED(x) UNUSED_ ## x __attribute__((__unused__))
172 #else
173 #  define UNUSED(x) UNUSED_ ## x
174 #endif
175
176 #ifdef __GNUC__
177 #  define WARN_UNUSED  __attribute__((warn_unused_result))
178 #else
179 #  define WARN_UNUSED
180 #endif
181
182 /*little macro so inline keyword works*/
183 #if defined(_MSC_VER)
184 #  define BM_INLINE static __forceinline
185 #elif defined(__GNUC__)
186 #  define BM_INLINE static inline __attribute((always_inline))
187 #else
188 /* #warning "MSC/GNUC defines not found, inline non-functional" */
189 #  define BM_INLINE static
190 #endif
191
192
193 /* BLI_assert(), default only to print
194  * for aborting need to define WITH_ASSERT_ABORT
195  */
196 #if !defined NDEBUG
197 #  ifdef WITH_ASSERT_ABORT
198 #    define _dummy_abort abort
199 #  else
200 #    define _dummy_abort() (void)0
201 #  endif
202 #  ifdef __GNUC__ /* just want to check if __func__ is available */
203 #    define BLI_assert(a) \
204 do { \
205         if (0 == (a)) { \
206                 fprintf(stderr, \
207                         "BLI_assert failed: %s, %s(), %d at \'%s\'\n", \
208                         __FILE__, __func__, __LINE__, STRINGIFY(a)); \
209                 _dummy_abort(); \
210         } \
211 } while (0)
212 #  else
213 #    define BLI_assert(a) \
214 do { \
215         if (0 == (a)) { \
216                 fprintf(stderr, \
217                         "BLI_assert failed: %s, %d at \'%s\'\n", \
218                         __FILE__, __LINE__, STRINGIFY(a)); \
219                 _dummy_abort(); \
220         } \
221 } while (0)
222 #  endif
223 #else
224 #  define BLI_assert(a) (void)0
225 #endif
226
227 #endif // BLI_UTILDEFINES_H