Added the docs & use Python booleans for physics reinstance.
[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 static inline PyObject* Py_Success(bool truth)
53 {
54         if (truth)
55         {
56                 Py_INCREF(Py_True);
57                 return Py_True;
58         }
59         Py_INCREF(Py_False);
60         return Py_False;
61 }
62
63 #define Py_Error(E, M)   {PyErr_SetString(E, M); return NULL;}
64 #define Py_Try(F) {if (!(F)) return NULL;}
65 #define Py_Assert(A,E,M) {if (!(A)) {PyErr_SetString(E, M); return NULL;}}
66
67 static inline void Py_Fatal(char *M) {
68         //cout << M << endl; 
69         exit(-1);
70 };
71
72                                                                 // This must be the first line of each 
73                                                                 // PyC++ class
74 #define Py_Header \
75  public: \
76   static PyTypeObject   Type; \
77   static PyMethodDef    Methods[]; \
78   static PyParentObject Parents[]; \
79   virtual PyTypeObject *GetType(void) {return &Type;}; \
80   virtual PyParentObject *GetParents(void) {return Parents;}
81
82                                                                 // This defines the _getattr_up macro
83                                                                 // which allows attribute and method calls
84                                                                 // to be properly passed up the hierarchy.
85 #define _getattr_up(Parent) \
86   PyObject *rvalue = Py_FindMethod(Methods, this, const_cast<char*>(attr.ReadPtr())); \
87   if (rvalue == NULL) \
88     { \
89       PyErr_Clear(); \
90       return Parent::_getattr(attr); \
91     } \
92   else \
93     return rvalue 
94
95 /**
96  * These macros are helpfull when embedding Python routines. The second
97  * macro is one that also requires a documentation string
98  */
99 #define KX_PYMETHOD(class_name, method_name)                    \
100         PyObject* Py##method_name(PyObject* self, PyObject* args, PyObject* kwds); \
101         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
102                 return ((class_name*) self)->Py##method_name(self, args, kwds);         \
103         }; \
104
105 #define KX_PYMETHOD_DOC(class_name, method_name)                        \
106         PyObject* Py##method_name(PyObject* self, PyObject* args, PyObject* kwds); \
107         static PyObject* sPy##method_name( PyObject* self, PyObject* args, PyObject* kwds) { \
108                 return ((class_name*) self)->Py##method_name(self, args, kwds);         \
109         }; \
110     static char method_name##_doc[]; \
111
112 /* The line above should remain empty */
113 /**
114  * Method table macro (with doc)
115  */
116 #define KX_PYMETHODTABLE(class_name, method_name) \
117         {#method_name , (PyCFunction) class_name::sPy##method_name, METH_VARARGS, class_name::method_name##_doc}
118
119 /**
120  * Function implementation macro
121  */
122 #define KX_PYMETHODDEF_DOC(class_name, method_name, doc_string) \
123 char class_name::method_name##_doc[] = doc_string; \
124 PyObject* class_name::Py##method_name(PyObject*, PyObject* args, PyObject*)
125
126
127 /*------------------------------
128  * PyObjectPlus
129 ------------------------------*/
130 typedef PyTypeObject * PyParentObject;                          // Define the PyParent Object
131
132 class PyObjectPlus : public PyObject 
133 {                               // The PyObjectPlus abstract class
134         Py_Header;                                                      // Always start with Py_Header
135         
136 public:
137         PyObjectPlus(PyTypeObject *T);
138         
139         virtual ~PyObjectPlus() {};                                     // destructor
140         static void PyDestructor(PyObject *P)                           // python wrapper
141         {  
142                 delete ((PyObjectPlus *) P);  
143         };
144         
145         //void INCREF(void) {
146         //        Py_INCREF(this);
147         //  };                          // incref method
148         //void DECREF(void) {
149         //        Py_DECREF(this);
150         //  };                          // decref method
151         
152         virtual PyObject *_getattr(const STR_String& attr);                     // _getattr method
153         static  PyObject *__getattr(PyObject * PyObj, char *attr)       // This should be the entry in Type. 
154         {
155                 return ((PyObjectPlus*) PyObj)->_getattr(STR_String(attr)); 
156         }
157         
158         virtual int _delattr(const STR_String& attr);
159         virtual int _setattr(const STR_String& attr, PyObject *value);          // _setattr method
160         static  int __setattr(PyObject *PyObj,                  // This should be the entry in Type. 
161                                 char *attr, 
162                                 PyObject *value)
163         { 
164                 if (!value)
165                         return ((PyObjectPlus*) PyObj)->_delattr(attr);
166                 return ((PyObjectPlus*) PyObj)->_setattr(STR_String(attr), value);  
167         }
168         
169         virtual PyObject *_repr(void);                          // _repr method
170         static  PyObject *__repr(PyObject *PyObj)                       // This should be the entry in Type.
171         {
172                 return ((PyObjectPlus*) PyObj)->_repr();  
173         }
174         
175                                                                         // isA methods
176         bool isA(PyTypeObject *T);
177         bool isA(const char *mytypename);
178         PyObject *Py_isA(PyObject *args);
179         static PyObject *sPy_isA(PyObject *self, PyObject *args, PyObject *kwd)
180         {
181                 return ((PyObjectPlus*)self)->Py_isA(args);
182         }
183 };
184
185 #endif //  _adr_py_lib_h_
186
187 #endif //NO_EXP_PYTHON_EMBEDDING
188