7ee4760c48d277b23c471bd80b19d6c4e0c1e950
[blender.git] / source / gameengine / Expressions / PyObjectPlus.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 /** \file PyObjectPlus.h
29  *  \ingroup expressions
30  */
31
32 /* for now keep weakrefs optional */
33 #define USE_WEAKREFS
34
35 #ifndef _adr_py_lib_h_                          // only process once,
36 #define _adr_py_lib_h_                          // even if multiply included
37
38 #ifndef __cplusplus                             // c++ only
39 #error Must be compiled with C++
40 #endif
41
42 #include "KX_Python.h"
43 #include "STR_String.h"
44 #include "MT_Vector3.h"
45 #include "SG_QList.h"
46 #include <stddef.h>
47
48 /*------------------------------
49  * Python defines
50 ------------------------------*/
51
52 #ifdef WITH_PYTHON
53 #ifdef USE_MATHUTILS
54 extern "C" {
55 #include "../../blender/python/mathutils/mathutils.h" /* so we can have mathutils callbacks */
56 #include "../../blender/python/generic/py_capi_utils.h" /* for PyC_LineSpit only */
57 }
58 #endif
59
60 static inline void Py_Fatal(const char *M) {
61         fprintf(stderr, "%s\n", M);
62         exit(-1);
63 };
64
65
66 /* Use with ShowDeprecationWarning macro */
67 typedef struct {
68         bool warn_done;
69         void *link;
70 } WarnLink;
71
72 #define ShowDeprecationWarning(old_way, new_way) \
73 { \
74         static WarnLink wlink = {false, NULL}; \
75         if ((m_ignore_deprecation_warnings || wlink.warn_done)==0) \
76         { \
77                 ShowDeprecationWarning_func(old_way, new_way); \
78  \
79                 WarnLink *wlink_last= GetDeprecationWarningLinkLast(); \
80                 wlink.warn_done = true; \
81                 wlink.link = NULL; \
82          \
83                 if(wlink_last) { \
84                         wlink_last->link= (void *)&(wlink); \
85                         SetDeprecationWarningLinkLast(&(wlink)); \
86                 } else { \
87                         SetDeprecationWarningFirst(&(wlink)); \
88                         SetDeprecationWarningLinkLast(&(wlink)); \
89                 } \
90         } \
91 } \
92
93
94
95 typedef struct PyObjectPlus_Proxy {
96         PyObject_HEAD           /* required python macro   */
97         class PyObjectPlus *ref;        // pointer to GE object, it holds a reference to this proxy
98         void *ptr;                                      // optional pointer to generic structure, the structure holds no reference to this proxy
99         bool py_owns;           // true if the object pointed by ref should be deleted when the proxy is deleted
100         bool py_ref;            // true if proxy is connected to a GE object (ref is used)
101 #ifdef USE_WEAKREFS
102         PyObject *in_weakreflist; // weak reference enabler
103 #endif
104 } PyObjectPlus_Proxy;
105
106 #define BGE_PROXY_ERROR_MSG "Blender Game Engine data has been freed, cannot use this python variable"
107 #define BGE_PROXY_REF(_self) (((PyObjectPlus_Proxy *)_self)->ref)
108 #define BGE_PROXY_PTR(_self) (((PyObjectPlus_Proxy *)_self)->ptr)
109 #define BGE_PROXY_PYOWNS(_self) (((PyObjectPlus_Proxy *)_self)->py_owns)
110 #define BGE_PROXY_PYREF(_self) (((PyObjectPlus_Proxy *)_self)->py_ref)
111 #ifdef USE_WEAKREFS
112         #define BGE_PROXY_WKREF(_self) (((PyObjectPlus_Proxy *)_self)->in_weakreflist)
113 #endif
114
115 /* Note, sometimes we dont care what BGE type this is as long as its a proxy */
116 #define BGE_PROXY_CHECK_TYPE(_type) ((_type)->tp_dealloc == PyObjectPlus::py_base_dealloc)
117
118 /* Opposite of BGE_PROXY_REF */
119 #define BGE_PROXY_FROM_REF(_self) (((PyObjectPlus *)_self)->GetProxy())
120
121
122 // This must be the first line of each 
123 // PyC++ class
124 // AttributesPtr correspond to attributes of proxy generic pointer 
125 // each PyC++ class must be registered in KX_PythonInitTypes.cpp
126 #define __Py_Header \
127  public: \
128   static PyTypeObject   Type; \
129   static PyMethodDef    Methods[]; \
130   static PyAttributeDef Attributes[]; \
131   virtual PyTypeObject *GetType(void) {return &Type;}; \
132   virtual PyObject *GetProxy() {return GetProxyPlus_Ext(this, &Type, NULL);}; \
133   virtual PyObject *NewProxy(bool py_owns) {return NewProxyPlus_Ext(this, &Type, NULL, py_owns);}; \
134
135 // leave above line empty (macro)!
136 // use this macro for class that use generic pointer in proxy
137 // GetProxy() and NewProxy() must be defined to set the correct pointer in the proxy
138 #define __Py_HeaderPtr \
139  public: \
140   static PyTypeObject   Type; \
141   static PyMethodDef    Methods[]; \
142   static PyAttributeDef Attributes[]; \
143   static PyAttributeDef AttributesPtr[]; \
144   virtual PyTypeObject *GetType(void) {return &Type;}; \
145   virtual PyObject *GetProxy(); \
146   virtual PyObject *NewProxy(bool py_owns); \
147
148 // leave above line empty (macro)!
149 #ifdef WITH_CXX_GUARDEDALLOC
150 #define Py_Header __Py_Header \
151   void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, Type.tp_name); } \
152   void operator delete(void *mem) { MEM_freeN(mem); } \
153
154 #else
155 #define Py_Header __Py_Header
156 #endif
157
158 #ifdef WITH_CXX_GUARDEDALLOC
159 #define Py_HeaderPtr __Py_HeaderPtr \
160   void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, Type.tp_name); } \
161   void operator delete( void *mem ) { MEM_freeN(mem); } \
162
163 #else
164 #define Py_HeaderPtr __Py_HeaderPtr
165 #endif
166
167 /*
168  * nonzero values are an error for setattr
169  * however because of the nested lookups we need to know if the errors
170  * was because the attribute didnt exits of if there was some problem setting the value
171  */
172
173 #define PY_SET_ATTR_COERCE_FAIL  2
174 #define PY_SET_ATTR_FAIL                 1
175 #define PY_SET_ATTR_MISSING             -1
176 #define PY_SET_ATTR_SUCCESS              0
177
178 /**
179  * These macros are helpfull when embedding Python routines. The second
180  * macro is one that also requires a documentation string
181  */
182 #define KX_PYMETHOD(class_name, method_name)                    \
183         PyObject* Py##method_name(PyObject* args, PyObject* kwds); \
184         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
185                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "() - " BGE_PROXY_ERROR_MSG); return NULL; } \
186                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name(args, kwds);         \
187         }; \
188
189 #define KX_PYMETHOD_VARARGS(class_name, method_name)                    \
190         PyObject* Py##method_name(PyObject* args); \
191         static PyObject* sPy##method_name( PyObject* self, PyObject* args) { \
192                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "() - " BGE_PROXY_ERROR_MSG); return NULL; } \
193                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name(args);               \
194         }; \
195
196 #define KX_PYMETHOD_NOARGS(class_name, method_name)                     \
197         PyObject* Py##method_name(); \
198         static PyObject* sPy##method_name( PyObject* self) { \
199                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "() - " BGE_PROXY_ERROR_MSG); return NULL; } \
200                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name();           \
201         }; \
202         
203 #define KX_PYMETHOD_O(class_name, method_name)                  \
204         PyObject* Py##method_name(PyObject* value); \
205         static PyObject* sPy##method_name( PyObject* self, PyObject* value) { \
206                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "(value) - " BGE_PROXY_ERROR_MSG); return NULL; } \
207                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name(value);              \
208         }; \
209
210 #define KX_PYMETHOD_DOC(class_name, method_name)                        \
211         PyObject* Py##method_name(PyObject* args, PyObject* kwds); \
212         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
213                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "(...) - " BGE_PROXY_ERROR_MSG); return NULL; } \
214                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name(args, kwds);         \
215         }; \
216         static const char method_name##_doc[]; \
217
218 #define KX_PYMETHOD_DOC_VARARGS(class_name, method_name)                        \
219         PyObject* Py##method_name(PyObject* args); \
220         static PyObject* sPy##method_name( PyObject* self, PyObject* args) { \
221                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "(...) - " BGE_PROXY_ERROR_MSG); return NULL; } \
222                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name(args);               \
223         }; \
224         static const char method_name##_doc[]; \
225
226 #define KX_PYMETHOD_DOC_O(class_name, method_name)                      \
227         PyObject* Py##method_name(PyObject* value); \
228         static PyObject* sPy##method_name( PyObject* self, PyObject* value) { \
229                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "(value) - " BGE_PROXY_ERROR_MSG); return NULL; } \
230                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name(value);              \
231         }; \
232         static const char method_name##_doc[]; \
233
234 #define KX_PYMETHOD_DOC_NOARGS(class_name, method_name)                 \
235         PyObject* Py##method_name(); \
236         static PyObject* sPy##method_name( PyObject* self) { \
237                 if(BGE_PROXY_REF(self)==NULL) { PyErr_SetString(PyExc_RuntimeError, #class_name "." #method_name "() - " BGE_PROXY_ERROR_MSG); return NULL; } \
238                 return ((class_name*)BGE_PROXY_REF(self))->Py##method_name();           \
239         }; \
240         static const char method_name##_doc[]; \
241
242
243 /* The line above should remain empty */
244 /**
245  * Method table macro (with doc)
246  */
247 #define KX_PYMETHODTABLE(class_name, method_name) \
248         {#method_name , (PyCFunction) class_name::sPy##method_name, METH_VARARGS, (const char *)class_name::method_name##_doc}
249
250 #define KX_PYMETHODTABLE_O(class_name, method_name) \
251         {#method_name , (PyCFunction) class_name::sPy##method_name, METH_O, (const char *)class_name::method_name##_doc}
252
253 #define KX_PYMETHODTABLE_NOARGS(class_name, method_name) \
254         {#method_name , (PyCFunction) class_name::sPy##method_name, METH_NOARGS, (const char *)class_name::method_name##_doc}
255
256 #define KX_PYMETHODTABLE_KEYWORDS(class_name, method_name) \
257         {#method_name , (PyCFunction) class_name::sPy##method_name, METH_VARARGS|METH_KEYWORDS, (const char *)class_name::method_name##_doc}
258
259 /**
260  * Function implementation macro
261  */
262 #define KX_PYMETHODDEF_DOC(class_name, method_name, doc_string) \
263 const char class_name::method_name##_doc[] = doc_string; \
264 PyObject* class_name::Py##method_name(PyObject* args, PyObject* kwds)
265
266 #define KX_PYMETHODDEF_DOC_VARARGS(class_name, method_name, doc_string) \
267 const char class_name::method_name##_doc[] = doc_string; \
268 PyObject* class_name::Py##method_name(PyObject* args)
269
270 #define KX_PYMETHODDEF_DOC_O(class_name, method_name, doc_string) \
271 const char class_name::method_name##_doc[] = doc_string; \
272 PyObject* class_name::Py##method_name(PyObject* value)
273
274 #define KX_PYMETHODDEF_DOC_NOARGS(class_name, method_name, doc_string) \
275 const char class_name::method_name##_doc[] = doc_string; \
276 PyObject* class_name::Py##method_name()
277
278 /**
279  * Attribute management
280  */
281 enum KX_PYATTRIBUTE_TYPE {
282         KX_PYATTRIBUTE_TYPE_BOOL,
283         KX_PYATTRIBUTE_TYPE_ENUM,
284         KX_PYATTRIBUTE_TYPE_SHORT,
285         KX_PYATTRIBUTE_TYPE_INT,
286         KX_PYATTRIBUTE_TYPE_FLOAT,
287         KX_PYATTRIBUTE_TYPE_STRING,
288         KX_PYATTRIBUTE_TYPE_DUMMY,
289         KX_PYATTRIBUTE_TYPE_FUNCTION,
290         KX_PYATTRIBUTE_TYPE_VECTOR,
291         KX_PYATTRIBUTE_TYPE_FLAG,
292         KX_PYATTRIBUTE_TYPE_CHAR,
293 };
294
295 enum KX_PYATTRIBUTE_ACCESS {
296         KX_PYATTRIBUTE_RW,
297         KX_PYATTRIBUTE_RO
298 };
299
300 struct KX_PYATTRIBUTE_DEF;
301 typedef int (*KX_PYATTRIBUTE_CHECK_FUNCTION)(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
302 typedef int (*KX_PYATTRIBUTE_SET_FUNCTION)(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
303 typedef PyObject* (*KX_PYATTRIBUTE_GET_FUNCTION)(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
304
305 typedef struct KX_PYATTRIBUTE_DEF {
306         const char *m_name;                             // name of the python attribute
307         KX_PYATTRIBUTE_TYPE m_type;             // type of value
308         KX_PYATTRIBUTE_ACCESS m_access; // read/write access or read-only
309         int m_imin;                                             // minimum value in case of integer attributes 
310                                                                         // (for string: minimum string length, for flag: mask value, for float: matrix row size)
311         int m_imax;                                             // maximum value in case of integer attributes 
312                                                                         // (for string: maximum string length, for flag: 1 if flag is negative, float: vector/matrix col size)
313         float m_fmin;                                   // minimum value in case of float attributes
314         float m_fmax;                                   // maximum value in case of float attributes
315         bool   m_clamp;                                 // enforce min/max value by clamping
316         bool   m_usePtr;                                // the attribute uses the proxy generic pointer, set at runtime
317         size_t m_offset;                                // position of field in structure
318         size_t m_size;                                  // size of field for runtime verification (enum only)
319         size_t m_length;                                // length of array, 1=simple attribute
320         KX_PYATTRIBUTE_CHECK_FUNCTION m_checkFunction;  // static function to check the assignment, returns 0 if no error
321         KX_PYATTRIBUTE_SET_FUNCTION m_setFunction;      // static function to check the assignment, returns 0 if no error
322         KX_PYATTRIBUTE_GET_FUNCTION m_getFunction;      // static function to check the assignment, returns 0 if no error
323
324         // The following pointers are just used to have compile time check for attribute type.
325         // It would have been good to use a union but that would require C99 compatibility
326         // to initialize specific union fields through designated initializers.
327         struct {
328                 bool *m_boolPtr;
329                 short int *m_shortPtr;
330                 int *m_intPtr;
331                 float *m_floatPtr;
332                 STR_String *m_stringPtr;
333                 MT_Vector3 *m_vectorPtr;
334                 char *m_charPtr;
335         } m_typeCheck;
336 } PyAttributeDef;
337
338 #define KX_PYATTRIBUTE_BOOL_RW(name,object,field) \
339         { name, KX_PYATTRIBUTE_TYPE_BOOL, KX_PYATTRIBUTE_RW, 0, 1, 0.f, 0.f, false, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {&((object *)0)->field, NULL, NULL, NULL, NULL, NULL, NULL} }
340 #define KX_PYATTRIBUTE_BOOL_RW_CHECK(name,object,field,function) \
341         { name, KX_PYATTRIBUTE_TYPE_BOOL, KX_PYATTRIBUTE_RW, 0, 1, 0.f, 0.f, false, false, offsetof(object,field), 0, 1, &object::function, NULL, NULL, {&((object *)0)->field, NULL, NULL, NULL, NULL, NULL, NULL} }
342 #define KX_PYATTRIBUTE_BOOL_RO(name,object,field) \
343         { name, KX_PYATTRIBUTE_TYPE_BOOL, KX_PYATTRIBUTE_RO, 0, 1, 0.f, 0.f, false, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {&((object *)0)->field, NULL, NULL, NULL, NULL, NULL, NULL} }
344
345 /* attribute points to a single bit of an integer field, attribute=true if bit is set */
346 #define KX_PYATTRIBUTE_FLAG_RW(name,object,field,bit) \
347         { name, KX_PYATTRIBUTE_TYPE_FLAG, KX_PYATTRIBUTE_RW, bit, 0, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
348 #define KX_PYATTRIBUTE_FLAG_RW_CHECK(name,object,field,bit,function) \
349         { name, KX_PYATTRIBUTE_TYPE_FLAG, KX_PYATTRIBUTE_RW, bit, 0, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, &object::function, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
350 #define KX_PYATTRIBUTE_FLAG_RO(name,object,field,bit) \
351         { name, KX_PYATTRIBUTE_TYPE_FLAG, KX_PYATTRIBUTE_RO, bit, 0, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
352
353 /* attribute points to a single bit of an integer field, attribute=true if bit is set*/
354 #define KX_PYATTRIBUTE_FLAG_NEGATIVE_RW(name,object,field,bit) \
355         { name, KX_PYATTRIBUTE_TYPE_FLAG, KX_PYATTRIBUTE_RW, bit, 1, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
356 #define KX_PYATTRIBUTE_FLAG_NEGATIVE_RW_CHECK(name,object,field,bit,function) \
357         { name, KX_PYATTRIBUTE_TYPE_FLAG, KX_PYATTRIBUTE_RW, bit, 1, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, &object::function, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
358 #define KX_PYATTRIBUTE_FLAG_NEGATIVE_RO(name,object,field,bit) \
359         { name, KX_PYATTRIBUTE_TYPE_FLAG, KX_PYATTRIBUTE_RO, bit, 1, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
360
361 // enum field cannot be mapped to pointer (because we would need a pointer for each enum)
362 // use field size to verify mapping at runtime only, assuming enum size is equal to int size.
363 #define KX_PYATTRIBUTE_ENUM_RW(name,min,max,clamp,object,field) \
364         { name, KX_PYATTRIBUTE_TYPE_ENUM, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
365 #define KX_PYATTRIBUTE_ENUM_RW_CHECK(name,min,max,clamp,object,field,function) \
366         { name, KX_PYATTRIBUTE_TYPE_ENUM, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), sizeof(((object *)0)->field), 1, &object::function, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
367 #define KX_PYATTRIBUTE_ENUM_RO(name,object,field) \
368         { name, KX_PYATTRIBUTE_TYPE_ENUM, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
369
370 #define KX_PYATTRIBUTE_SHORT_RW(name,min,max,clamp,object,field) \
371         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, &((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
372 #define KX_PYATTRIBUTE_SHORT_RW_CHECK(name,min,max,clamp,object,field,function) \
373         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, 1, &object::function, NULL, NULL, {NULL, &((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
374 #define KX_PYATTRIBUTE_SHORT_RO(name,object,field) \
375         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, &((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
376 #define KX_PYATTRIBUTE_SHORT_ARRAY_RW(name,min,max,clamp,object,field,length) \
377         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, ((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
378 #define KX_PYATTRIBUTE_SHORT_ARRAY_RW_CHECK(name,min,max,clamp,object,field,length,function) \
379         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, &object::function, NULL, NULL, {NULL, ((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
380 #define KX_PYATTRIBUTE_SHORT_ARRAY_RO(name,object,field,length) \
381         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, ((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
382 // SHORT_LIST
383 #define KX_PYATTRIBUTE_SHORT_LIST_RW(name,min,max,clamp,object,field,length) \
384         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, &((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
385 #define KX_PYATTRIBUTE_SHORT_LIST_RW_CHECK(name,min,max,clamp,object,field,length,function) \
386         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, &object::function, NULL, NULL, {NULL, &((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
387 #define KX_PYATTRIBUTE_SHORT_LIST_RO(name,object,field,length) \
388         { name, KX_PYATTRIBUTE_TYPE_SHORT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, &((object *)0)->field, NULL, NULL, NULL, NULL, NULL} }
389
390 #define KX_PYATTRIBUTE_INT_RW(name,min,max,clamp,object,field) \
391         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, NULL, &((object *)0)->field, NULL, NULL, NULL, NULL} }
392 #define KX_PYATTRIBUTE_INT_RW_CHECK(name,min,max,clamp,object,field,function) \
393         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, 1, &object::function, NULL, NULL, {NULL, NULL, &((object *)0)->field, NULL, NULL, NULL, NULL} }
394 #define KX_PYATTRIBUTE_INT_RO(name,object,field) \
395         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, NULL, &((object *)0)->field, NULL, NULL, NULL, NULL} }
396 #define KX_PYATTRIBUTE_INT_ARRAY_RW(name,min,max,clamp,object,field,length) \
397         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, NULL, ((object *)0)->field, NULL, NULL, NULL, NULL} }
398 #define KX_PYATTRIBUTE_INT_ARRAY_RW_CHECK(name,min,max,clamp,object,field,length,function) \
399         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, &object::function, NULL, NULL, {NULL, NULL, ((object *)0)->field, NULL, NULL, NULL, NULL} }
400 #define KX_PYATTRIBUTE_INT_ARRAY_RO(name,object,field,length) \
401         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, NULL, ((object *)0)->field, NULL, NULL, NULL, NULL} }
402 // INT_LIST
403 #define KX_PYATTRIBUTE_INT_LIST_RW(name,min,max,clamp,object,field,length) \
404         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, NULL, &((object *)0)->field, NULL, NULL, NULL, NULL} }
405 #define KX_PYATTRIBUTE_INT_LIST_RW_CHECK(name,min,max,clamp,object,field,length,function) \
406         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, length, &object::function, NULL, NULL, {NULL, NULL, &((object *)0)->field, NULL, NULL, NULL, NULL} }
407 #define KX_PYATTRIBUTE_INT_LIST_RO(name,object,field,length) \
408         { name, KX_PYATTRIBUTE_TYPE_INT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, NULL, &((object *)0)->field, NULL, NULL, NULL, NULL} }
409
410 // always clamp for float
411 #define KX_PYATTRIBUTE_FLOAT_RW(name,min,max,object,field) \
412         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, 0, 0, min, max, true, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, NULL, NULL, &((object *)0)->field, NULL, NULL, NULL} }
413 #define KX_PYATTRIBUTE_FLOAT_RW_CHECK(name,min,max,object,field,function) \
414         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, 0, 0, min, max, true, false, offsetof(object,field), 0, 1, &object::function, NULL, NULL, {NULL, NULL, NULL, &((object *)0)->field, NULL, NULL, NULL} }
415 #define KX_PYATTRIBUTE_FLOAT_RO(name,object,field) \
416         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, NULL, NULL, &((object *)0)->field, NULL, NULL, NULL} }
417 // field must be float[n], returns a sequence
418 #define KX_PYATTRIBUTE_FLOAT_ARRAY_RW(name,min,max,object,field,length) \
419         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, 0, 0, min, max, true, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field, NULL, NULL, NULL} }
420 #define KX_PYATTRIBUTE_FLOAT_ARRAY_RW_CHECK(name,min,max,object,field,length,function) \
421         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, 0, 0, min, max, true, false, offsetof(object,field), 0, length, &object::function, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field, NULL, NULL, NULL} }
422 #define KX_PYATTRIBUTE_FLOAT_ARRAY_RO(name,object,field,length) \
423         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, length, NULL, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field, NULL, NULL, NULL} }
424 // field must be float[n], returns a vector
425 #define KX_PYATTRIBUTE_FLOAT_VECTOR_RW(name,min,max,object,field,length) \
426         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, 0, length, min, max, true, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field, NULL, NULL, NULL} }
427 #define KX_PYATTRIBUTE_FLOAT_VECTOR_RW_CHECK(name,min,max,object,field,length,function) \
428         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, 0, length, min, max, true, false, offsetof(object,field), sizeof(((object *)0)->field), 1, &object::function, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field, NULL, NULL, NULL} }
429 #define KX_PYATTRIBUTE_FLOAT_VECTOR_RO(name,object,field,length) \
430         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RO, 0, length, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field, NULL, NULL, NULL} }
431 // field must be float[n][n], returns a matrix
432 #define KX_PYATTRIBUTE_FLOAT_MATRIX_RW(name,min,max,object,field,length) \
433         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, length, length, min, max, true, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field[0], NULL, NULL, NULL} }
434 #define KX_PYATTRIBUTE_FLOAT_MATRIX_RW_CHECK(name,min,max,object,field,length,function) \
435         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RW, length, length, min, max, true, false, offsetof(object,field), sizeof(((object *)0)->field), 1, &object::function, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field[0], NULL, NULL, NULL} }
436 #define KX_PYATTRIBUTE_FLOAT_MATRIX_RO(name,object,field,length) \
437         { name, KX_PYATTRIBUTE_TYPE_FLOAT, KX_PYATTRIBUTE_RO, length, length, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, ((object *)0)->field[0], NULL, NULL, NULL} }
438
439 // only for STR_String member
440 #define KX_PYATTRIBUTE_STRING_RW(name,min,max,clamp,object,field) \
441         { name, KX_PYATTRIBUTE_TYPE_STRING, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, &((object *)0)->field, NULL, NULL} }
442 #define KX_PYATTRIBUTE_STRING_RW_CHECK(name,min,max,clamp,object,field,function) \
443         { name, KX_PYATTRIBUTE_TYPE_STRING, KX_PYATTRIBUTE_RW, min, max, 0.f, 0.f, clamp, false, offsetof(object,field), 0, 1, &object::function, NULL, NULL, {NULL, NULL, NULL, NULL, &((object *)0)->field, NULL, NULL} }
444 #define KX_PYATTRIBUTE_STRING_RO(name,object,field) \
445         { name, KX_PYATTRIBUTE_TYPE_STRING, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, 1 , NULL, NULL, NULL, {NULL, NULL, NULL, NULL, &((object *)0)->field, NULL, NULL} }
446
447 // only for char [] array 
448 #define KX_PYATTRIBUTE_CHAR_RW(name,object,field) \
449         { name, KX_PYATTRIBUTE_TYPE_CHAR, KX_PYATTRIBUTE_RW, 0, 0, 0.f, 0.f, true, false, offsetof(object,field), sizeof(((object *)0)->field), 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, ((object *)0)->field} }
450 #define KX_PYATTRIBUTE_CHAR_RW_CHECK(name,object,field,function) \
451         { name, KX_PYATTRIBUTE_TYPE_CHAR, KX_PYATTRIBUTE_RW, 0, 0, 0.f, 0.f, true, false, offsetof(object,field), sizeof(((object *)0)->field), 1, &object::function, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, ((object *)0)->field} }
452 #define KX_PYATTRIBUTE_CHAR_RO(name,object,field) \
453         { name, KX_PYATTRIBUTE_TYPE_CHAR, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), sizeof(((object *)0)->field), 1 , NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, NULL, ((object *)0)->field} }
454
455 // for MT_Vector3 member
456 #define KX_PYATTRIBUTE_VECTOR_RW(name,min,max,object,field) \
457         { name, KX_PYATTRIBUTE_TYPE_VECTOR, KX_PYATTRIBUTE_RW, 0, 0, min, max, true, false, offsetof(object,field), 0, 1, NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, &((object *)0)->field, NULL} }
458 #define KX_PYATTRIBUTE_VECTOR_RW_CHECK(name,min,max,clamp,object,field,function) \
459         { name, KX_PYATTRIBUTE_TYPE_VECTOR, KX_PYATTRIBUTE_RW, 0, 0, min, max, true, false, offsetof(object,field), 0, 1, &object::function, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, &((object *)0)->field, NULL} }
460 #define KX_PYATTRIBUTE_VECTOR_RO(name,object,field) \
461         { name, KX_PYATTRIBUTE_TYPE_VECTOR, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, offsetof(object,field), 0, 1 , NULL, NULL, NULL, {NULL, NULL, NULL, NULL, NULL, &((object *)0)->field, NULL} }
462
463 #define KX_PYATTRIBUTE_RW_FUNCTION(name,object,getfunction,setfunction) \
464         { name, KX_PYATTRIBUTE_TYPE_FUNCTION, KX_PYATTRIBUTE_RW, 0, 0, 0.f, 0.f, false, false, 0, 0, 1, NULL, &object::setfunction, &object::getfunction, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
465 #define KX_PYATTRIBUTE_RO_FUNCTION(name,object,getfunction) \
466         { name, KX_PYATTRIBUTE_TYPE_FUNCTION, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0.f, false, false, 0, 0, 1, NULL, NULL, &object::getfunction, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
467 #define KX_PYATTRIBUTE_ARRAY_RW_FUNCTION(name,object,length,getfunction,setfunction) \
468         { name, KX_PYATTRIBUTE_TYPE_FUNCTION, KX_PYATTRIBUTE_RW, 0, 0, 0.f, 0,f, false, false, 0, 0, length, NULL, &object::setfunction, &object::getfunction, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
469 #define KX_PYATTRIBUTE_ARRAY_RO_FUNCTION(name,object,length,getfunction) \
470         { name, KX_PYATTRIBUTE_TYPE_FUNCTION, KX_PYATTRIBUTE_RO, 0, 0, 0.f, 0,f, false, false, 0, 0, length, NULL, NULL, &object::getfunction, {NULL, NULL, NULL, NULL, NULL, NULL, NULL} }
471
472
473 /*------------------------------
474  * PyObjectPlus
475 ------------------------------*/
476 typedef PyTypeObject * PyParentObject;                          // Define the PyParent Object
477
478 #else // WITH_PYTHON
479
480 #ifdef WITH_CXX_GUARDEDALLOC
481 #define Py_Header \
482  public: \
483         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:PyObjectPlus"); } \
484         void operator delete( void *mem ) { MEM_freeN(mem); } \
485
486 #define Py_HeaderPtr \
487  public: \
488         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:PyObjectPlusPtr"); } \
489         void operator delete( void *mem ) { MEM_freeN(mem); } \
490
491 #else // WITH_CXX_GUARDEDALLOC
492
493 #define Py_Header \
494  public: \
495
496 #define Py_HeaderPtr \
497  public: \
498
499 #endif // WITH_CXX_GUARDEDALLOC
500
501 #endif
502
503
504 // By making SG_QList the ultimate parent for PyObjectPlus objects, it
505 // allows to put them in 2 different dynamic lists at the same time
506 // The use of these links is interesting because they free of memory allocation
507 // but it's very important not to mess up with them. If you decide that 
508 // the SG_QList or SG_DList component is used for something for a certain class,
509 // they cannot can be used for anything else at a parent level!
510 // What these lists are and what they are used for must be carefully documented
511 // at the level where they are used.
512 // DON'T MAKE ANY USE OF THESE LIST AT THIS LEVEL, they are already used
513 // at SCA_IActuator, SCA_ISensor, SCA_IController level which rules out the
514 // possibility to use them at SCA_ILogicBrick, CValue and PyObjectPlus level.
515 class PyObjectPlus : public SG_QList
516 {                               // The PyObjectPlus abstract class
517         Py_Header;                                                      // Always start with Py_Header
518         
519 public:
520         PyObjectPlus();
521         
522         virtual ~PyObjectPlus();                                        // destructor
523         
524 #ifdef WITH_PYTHON
525         PyObject *m_proxy; /* actually a PyObjectPlus_Proxy */
526
527         /* These static functions are referenced by ALL PyObjectPlus_Proxy types
528          * they take the C++ reference from the PyObjectPlus_Proxy and call
529          * its own virtual py_repr, py_base_dealloc ,etc. functions.
530          */
531
532         static PyObject*                py_base_new(PyTypeObject *type, PyObject *args, PyObject *kwds); /* allows subclassing */
533         static void                     py_base_dealloc(PyObject *self);
534         static PyObject*                py_base_repr(PyObject *self);
535
536         /* These are all virtual python methods that are defined in each class
537          * Our own fake subclassing calls these on each class, then calls the parent */
538         virtual PyObject*               py_repr(void);
539         /* subclass may overwrite this function to implement more sophisticated method of validating a proxy */
540         virtual bool                    py_is_valid(void) { return true; }
541
542         static PyObject*                py_get_attrdef(PyObject *self_py, const PyAttributeDef *attrdef);
543         static int                              py_set_attrdef(PyObject *self_py, PyObject *value, const PyAttributeDef *attrdef);
544         
545         /* Kindof dumb, always returns True, the false case is checked for, before this function gets accessed */
546         static PyObject*        pyattr_get_invalid(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
547
548         static PyObject *GetProxyPlus_Ext(PyObjectPlus *self, PyTypeObject *tp, void *ptr);
549         /* self=NULL => proxy to generic pointer detached from GE object
550                         if py_owns is true, the memory pointed by ptr will be deleted automatially with MEM_freeN 
551            self!=NULL=> proxy attached to GE object, ptr is optional and point to a struct from which attributes can be defined
552                         if py_owns is true, the object will be deleted automatically, ptr will NOT be deleted 
553                                         (assume object destructor takes care of it) */
554         static PyObject *NewProxyPlus_Ext(PyObjectPlus *self, PyTypeObject *tp, void *ptr, bool py_owns);
555
556         static  WarnLink*               GetDeprecationWarningLinkFirst(void);
557         static  WarnLink*               GetDeprecationWarningLinkLast(void);
558         static  void                    SetDeprecationWarningFirst(WarnLink* wlink);
559         static  void                    SetDeprecationWarningLinkLast(WarnLink* wlink);
560         static void                     NullDeprecationWarning();
561         
562         /** enable/disable display of deprecation warnings */
563         static void                     SetDeprecationWarnings(bool ignoreDeprecationWarnings);
564         /** Shows a deprecation warning */
565         static void                     ShowDeprecationWarning_func(const char* method,const char* prop);
566         static void                     ClearDeprecationWarning();
567         
568 #endif
569
570         void    InvalidateProxy();
571
572         /**
573          * Makes sure any internal data owned by this class is deep copied.
574          */
575         virtual void ProcessReplica();
576
577         static bool                     m_ignore_deprecation_warnings;
578 };
579
580 #ifdef WITH_PYTHON
581 PyObject *py_getattr_dict(PyObject *pydict, PyObject *tp_dict);
582 #endif
583
584 #endif //  _adr_py_lib_h_