[GEN][ZH] Implement new GUI error dialogs when attempting to load a Replay that was deleted or whose map is missing (#992)

Co-authored-by: Helmut Buhler <buhler@8gadgetpack.net>

Author: xezon

Core/GameEngine/Include/Common/GameDefines.h

@@ -28,3 +28,7 @@
 #ifndef RETAIL_COMPATIBLE_XFER_SAVE
 #define RETAIL_COMPATIBLE_XFER_SAVE (1) // Game is expected to be Xfer Save compatible with retail Generals 1.08, Zero Hour 1.04
 #endif
+
+#ifndef ENABLE_GAMETEXT_SUBSTITUTES
+#define ENABLE_GAMETEXT_SUBSTITUTES (1) // The code can provide substitute texts when labels and strings are missing in the STR or CSF translation file
+#endif

Generals/Code/GameEngine/Include/GameClient/GameText.h

@@ -78,6 +78,10 @@ class GameTextInterface : public SubsystemInterface
 
 		virtual UnicodeString fetch( const Char *label, Bool *exists = NULL ) = 0;		///< Returns the associated labeled unicode text
 		virtual UnicodeString fetch( AsciiString label, Bool *exists = NULL ) = 0;		///< Returns the associated labeled unicode text
+
+		// Do not call this directly, but use the FETCH_OR_SUBSTITUTE macro
+		virtual UnicodeString fetchOrSubstitute( const Char *label, const WideChar *substituteText ) = 0;
+
 		// This function is not performance tuned.. Its really only for Worldbuilder. jkmcd
 		virtual AsciiStringVec& getStringsWithLabelPrefix(AsciiString label) = 0;
 
@@ -92,5 +96,14 @@ extern GameTextInterface* CreateGameTextInterface( void );
 //           Inlining                                                       
 //----------------------------------------------------------------------------
 
+// TheSuperHackers @info This is meant to be used like:
+// TheGameText->FETCH_OR_SUBSTITUTE("GUI:LabelName", L"Substitute Fallback Text")
+// The substitute text will be compiled out if ENABLE_GAMETEXT_SUBSTITUTES is not defined.
+#if ENABLE_GAMETEXT_SUBSTITUTES
+#define FETCH_OR_SUBSTITUTE(labelA, substituteTextW) fetchOrSubstitute(labelA, substituteTextW)
+#else
+#define FETCH_OR_SUBSTITUTE(labelA, substituteTextW) fetch(labelA)
+#endif
+
 
 #endif // __GAMECLIENT_GAMETEXT_H_

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/ReplayMenu.cpp

@@ -491,8 +491,32 @@ static void loadReplay(UnicodeString filename)
 	AsciiString asciiFilename;
 	asciiFilename.translate(filename);
 
-	if(!TheRecorder->replayMatchesGameVersion(asciiFilename))
+	RecorderClass::ReplayHeader header;
+	ReplayGameInfo info;
+	const MapMetaData *mapData;
+
+	if(!readReplayMapInfo(asciiFilename, header, info, mapData))
+	{
+		// TheSuperHackers @bugfix Prompts a message box when the replay was deleted by the user while the Replay Menu was opened.
+
+		UnicodeString title = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayFileNotFoundTitle", L"REPLAY NOT FOUND");
+		UnicodeString body = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayFileNotFound", L"This replay cannot be loaded because the file no longer exists on this device.");
+
+		MessageBoxOk(title, body, NULL);
+	}
+	else if(mapData == NULL)
 	{
+		// TheSuperHackers @bugfix Prompts a message box when the map used by the replay was not found.
+
+		UnicodeString title = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayMapNotFoundTitle", L"MAP NOT FOUND");
+		UnicodeString body = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayMapNotFound", L"This replay cannot be loaded because the map was not found on this device.");
+
+		MessageBoxOk(title, body, NULL);
+	}
+	else if(!TheRecorder->replayMatchesGameVersion(header))
+	{
+		// Pressing OK loads the replay.
+
 		MessageBoxOkCancel(TheGameText->fetch("GUI:OlderReplayVersionTitle"), TheGameText->fetch("GUI:OlderReplayVersion"), reallyLoadReplay, NULL);
 	}
 	else

Generals/Code/GameEngine/Source/GameClient/GameText.cpp

@@ -152,6 +152,8 @@ class GameTextManager : public GameTextInterface
 
 		virtual UnicodeString fetch( const Char *label, Bool *exists = NULL );		///< Returns the associated labeled unicode text
 		virtual UnicodeString fetch( AsciiString label, Bool *exists = NULL );		///< Returns the associated labeled unicode text
+		virtual UnicodeString fetchOrSubstitute( const Char *label, const WideChar *substituteText );
+
 		virtual AsciiStringVec& getStringsWithLabelPrefix(AsciiString label);
 
 		virtual void					initMapStringFile( const AsciiString& filename );
@@ -1341,6 +1343,19 @@ UnicodeString GameTextManager::fetch( AsciiString label, Bool *exists )
 	return fetch(label.str(), exists);
 }
 
+//============================================================================
+// GameTextManager::fetchOrSubstitute
+//============================================================================
+
+UnicodeString GameTextManager::fetchOrSubstitute( const Char *label, const WideChar *substituteText )
+{
+	Bool exists;
+	UnicodeString str = fetch(label, &exists);
+	if (!exists)
+		str = substituteText;
+	return str;
+}
+
 //============================================================================
 // GameTextManager::getStringsWithLabelPrefix
 //============================================================================

GeneralsMD/Code/GameEngine/Include/GameClient/GameText.h

@@ -78,6 +78,10 @@ class GameTextInterface : public SubsystemInterface
 
 		virtual UnicodeString fetch( const Char *label, Bool *exists = NULL ) = 0;		///< Returns the associated labeled unicode text
 		virtual UnicodeString fetch( AsciiString label, Bool *exists = NULL ) = 0;		///< Returns the associated labeled unicode text
+
+		// Do not call this directly, but use the FETCH_OR_SUBSTITUTE macro
+		virtual UnicodeString fetchOrSubstitute( const Char *label, const WideChar *substituteText ) = 0;
+
 		// This function is not performance tuned.. Its really only for Worldbuilder. jkmcd
 		virtual AsciiStringVec& getStringsWithLabelPrefix(AsciiString label) = 0;
 
@@ -92,5 +96,14 @@ extern GameTextInterface* CreateGameTextInterface( void );
 //           Inlining                                                       
 //----------------------------------------------------------------------------
 
+// TheSuperHackers @info This is meant to be used like:
+// TheGameText->FETCH_OR_SUBSTITUTE("GUI:LabelName", L"Substitute Fallback Text")
+// The substitute text will be compiled out if ENABLE_GAMETEXT_SUBSTITUTES is not defined.
+#if ENABLE_GAMETEXT_SUBSTITUTES
+#define FETCH_OR_SUBSTITUTE(labelA, substituteTextW) fetchOrSubstitute(labelA, substituteTextW)
+#else
+#define FETCH_OR_SUBSTITUTE(labelA, substituteTextW) fetch(labelA)
+#endif
+
 
 #endif // __GAMECLIENT_GAMETEXT_H_

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

@@ -491,8 +491,32 @@ static void loadReplay(UnicodeString filename)
 	AsciiString asciiFilename;
 	asciiFilename.translate(filename);
 
-	if(!TheRecorder->replayMatchesGameVersion(asciiFilename))
+	RecorderClass::ReplayHeader header;
+	ReplayGameInfo info;
+	const MapMetaData *mapData;
+
+	if(!readReplayMapInfo(asciiFilename, header, info, mapData))
+	{
+		// TheSuperHackers @bugfix Prompts a message box when the replay was deleted by the user while the Replay Menu was opened.
+
+		UnicodeString title = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayFileNotFoundTitle", L"REPLAY NOT FOUND");
+		UnicodeString body = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayFileNotFound", L"This replay cannot be loaded because the file no longer exists on this device.");
+
+		MessageBoxOk(title, body, NULL);
+	}
+	else if(mapData == NULL)
 	{
+		// TheSuperHackers @bugfix Prompts a message box when the map used by the replay was not found.
+
+		UnicodeString title = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayMapNotFoundTitle", L"MAP NOT FOUND");
+		UnicodeString body = TheGameText->FETCH_OR_SUBSTITUTE("GUI:ReplayMapNotFound", L"This replay cannot be loaded because the map was not found on this device.");
+
+		MessageBoxOk(title, body, NULL);
+	}
+	else if(!TheRecorder->replayMatchesGameVersion(header))
+	{
+		// Pressing OK loads the replay.
+
 		MessageBoxOkCancel(TheGameText->fetch("GUI:OlderReplayVersionTitle"), TheGameText->fetch("GUI:OlderReplayVersion"), reallyLoadReplay, NULL);
 	}
 	else

GeneralsMD/Code/GameEngine/Source/GameClient/GameText.cpp

@@ -152,6 +152,8 @@ class GameTextManager : public GameTextInterface
 
 		virtual UnicodeString fetch( const Char *label, Bool *exists = NULL );		///< Returns the associated labeled unicode text
 		virtual UnicodeString fetch( AsciiString label, Bool *exists = NULL );		///< Returns the associated labeled unicode text
+		virtual UnicodeString fetchOrSubstitute( const Char *label, const WideChar *substituteText );
+
 		virtual AsciiStringVec& getStringsWithLabelPrefix(AsciiString label);
 
 		virtual void					initMapStringFile( const AsciiString& filename );
@@ -1341,6 +1343,19 @@ UnicodeString GameTextManager::fetch( AsciiString label, Bool *exists )
 	return fetch(label.str(), exists);
 }
 
+//============================================================================
+// GameTextManager::fetchOrSubstitute
+//============================================================================
+
+UnicodeString GameTextManager::fetchOrSubstitute( const Char *label, const WideChar *substituteText )
+{
+	Bool exists;
+	UnicodeString str = fetch(label, &exists);
+	if (!exists)
+		str = substituteText;
+	return str;
+}
+
 //============================================================================
 // GameTextManager::getStringsWithLabelPrefix
 //============================================================================