2002-10-12 11:37:38 +00:00
|
|
|
/**
|
|
|
|
* Execute Python scripts
|
|
|
|
*
|
|
|
|
* $Id$
|
|
|
|
*
|
|
|
|
* ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version. The Blender
|
|
|
|
* Foundation also sells licenses for use in proprietary software under
|
|
|
|
* the Blender License. See http://www.blender.org/BL/ for information
|
|
|
|
* about this.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
|
|
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
|
|
*
|
|
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* The Original Code is: all of this file.
|
|
|
|
*
|
|
|
|
* Contributor(s): none yet.
|
|
|
|
*
|
|
|
|
* ***** END GPL/BL DUAL LICENSE BLOCK *****
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "SCA_PythonController.h"
|
|
|
|
#include "SCA_LogicManager.h"
|
|
|
|
#include "SCA_ISensor.h"
|
|
|
|
#include "SCA_IActuator.h"
|
|
|
|
#include "compile.h"
|
|
|
|
#include "eval.h"
|
|
|
|
|
2002-11-25 15:29:57 +00:00
|
|
|
#ifdef HAVE_CONFIG_H
|
|
|
|
#include <config.h>
|
|
|
|
#endif
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
// initialize static member variables
|
|
|
|
SCA_PythonController* SCA_PythonController::m_sCurrentController = NULL;
|
|
|
|
|
|
|
|
|
|
|
|
SCA_PythonController::SCA_PythonController(SCA_IObject* gameobj,
|
|
|
|
PyTypeObject* T)
|
|
|
|
: SCA_IController(gameobj, T),
|
|
|
|
m_bytecode(NULL),
|
2004-03-22 22:02:18 +00:00
|
|
|
m_bModified(true),
|
|
|
|
m_pythondictionary(NULL)
|
2002-10-12 11:37:38 +00:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2006-05-14 03:39:07 +00:00
|
|
|
/*
|
|
|
|
//debugging
|
|
|
|
CValue* SCA_PythonController::AddRef()
|
|
|
|
{
|
|
|
|
//printf("AddRef refcount = %i\n",GetRefCount());
|
|
|
|
return CValue::AddRef();
|
|
|
|
}
|
|
|
|
int SCA_PythonController::Release()
|
|
|
|
{
|
|
|
|
//printf("Release refcount = %i\n",GetRefCount());
|
|
|
|
return CValue::Release();
|
|
|
|
}
|
|
|
|
*/
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
SCA_PythonController::~SCA_PythonController()
|
|
|
|
{
|
|
|
|
if (m_bytecode)
|
|
|
|
{
|
|
|
|
//
|
|
|
|
//printf("released python byte script\n");
|
|
|
|
Py_DECREF(m_bytecode);
|
|
|
|
}
|
2005-01-23 01:38:41 +00:00
|
|
|
|
|
|
|
if (m_pythondictionary)
|
|
|
|
{
|
|
|
|
// break any circular references in the dictionary
|
|
|
|
PyDict_Clear(m_pythondictionary);
|
|
|
|
Py_DECREF(m_pythondictionary);
|
|
|
|
}
|
2002-10-12 11:37:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CValue* SCA_PythonController::GetReplica()
|
|
|
|
{
|
|
|
|
SCA_PythonController* replica = new SCA_PythonController(*this);
|
2005-01-23 01:38:41 +00:00
|
|
|
// Copy the compiled bytecode if possible.
|
|
|
|
Py_XINCREF(replica->m_bytecode);
|
|
|
|
replica->m_bModified = replica->m_bytecode == NULL;
|
|
|
|
|
|
|
|
// The replica->m_pythondictionary is stolen - replace with a copy.
|
|
|
|
if (m_pythondictionary)
|
|
|
|
replica->m_pythondictionary = PyDict_Copy(m_pythondictionary);
|
|
|
|
|
|
|
|
/*
|
|
|
|
// The other option is to incref the replica->m_pythondictionary -
|
|
|
|
// the replica objects can then share data.
|
|
|
|
if (m_pythondictionary)
|
|
|
|
Py_INCREF(replica->m_pythondictionary);
|
|
|
|
*/
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
// this will copy properties and so on...
|
|
|
|
CValue::AddDataToReplica(replica);
|
|
|
|
|
|
|
|
return replica;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void SCA_PythonController::SetScriptText(const STR_String& text)
|
|
|
|
{
|
2005-01-23 01:38:41 +00:00
|
|
|
m_scriptText = "import GameLogic\n" + text;
|
2002-10-12 11:37:38 +00:00
|
|
|
m_bModified = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void SCA_PythonController::SetScriptName(const STR_String& name)
|
|
|
|
{
|
|
|
|
m_scriptName = name;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void SCA_PythonController::SetDictionary(PyObject* pythondictionary)
|
|
|
|
{
|
2005-01-23 01:38:41 +00:00
|
|
|
if (m_pythondictionary)
|
|
|
|
{
|
|
|
|
PyDict_Clear(m_pythondictionary);
|
|
|
|
Py_DECREF(m_pythondictionary);
|
|
|
|
}
|
|
|
|
m_pythondictionary = PyDict_Copy(pythondictionary); /* new reference */
|
2002-10-12 11:37:38 +00:00
|
|
|
}
|
|
|
|
|
2005-03-14 20:10:22 +00:00
|
|
|
#if 0
|
2002-10-12 11:37:38 +00:00
|
|
|
static char* sPyGetCurrentController__doc__;
|
2005-03-14 20:10:22 +00:00
|
|
|
#endif
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
PyObject* SCA_PythonController::sPyGetCurrentController(PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
m_sCurrentController->AddRef();
|
|
|
|
return m_sCurrentController;
|
|
|
|
}
|
|
|
|
|
2005-03-14 20:10:22 +00:00
|
|
|
#if 0
|
2002-10-12 11:37:38 +00:00
|
|
|
static char* sPyAddActiveActuator__doc__;
|
2005-03-14 20:10:22 +00:00
|
|
|
#endif
|
2006-01-06 03:46:54 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
PyObject* SCA_PythonController::sPyAddActiveActuator(
|
|
|
|
|
|
|
|
PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
|
|
|
|
PyObject* ob1;
|
|
|
|
int activate;
|
|
|
|
if (!PyArg_ParseTuple(args, "Oi", &ob1,&activate))
|
|
|
|
return NULL;
|
2006-01-06 03:46:54 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
// for safety, todo: only allow for registered actuators (pointertable)
|
|
|
|
// we don't want to crash gameengine/blender by python scripts
|
2006-01-06 03:46:54 +00:00
|
|
|
std::vector<SCA_IActuator*> lacts = m_sCurrentController->GetLinkedActuators();
|
2002-10-12 11:37:38 +00:00
|
|
|
|
2006-01-06 03:46:54 +00:00
|
|
|
std::vector<SCA_IActuator*>::iterator it;
|
|
|
|
bool found = false;
|
|
|
|
CValue* act = (CValue*)ob1;
|
|
|
|
|
|
|
|
for(it = lacts.begin(); it!= lacts.end(); it++) {
|
|
|
|
if( static_cast<SCA_IActuator*>(act) == (*it) ) {
|
|
|
|
found=true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if(found){
|
|
|
|
CValue* boolval = new CBoolValue(activate!=0);
|
|
|
|
m_sCurrentLogicManager->AddActiveActuator((SCA_IActuator*)act,boolval);
|
|
|
|
boolval->Release();
|
|
|
|
}
|
2002-10-12 11:37:38 +00:00
|
|
|
Py_INCREF(Py_None);
|
|
|
|
return Py_None;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
char* SCA_PythonController::sPyGetCurrentController__doc__ = "getCurrentController()";
|
|
|
|
char* SCA_PythonController::sPyAddActiveActuator__doc__= "addActiveActuator(actuator,bool)";
|
|
|
|
char SCA_PythonController::GetActuators_doc[] = "getActuator";
|
|
|
|
|
|
|
|
PyTypeObject SCA_PythonController::Type = {
|
|
|
|
PyObject_HEAD_INIT(&PyType_Type)
|
|
|
|
0,
|
|
|
|
"SCA_PythonController",
|
|
|
|
sizeof(SCA_PythonController),
|
|
|
|
0,
|
|
|
|
PyDestructor,
|
|
|
|
0,
|
|
|
|
__getattr,
|
|
|
|
__setattr,
|
|
|
|
0, //&MyPyCompare,
|
|
|
|
__repr,
|
|
|
|
0, //&cvalue_as_number,
|
|
|
|
0,
|
|
|
|
0,
|
|
|
|
0,
|
|
|
|
0
|
|
|
|
};
|
|
|
|
|
|
|
|
PyParentObject SCA_PythonController::Parents[] = {
|
|
|
|
&SCA_PythonController::Type,
|
|
|
|
&SCA_IController::Type,
|
|
|
|
&CValue::Type,
|
|
|
|
NULL
|
|
|
|
};
|
|
|
|
PyMethodDef SCA_PythonController::Methods[] = {
|
|
|
|
{"getActuators", (PyCFunction) SCA_PythonController::sPyGetActuators,
|
|
|
|
METH_VARARGS, SCA_PythonController::GetActuators_doc},
|
|
|
|
{"getActuator", (PyCFunction) SCA_PythonController::sPyGetActuator,
|
|
|
|
METH_VARARGS, SCA_PythonController::GetActuator_doc},
|
|
|
|
{"getSensors", (PyCFunction) SCA_PythonController::sPyGetSensors,
|
|
|
|
METH_VARARGS, SCA_PythonController::GetSensors_doc},
|
|
|
|
{"getSensor", (PyCFunction) SCA_PythonController::sPyGetSensor,
|
2004-05-26 12:09:17 +00:00
|
|
|
METH_VARARGS, SCA_PythonController::GetSensor_doc},
|
|
|
|
{"getScript", (PyCFunction) SCA_PythonController::sPyGetScript, METH_VARARGS},
|
|
|
|
{"setScript", (PyCFunction) SCA_PythonController::sPySetScript, METH_VARARGS},
|
2002-10-12 11:37:38 +00:00
|
|
|
{NULL,NULL} //Sentinel
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
void SCA_PythonController::Trigger(SCA_LogicManager* logicmgr)
|
|
|
|
{
|
|
|
|
m_sCurrentController = this;
|
|
|
|
m_sCurrentLogicManager = logicmgr;
|
|
|
|
|
|
|
|
if (m_bModified)
|
|
|
|
{
|
|
|
|
// if a script already exists, decref it before replace the pointer to a new script
|
|
|
|
if (m_bytecode)
|
|
|
|
{
|
|
|
|
Py_DECREF(m_bytecode);
|
|
|
|
m_bytecode=NULL;
|
|
|
|
}
|
|
|
|
// recompile the scripttext into bytecode
|
|
|
|
m_bytecode = Py_CompileString(m_scriptText.Ptr(), m_scriptName.Ptr(), Py_file_input);
|
2005-01-23 01:38:41 +00:00
|
|
|
if (!m_bytecode)
|
2002-10-12 11:37:38 +00:00
|
|
|
{
|
|
|
|
// didn't compile, so instead of compile, complain
|
2004-06-04 02:10:58 +00:00
|
|
|
// something is wrong, tell the user what went wrong
|
|
|
|
printf("PYTHON SCRIPT ERROR:\n");
|
2005-01-23 01:38:41 +00:00
|
|
|
//PyRun_SimpleString(m_scriptText.Ptr());
|
|
|
|
PyErr_Print();
|
2004-06-04 02:10:58 +00:00
|
|
|
return;
|
2002-10-12 11:37:38 +00:00
|
|
|
}
|
|
|
|
m_bModified=false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This part here with excdict is a temporary patch
|
|
|
|
* to avoid python/gameengine crashes when python
|
|
|
|
* inadvertently holds references to game objects
|
|
|
|
* in global variables.
|
|
|
|
*
|
|
|
|
* The idea is always make a fresh dictionary, and
|
|
|
|
* destroy it right after it is used to make sure
|
|
|
|
* python won't hold any gameobject references.
|
|
|
|
*
|
|
|
|
* Note that the PyDict_Clear _is_ necessary before
|
|
|
|
* the Py_DECREF() because it is possible for the
|
|
|
|
* variables inside the dictionary to hold references
|
|
|
|
* to the dictionary (ie. generate a cycle), so we
|
|
|
|
* break it by hand, then DECREF (which in this case
|
|
|
|
* should always ensure excdict is cleared).
|
|
|
|
*/
|
2005-01-23 01:38:41 +00:00
|
|
|
/* PyObject *excdict= myPyDict_Copy(m_pythondictionary);
|
2002-10-12 11:37:38 +00:00
|
|
|
struct _object* resultobj = PyEval_EvalCode((PyCodeObject*)m_bytecode,
|
|
|
|
excdict,
|
|
|
|
excdict
|
|
|
|
);
|
|
|
|
PyDict_Clear(excdict);
|
2005-01-23 01:38:41 +00:00
|
|
|
Py_DECREF(excdict);*/
|
2006-01-06 03:46:54 +00:00
|
|
|
|
2006-02-13 05:45:32 +00:00
|
|
|
|
2006-05-14 03:39:07 +00:00
|
|
|
#if 1
|
2006-01-06 03:46:54 +00:00
|
|
|
PyObject *excdict= PyDict_Copy(m_pythondictionary);
|
|
|
|
PyObject* resultobj = PyEval_EvalCode((PyCodeObject*)m_bytecode,
|
|
|
|
excdict,
|
|
|
|
excdict
|
|
|
|
);
|
|
|
|
PyDict_Clear(excdict);
|
|
|
|
Py_DECREF(excdict);
|
2006-05-13 23:31:36 +00:00
|
|
|
#else
|
2006-01-06 03:46:54 +00:00
|
|
|
|
2005-01-23 01:38:41 +00:00
|
|
|
PyObject* resultobj = PyEval_EvalCode((PyCodeObject*)m_bytecode,
|
|
|
|
m_pythondictionary,
|
|
|
|
m_pythondictionary
|
|
|
|
);
|
2006-05-13 23:31:36 +00:00
|
|
|
|
2006-01-06 03:46:54 +00:00
|
|
|
#endif
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
if (resultobj)
|
|
|
|
{
|
|
|
|
Py_DECREF(resultobj);
|
|
|
|
} else
|
|
|
|
{
|
|
|
|
// something is wrong, tell the user what went wrong
|
|
|
|
printf("PYTHON SCRIPT ERROR:\n");
|
2005-01-23 01:38:41 +00:00
|
|
|
PyErr_Print();
|
|
|
|
//PyRun_SimpleString(m_scriptText.Ptr());
|
2002-10-12 11:37:38 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
m_sCurrentController = NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
2004-05-16 13:05:15 +00:00
|
|
|
PyObject* SCA_PythonController::_getattr(const STR_String& attr)
|
2002-10-12 11:37:38 +00:00
|
|
|
{
|
|
|
|
_getattr_up(SCA_IController);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
PyObject* SCA_PythonController::PyGetActuators(PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
PyObject* resultlist = PyList_New(m_linkedactuators.size());
|
2004-03-22 22:02:18 +00:00
|
|
|
for (unsigned int index=0;index<m_linkedactuators.size();index++)
|
2002-10-12 11:37:38 +00:00
|
|
|
{
|
|
|
|
PyList_SetItem(resultlist,index,m_linkedactuators[index]->AddRef());
|
|
|
|
}
|
|
|
|
|
|
|
|
return resultlist;
|
|
|
|
}
|
|
|
|
|
|
|
|
char SCA_PythonController::GetSensor_doc[] =
|
|
|
|
"GetSensor (char sensorname) return linked sensor that is named [sensorname]\n";
|
|
|
|
PyObject*
|
|
|
|
SCA_PythonController::PyGetSensor(PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
|
|
|
|
char *scriptArg;
|
|
|
|
|
|
|
|
if (!PyArg_ParseTuple(args, "s", &scriptArg)) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2004-03-22 22:02:18 +00:00
|
|
|
for (unsigned int index=0;index<m_linkedsensors.size();index++)
|
2002-10-12 11:37:38 +00:00
|
|
|
{
|
|
|
|
SCA_ISensor* sensor = m_linkedsensors[index];
|
|
|
|
STR_String realname = sensor->GetName();
|
|
|
|
if (realname == scriptArg)
|
|
|
|
{
|
|
|
|
return sensor->AddRef();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
PyErr_SetString(PyExc_AttributeError, "Unable to find requested sensor");
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
char SCA_PythonController::GetActuator_doc[] =
|
|
|
|
"GetActuator (char sensorname) return linked actuator that is named [actuatorname]\n";
|
|
|
|
PyObject*
|
|
|
|
SCA_PythonController::PyGetActuator(PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
|
|
|
|
char *scriptArg;
|
|
|
|
|
|
|
|
if (!PyArg_ParseTuple(args, "s", &scriptArg)) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2004-03-22 22:02:18 +00:00
|
|
|
for (unsigned int index=0;index<m_linkedactuators.size();index++)
|
2002-10-12 11:37:38 +00:00
|
|
|
{
|
|
|
|
SCA_IActuator* actua = m_linkedactuators[index];
|
|
|
|
STR_String realname = actua->GetName();
|
|
|
|
if (realname == scriptArg)
|
|
|
|
{
|
|
|
|
return actua->AddRef();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
PyErr_SetString(PyExc_AttributeError, "Unable to find requested actuator");
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
char SCA_PythonController::GetSensors_doc[] = "getSensors returns a list of all attached sensors";
|
|
|
|
PyObject*
|
|
|
|
SCA_PythonController::PyGetSensors(PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
PyObject* resultlist = PyList_New(m_linkedsensors.size());
|
2004-03-22 22:02:18 +00:00
|
|
|
for (unsigned int index=0;index<m_linkedsensors.size();index++)
|
2002-10-12 11:37:38 +00:00
|
|
|
{
|
|
|
|
PyList_SetItem(resultlist,index,m_linkedsensors[index]->AddRef());
|
|
|
|
}
|
|
|
|
|
|
|
|
return resultlist;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* 1. getScript */
|
|
|
|
PyObject* SCA_PythonController::PyGetScript(PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
return PyString_FromString(m_scriptText);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* 2. setScript */
|
|
|
|
PyObject* SCA_PythonController::PySetScript(PyObject* self,
|
|
|
|
PyObject* args,
|
|
|
|
PyObject* kwds)
|
|
|
|
{
|
|
|
|
char *scriptArg;
|
|
|
|
if (!PyArg_ParseTuple(args, "s", &scriptArg)) {
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* set scripttext sets m_bModified to true,
|
|
|
|
so next time the script is needed, a reparse into byte code is done */
|
|
|
|
|
|
|
|
this->SetScriptText(scriptArg);
|
|
|
|
|
|
|
|
Py_Return;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* eof */
|