Implement graceful exit for Alt+F4 and window close events

Author: githubawn

GeneralsMD/Code/GameEngine/Include/GameLogic/GameLogic.h

@@ -136,6 +136,7 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	Bool isInGameLogicUpdate( void ) const { return m_isInUpdate; }
 	Bool hasUpdated() const { return m_hasUpdated; } ///< Returns true if the logic frame has advanced in the current client/render update
 	UnsignedInt getFrame( void );										///< Returns the current simulation frame number
+	void quit(Bool toDesktop, Bool forceSurrender = TRUE);
 	UnsignedInt getCRC( Int mode = CRC_CACHED, AsciiString deepCRCFileName = AsciiString::TheEmptyString );		///< Returns the CRC
 
 	void setObjectIDCounter( ObjectID nextObjID ) { m_nextObjID = nextObjID; }
@@ -405,6 +406,7 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	void xferObjectTOC( Xfer *xfer );												///< save/load object TOC for current state of map
 	void prepareLogicForObjectLoad( void );									///< prepare engine for object data from game file
 
+	Bool m_quitToDesktopAfterMatch;
 };
 
 // INLINE /////////////////////////////////////////////////////////////////////////////////////////

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/QuitMenu.cpp

@@ -139,21 +139,7 @@ static void exitQuitMenu()
 {
   // destroy the quit menu
 	destroyQuitMenu();
-
-	// clear out all the game data
-	if ( TheGameLogic->isInMultiplayerGame() && !TheGameLogic->isInSkirmishGame() && !TheGameInfo->isSandbox() )
-	{
-		GameMessage *msg = TheMessageStream->appendMessage(GameMessage::MSG_SELF_DESTRUCT);
-		msg->appendBooleanArgument(TRUE);
-	}
-	TheGameLogic->exitGame();
-	// TheGameLogic->clearGameData();
-	// display the menu on top of the shell stack
-  // TheShell->showShell();
-
-	// this will trigger an exit
-  // TheGameEngine->setQuitting( TRUE );
-	TheInGameUI->setClientQuiet( TRUE );
+	TheGameLogic->quit(FALSE);
 }
 static void noExitQuitMenu()
 {
@@ -164,18 +150,7 @@ static void quitToDesktopQuitMenu()
 {
   // destroy the quit menu
 	destroyQuitMenu();
-
-	if (TheGameLogic->isInGame())
-	{
-		if (TheRecorder->getMode() == RECORDERMODETYPE_RECORD)
-		{
-			TheRecorder->stopRecording();
-		}
-		TheGameLogic->clearGameData();
-	}
-	TheGameEngine->setQuitting(TRUE);
-	TheInGameUI->setClientQuiet( TRUE );
-
+	TheGameLogic->quit(TRUE);
 }
 
 static void surrenderQuitMenu()

GeneralsMD/Code/GameEngine/Source/GameClient/MessageStream/CommandXlat.cpp

@@ -91,10 +91,6 @@
 
 #include "ww3d.h"
 
-
-#define dont_ALLOW_ALT_F4
-
-
 #if defined(RTS_DEBUG)
 /*non-static*/ Real TheSkateDistOverride = 0.0f;
 
@@ -4076,26 +4072,12 @@ GameMessageDisposition CommandTranslator::translateGameMessage(const GameMessage
 
 		}
 
-
-
-#ifdef ALLOW_ALT_F4
 		case GameMessage::MSG_META_DEMO_INSTANT_QUIT:
     {
-			if (TheGameLogic->isInGame())
-			{
-				if (TheRecorder->getMode() == RECORDERMODETYPE_RECORD)
-				{
-					TheRecorder->stopRecording();
-				}
-				TheGameLogic->clearGameData();
-			}
-			TheGameEngine->setQuitting(TRUE);
+			TheGameLogic->quit(TRUE);
 			disp = DESTROY_MESSAGE;
 			break;
     }
-#endif
-
-
 
 		//------------------------------------------------------------------------------- DEMO MESSAGES
 

GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp

@@ -141,6 +141,9 @@ enum { OBJ_HASH_SIZE	= 8192 };
 /// The GameLogic singleton instance
 GameLogic *TheGameLogic = nullptr;
 
+extern GameInfo *TheGameInfo;
+
+
 static void findAndSelectCommandCenter(Object *obj, void* alreadyFound);
 
 
@@ -262,6 +265,7 @@ GameLogic::GameLogic( void )
 	m_loadingMap = FALSE;
 	m_loadingSave = FALSE;
 	m_clearingGameData = FALSE;
+	m_quitToDesktopAfterMatch = FALSE;
 }
 
 //-------------------------------------------------------------------------------------------------
@@ -4162,14 +4166,71 @@ UnsignedInt GameLogic::getCRC( Int mode, AsciiString deepCRCFileName )
 // ------------------------------------------------------------------------------------------------
 void GameLogic::exitGame()
 {
-	// TheSuperHackers @fix The logic update must not be halted to process the game exit message.
 	setGamePaused(FALSE);
 	TheScriptEngine->forceUnfreezeTime();
 	TheScriptEngine->doUnfreezeTime();
 
 	TheMessageStream->appendMessage(GameMessage::MSG_CLEAR_GAME_DATA);
 }
 
+// ------------------------------------------------------------------------------------------------
+void GameLogic::quit(Bool toDesktop, Bool forceSurrender)
+{
+	if (isInGame())
+	{
+		if (forceSurrender)
+		{
+			if (isInMultiplayerGame() && !isInSkirmishGame() && TheGameInfo && !TheGameInfo->isSandbox())
+			{
+				GameMessage *msg = TheMessageStream->appendMessage(GameMessage::MSG_SELF_DESTRUCT);
+				msg->appendBooleanArgument(TRUE);
+			}
+		}
+
+		if (TheRecorder && TheRecorder->getMode() == RECORDERMODETYPE_RECORD)
+		{
+			TheRecorder->stopRecording();
+		}
+
+		setGamePaused(FALSE);
+		if (TheScriptEngine)
+		{
+			TheScriptEngine->forceUnfreezeTime();
+			TheScriptEngine->doUnfreezeTime();
+		}
+
+		if (toDesktop)
+		{
+			if (isInMultiplayerGame())
+			{
+				m_quitToDesktopAfterMatch = TRUE;
+				exitGame();
+			}
+			else
+			{
+				clearGameData();
+			}
+		}
+		else
+		{
+			exitGame();
+		}
+	}
+
+	if (toDesktop)
+	{
+		if (!isInMultiplayerGame())
+		{
+			TheGameEngine->setQuitting(TRUE);
+		}
+	}
+
+	if (TheInGameUI)
+	{
+		TheInGameUI->setClientQuiet(TRUE);
+	}
+}
+
 // ------------------------------------------------------------------------------------------------
 /** A new GameLogic object has been constructed, therefore create
  * a corresponding drawable and bind them together. */

GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogicDispatch.cpp

@@ -280,9 +280,10 @@ void GameLogic::clearGameData( Bool showScoreScreen )
 //	if(shellGame)
 
 
-	if (TheGlobalData->m_initialFile.isEmpty() == FALSE)
+	if (TheGlobalData->m_initialFile.isEmpty() == FALSE || m_quitToDesktopAfterMatch)
 	{
 		TheGameEngine->setQuitting(TRUE);
+		m_quitToDesktopAfterMatch = FALSE;
 	}
 
 	HideControlBar();