PythonHotPlugActionExtension.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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 version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifdef PYTHON_BINDING
 
#ifndef __PYTHON_HOTPLUG_ACTION_EXTENSION__
#define __PYTHON_HOTPLUG_ACTION_EXTENSION__
 
#include "HotPlugActionExtension.h"
#include "InterfaceLogger.h"
 
#include <QDir>
 
namespace camitk {
 
class PythonHotPlugAction;
 
class CAMITK_API PythonHotPlugActionExtension : public HotPlugActionExtension {
    Q_OBJECT
 
public:
    PythonHotPlugActionExtension(const QString& camitkFilePath, bool verifyVirtualEnv = false);
 
    ~PythonHotPlugActionExtension() override;
 
    enum class PythonCallStatus {
        ALREADY_IN_CALL,   // the method is already running, nothing was done
        MODULE_NOT_LOADED, // python module was not loaded properly (i.e. lockContext failed)
        MISSING_FUNCTION,  // python function is missing in the script
        NOT_A_FUNCTION,    // python function is a symbol but is not callable
        RETURNED_FALSE,    // python function returned false
        EXCEPTION_RAISED,  // python code raised an exception
        SUCCESS            // everything went well
    };
 
    virtual QString getProgrammingLanguage() const override {
        return "Python";
    }
 
    virtual bool initActions(int progressMinimum = 0, int progressMaximum = 100) override;
 
    PythonHotPlugActionExtension::PythonCallStatus callPython(PythonHotPlugAction* action, QString methodName, QString param = QString());
 
private:
    QDir extensionDir;
 
    bool verifyVirtualEnvRequested;
};
 
} // namespace camitk
 
#endif // __PYTHON_HOTPLUG_ACTION_EXTENSION__
#endif // PYTHON_BINDING