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