forked from qt-creator/qt-creator
218f07bdef
We want to make sure that the LuaEngine is deleted when the plugin is removed. We also derive LuaEngine from QObject so we can use it as a guard in QObject::connect calls. Change-Id: I6b0568f11bee283f880ede9432b2a9fe83014758 Reviewed-by: David Schulz <david.schulz@qt.io>
113 lines
3.3 KiB
C++
113 lines
3.3 KiB
C++
// Copyright (C) 2024 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
|
|
|
|
#pragma once
|
|
|
|
#include "lua_global.h"
|
|
|
|
#include <extensionsystem/iplugin.h>
|
|
#include <extensionsystem/pluginspec.h>
|
|
|
|
#include <utils/expected.h>
|
|
#include <utils/filepath.h>
|
|
|
|
#include <sol/sol.hpp>
|
|
|
|
// this needs to be included after sol/sol.hpp!
|
|
#include "luaqttypes.h"
|
|
|
|
#include <QJsonValue>
|
|
|
|
#include <memory>
|
|
|
|
namespace Lua {
|
|
class LuaEnginePrivate;
|
|
class LuaPluginSpec;
|
|
|
|
namespace Internal {
|
|
class LuaPlugin;
|
|
}
|
|
|
|
struct CoroutineState
|
|
{
|
|
bool isMainThread;
|
|
};
|
|
|
|
class LUA_EXPORT LuaEngine final : public QObject
|
|
{
|
|
friend class Internal::LuaPlugin;
|
|
|
|
protected:
|
|
LuaEngine();
|
|
|
|
public:
|
|
using PackageProvider = std::function<sol::object(sol::state_view)>;
|
|
|
|
~LuaEngine();
|
|
static LuaEngine &instance();
|
|
|
|
Utils::expected_str<LuaPluginSpec *> loadPlugin(const Utils::FilePath &path);
|
|
Utils::expected_str<void> prepareSetup(
|
|
sol::state_view &lua, const LuaPluginSpec &pluginSpec, sol::optional<sol::table> hookTable);
|
|
|
|
static void registerProvider(const QString &packageName, const PackageProvider &provider);
|
|
static void autoRegister(const std::function<void(sol::state_view)> ®isterFunction);
|
|
static void registerHook(QString name, const std::function<void(sol::function)> &hookProvider);
|
|
|
|
static Utils::expected_str<void> connectHooks(sol::state_view lua, const sol::table &hookTable);
|
|
|
|
static bool isCoroutine(lua_State *state);
|
|
|
|
static sol::table toTable(const sol::state_view &lua, const QJsonValue &v);
|
|
static QJsonValue toJson(const sol::table &t);
|
|
|
|
template<class T>
|
|
static void checkKey(const sol::table &table, const QString &key)
|
|
{
|
|
if (table[key].template is<T>())
|
|
return;
|
|
if (!table[key].valid())
|
|
throw sol::error("Expected " + key.toStdString() + " to be defined");
|
|
throw sol::error(
|
|
"Expected " + key.toStdString() + " to be of type " + sol::detail::demangle<T>());
|
|
}
|
|
|
|
static QStringList variadicToStringList(const sol::variadic_args &vargs);
|
|
|
|
template<typename R, typename... Args>
|
|
static Utils::expected_str<R> safe_call(const sol::protected_function &function, Args &&...args)
|
|
{
|
|
sol::protected_function_result result = function(std::forward<Args>(args)...);
|
|
if (!result.valid()) {
|
|
sol::error err = result;
|
|
return Utils::make_unexpected(QString::fromLocal8Bit(err.what()));
|
|
}
|
|
try {
|
|
return result.get<R>();
|
|
} catch (std::runtime_error &e) {
|
|
return Utils::make_unexpected(QString::fromLocal8Bit(e.what()));
|
|
}
|
|
}
|
|
|
|
template<typename... Args>
|
|
static Utils::expected_str<void> void_safe_call(
|
|
const sol::protected_function &function, Args &&...args)
|
|
{
|
|
sol::protected_function_result result = function(std::forward<Args>(args)...);
|
|
if (!result.valid()) {
|
|
sol::error err = result;
|
|
return Utils::make_unexpected(QString::fromLocal8Bit(err.what()));
|
|
}
|
|
return {};
|
|
}
|
|
|
|
protected:
|
|
Utils::expected_str<void> connectHooks(
|
|
sol::state_view lua, const sol::table &table, const QString &path);
|
|
|
|
private:
|
|
std::unique_ptr<LuaEnginePrivate> d;
|
|
};
|
|
|
|
} // namespace Lua
|