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