##// END OF EJS Templates
changed implementation to allow deriving python classes from PythonQt classes...
changed implementation to allow deriving python classes from PythonQt classes (it is still work in progress and is not very useful yet without having shell classes that reimplement the C++ virtual functions) git-svn-id: svn://svn.code.sf.net/p/pythonqt/code/trunk@58 ea8d5007-eb21-0410-b261-ccb3ea6e24a9

File last commit:

r22:29d38290403f
r22:29d38290403f
Show More
PythonQtInstanceWrapper.cpp
537 lines | 19.1 KiB | text/x-c | CppLexer
/ src / PythonQtInstanceWrapper.cpp
/*
*
* Copyright (C) 2006 MeVis Research GmbH All Rights Reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* Further, this software is distributed without any warranty that it is
* free of the rightful claim of any third person regarding infringement
* or the like. Any license provided herein, whether implied or
* otherwise, applies only to this software file. Patent licenses, if
* any, provided herein do not apply to combinations of this program with
* other software, or any other product whatsoever.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Contact information: MeVis Research GmbH, Universitaetsallee 29,
* 28359 Bremen, Germany or:
*
* http://www.mevis.de
*
*/
//----------------------------------------------------------------------------------
/*!
// \file PythonQtInstanceWrapper.cpp
// \author Florian Link
// \author Last changed by $Author: florian $
// \date 2006-05
*/
//----------------------------------------------------------------------------------
#include "PythonQtInstanceWrapper.h"
#include <QObject>
#include "PythonQt.h"
#include "PythonQtSlot.h"
#include "PythonQtClassInfo.h"
#include "PythonQtConversion.h"
#include "PythonQtClassWrapper.h"
PythonQtClassInfo* PythonQtInstanceWrapperStruct::classInfo()
{
// take the class info from our type object
return ((PythonQtClassWrapper*)ob_type)->_classInfo;
}
static void PythonQtInstanceWrapper_deleteObject(PythonQtInstanceWrapper* self, bool force = false) {
// is this a C++ wrapper?
if (self->_wrappedPtr) {
//mlabDebugConst("Python","c++ wrapper removed " << self->_wrappedPtr << " " << self->_obj->className() << " " << self->classInfo()->wrappedClassName().latin1());
PythonQt::priv()->removeWrapperPointer(self->_wrappedPtr);
// we own our qobject, so we delete it now:
delete self->_obj;
self->_obj = NULL;
if (force || self->classInfo()->hasOwnerMethodButNoOwner(self->_wrappedPtr) || self->_ownedByPythonQt) {
int type = self->classInfo()->metaTypeId();
if (self->_useQMetaTypeDestroy && type>=0) {
// use QMetaType to destroy the object
QMetaType::destroy(type, self->_wrappedPtr);
} else {
PythonQtSlotInfo* slot = PythonQt::priv()->getDestructorSlot(self->classInfo()->className());
if (slot) {
void* args[2];
args[0] = NULL;
args[1] = &self->_wrappedPtr;
slot->decorator()->qt_metacall(QMetaObject::InvokeMetaMethod, slot->slotIndex(), args);
self->_wrappedPtr = NULL;
} else {
if (type>=0) {
// use QMetaType to destroy the object
QMetaType::destroy(type, self->_wrappedPtr);
} else {
// TODO: warn about not being able to destroy the object?
}
}
}
}
} else {
//mlabDebugConst("Python","qobject wrapper removed " << self->_obj->className() << " " << self->classInfo()->wrappedClassName().latin1());
if (self->_objPointerCopy) {
PythonQt::priv()->removeWrapperPointer(self->_objPointerCopy);
}
if (self->_obj) {
if (force || self->_ownedByPythonQt) {
if (force || !self->_obj->parent()) {
delete self->_obj;
}
} else {
if (self->_obj->parent()==NULL) {
// tell someone who is interested that the qobject is no longer wrapped, if it has no parent
PythonQt::qObjectNoLongerWrappedCB(self->_obj);
}
}
}
}
self->_obj = NULL;
}
static void PythonQtInstanceWrapper_dealloc(PythonQtInstanceWrapper* self)
{
PythonQtInstanceWrapper_deleteObject(self);
self->_obj.~QPointer<QObject>();
self->ob_type->tp_free((PyObject*)self);
}
static PyObject* PythonQtInstanceWrapper_new(PyTypeObject *type, PyObject * args, PyObject * /*kwds*/)
{
PythonQtClassWrapper *classType = (PythonQtClassWrapper*)type;
PythonQtInstanceWrapper *self;
static PyObject* emptyTuple = NULL;
if (emptyTuple==NULL) {
emptyTuple = PyTuple_New(0);
}
self = (PythonQtInstanceWrapper*)PyBaseObject_Type.tp_new(type, emptyTuple, NULL);
if (self != NULL) {
new (&self->_obj) QPointer<QObject>();
self->_wrappedPtr = NULL;
self->_ownedByPythonQt = false;
self->_useQMetaTypeDestroy = false;
}
return (PyObject *)self;
}
int PythonQtInstanceWrapper_init(PythonQtInstanceWrapper * self, PyObject * args, PyObject * kwds)
{
PyObject* result = NULL;
if (args == PythonQtPrivate::dummyTuple()) {
// we are called from the internal PythonQt API, so our data will be filled later on...
return 0;
}
// we are called from python, try to construct our object
if (self->classInfo()->constructors()) {
void* directCPPPointer = NULL;
PythonQtSlotFunction_CallImpl(NULL, self->classInfo()->constructors(), args, kwds, NULL, &directCPPPointer);
if (PyErr_Occurred()) {
return -1;
}
if (directCPPPointer) {
// change ownershipflag to be owned by PythonQt
self->_ownedByPythonQt = true;
self->_useQMetaTypeDestroy = false;
if (self->classInfo()->isCPPWrapper()) {
self->_wrappedPtr = directCPPPointer;
// TODO xxx: if there is a wrapper factory, we might want to generate a wrapper for our class?!
} else {
self->setQObject((QObject*)directCPPPointer);
}
// register with PythonQt
PythonQt::priv()->addWrapperPointer(directCPPPointer, self);
}
} else {
QString error = QString("No constructors available for ") + self->classInfo()->className();
PyErr_SetString(PyExc_ValueError, error.toLatin1().data());
return -1;
}
return 0;
}
static PyObject *PythonQtInstanceWrapper_classname(PythonQtInstanceWrapper* type)
{
return PyString_FromString(type->classInfo()->className());
}
static PyObject *PythonQtInstanceWrapper_help(PythonQtInstanceWrapper* type)
{
return PythonQt::self()->helpCalled(type->classInfo());
}
static PyObject *PythonQtInstanceWrapper_delete(PythonQtInstanceWrapper * self)
{
PythonQtInstanceWrapper_deleteObject(self, true);
Py_INCREF(Py_None);
return Py_None;
}
static PyMethodDef PythonQtInstanceWrapper_methods[] = {
{"className", (PyCFunction)PythonQtInstanceWrapper_classname, METH_NOARGS,
"Return the classname of the object"
},
{"help", (PyCFunction)PythonQtInstanceWrapper_help, METH_NOARGS,
"Shows the help of available methods for this class"
},
{"delete", (PyCFunction)PythonQtInstanceWrapper_delete, METH_NOARGS,
"Deletes the C++ object (at your own risk, my friend!)"
},
{NULL, NULL, 0, NULL} /* Sentinel */
};
static PyObject *PythonQtInstanceWrapper_getattro(PyObject *obj,PyObject *name)
{
const char *attributeName;
PythonQtInstanceWrapper *wrapper = (PythonQtInstanceWrapper *)obj;
if ((attributeName = PyString_AsString(name)) == NULL) {
return NULL;
}
if (!wrapper->_obj && !wrapper->_wrappedPtr) {
QString error = QString("Trying to read attribute '") + attributeName + "' from a destroyed " + wrapper->classInfo()->className() + " object";
PyErr_SetString(PyExc_ValueError, error.toLatin1().data());
return NULL;
}
// mlabDebugConst("Python","get " << attributeName);
// TODO: dynamic properties are missing
PythonQtMemberInfo member = wrapper->classInfo()->member(attributeName);
switch (member._type) {
case PythonQtMemberInfo::Property:
if (wrapper->_obj) {
return PythonQtConv::QVariantToPyObject(member._property.read(wrapper->_obj));
}
break;
case PythonQtMemberInfo::Slot:
return PythonQtSlotFunction_New(member._slot, obj, NULL);
break;
case PythonQtMemberInfo::EnumValue:
return PyInt_FromLong(member._enumValue);
break;
default:
// is an invalid type, go on
break;
}
// look for the interal methods (className(), help())
PyObject* internalMethod = Py_FindMethod( PythonQtInstanceWrapper_methods, obj, (char*)attributeName);
if (internalMethod) {
return internalMethod;
}
PyErr_Clear();
if (qstrcmp(attributeName, "__dict__")==0) {
QStringList l = wrapper->classInfo()->memberList(false);
PyObject* dict = PyDict_New();
foreach (QString name, l) {
PyObject* o = PyObject_GetAttrString(obj, name.toLatin1().data());
PyDict_SetItemString(dict, name.toLatin1().data(), Py_None);
Py_DECREF(o);
}
// Note: we do not put children into the dict, is would look confusing?!
return dict;
}
// look in super
PyObject* superAttr = PyBaseObject_Type.tp_getattro(obj, name);
if (superAttr) {
return superAttr;
}
if (wrapper->_obj) {
// look for a child
QObjectList children = wrapper->_obj->children();
for (int i = 0; i < children.count(); i++) {
QObject *child = children.at(i);
if (child->objectName() == attributeName) {
return PythonQt::self()->priv()->wrapQObject(child);
}
}
}
QString error = QString(wrapper->classInfo()->className()) + " has no attribute named '" + QString(attributeName) + "'";
PyErr_SetString(PyExc_AttributeError, error.toLatin1().data());
return NULL;
}
static int PythonQtInstanceWrapper_setattro(PyObject *obj,PyObject *name,PyObject *value)
{
QString error;
char *attributeName;
PythonQtInstanceWrapper *wrapper = (PythonQtInstanceWrapper *)obj;
if ((attributeName = PyString_AsString(name)) == NULL)
return -1;
if (!wrapper->_obj) {
error = QString("Trying to set attribute '") + attributeName + "' on a destroyed " + wrapper->classInfo()->className() + " object";
PyErr_SetString(PyExc_AttributeError, error.toLatin1().data());
return -1;
}
PythonQtMemberInfo member = wrapper->classInfo()->member(attributeName);
if (member._type == PythonQtMemberInfo::Property) {
QMetaProperty prop = member._property;
if (prop.isWritable()) {
QVariant v;
if (prop.isEnumType()) {
// this will give us either a string or an int, everything else will probably be an error
v = PythonQtConv::PyObjToQVariant(value);
} else {
int t = prop.userType();
v = PythonQtConv::PyObjToQVariant(value, t);
}
bool success = false;
if (v.isValid()) {
success = prop.write(wrapper->_obj, v);
}
if (success) {
return 0;
} else {
error = QString("Property '") + attributeName + "' of type '" +
prop.typeName() + "' does not accept an object of type "
+ QString(value->ob_type->tp_name) + " (" + PythonQtConv::PyObjGetRepresentation(value) + ")";
}
} else {
error = QString("Property '") + attributeName + "' of " + wrapper->classInfo()->className() + " object is not writable";
}
} else {
if (member._type == PythonQtMemberInfo::Slot) {
error = QString("Slot '") + attributeName + "' can not be overwritten on " + wrapper->classInfo()->className() + " object";
} else if (member._type == PythonQtMemberInfo::EnumValue) {
error = QString("EnumValue '") + attributeName + "' can not be overwritten on " + wrapper->classInfo()->className() + " object";
}
}
PyErr_SetString(PyExc_AttributeError, error.toLatin1().data());
return -1;
}
static PyObject * PythonQtInstanceWrapper_str(PyObject * obj)
{
PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj;
const char* typeName = obj->ob_type->tp_name;
QObject *qobj = wrapper->_obj;
if (wrapper->_wrappedPtr) {
QString str = PythonQtConv::CPPObjectToString(wrapper->classInfo()->metaTypeId(), wrapper->_wrappedPtr);
if (!str.isEmpty()) {
return PyString_FromFormat("%s", str.toLatin1().constData());
} else
if (wrapper->_obj) {
return PyString_FromFormat("%s (C++ Object %p wrapped by %s %p))", typeName, wrapper->_wrappedPtr, wrapper->_obj->metaObject()->className(), qobj);
} else {
return PyString_FromFormat("%s (C++ Object %p)", typeName, wrapper->_wrappedPtr);
}
} else {
return PyString_FromFormat("%s (QObject %p)", typeName, qobj);
}
}
static PyObject * PythonQtInstanceWrapper_repr(PyObject * obj)
{
PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj;
const char* typeName = obj->ob_type->tp_name;
QObject *qobj = wrapper->_obj;
if (wrapper->_wrappedPtr) {
QString str = PythonQtConv::CPPObjectToString(wrapper->classInfo()->metaTypeId(), wrapper->_wrappedPtr);
if (!str.isEmpty()) {
return PyString_FromFormat("%s(%s, %p)", typeName, str.toLatin1().constData(), wrapper->_wrappedPtr);
} else
if (wrapper->_obj) {
return PyString_FromFormat("%s (C++ Object %p wrapped by %s %p))", typeName, wrapper->_wrappedPtr, wrapper->_obj->metaObject()->className(), qobj);
} else {
return PyString_FromFormat("%s (C++ Object %p)", typeName, wrapper->_wrappedPtr);
}
} else {
return PyString_FromFormat("%s (QObject %p)", wrapper->classInfo()->className(), qobj);
}
}
static int PythonQtInstanceWrapper_compare(PyObject * obj1, PyObject * obj2)
{
if (PyObject_TypeCheck(obj1, &PythonQtInstanceWrapper_Type) &&
PyObject_TypeCheck(obj2, &PythonQtInstanceWrapper_Type)) {
PythonQtInstanceWrapper* w1 = (PythonQtInstanceWrapper*)obj1;
PythonQtInstanceWrapper* w2 = (PythonQtInstanceWrapper*)obj2;
// check pointers directly first:
if (w1->_wrappedPtr != NULL) {
if (w1->_wrappedPtr == w2->_wrappedPtr) {
return 0;
}
} else if (w1->_obj == w2->_obj) {
return 0;
}
const char* class1 = w1->classInfo()->className();
const char* class2 = w2->classInfo()->className();
if (strcmp(class1, class2) == 0) {
// same class names, so we can try the operator_equal
PythonQtMemberInfo info = w1->classInfo()->member("operator_equal");
if (info._type == PythonQtMemberInfo::Slot) {
bool result = false;
void* obj1 = w1->_wrappedPtr;
if (!obj1) {
obj1 = w1->_obj;
}
if (!obj1) { return -1; }
void* obj2 = w2->_wrappedPtr;
if (!obj2) {
obj2 = w2->_obj;
}
if (!obj2) { return -1; }
if (info._slot->isInstanceDecorator()) {
// call on decorator QObject
void* args[3];
args[0] = &result;
args[1] = &obj1; // this is a pointer, so it needs a pointer to a pointer
args[2] = obj2; // this is a reference, so it needs the direct pointer
info._slot->decorator()->qt_metacall(QMetaObject::InvokeMetaMethod, info._slot->slotIndex(), args);
return result?0:-1;
} else {
// call directly on QObject
if (w1->_obj && w2->_obj) {
void* args[2];
args[0] = &result;
args[2] = obj2; // this is a reference, so it needs the direct pointer
w1->_obj->qt_metacall(QMetaObject::InvokeMetaMethod, info._slot->slotIndex(), args);
}
}
}
}
}
return -1;
}
static int PythonQtInstanceWrapper_nonzero(PyObject *obj)
{
PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj;
return (wrapper->_wrappedPtr == NULL && wrapper->_obj == NULL)?0:1;
}
static long PythonQtInstanceWrapper_hash(PythonQtInstanceWrapper *obj)
{
if (obj->_wrappedPtr != NULL) {
return reinterpret_cast<long>(obj->_wrappedPtr);
} else {
QObject* qobj = obj->_obj; // get pointer from QPointer wrapper
return reinterpret_cast<long>(qobj);
}
}
// we override nb_nonzero, so that one can do 'if' expressions to test for a NULL ptr
static PyNumberMethods PythonQtInstanceWrapper_as_number = {
0, /* nb_add */
0, /* nb_subtract */
0, /* nb_multiply */
0, /* nb_divide */
0, /* nb_remainder */
0, /* nb_divmod */
0, /* nb_power */
0, /* nb_negative */
0, /* nb_positive */
0, /* nb_absolute */
PythonQtInstanceWrapper_nonzero, /* nb_nonzero */
0, /* nb_invert */
0, /* nb_lshift */
0, /* nb_rshift */
0, /* nb_and */
0, /* nb_xor */
0, /* nb_or */
0, /* nb_coerce */
0, /* nb_int */
0, /* nb_long */
0, /* nb_float */
0, /* nb_oct */
0, /* nb_hex */
0, /* nb_inplace_add */
0, /* nb_inplace_subtract */
0, /* nb_inplace_multiply */
0, /* nb_inplace_divide */
0, /* nb_inplace_remainder */
0, /* nb_inplace_power */
0, /* nb_inplace_lshift */
0, /* nb_inplace_rshift */
0, /* nb_inplace_and */
0, /* nb_inplace_xor */
0, /* nb_inplace_or */
0, /* nb_floor_divide */
0, /* nb_true_divide */
0, /* nb_inplace_floor_divide */
0, /* nb_inplace_true_divide */
};
PyTypeObject PythonQtInstanceWrapper_Type = {
PyObject_HEAD_INIT(&PythonQtClassWrapper_Type)
0, /*ob_size*/
"PythonQt.PythonQtInstanceWrapper", /*tp_name*/
sizeof(PythonQtInstanceWrapper), /*tp_basicsize*/
0, /*tp_itemsize*/
(destructor)PythonQtInstanceWrapper_dealloc, /*tp_dealloc*/
0, /*tp_print*/
0, /*tp_getattr*/
0, /*tp_setattr*/
PythonQtInstanceWrapper_compare, /*tp_compare*/
PythonQtInstanceWrapper_repr, /*tp_repr*/
&PythonQtInstanceWrapper_as_number, /*tp_as_number*/
0, /*tp_as_sequence*/
0, /*tp_as_mapping*/
(hashfunc)PythonQtInstanceWrapper_hash, /*tp_hash */
0, /*tp_call*/
PythonQtInstanceWrapper_str, /*tp_str*/
PythonQtInstanceWrapper_getattro, /*tp_getattro*/
PythonQtInstanceWrapper_setattro, /*tp_setattro*/
0, /*tp_as_buffer*/
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/
"PythonQtInstanceWrapper object", /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
0, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
(initproc)PythonQtInstanceWrapper_init, /* tp_init */
0, /* tp_alloc */
PythonQtInstanceWrapper_new, /* tp_new */
};
//-------------------------------------------------------