PythonQtObjectPtr.h

Go to the documentation of this file.

#ifndef _PYTHONQTOBJECTPTR_H
#define _PYTHONQTOBJECTPTR_H
 
/*
 *
 *  Copyright (C) 2010 MeVis Medical Solutions AG 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 Medical Solutions AG, Universitaetsallee 29,
 *  28359 Bremen, Germany or:
 *
 *  http://www.mevis.de
 *
 */
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
 
#include "PythonQtPythonInclude.h"
 
#include "PythonQtSystem.h"
#include "PythonQtThreadSupport.h"
#include <QVariant>
#include <QVariantList>
#include <QVariantMap>
 
class PythonQtSafeObjectPtr;
 
class PYTHONQT_EXPORT PythonQtObjectPtr
{
public:
  PythonQtObjectPtr()
    : _object(nullptr)
  {
  }
 
  PythonQtObjectPtr(const PythonQtObjectPtr& p)
    : _object(nullptr)
  {
    setObject(p.object());
  }
 
  PythonQtObjectPtr(PythonQtObjectPtr&& p) noexcept
    : _object(p.takeObject())
  {
  }
 
  PythonQtObjectPtr(PythonQtSafeObjectPtr&& p);
 
  PythonQtObjectPtr(const QVariant& variant)
    : _object(nullptr)
  {
    fromVariant(variant);
  }
 
  PythonQtObjectPtr(PyObject* o);
 
  ~PythonQtObjectPtr();
 
  bool fromVariant(const QVariant& variant);
 
  QVariant toVariant();
 
  QVariant toLocalVariant();
 
  PythonQtObjectPtr& operator=(const PythonQtObjectPtr& p)
  {
    setObject(p.object());
    return *this;
  }
 
  PythonQtObjectPtr& operator=(PythonQtObjectPtr&& p) noexcept
  {
    if (_object) {
      setObject(nullptr);
    }
    _object = p.takeObject();
    return *this;
  }
 
  PythonQtObjectPtr& operator=(PythonQtSafeObjectPtr&& p);
 
  PythonQtObjectPtr& operator=(PyObject* o)
  {
    setObject(o);
    return *this;
  }
 
  PythonQtObjectPtr& operator=(const QVariant& variant)
  {
    fromVariant(variant);
    return *this;
  }
 
  bool operator==(const PythonQtObjectPtr& p) const { return object() == p.object(); }
 
  bool operator!=(const PythonQtObjectPtr& p) const { return !(*this == p); }
 
  bool operator==(PyObject* p) const { return object() == p; }
 
  bool operator!=(PyObject* p) const { return object() != p; }
 
  bool isNull() const { return !object(); }
 
  PyObject* operator->() const { return object(); }
 
  PyObject& operator*() const { return *(object()); }
 
  operator PyObject*() const { return object(); }
 
  void setNewRef(PyObject* o);
 
  PyObject* object() const { return _object; }
 
  QVariant evalScript(const QString& script, int start = Py_file_input);
 
  QVariant evalCode(PyObject* pycode);
 
  void evalFile(const QString& filename);
 
  void addObject(const QString& name, QObject* object);
 
  void addVariable(const QString& name, const QVariant& v);
 
  void removeVariable(const QString& name);
 
  QVariant getVariable(const QString& name);
 
  QVariant call(const QString& callable, const QVariantList& args = QVariantList(),
    const QVariantMap& kwargs = QVariantMap());
 
  QVariant call(const QVariantList& args = QVariantList(), const QVariantMap& kwargs = QVariantMap());
 
  PyObject* takeObject()
  {
    PyObject* o = _object;
    _object = nullptr;
    return o;
  }
 
protected:
 
  void setObject(PyObject* o);
 
private:
  PyObject* _object;
};
 
class PYTHONQT_EXPORT PythonQtSafeObjectPtr
{
public:
  PythonQtSafeObjectPtr()
    : _object(nullptr)
  {
  }
 
  PythonQtSafeObjectPtr(const PythonQtSafeObjectPtr& p)
    : _object(nullptr)
  {
    setObject(p.object());
  }
 
  PythonQtSafeObjectPtr(const PythonQtObjectPtr& p)
    : _object(nullptr)
  {
    setObject(p.object());
  }
 
  PythonQtSafeObjectPtr(PythonQtSafeObjectPtr&& p) noexcept
    : _object(p._object)
  {
    p._object = nullptr;
  }
 
  PythonQtSafeObjectPtr(PythonQtObjectPtr&& p)
    : _object(p.takeObject())
  {
  }
 
  PythonQtSafeObjectPtr(PyObject* o);
 
  ~PythonQtSafeObjectPtr();
 
  PythonQtSafeObjectPtr& operator=(const PythonQtSafeObjectPtr& p)
  {
    setObject(p.object());
    return *this;
  }
 
  PythonQtSafeObjectPtr& operator=(const PythonQtObjectPtr& p)
  {
    setObjectUnsafe(p.object());
    return *this;
  }
 
  PythonQtSafeObjectPtr& operator=(PythonQtSafeObjectPtr&& p) noexcept
  {
    if (_object) {
      setObject(nullptr);
    }
    _object = p._object;
    p._object = nullptr;
    return *this;
  }
 
  PythonQtSafeObjectPtr& operator=(PythonQtObjectPtr&& p)
  {
    if (_object) {
      setObjectUnsafe(nullptr);
    }
    _object = p.takeObject();
    return *this;
  }
 
  PythonQtSafeObjectPtr& operator=(PyObject* o)
  {
    setObject(o);
    return *this;
  }
 
  bool operator==(const PythonQtSafeObjectPtr& p) const { return object() == p.object(); }
 
  bool operator!=(const PythonQtSafeObjectPtr& p) const { return !(*this == p); }
 
  bool operator==(PyObject* p) const { return object() == p; }
 
  bool operator!=(PyObject* p) const { return object() != p; }
 
  bool isNull() const { return !object(); }
 
  PyObject* operator->() const { return object(); }
 
  PyObject& operator*() const { return *(object()); }
 
  operator PyObject*() const { return object(); }
 
  PyObject* object() const { return _object; }
 
  PyObject* takeObject()
  {
    PyObject* o = _object;
    _object = nullptr;
    return o;
  }
 
protected:
  void setObject(PyObject* o);
  void setObjectUnsafe(PyObject* o);
 
private:
  PyObject* _object;
};
 
// We don't want QVariant to take PythonQtObjectPtr via QVariant::fromValue, because it is unsafe when using multi-threading/GIL
// A QVariant can still be obtained with PythonQtObjectPtr::toLocalVariant().
//Q_DECLARE_METATYPE(PythonQtObjectPtr)
 
// register PythonQtSafeObjectPtr to the meta type system
Q_DECLARE_METATYPE(PythonQtSafeObjectPtr)
 
#endif