load_plugins.cpp

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#include <QCoreApplication>
#include <QDir>
#include <QDirIterator>
#include <QString>
#include <QtGlobal>
 
#include "casters.h"
 
#include <pybind11/numpy.h>
#include <pybind11/stl_bind.h>
 
namespace py = pybind11;
 
#if defined(Q_OS_WIN32)
const char *MODULE_EXTENSION = ".pyd";
 
QString getPluginsWrappersPath()
{
#ifdef PYCC_STAND_ALONE
    py::module_ sysconfig = py::module_::import("sysconfig");
    const QString site_packages = sysconfig.attr("get_path")("purelib").cast<QString>();
    return QString("%1\\pycc\\plugins-python").arg(site_packages);
#else
    QDir appDir = QCoreApplication::applicationDirPath();
    QString pluginPath = QString("%1\\plugins-python").arg(appDir.absolutePath());
    return pluginPath;
#endif
}
#elif defined(Q_OS_MACOS)
const char *MODULE_EXTENSION = ".so";
 
QString getPluginsWrappersPath()
{
#ifdef PYCC_STAND_ALONE
    py::module_ sys = py::module_::import("sys");
    const QString envPrefix = sys.attr("prefix").cast<QString>();
    QString pluginPath = QString("%1/lib/plugins-python").arg(envPrefix);
#else
    // This point to $InstallFolder/ACloudViewer.app/Contents/MacOS
    // We store python plugin wrappers in
    // $InstallFolder/ACloudViewer.app/Contents/cvPythonPlugins
    QDir appDir = QCoreApplication::applicationDirPath();
    appDir.cdUp();
    QString pluginPath = QString("%1/cvPythonPlugins").arg(appDir.absolutePath());
#endif
    return pluginPath;
}
#else
const char *MODULE_EXTENSION = ".so";
 
QString guessPlatlibdir()
{
#if PY_MAJOR_VERSION >= 3 && PY_MINOR_VERSION >= 9
    // TODO it might be interesting to get the lib64 / lib from a config.h generated by cmake
    //  instead of calling python
    py::module_ sys = py::module_::import("sys");
    const QString platlibdir = sys.attr("platlibdir").cast<QString>();
#else
    const QString platlibdir = "lib";
#endif
    return platlibdir;
}
 
QString getPluginsWrappersPath()
{
#ifdef PYCC_STAND_ALONE
    // We put the python wrapper in $venvPrefix/lib(64)/plugins-python
    py::module_ sys = py::module_::import("sys");
    const QString envPrefix = sys.attr("prefix").cast<QString>();
    const QString platlibdir = guessPlatlibdir();
    QString pluginPath = QString("%1/%2/plugins-python").arg(envPrefix, platlibdir);
#else  // PYCC_STAND_ALONE
 
    QDir theDir = QCoreApplication::applicationDirPath();
    if (theDir.dirName() == "bin")
    {
        theDir.cdUp();
    }
 
    QString pluginPath = QString("%1/plugins-python").arg(theDir.absolutePath());
#endif // PYCC_STAND_ALONE
    return pluginPath;
}
#endif // Q_OS_WIN32
 
void load_pluginWrappers(py::module_ &m)
{
    py::module_ pluginWrappers = m.def_submodule("plugins");
    pluginWrappers.doc() = "Module we wrap around some ACloudViewer plugins";
 
    const QString pluginPath = getPluginsWrappersPath();
 
    QDir pluginPathDir(pluginPath);
    if (!pluginPathDir.exists())
    {
        return;
    }
 
    py::print(
        "[PythonRuntime] Start load plugin python wrapper from: '", pluginPath.toStdString(), "'");
    py::module_::import("sys").attr("path").attr("append")(pluginPath);
    QDirIterator iter(pluginPathDir);
    while (iter.hasNext())
    {
        iter.next();
        QFileInfo entry = iter.fileInfo();
        QString fileName = entry.fileName();
 
        if (!fileName.endsWith(MODULE_EXTENSION))
        {
            continue;
        }
 
        // Our wrappers are wheels with name like "pluginName.cpython.etc.etc.so"
        const std::string stdFileName = fileName.split('.')[0].toStdString();
        try
        {
            const py::module mod = py::module_::import(stdFileName.c_str());
            const std::string pluginName = mod.attr("plugin_name").cast<std::string>();
            pluginWrappers.attr(pluginName.c_str()) = mod;
            py::print("[PythonRuntime] Plugin python wrapper found: '", pluginName, "'");
        }
        catch (const std::exception &e)
        {
            py::print("Failed to load plugin '", stdFileName, "': ", e.what());
            continue;
        }
    }
}