simulationexperimentviewpythonwrapper.cpp

/*******************************************************************************

Copyright (C) The University of Auckland

OpenCOR 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 3 of the License, or
(at your option) any later version.

OpenCOR 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, see <http://www.gnu.org/licenses/>.

*******************************************************************************/

//==============================================================================
// Python wrapper for SimulationExperimentView classes
//==============================================================================

#include "centralwidget.h"
#include "coreguiutils.h"
#include "file.h"
#include "pythonqtsupport.h"
#include "simulation.h"
#include "simulationexperimentviewplugin.h"
#include "simulationexperimentviewpythonwrapper.h"
#include "simulationexperimentviewsimulationwidget.h"
#include "simulationexperimentviewwidget.h"

//==============================================================================

#include <array>

//==============================================================================

namespace OpenCOR {

//==============================================================================

namespace SimulationSupport {
    class Simulation;
}   // namespace SimulationSupport

//==============================================================================

namespace SimulationExperimentView {

//==============================================================================

static PyObject *getSimulation(const QString &pFileName,
                               SimulationExperimentViewWidget *pSimulationExperimentViewWidget)
{
    SimulationSupport::Simulation *simulation = pSimulationExperimentViewWidget->simulation(pFileName);

    if (simulation != nullptr) {
        if (simulation->runtime() != nullptr) {
            // The simulation is missing a runtime so raise a Python exception

            PyErr_SetString(PyExc_ValueError, qPrintable(QObject::tr("unable to get simulations's runtime")));

            return nullptr;
        }
        // Let the simulation's widget know when we start running
        // Note: connect is also in the PythonQt namespace

        QObject::connect(simulation, &SimulationSupport::Simulation::runStarting,
                         pSimulationExperimentViewWidget, &SimulationExperimentViewWidget::startingRun);

        // Use the simulation's widget to clear our data

        QObject::connect(simulation, &SimulationSupport::Simulation::clearResults,
                         pSimulationExperimentViewWidget, &SimulationExperimentViewWidget::clearResults);

        return PythonQt::priv()->wrapQObject(simulation);
    }

#include "pythonbegin.h"
    Py_RETURN_NONE;
#include "pythonend.h"
}

//==============================================================================

static PyObject *initializeSimulation(const QString &pFileName)
{
    SimulationExperimentViewWidget *simulationExperimentViewWidget = SimulationExperimentViewPlugin::instance()->viewWidget();

    if (simulationExperimentViewWidget != nullptr) {
        simulationExperimentViewWidget->initialize(pFileName);

        return getSimulation(pFileName, simulationExperimentViewWidget);
    }

#include "pythonbegin.h"
    Py_RETURN_NONE;
#include "pythonend.h"
}

//==============================================================================

static PyObject *openSimulation(PyObject *self, PyObject *args)
{
    Q_UNUSED(self)

    PyObject *bytes;
    char *name;
    Py_ssize_t len;
    if (PyArg_ParseTuple(args, "O&", PyUnicode_FSConverter, &bytes) == 0) { // NOLINT(cppcoreguidelines-pro-type-vararg)
#include "pythonbegin.h"
        Py_RETURN_NONE;
#include "pythonend.h"
    }
    PyBytes_AsStringAndSize(bytes, &name, &len);
    QString fileName = QString::fromUtf8(name, int(len));
#include "pythonbegin.h"
    Py_DECREF(bytes);
#include "pythonend.h"

    QString ioError = Core::centralWidget()->openFile(fileName,
                                                      Core::File::Type::Local,
                                                      QString(), false);

    if (!ioError.isEmpty()) {
        PyErr_SetString(PyExc_IOError, qPrintable(ioError));

        return nullptr;
    }

    return initializeSimulation(QFileInfo(fileName).canonicalFilePath());
}

//==============================================================================

static PyObject *openRemoteSimulation(PyObject *self, PyObject *args)
{
    Q_UNUSED(self)

    PyObject *bytes;
    char *name;
    Py_ssize_t len;
    if (PyArg_ParseTuple(args, "O&", PyUnicode_FSConverter, &bytes) == 0) { // NOLINT(cppcoreguidelines-pro-type-vararg)
#include "pythonbegin.h"
        Py_RETURN_NONE;
#include "pythonend.h"
    }
    PyBytes_AsStringAndSize(bytes, &name, &len);
    QString url = QString::fromUtf8(name, int(len));
#include "pythonbegin.h"
    Py_DECREF(bytes);
#include "pythonend.h"

    QString ioError = Core::centralWidget()->openRemoteFile(url, false);

    if (!ioError.isEmpty()) {
        PyErr_SetString(PyExc_IOError, qPrintable(ioError));

        return nullptr;
    }

    return initializeSimulation(Core::localFileName(url));
}

//==============================================================================

static PyObject *closeSimulation(PyObject *self, PyObject *args)
{
    Q_UNUSED(self)

    if (PyTuple_Size(args) > 0) {
#include "pythonbegin.h"
        PythonQtInstanceWrapper *wrappedSimulation = PythonQtSupport::getInstanceWrapper(PyTuple_GET_ITEM(args, 0)); // NOLINT(cppcoreguidelines-pro-type-cstyle-cast)
#include "pythonend.h"

        if (wrappedSimulation != nullptr) {
            auto simulation = static_cast<SimulationSupport::Simulation *>(wrappedSimulation->_objPointerCopy);

            // Close the simulation by closing its file, raising an exception if we
            // are unable to do so

            if (!Core::centralWidget()->closeFile(simulation->fileName())) {
                PyErr_SetString(PyExc_IOError, "unable to close file");

                return nullptr;
            }
        }
    }

#include "pythonbegin.h"
    Py_RETURN_NONE;
#include "pythonend.h"
}

//==============================================================================

static PyObject *OpenCOR_simulation(PyObject *self,  PyObject *args)
{
    Q_UNUSED(self)
    Q_UNUSED(args)

    SimulationExperimentViewWidget *simulationExperimentViewWidget = SimulationExperimentViewPlugin::instance()->viewWidget();

    if (simulationExperimentViewWidget != nullptr) {
        return getSimulation(Core::centralWidget()->currentFileName(), simulationExperimentViewWidget);
    }

#include "pythonbegin.h"
    Py_RETURN_NONE;
#include "pythonend.h"
}

//==============================================================================

SimulationExperimentViewPythonWrapper::SimulationExperimentViewPythonWrapper(PyObject *pModule, QObject *pParent) : QObject(pParent)
{
    static std::array<PyMethodDef, 5> PythonSimulationExperimentViewMethods = {{
                                                                                  { "simulation",  OpenCOR_simulation, METH_VARARGS, "Current simulation." },
                                                                                  { "openSimulation", openSimulation, METH_VARARGS, "Open a simulation." },
                                                                                  { "openRemoteSimulation", openRemoteSimulation, METH_VARARGS, "Open a remote simulation." },
                                                                                  { "closeSimulation", closeSimulation, METH_VARARGS, "Close a simulation." },
                                                                                  { nullptr, nullptr, 0, nullptr }
                                                                              }};

    PyModule_AddFunctions(pModule, PythonSimulationExperimentViewMethods.data());
}

//==============================================================================

}   // namespace SimulationExperimentView
}   // namespace OpenCOR

//==============================================================================
// End of file
//==============================================================================