From 2d2d136952b748773e72c3d350b83269ddbd996f Mon Sep 17 00:00:00 2001
From: Marcus Tillmanns <marcus.tillmanns@qt.io>
Date: Wed, 25 Sep 2024 12:29:05 +0200
Subject: [PATCH] Lua: Make OptionsPage safer

If the calling script does not keep a reference to the OptionsPage
it will be garbage collected by Lua eventually. That can happen while
the SettingsDialog is open, which cannot cope with a page
being destroyed while its open.

For now we just keep the OptionsPage alive until the plugin is unloaded.

Change-Id: I8d0592731236482bbdc35078c24a5c6b962b1147
Reviewed-by: hjk <hjk@qt.io>
---
 src/plugins/lua/bindings/settings.cpp | 24 +++++++++++++++++++-----
 1 file changed, 19 insertions(+), 5 deletions(-)

diff --git a/src/plugins/lua/bindings/settings.cpp b/src/plugins/lua/bindings/settings.cpp
index 0474fa50552..64ecd1e8dc0 100644
--- a/src/plugins/lua/bindings/settings.cpp
+++ b/src/plugins/lua/bindings/settings.cpp
@@ -286,9 +286,23 @@ sol::usertype<T> addTypedAspect(sol::table &lua, const QString &name)
         sol::bases<TypedAspect<typename T::valueType>, BaseAspect>());
 }
 
+class ObjectPool
+{
+public:
+    mutable std::vector<std::shared_ptr<Core::IOptionsPage>> optionsPages;
+
+    template<class T, class... _Args>
+    std::shared_ptr<T> makePage(_Args &&...__args) const
+    {
+        auto page = std::make_shared<T>(std::forward<_Args>(__args)...);
+        optionsPages.push_back(page);
+        return page;
+    }
+};
+
 void setupSettingsModule()
 {
-    registerProvider("Settings", [](sol::state_view lua) -> sol::object {
+    registerProvider("Settings", [pool = ObjectPool()](sol::state_view lua) -> sol::object {
         const ScriptPluginSpec *pluginSpec = lua.get<ScriptPluginSpec *>("PluginSpec");
 
         sol::table settings = lua.create_table();
@@ -607,8 +621,8 @@ void setupSettingsModule()
         settings.new_usertype<OptionsPage>(
             "OptionsPage",
             "create",
-            [pluginSpec](const sol::table &options) {
-                return std::make_unique<OptionsPage>(pluginSpec, options);
+            [&pool, pluginSpec](const sol::table &options) {
+                return pool.makePage<OptionsPage>(pluginSpec, options);
             },
             "show",
             [](OptionsPage *page) { Core::ICore::showOptionsDialog(page->id()); });
@@ -616,8 +630,8 @@ void setupSettingsModule()
         settings.new_usertype<ExtensionOptionsPage>(
             "ExtensionOptionsPage",
             "create",
-            [pluginSpec](AspectContainer *container) {
-                return std::make_unique<ExtensionOptionsPage>(pluginSpec, container);
+            [pluginSpec, &pool](AspectContainer *container) {
+                return pool.makePage<ExtensionOptionsPage>(pluginSpec, container);
             },
             "show",
             [](ExtensionOptionsPage *page) { Core::ICore::showOptionsDialog(page->id()); });