#5200: Introduce "UI shutting down" signal to replace most of the UI-…

…related code registering to onRadiantShutdown.

include/imainframe.h

@@ -125,6 +125,15 @@ class IMainFrame :
 	 * automatically removed by this class.
 	 */
 	virtual sigc::signal<void>& signal_MainFrameReady() = 0;
+
+	/**
+	 * Signal fired when the UI is shutting down, right before the MainFrame 
+	 * window will be destroyed. Dependant UI modules can listen to this
+	 * event to get a chance to clean up and save their state.
+	 * This is a one-time signal, after emission the subscribers will be
+	 * automatically removed by this class.
+	 */
+	virtual sigc::signal<void>& signal_MainFrameShuttingDown() = 0;
 };
 
 // This is the accessor for the mainframe module

radiant/RadiantModule.h

@@ -1,7 +1,6 @@
 #pragma once
 
 #include "iradiant.h"
-#include "messages/CommandExecutionFailed.h"
 #include <memory>
 
 namespace radiant

radiant/ui/mainframe/MainFrame.cpp

@@ -307,9 +307,6 @@ void MainFrame::preDestructionCleanup()
     {
         removeLayout();
     }
-
-	// Broadcast shutdown event to RadiantListeners
-	radiant::getGlobalRadiant()->broadcastShutdownEvent();
 }
 
 void MainFrame::updateTitle()
@@ -353,6 +350,13 @@ void MainFrame::onTopLevelFrameClose(wxCloseEvent& ev)
     // present
     preDestructionCleanup();
 
+	// Broadcast shutdown event
+	signal_MainFrameShuttingDown().emit();
+	signal_MainFrameShuttingDown().clear();
+
+	// TODO: Remove this
+	radiant::getGlobalRadiant()->broadcastShutdownEvent();
+
     // Destroy the actual window
     _topLevelWindow->Destroy();
 
@@ -565,6 +569,11 @@ sigc::signal<void>& MainFrame::signal_MainFrameReady()
 	return _sigMainFrameReady;
 }
 
+sigc::signal<void>& MainFrame::signal_MainFrameShuttingDown()
+{
+	return _sigMainFrameShuttingDown;
+}
+
 // Define the static MainFrame module
 module::StaticModule<MainFrame> mainFrameModule;
 

radiant/ui/mainframe/MainFrame.h

@@ -30,6 +30,7 @@ class MainFrame :
 
 	sigc::signal<void> _sigMainFrameConstructed;
 	sigc::signal<void> _sigMainFrameReady;
+	sigc::signal<void> _sigMainFrameShuttingDown;
 
 private:
 	void keyChanged();
@@ -64,6 +65,7 @@ class MainFrame :
 
 	sigc::signal<void>& signal_MainFrameConstructed() override;
 	sigc::signal<void>& signal_MainFrameReady() override;
+	sigc::signal<void>& signal_MainFrameShuttingDown() override;
 
 	// Command to toggle the current layout's camera fullscreen mode
 	void toggleFullscreenCameraView(const cmd::ArgumentList& args);