#5675: Block auto saves when a modal dialog is open

codereader · Aug 6, 2021 · 4cbcf68 · 4cbcf68
1 parent c895b4f
commit 4cbcf68
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 0 deletions.
diff --git a/libs/wxutil/dialog/AutoSaveRequestBlocker.h b/libs/wxutil/dialog/AutoSaveRequestBlocker.h
@@ -0,0 +1,38 @@
+#pragma once
+
+#include "imessagebus.h"
+#include "iradiant.h"
+#include "messages/AutomaticMapSaveRequest.h"
+
+namespace wxutil
+{
+
+class AutoSaveRequestBlocker
+{
+private:
+    std::size_t _msgSubscription;
+    std::string _reason;
+
+public:
+    AutoSaveRequestBlocker(const std::string& reason) :
+        _reason(reason)
+    {
+        _msgSubscription = GlobalRadiantCore().getMessageBus().addListener(
+            radiant::IMessage::Type::AutomaticMapSaveRequest,
+            radiant::TypeListener<map::AutomaticMapSaveRequest>(
+                sigc::mem_fun(this, &AutoSaveRequestBlocker::handleRequest)));
+    }
+
+    ~AutoSaveRequestBlocker()
+    {
+        GlobalRadiantCore().getMessageBus().removeListener(_msgSubscription);
+    }
+
+private:
+    void handleRequest(map::AutomaticMapSaveRequest& msg)
+    {
+        msg.denyWithReason(_reason);
+    }
+};
+
+}
diff --git a/libs/wxutil/dialog/DialogBase.cpp b/libs/wxutil/dialog/DialogBase.cpp
@@ -1,5 +1,7 @@
 #include "DialogBase.h"
 
+#include "AutoSaveRequestBlocker.h"
+
 namespace wxutil
 {
 
@@ -57,4 +59,12 @@ void DialogBase::FitToScreen(float xProp, float yProp)
     CenterOnScreen();
 }
 
+int DialogBase::ShowModal()
+{
+    // While this dialog is active, block any auto save requests
+    AutoSaveRequestBlocker blocker("Modal Dialog is active");
+
+    return wxDialog::ShowModal();
+}
+
 }
diff --git a/libs/wxutil/dialog/DialogBase.h b/libs/wxutil/dialog/DialogBase.h
@@ -32,6 +32,8 @@ class DialogBase :
      */
     void FitToScreen(float xProp, float yProp);
 
+    virtual int ShowModal() override;
+
 protected:
     // Overrideable: return true to prevent the window from being deleted
     virtual bool _onDeleteEvent()

diff --git a/tools/msvc/wxutillib.vcxproj b/tools/msvc/wxutillib.vcxproj
@@ -151,6 +151,7 @@
     <ClInclude Include="..\..\libs\wxutil\dataview\TreeViewItemStyle.h" />
     <ClInclude Include="..\..\libs\wxutil\dataview\VFSTreePopulator.h" />
     <ClInclude Include="..\..\libs\wxutil\DeferredMotionDelta.h" />
+    <ClInclude Include="..\..\libs\wxutil\dialog\AutoSaveRequestBlocker.h" />
     <ClInclude Include="..\..\libs\wxutil\dialog\Dialog.h" />
     <ClInclude Include="..\..\libs\wxutil\dialog\DialogBase.h" />
     <ClInclude Include="..\..\libs\wxutil\dialog\DialogElements.h" />

diff --git a/tools/msvc/wxutillib.vcxproj.filters b/tools/msvc/wxutillib.vcxproj.filters
@@ -150,6 +150,9 @@
     </ClInclude>
     <ClInclude Include="..\..\libs\wxutil\Bitmap.h" />
     <ClInclude Include="..\..\libs\wxutil\LocalBitmapArtProvider.h" />
+    <ClInclude Include="..\..\libs\wxutil\dialog\AutoSaveRequestBlocker.h">
+      <Filter>dialog</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="..\..\libs\wxutil\dialog\MessageBox.cpp">