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