Fix for bugs: 1788 (forces) and 1799 (python delattr on game objects)
[blender.git] / source / gameengine / Expressions / PyObjectPlus.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32
33 #ifndef NO_EXP_PYTHON_EMBEDDING
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
45 /*------------------------------
46  * Python defines
47 ------------------------------*/
48
49                                                                 // some basic python macros
50 #define Py_NEWARGS 1                    
51 #define Py_Return Py_INCREF(Py_None); return Py_None;   
52
53 #define Py_Error(E, M)   {PyErr_SetString(E, M); return NULL;}
54 #define Py_Try(F) {if (!(F)) return NULL;}
55 #define Py_Assert(A,E,M) {if (!(A)) {PyErr_SetString(E, M); return NULL;}}
56
57 inline void Py_Fatal(char *M) {
58         //cout << M << endl; 
59         exit(-1);
60 };
61
62                                                                 // This must be the first line of each 
63                                                                 // PyC++ class
64 #define Py_Header \
65  public: \
66   static PyTypeObject   Type; \
67   static PyMethodDef    Methods[]; \
68   static PyParentObject Parents[]; \
69   virtual PyTypeObject *GetType(void) {return &Type;}; \
70   virtual PyParentObject *GetParents(void) {return Parents;}
71
72                                                                 // This defines the _getattr_up macro
73                                                                 // which allows attribute and method calls
74                                                                 // to be properly passed up the hierarchy.
75 #define _getattr_up(Parent) \
76   PyObject *rvalue = Py_FindMethod(Methods, this, const_cast<char*>(attr.ReadPtr())); \
77   if (rvalue == NULL) \
78     { \
79       PyErr_Clear(); \
80       return Parent::_getattr(attr); \
81     } \
82   else \
83     return rvalue 
84
85 /**
86  * These macros are helpfull when embedding Python routines. The second
87  * macro is one that also requires a documentation string
88  */
89 #define KX_PYMETHOD(class_name, method_name)                    \
90         PyObject* Py##method_name(PyObject* self, PyObject* args, PyObject* kwds); \
91         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
92                 return ((class_name*) self)->Py##method_name(self, args, kwds);         \
93         }; \
94
95 #define KX_PYMETHOD_DOC(class_name, method_name)                        \
96         PyObject* Py##method_name(PyObject* self, PyObject* args, PyObject* kwds); \
97         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
98                 return ((class_name*) self)->Py##method_name(self, args, kwds);         \
99         }; \
100     static char method_name##_doc[]; \
101
102 /* The line above should remain empty */
103 /**
104  * Method table macro (with doc)
105  */
106 #define KX_PYMETHODTABLE(class_name, method_name) \
107         {#method_name , (PyCFunction) class_name::sPy##method_name, METH_VARARGS, class_name::method_name##_doc}
108
109 /**
110  * Function implementation macro
111  */
112 #define KX_PYMETHODDEF_DOC(class_name, method_name, doc_string) \
113 char class_name::method_name##_doc[] = doc_string; \
114 PyObject* class_name::Py##method_name(PyObject*, PyObject* args, PyObject*)
115
116
117 /*------------------------------
118  * PyObjectPlus
119 ------------------------------*/
120 typedef PyTypeObject * PyParentObject;                          // Define the PyParent Object
121
122 class PyObjectPlus : public PyObject 
123 {                               // The PyObjectPlus abstract class
124         Py_Header;                                                      // Always start with Py_Header
125         
126 public:
127         PyObjectPlus(PyTypeObject *T);
128         
129         virtual ~PyObjectPlus() {};                                     // destructor
130         static void PyDestructor(PyObject *P)                           // python wrapper
131         {  
132                 delete ((PyObjectPlus *) P);  
133         };
134         
135         //void INCREF(void) {
136         //        Py_INCREF(this);
137         //  };                          // incref method
138         //void DECREF(void) {
139         //        Py_DECREF(this);
140         //  };                          // decref method
141         
142         virtual PyObject *_getattr(const STR_String& attr);                     // _getattr method
143         static  PyObject *__getattr(PyObject * PyObj, char *attr)       // This should be the entry in Type. 
144         {
145                 return ((PyObjectPlus*) PyObj)->_getattr(STR_String(attr)); 
146         }
147         
148         virtual int _delattr(const STR_String& attr);
149         virtual int _setattr(const STR_String& attr, PyObject *value);          // _setattr method
150         static  int __setattr(PyObject *PyObj,                  // This should be the entry in Type. 
151                                 char *attr, 
152                                 PyObject *value)
153         { 
154                 if (!value)
155                         return ((PyObjectPlus*) PyObj)->_delattr(attr);
156                 return ((PyObjectPlus*) PyObj)->_setattr(STR_String(attr), value);  
157         }
158         
159         virtual PyObject *_repr(void);                          // _repr method
160         static  PyObject *__repr(PyObject *PyObj)                       // This should be the entry in Type.
161         {
162                 return ((PyObjectPlus*) PyObj)->_repr();  
163         }
164         
165                                                                         // isA methods
166         bool isA(PyTypeObject *T);
167         bool isA(const char *mytypename);
168         PyObject *Py_isA(PyObject *args);
169         static PyObject *sPy_isA(PyObject *self, PyObject *args, PyObject *kwd)
170         {
171                 return ((PyObjectPlus*)self)->Py_isA(args);
172         }
173 };
174
175 #endif //  _adr_py_lib_h_
176
177 #endif //NO_EXP_PYTHON_EMBEDDING
178