synched with trunk at revision 34793
[blender.git] / source / blender / blenkernel / BKE_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 BKE_UTILDEFINES_H
31 #define BKE_UTILDEFINES_H
32
33 #ifndef FALSE
34 #define FALSE 0
35 #endif
36
37 #ifndef TRUE
38 #define TRUE 1
39 #endif
40
41 /* Macro to convert a value to string in the preprocessor */
42 #define QUOTE(x) #x
43
44 /* these values need to be hardcoded in structs, dna does not recognize defines */
45 /* also defined in DNA_space_types.h */
46 #ifndef FILE_MAXDIR
47 #define FILE_MAXDIR                     160
48 #define FILE_MAXFILE            80
49 #define FILE_MAX                        240
50 #endif
51
52 #define ELEM(a, b, c)           ( (a)==(b) || (a)==(c) )
53 #define ELEM3(a, b, c, d)       ( ELEM(a, b, c) || (a)==(d) )
54 #define ELEM4(a, b, c, d, e)    ( ELEM(a, b, c) || ELEM(a, d, e) )
55 #define ELEM5(a, b, c, d, e, f) ( ELEM(a, b, c) || ELEM3(a, d, e, f) )
56 #define ELEM6(a, b, c, d, e, f, g)      ( ELEM(a, b, c) || ELEM4(a, d, e, f, g) )
57 #define ELEM7(a, b, c, d, e, f, g, h)   ( ELEM3(a, b, c, d) || ELEM4(a, e, f, g, h) )
58 #define ELEM8(a, b, c, d, e, f, g, h, i)        ( ELEM4(a, b, c, d, e) || ELEM4(a, f, g, h, i) )
59 #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) )
60 #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) )
61 #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) )
62
63 /* shift around elements */
64 #define SHIFT3(type, a, b, c) { type tmp; tmp = a; a = c; c = b; b = tmp; }
65 #define SHIFT4(type, a, b, c, d) { type tmp; tmp = a; a = d; d = c; c = b; b = tmp; }
66
67 /* min/max */
68 #define MIN2(x,y)               ( (x)<(y) ? (x) : (y) )
69 #define MIN3(x,y,z)             MIN2( MIN2((x),(y)) , (z) )
70 #define MIN4(x,y,z,a)           MIN2( MIN2((x),(y)) , MIN2((z),(a)) )
71
72 #define MAX2(x,y)               ( (x)>(y) ? (x) : (y) )
73 #define MAX3(x,y,z)             MAX2( MAX2((x),(y)) , (z) )
74 #define MAX4(x,y,z,a)           MAX2( MAX2((x),(y)) , MAX2((z),(a)) )
75
76 #define INIT_MINMAX(min, max) { (min)[0]= (min)[1]= (min)[2]= 1.0e30f; (max)[0]= (max)[1]= (max)[2]= -1.0e30f; }
77
78 #define INIT_MINMAX2(min, max) { (min)[0]= (min)[1]= 1.0e30f; (max)[0]= (max)[1]= -1.0e30f; }
79
80 #define DO_MIN(vec, min) { if( (min)[0]>(vec)[0] ) (min)[0]= (vec)[0];      \
81                                                           if( (min)[1]>(vec)[1] ) (min)[1]= (vec)[1];   \
82                                                           if( (min)[2]>(vec)[2] ) (min)[2]= (vec)[2]; } \
83
84 #define DO_MAX(vec, max) { if( (max)[0]<(vec)[0] ) (max)[0]= (vec)[0];          \
85                                                           if( (max)[1]<(vec)[1] ) (max)[1]= (vec)[1];   \
86                                                           if( (max)[2]<(vec)[2] ) (max)[2]= (vec)[2]; } \
87
88 #define DO_MINMAX(vec, min, max) { if( (min)[0]>(vec)[0] ) (min)[0]= (vec)[0]; \
89                                                           if( (min)[1]>(vec)[1] ) (min)[1]= (vec)[1]; \
90                                                           if( (min)[2]>(vec)[2] ) (min)[2]= (vec)[2]; \
91                                                           if( (max)[0]<(vec)[0] ) (max)[0]= (vec)[0]; \
92                                                           if( (max)[1]<(vec)[1] ) (max)[1]= (vec)[1]; \
93                                                           if( (max)[2]<(vec)[2] ) (max)[2]= (vec)[2]; } \
94
95 #define DO_MINMAX2(vec, min, max) { if( (min)[0]>(vec)[0] ) (min)[0]= (vec)[0]; \
96                                                           if( (min)[1]>(vec)[1] ) (min)[1]= (vec)[1]; \
97                                                           if( (max)[0]<(vec)[0] ) (max)[0]= (vec)[0]; \
98                                                           if( (max)[1]<(vec)[1] ) (max)[1]= (vec)[1]; }
99
100 /* some math and copy defines */
101
102 #ifndef SWAP
103 #define SWAP(type, a, b)        { type sw_ap; sw_ap=(a); (a)=(b); (b)=sw_ap; }
104 #endif
105
106 #define ABS(a)                                  ( (a)<0 ? (-(a)) : (a) )
107
108 #define AVG2(x, y)              ( 0.5 * ((x) + (y)) )
109
110 #define FTOCHAR(val) ((val)<=0.0f)? 0 : (((val)>(1.0f-0.5f/255.0f))? 255 : (char)((255.0f*(val))+0.5f))
111 #define FTOUSHORT(val) ((val >= 1.0f-0.5f/65535)? 65535: (val <= 0.0f)? 0: (unsigned short)(val*65535.0f + 0.5f))
112
113 #define VECCOPY(v1,v2)          {*(v1)= *(v2); *(v1+1)= *(v2+1); *(v1+2)= *(v2+2);}
114 #define VECCOPY2D(v1,v2)          {*(v1)= *(v2); *(v1+1)= *(v2+1);}
115 #define QUATCOPY(v1,v2)         {*(v1)= *(v2); *(v1+1)= *(v2+1); *(v1+2)= *(v2+2); *(v1+3)= *(v2+3);}
116 #define LONGCOPY(a, b, c)       {int lcpc=c, *lcpa=(int *)a, *lcpb=(int *)b; while(lcpc-->0) *(lcpa++)= *(lcpb++);}
117
118
119 #define VECADD(v1,v2,v3)        {*(v1)= *(v2) + *(v3); *(v1+1)= *(v2+1) + *(v3+1); *(v1+2)= *(v2+2) + *(v3+2);}
120 #define VECSUB(v1,v2,v3)        {*(v1)= *(v2) - *(v3); *(v1+1)= *(v2+1) - *(v3+1); *(v1+2)= *(v2+2) - *(v3+2);}
121 #define VECSUB2D(v1,v2,v3)      {*(v1)= *(v2) - *(v3); *(v1+1)= *(v2+1) - *(v3+1);}
122 #define VECADDFAC(v1,v2,v3,fac) {*(v1)= *(v2) + *(v3)*(fac); *(v1+1)= *(v2+1) + *(v3+1)*(fac); *(v1+2)= *(v2+2) + *(v3+2)*(fac);}
123 #define VECSUBFAC(v1,v2,v3,fac) {*(v1)= *(v2) - *(v3)*(fac); *(v1+1)= *(v2+1) - *(v3+1)*(fac); *(v1+2)= *(v2+2) - *(v3+2)*(fac);}
124 #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);}
125
126 #define INPR(v1, v2)            ( (v1)[0]*(v2)[0] + (v1)[1]*(v2)[1] + (v1)[2]*(v2)[2] )
127
128
129 /* some misc stuff.... */
130 #define CLAMP(a, b, c)          if((a)<(b)) (a)=(b); else if((a)>(c)) (a)=(c)
131 #define CLAMPIS(a, b, c) ((a)<(b) ? (b) : (a)>(c) ? (c) : (a))
132 #define CLAMPTEST(a, b, c)      if((b)<(c)) {CLAMP(a, b, c);} else {CLAMP(a, c, b);}
133
134 #define IS_EQ(a,b) ((fabs((double)(a)-(b)) >= (double) FLT_EPSILON) ? 0 : 1)
135
136 #define IS_EQT(a, b, c) ((a > b)? (((a-b) <= c)? 1:0) : ((((b-a) <= c)? 1:0)))
137 #define IN_RANGE(a, b, c) ((b < c)? ((b<a && a<c)? 1:0) : ((c<a && a<b)? 1:0))
138 #define IN_RANGE_INCL(a, b, c) ((b < c)? ((b<=a && a<=c)? 1:0) : ((c<=a && a<=b)? 1:0))
139
140 /* this weirdo pops up in two places ... */
141 #if !defined(WIN32)
142 #ifndef O_BINARY
143 #define O_BINARY 0
144 #endif
145 #endif
146
147 /* INTEGER CODES */
148 #if defined(__sgi) || defined (__sparc) || defined (__sparc__) || defined (__PPC__) || defined (__ppc__) || defined (__hppa__) || defined (__BIG_ENDIAN__)
149         /* Big Endian */
150 #define MAKE_ID(a,b,c,d) ( (int)(a)<<24 | (int)(b)<<16 | (c)<<8 | (d) )
151 #else
152         /* Little Endian */
153 #define MAKE_ID(a,b,c,d) ( (int)(d)<<24 | (int)(c)<<16 | (b)<<8 | (a) )
154 #endif
155
156 #define ID_NEW(a)               if( (a) && (a)->id.newid ) (a)= (void *)(a)->id.newid
157
158 #define FORM MAKE_ID('F','O','R','M')
159
160 #define BLEN MAKE_ID('B','L','E','N')
161 #define DER_ MAKE_ID('D','E','R','_')
162 #define V100 MAKE_ID('V','1','0','0')
163
164 #define DATA MAKE_ID('D','A','T','A')
165 #define GLOB MAKE_ID('G','L','O','B')
166 #define IMAG MAKE_ID('I','M','A','G')
167
168 #define DNA1 MAKE_ID('D','N','A','1')
169 #define TEST MAKE_ID('T','E','S','T') /* used as preview between 'REND' and 'GLOB' */
170 #define REND MAKE_ID('R','E','N','D')
171 #define USER MAKE_ID('U','S','E','R')
172
173 #define ENDB MAKE_ID('E','N','D','B')
174
175
176 /* This one rotates the bytes in an int64, int (32) and short (16) */
177 #define SWITCH_INT64(a) { \
178         char s_i, *p_i; \
179         p_i= (char *)&(a); \
180         s_i=p_i[0]; p_i[0]=p_i[7]; p_i[7]=s_i; \
181         s_i=p_i[1]; p_i[1]=p_i[6]; p_i[6]=s_i; \
182         s_i=p_i[2]; p_i[2]=p_i[5]; p_i[5]=s_i; \
183         s_i=p_i[3]; p_i[3]=p_i[4]; p_i[4]=s_i; }
184
185 #define SWITCH_INT(a) { \
186         char s_i, *p_i; \
187         p_i= (char *)&(a); \
188         s_i=p_i[0]; p_i[0]=p_i[3]; p_i[3]=s_i; \
189         s_i=p_i[1]; p_i[1]=p_i[2]; p_i[2]=s_i; }
190
191 #define SWITCH_SHORT(a) { \
192         char s_i, *p_i; \
193         p_i= (char *)&(a); \
194         s_i=p_i[0]; p_i[0]=p_i[1]; p_i[1]=s_i; }
195
196
197 /* Bit operations */
198 #define BTST(a,b)       ( ( (a) & 1<<(b) )!=0 )   
199 #define BNTST(a,b)      ( ( (a) & 1<<(b) )==0 )
200 #define BTST2(a,b,c)    ( BTST( (a), (b) ) || BTST( (a), (c) ) )
201 #define BSET(a,b)       ( (a) | 1<<(b) )
202 #define BCLR(a,b)       ( (a) & ~(1<<(b)) )
203 /* bit-row */
204 #define BROW(min, max)  (((max)>=31? 0xFFFFFFFF: (1<<(max+1))-1) - ((min)? ((1<<(min))-1):0) )
205
206
207 #ifdef GS
208 #undef GS
209 #endif
210 #define GS(a)   (*((short *)(a)))
211
212 /* Warning-free macros for storing ints in pointers. Use these _only_
213  * for storing an int in a pointer, not a pointer in an int (64bit)! */
214 #define SET_INT_IN_POINTER(i) ((void*)(intptr_t)(i))
215 #define GET_INT_FROM_POINTER(i) ((int)(intptr_t)(i))
216
217 /*little array macro library.  example of usage:
218
219 int *arr = NULL;
220 V_DECLARE(arr);
221 int i;
222
223 for (i=0; i<10; i++) {
224         V_GROW(arr);
225         arr[i] = something;
226 }
227 V_FREE(arr);
228
229 arrays are buffered, using double-buffering (so on each reallocation,
230 the array size is doubled).  supposedly this should give good Big Oh
231 behaviour, though it may not be the best in practice.
232 */
233
234 #define V_DECLARE(vec) int _##vec##_count=0; void *_##vec##_tmp
235
236 /*in the future, I plan on having V_DECLARE allocate stack memory it'll
237   use at first, and switch over to heap when it needs more.  that'll mess
238   up cases where you'd want to use this API to build a dynamic list for
239   non-local use, so all such cases should use this macro.*/
240 #define V_DYNDECLARE(vec) V_DECLARE(vec)
241
242 /*this returns the entire size of the array, including any buffering.*/
243 #define V_SIZE(vec) ((signed int)((vec)==NULL ? 0 : MEM_allocN_len(vec) / sizeof(*vec)))
244
245 /*this returns the logical size of the array, not including buffering.*/
246 #define V_COUNT(vec) _##vec##_count
247
248 /*grow the array by one.  zeroes the new elements.*/
249 #define V_GROW(vec) \
250         V_SIZE(vec) > _##vec##_count ? _##vec##_count++ : \
251         ((_##vec##_tmp = MEM_callocN(sizeof(*vec)*(_##vec##_count*2+2), #vec " " __FILE__ " ")),\
252         (vec && memcpy(_##vec##_tmp, vec, sizeof(*vec) * _##vec##_count)),\
253         (vec && (MEM_freeN(vec),1)),\
254         (vec = _##vec##_tmp),\
255         _##vec##_count++)
256
257 #define V_FREE(vec) if (vec) MEM_freeN(vec);
258
259 /*resets the logical size of an array to zero, but doesn't
260   free the memory.*/
261 #define V_RESET(vec) _##vec##_count=0
262
263 /*set the count of the array*/
264 #define V_SETCOUNT(vec, count) _##vec##_count = (count)
265
266 /*little macro so inline keyword works*/
267 #if defined(_MSC_VER)
268 #define BM_INLINE static __forceinline
269 #else
270 #define BM_INLINE static inline __attribute((always_inline))
271 #endif
272
273 #define BMEMSET(mem, val, size) {unsigned int _i; char *_c = (char*) mem; for (_i=0; _i<size; _i++) *_c++ = val;}
274
275 #endif