Lua: Guard Hook connections

Change-Id: Id30c75093879b92321af864273c6d4ef390cf71a
Reviewed-by: hjk <hjk@qt.io>

src/plugins/lua/bindings/hook.cpp

@@ -12,20 +12,24 @@ namespace Internal {
 
 void addHookModule()
 {
-    LuaEngine::registerHook("editors.documentOpened", [](const sol::protected_function &func) {
+    LuaEngine::registerHook(
+        "editors.documentOpened", [](const sol::protected_function &func, QObject *guard) {
             QObject::connect(
                 Core::EditorManager::instance(),
                 &Core::EditorManager::documentOpened,
+                guard,
                 [func](Core::IDocument *document) {
                     Utils::expected_str<void> res = LuaEngine::void_safe_call(func, document);
                     QTC_CHECK_EXPECTED(res);
                 });
         });
 
-    LuaEngine::registerHook("editors.documentClosed", [](const sol::protected_function &func) {
+    LuaEngine::registerHook(
+        "editors.documentClosed", [](const sol::protected_function &func, QObject *guard) {
             QObject::connect(
                 Core::EditorManager::instance(),
                 &Core::EditorManager::documentClosed,
+                guard,
                 [func](Core::IDocument *document) {
                     Utils::expected_str<void> res = LuaEngine::void_safe_call(func, document);
                     QTC_CHECK_EXPECTED(res);

src/plugins/lua/bindings/textdocument.cpp

@@ -117,30 +117,33 @@ void addTextDocumentsModule()
         return documents;
     });
 
-    LuaEngine::registerHook("editors.text.opened", [](sol::function func) {
+    LuaEngine::registerHook("editors.text.opened", [](sol::function func, QObject *guard) {
         QObject::connect(
             TextDocumentRegistry::instance(),
             &TextDocumentRegistry::documentOpened,
+            guard,
             [func](TextEditor::TextDocument *document) {
                 Utils::expected_str<void> res = LuaEngine::void_safe_call(func, document);
                 QTC_CHECK_EXPECTED(res);
             });
     });
 
-    LuaEngine::registerHook("editors.text.closed", [](sol::function func) {
+    LuaEngine::registerHook("editors.text.closed", [](sol::function func, QObject *guard) {
         QObject::connect(
             TextDocumentRegistry::instance(),
             &TextDocumentRegistry::documentClosed,
+            guard,
             [func](TextEditor::TextDocument *document) {
                 Utils::expected_str<void> res = LuaEngine::void_safe_call(func, document);
                 QTC_CHECK_EXPECTED(res);
             });
     });
 
-    LuaEngine::registerHook("editors.text.contentsChanged", [](sol::function func) {
+    LuaEngine::registerHook("editors.text.contentsChanged", [](sol::function func, QObject *guard) {
         QObject::connect(
             TextDocumentRegistry::instance(),
             &TextDocumentRegistry::documentContentsChanged,
+            guard,
             [func](TextEditor::TextDocument *document, int position, int charsRemoved, int charsAdded) {
                 Utils::expected_str<void> res
                     = LuaEngine::void_safe_call(func, document, position, charsRemoved, charsAdded);
@@ -148,10 +151,11 @@ void addTextDocumentsModule()
             });
     });
 
-    LuaEngine::registerHook("editors.text.currentChanged", [](sol::function func) {
+    LuaEngine::registerHook("editors.text.currentChanged", [](sol::function func, QObject *guard) {
         QObject::connect(
             TextDocumentRegistry::instance(),
             &TextDocumentRegistry::currentDocumentChanged,
+            guard,
             [func](TextEditor::TextDocument *document) {
                 Utils::expected_str<void> res = LuaEngine::void_safe_call(func, document);
                 QTC_CHECK_EXPECTED(res);

src/plugins/lua/luaengine.cpp

@@ -51,7 +51,7 @@ public:
     QHash<QString, LuaEngine::PackageProvider> m_providers;
     QList<std::function<void(sol::state_view)>> m_autoProviders;
 
-    QMap<QString, std::function<void(sol::function)>> m_hooks;
+    QMap<QString, std::function<void(sol::function, QObject *)>> m_hooks;
 
     std::unique_ptr<LuaInterfaceImpl> m_luaInterface;
 };
@@ -155,20 +155,22 @@ void LuaEngine::autoRegister(const std::function<void(sol::state_view)> &registe
     instance().d->m_autoProviders.append(registerFunction);
 }
 
-void LuaEngine::registerHook(QString name, const std::function<void(sol::function)> &hook)
+void LuaEngine::registerHook(
+    QString name, const std::function<void(sol::function, QObject *guard)> &hook)
 {
     instance().d->m_hooks.insert("." + name, hook);
 }
 
 expected_str<void> LuaEngine::connectHooks(
-    sol::state_view lua, const sol::table &table, const QString &path)
+    sol::state_view lua, const sol::table &table, const QString &path, QObject *guard)
 {
     qCDebug(logLuaEngine) << "connectHooks called with path: " << path;
 
     for (const auto &[k, v] : table) {
         qCDebug(logLuaEngine) << "Processing key: " << k.as<QString>();
         if (v.get_type() == sol::type::table) {
-            return connectHooks(lua, v.as<sol::table>(), QStringList{path, k.as<QString>()}.join("."));
+            return connectHooks(
+                lua, v.as<sol::table>(), QStringList{path, k.as<QString>()}.join("."), guard);
         } else if (v.get_type() == sol::type::function) {
             QString hookName = QStringList{path, k.as<QString>()}.join(".");
             qCDebug(logLuaEngine) << "Connecting function to hook: " << hookName;
@@ -176,7 +178,7 @@ expected_str<void> LuaEngine::connectHooks(
             if (it == d->m_hooks.end())
                 return make_unexpected(Tr::tr("No hook with the name \"%1\" found.").arg(hookName));
             else
-                it.value()(v.as<sol::function>());
+                it.value()(v.as<sol::function>(), guard);
         }
     }
 
@@ -255,8 +257,10 @@ expected_str<sol::protected_function> LuaEngine::prepareSetup(
             return self.name;
         }));
 
-    lua["PluginSpec"]
+    auto guardObject = std::make_unique<QObject>();
-        = ScriptPluginSpec{pluginSpec.name(), appDataPath, std::make_unique<QObject>()};
+    auto guardObjectPtr = guardObject.get();
+
+    lua["PluginSpec"] = ScriptPluginSpec{pluginSpec.name(), appDataPath, std::move(guardObject)};
 
     // TODO: only register what the plugin requested
     for (const auto &[name, func] : d->m_providers.asKeyValueRange()) {
@@ -289,7 +293,7 @@ expected_str<sol::protected_function> LuaEngine::prepareSetup(
 
     qCDebug(logLuaEngine) << "Hooks table found: " << hookTable.has_value();
     if (hookTable) {
-        auto connectResult = connectHooks(lua, *hookTable, {});
+        auto connectResult = connectHooks(lua, *hookTable, {}, guardObjectPtr);
         if (!connectResult)
             return make_unexpected(connectResult.error());
     }

src/plugins/lua/luaengine.h

@@ -60,7 +60,8 @@ public:
 
     static void registerProvider(const QString &packageName, const PackageProvider &provider);
     static void autoRegister(const std::function<void(sol::state_view)> &registerFunction);
-    static void registerHook(QString name, const std::function<void(sol::function)> &hookProvider);
+    static void registerHook(
+        QString name, const std::function<void(sol::function, QObject *guard)> &hookProvider);
 
     static bool isCoroutine(lua_State *state);
 
@@ -115,7 +116,7 @@ public:
 
 protected:
     Utils::expected_str<void> connectHooks(
-        sol::state_view lua, const sol::table &table, const QString &path);
+        sol::state_view lua, const sol::table &table, const QString &path, QObject *guard);
 
 private:
     std::unique_ptr<LuaEnginePrivate> d;