2nd try to merge sim_physics with trunk rev 19825
[blender.git] / source / gameengine / GameLogic / SCA_PythonController.cpp
1 /**
2  * Execute Python scripts
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #include "SCA_PythonController.h"
33 #include "SCA_LogicManager.h"
34 #include "SCA_ISensor.h"
35 #include "SCA_IActuator.h"
36 #include "PyObjectPlus.h"
37 #include "compile.h"
38 #include "eval.h"
39 #include <algorithm>
40
41
42 #ifdef HAVE_CONFIG_H
43 #include <config.h>
44 #endif
45
46 // initialize static member variables
47 SCA_PythonController* SCA_PythonController::m_sCurrentController = NULL;
48
49
50 SCA_PythonController::SCA_PythonController(SCA_IObject* gameobj,
51                                                                                    PyTypeObject* T)
52         : SCA_IController(gameobj, T),
53         m_bytecode(NULL),
54         m_bModified(true),
55         m_pythondictionary(NULL)
56 {
57 }
58
59 /*
60 //debugging
61 CValue*         SCA_PythonController::AddRef()
62 {
63         //printf("AddRef refcount = %i\n",GetRefCount());
64         return CValue::AddRef();
65 }
66 int                     SCA_PythonController::Release()
67 {
68         //printf("Release refcount = %i\n",GetRefCount());
69         return CValue::Release();
70 }
71 */
72
73
74
75 SCA_PythonController::~SCA_PythonController()
76 {
77         if (m_bytecode)
78         {
79                 //
80                 //printf("released python byte script\n");
81                 Py_DECREF(m_bytecode);
82         }
83         
84         if (m_pythondictionary)
85         {
86                 // break any circular references in the dictionary
87                 PyDict_Clear(m_pythondictionary);
88                 Py_DECREF(m_pythondictionary);
89         }
90 }
91
92
93
94 CValue* SCA_PythonController::GetReplica()
95 {
96         SCA_PythonController* replica = new SCA_PythonController(*this);
97         // Copy the compiled bytecode if possible.
98         Py_XINCREF(replica->m_bytecode);
99         replica->m_bModified = replica->m_bytecode == NULL;
100         
101         // The replica->m_pythondictionary is stolen - replace with a copy.
102         if (m_pythondictionary)
103                 replica->m_pythondictionary = PyDict_Copy(m_pythondictionary);
104                 
105         /*
106         // The other option is to incref the replica->m_pythondictionary -
107         // the replica objects can then share data.
108         if (m_pythondictionary)
109                 Py_INCREF(replica->m_pythondictionary);
110         */
111         
112         // this will copy properties and so on...
113         CValue::AddDataToReplica(replica);
114
115         return replica;
116 }
117
118
119
120 void SCA_PythonController::SetScriptText(const STR_String& text)
121
122         m_scriptText = text;
123         m_bModified = true;
124 }
125
126
127
128 void SCA_PythonController::SetScriptName(const STR_String& name)
129 {
130         m_scriptName = name;
131 }
132
133
134
135 void SCA_PythonController::SetDictionary(PyObject*      pythondictionary)
136 {
137         if (m_pythondictionary)
138         {
139                 PyDict_Clear(m_pythondictionary);
140                 Py_DECREF(m_pythondictionary);
141         }
142         m_pythondictionary = PyDict_Copy(pythondictionary); /* new reference */
143 }
144
145 int SCA_PythonController::IsTriggered(class SCA_ISensor* sensor)
146 {
147         if (std::find(m_triggeredSensors.begin(), m_triggeredSensors.end(), sensor) != 
148                 m_triggeredSensors.end())
149                 return 1;
150         return 0;
151 }
152
153 #if 0
154 static const char* sPyGetCurrentController__doc__;
155 #endif
156
157 /* warning, self is not the SCA_PythonController, its a PyObjectPlus_Proxy */
158 PyObject* SCA_PythonController::sPyGetCurrentController(PyObject *self)
159 {
160         return m_sCurrentController->GetProxy();
161 }
162
163 SCA_IActuator* SCA_PythonController::LinkedActuatorFromPy(PyObject *value)
164 {
165         // for safety, todo: only allow for registered actuators (pointertable)
166         // we don't want to crash gameengine/blender by python scripts
167         std::vector<SCA_IActuator*> lacts =  m_sCurrentController->GetLinkedActuators();
168         std::vector<SCA_IActuator*>::iterator it;
169         
170         if (PyString_Check(value)) {
171                 /* get the actuator from the name */
172                 char *name= PyString_AsString(value);
173                 for(it = lacts.begin(); it!= lacts.end(); it++) {
174                         if( name == (*it)->GetName() ) {
175                                 return *it;
176                         }
177                 }
178         }
179         else if (BGE_PROXY_CHECK_TYPE(value)) {
180                 PyObjectPlus *value_plus= BGE_PROXY_REF(value); /* Expecting an actuator type */ // XXX TODO - CHECK TYPE
181                 for(it = lacts.begin(); it!= lacts.end(); it++) {
182                         if( static_cast<SCA_IActuator*>(value_plus) == (*it) ) {
183                                 return *it;
184                         }
185                 }
186         }
187         
188         /* set the exception */
189         PyObject *value_str = PyObject_Repr(value); /* new ref */
190         PyErr_Format(PyExc_ValueError, "'%s' not in this controllers actuator list", PyString_AsString(value_str));
191         Py_DECREF(value_str);
192         
193         return false;
194 }
195
196 #if 0
197 static const char* sPyAddActiveActuator__doc__;
198 #endif
199
200 /* warning, self is not the SCA_PythonController, its a PyObjectPlus_Proxy */
201 PyObject* SCA_PythonController::sPyAddActiveActuator(PyObject* self, PyObject* args)
202 {
203         PyObject* ob1;
204         int activate;
205         if (!PyArg_ParseTuple(args, "Oi:addActiveActuator", &ob1,&activate))
206                 return NULL;
207         
208         SCA_IActuator* actu = LinkedActuatorFromPy(ob1);
209         if(actu==NULL)
210                 return NULL;
211         
212         CValue* boolval = new CBoolValue(activate!=0);
213         m_sCurrentLogicManager->AddActiveActuator((SCA_IActuator*)actu,boolval);
214         boolval->Release();
215         Py_RETURN_NONE;
216 }
217
218
219 const char* SCA_PythonController::sPyGetCurrentController__doc__ = "getCurrentController()";
220 const char* SCA_PythonController::sPyAddActiveActuator__doc__= "addActiveActuator(actuator,bool)";
221 const char SCA_PythonController::GetActuators_doc[] = "getActuator";
222
223 PyTypeObject SCA_PythonController::Type = {
224         PyObject_HEAD_INIT(NULL)
225                 0,
226                 "SCA_PythonController",
227                 sizeof(PyObjectPlus_Proxy),
228                 0,
229                 py_base_dealloc,
230                 0,
231                 0,
232                 0,
233                 0,
234                 py_base_repr,
235                 0,0,0,0,0,0,
236                 py_base_getattro,
237                 py_base_setattro,
238                 0,0,0,0,0,0,0,0,0,
239                 Methods
240 };
241
242 PyParentObject SCA_PythonController::Parents[] = {
243         &SCA_PythonController::Type,
244         &SCA_IController::Type,
245         &CValue::Type,
246         NULL
247 };
248 PyMethodDef SCA_PythonController::Methods[] = {
249         {"activate", (PyCFunction) SCA_PythonController::sPyActivate, METH_O},
250         {"deactivate", (PyCFunction) SCA_PythonController::sPyDeActivate, METH_O},
251         
252         {"getActuators", (PyCFunction) SCA_PythonController::sPyGetActuators, METH_NOARGS, (PY_METHODCHAR)SCA_PythonController::GetActuators_doc},
253         {"getActuator", (PyCFunction) SCA_PythonController::sPyGetActuator, METH_O, (PY_METHODCHAR)SCA_PythonController::GetActuator_doc},
254         {"getSensors", (PyCFunction) SCA_PythonController::sPyGetSensors, METH_NOARGS, (PY_METHODCHAR)SCA_PythonController::GetSensors_doc},
255         {"getSensor", (PyCFunction) SCA_PythonController::sPyGetSensor, METH_O, (PY_METHODCHAR)SCA_PythonController::GetSensor_doc},
256         //Deprecated functions ------>
257         {"setScript", (PyCFunction) SCA_PythonController::sPySetScript, METH_O},
258         {"getScript", (PyCFunction) SCA_PythonController::sPyGetScript, METH_NOARGS},
259         {"getState", (PyCFunction) SCA_PythonController::sPyGetState, METH_NOARGS},
260         //<----- Deprecated
261         {NULL,NULL} //Sentinel
262 };
263
264 PyAttributeDef SCA_PythonController::Attributes[] = {
265         KX_PYATTRIBUTE_RO_FUNCTION("state", SCA_PythonController, pyattr_get_state),
266         KX_PYATTRIBUTE_RW_FUNCTION("script", SCA_PythonController, pyattr_get_script, pyattr_set_script),
267         { NULL }        //Sentinel
268 };
269
270 bool SCA_PythonController::Compile()
271 {
272         //printf("py script modified '%s'\n", m_scriptName.Ptr());
273         
274         // if a script already exists, decref it before replace the pointer to a new script
275         if (m_bytecode)
276         {
277                 Py_DECREF(m_bytecode);
278                 m_bytecode=NULL;
279         }
280         // recompile the scripttext into bytecode
281         m_bytecode = Py_CompileString(m_scriptText.Ptr(), m_scriptName.Ptr(), Py_file_input);
282         m_bModified=false;
283         
284         if (m_bytecode)
285         {
286                 
287                 return true;
288         }
289         else {
290                 // didn't compile, so instead of compile, complain
291                 // something is wrong, tell the user what went wrong
292                 printf("Python compile error from controller \"%s\": \n", GetName().Ptr());
293                 //PyRun_SimpleString(m_scriptText.Ptr());
294                 PyErr_Print();
295                 
296                 /* Added in 2.48a, the last_traceback can reference Objects for example, increasing
297                  * their user count. Not to mention holding references to wrapped data.
298                  * This is especially bad when the PyObject for the wrapped data is free'd, after blender 
299                  * has alredy dealocated the pointer */
300                 PySys_SetObject( (char *)"last_traceback", NULL);
301                 PyErr_Clear(); /* just to be sure */
302                 
303                 return false;
304         }
305 }
306
307 void SCA_PythonController::Trigger(SCA_LogicManager* logicmgr)
308 {
309         m_sCurrentController = this;
310         m_sCurrentLogicManager = logicmgr;
311         
312         if (m_bModified)
313         {
314                 if (Compile()==false) // sets m_bModified to false
315                         return;
316         }
317         if (!m_bytecode) {
318                 return;
319         }
320                 
321         
322                 /*
323                  * This part here with excdict is a temporary patch
324                  * to avoid python/gameengine crashes when python
325                  * inadvertently holds references to game objects
326                  * in global variables.
327                  * 
328                  * The idea is always make a fresh dictionary, and
329                  * destroy it right after it is used to make sure
330                  * python won't hold any gameobject references.
331                  * 
332                  * Note that the PyDict_Clear _is_ necessary before
333                  * the Py_DECREF() because it is possible for the
334                  * variables inside the dictionary to hold references
335                  * to the dictionary (ie. generate a cycle), so we
336                  * break it by hand, then DECREF (which in this case
337                  * should always ensure excdict is cleared).
338                  */
339
340         PyObject *excdict= PyDict_Copy(m_pythondictionary);
341         PyObject* resultobj = PyEval_EvalCode((PyCodeObject*)m_bytecode,
342                 excdict, excdict);
343
344         if (resultobj)
345         {
346                 Py_DECREF(resultobj);
347         }
348         else
349         {
350                 // something is wrong, tell the user what went wrong
351                 printf("Python script error from controller \"%s\": \n", GetName().Ptr());
352                 PyErr_Print();
353                 
354                 /* Added in 2.48a, the last_traceback can reference Objects for example, increasing
355                  * their user count. Not to mention holding references to wrapped data.
356                  * This is especially bad when the PyObject for the wrapped data is free'd, after blender 
357                  * has alredy dealocated the pointer */
358                 PySys_SetObject( (char *)"last_traceback", NULL);
359                 PyErr_Clear(); /* just to be sure */
360                 
361                 //PyRun_SimpleString(m_scriptText.Ptr());
362         }
363
364         // clear after PyErrPrint - seems it can be using
365         // something in this dictionary and crash?
366         PyDict_Clear(excdict);
367         Py_DECREF(excdict);
368         m_triggeredSensors.erase(m_triggeredSensors.begin(), m_triggeredSensors.end());
369         m_sCurrentController = NULL;
370 }
371
372
373
374 PyObject* SCA_PythonController::py_getattro(PyObject *attr)
375 {
376         py_getattro_up(SCA_IController);
377 }
378
379 int SCA_PythonController::py_setattro(PyObject *attr, PyObject *value)
380 {
381         py_setattro_up(SCA_IController);
382 }
383
384 PyObject* SCA_PythonController::PyActivate(PyObject *value)
385 {
386         SCA_IActuator* actu = LinkedActuatorFromPy(value);
387         if(actu==NULL)
388                 return NULL;
389         
390         CValue* boolval = new CBoolValue(true);
391         m_sCurrentLogicManager->AddActiveActuator((SCA_IActuator*)actu, boolval);
392         boolval->Release();
393         Py_RETURN_NONE;
394 }
395
396 PyObject* SCA_PythonController::PyDeActivate(PyObject *value)
397 {
398         SCA_IActuator* actu = LinkedActuatorFromPy(value);
399         if(actu==NULL)
400                 return NULL;
401         
402         CValue* boolval = new CBoolValue(false);
403         m_sCurrentLogicManager->AddActiveActuator((SCA_IActuator*)actu, boolval);
404         boolval->Release();
405         Py_RETURN_NONE;
406 }
407
408 PyObject* SCA_PythonController::PyGetActuators()
409 {
410         PyObject* resultlist = PyList_New(m_linkedactuators.size());
411         for (unsigned int index=0;index<m_linkedactuators.size();index++)
412         {
413                 PyList_SET_ITEM(resultlist,index, m_linkedactuators[index]->GetProxy());
414         }
415
416         return resultlist;
417 }
418
419 const char SCA_PythonController::GetSensor_doc[] = 
420 "GetSensor (char sensorname) return linked sensor that is named [sensorname]\n";
421 PyObject*
422 SCA_PythonController::PyGetSensor(PyObject* value)
423 {
424
425         char *scriptArg = PyString_AsString(value);
426         if (scriptArg==NULL) {
427                 PyErr_SetString(PyExc_TypeError, "expected a string (sensor name)");
428                 return NULL;
429         }
430         
431         for (unsigned int index=0;index<m_linkedsensors.size();index++)
432         {
433                 SCA_ISensor* sensor = m_linkedsensors[index];
434                 STR_String realname = sensor->GetName();
435                 if (realname == scriptArg)
436                 {
437                         return sensor->GetProxy();
438                 }
439         }
440         
441         PyErr_Format(PyExc_AttributeError, "Unable to find requested sensor \"%s\"", scriptArg);
442         return NULL;
443 }
444
445
446
447 const char SCA_PythonController::GetActuator_doc[] = 
448 "GetActuator (char sensorname) return linked actuator that is named [actuatorname]\n";
449 PyObject*
450 SCA_PythonController::PyGetActuator(PyObject* value)
451 {
452
453         char *scriptArg = PyString_AsString(value);
454         if (scriptArg==NULL) {
455                 PyErr_SetString(PyExc_TypeError, "expected a string (actuator name)");
456                 return NULL;
457         }
458         
459         for (unsigned int index=0;index<m_linkedactuators.size();index++)
460         {
461                 SCA_IActuator* actua = m_linkedactuators[index];
462                 if (actua->GetName() == scriptArg)
463                 {
464                         return actua->GetProxy();
465                 }
466         }
467         
468         PyErr_Format(PyExc_AttributeError, "Unable to find requested actuator \"%s\"", scriptArg);
469         return NULL;
470 }
471
472
473 const char SCA_PythonController::GetSensors_doc[]   = "getSensors returns a list of all attached sensors";
474 PyObject*
475 SCA_PythonController::PyGetSensors()
476 {
477         PyObject* resultlist = PyList_New(m_linkedsensors.size());
478         for (unsigned int index=0;index<m_linkedsensors.size();index++)
479         {
480                 PyList_SET_ITEM(resultlist,index, m_linkedsensors[index]->GetProxy());
481         }
482         
483         return resultlist;
484 }
485
486 /* 1. getScript */
487 PyObject* SCA_PythonController::PyGetScript()
488 {
489         ShowDeprecationWarning("getScript()", "the script property");
490         return PyString_FromString(m_scriptText);
491 }
492
493 /* 2. setScript */
494 PyObject* SCA_PythonController::PySetScript(PyObject* value)
495 {
496         char *scriptArg = PyString_AsString(value);
497         
498         ShowDeprecationWarning("setScript()", "the script property");
499         
500         if (scriptArg==NULL) {
501                 PyErr_SetString(PyExc_TypeError, "expected a string (script name)");
502                 return NULL;
503         }
504         
505         /* set scripttext sets m_bModified to true, 
506                 so next time the script is needed, a reparse into byte code is done */
507
508         this->SetScriptText(scriptArg);
509         
510         Py_RETURN_NONE;
511 }
512
513 /* 1. getScript */
514 PyObject* SCA_PythonController::PyGetState()
515 {
516         ShowDeprecationWarning("getState()", "the state property");
517         return PyInt_FromLong(m_statemask);
518 }
519
520 PyObject* SCA_PythonController::pyattr_get_state(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
521 {
522         SCA_PythonController* self= static_cast<SCA_PythonController*>(self_v);
523         return PyInt_FromLong(self->m_statemask);
524 }
525
526 PyObject* SCA_PythonController::pyattr_get_script(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
527 {
528         SCA_PythonController* self= static_cast<SCA_PythonController*>(self_v);
529         return PyString_FromString(self->m_scriptText);
530 }
531
532 int SCA_PythonController::pyattr_set_script(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
533 {
534         SCA_PythonController* self= static_cast<SCA_PythonController*>(self_v);
535         
536         char *scriptArg = PyString_AsString(value);
537         
538         if (scriptArg==NULL) {
539                 PyErr_SetString(PyExc_TypeError, "expected a string (script name)");
540                 return -1;
541         }
542
543         /* set scripttext sets m_bModified to true, 
544                 so next time the script is needed, a reparse into byte code is done */
545         self->SetScriptText(scriptArg);
546                 
547         return 0;
548 }
549
550
551 /* eof */