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