[GEN][ZH] Fix crash when DEBUG_CRASHING is enabled and loading a replay with unicode characters (#824)

helmutbuhler · web-flow · commit 7fff044400a5 · 2025-05-09T23:26:37.000+02:00
diff --git a/Generals/Code/GameEngine/Source/Common/Recorder.cpp b/Generals/Code/GameEngine/Source/Common/Recorder.cpp
@@ -1099,8 +1099,8 @@ Bool RecorderClass::playbackFile(AsciiString filename)
 	{
 		return FALSE;
 	}
-#ifdef DEBUG_LOGGING
 
+#ifdef DEBUG_CRASHING
 	Bool versionStringDiff = header.versionString != TheVersion->getUnicodeVersion();
 	Bool versionTimeStringDiff = header.versionTimeString != TheVersion->getUnicodeBuildTime();
 	Bool versionNumberDiff = header.versionNumber != TheVersion->getVersionNumber();
@@ -1112,15 +1112,20 @@ Bool RecorderClass::playbackFile(AsciiString filename)
 	AsciiString tempStr;
 	if (exeDifferent)
 	{
+		// TheSuperHackers @fix helmutbuhler 05/05/2025 No longer attempts to print unicode as ascii
+		// via a call to AsciiString::format with %ls format. It does not work with non-ascii characters.
+		UnicodeString tempStrWide;
 		debugString = "EXE is different:\n";
 		if (versionStringDiff)
 		{
-			tempStr.format("   Version [%ls] vs [%ls]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());
+			tempStrWide.format(L"   Version [%s] vs [%s]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());
+			tempStr.translate(tempStrWide);
 			debugString.concat(tempStr);
 		}
 		if (versionTimeStringDiff)
 		{
-			tempStr.format("   Build Time [%ls] vs [%ls]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());
+			tempStrWide.format(L"   Build Time [%s] vs [%s]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());
+			tempStr.translate(tempStrWide);
 			debugString.concat(tempStr);
 		}
 		if (versionNumberDiff)
diff --git a/GeneralsMD/Code/GameEngine/Source/Common/Recorder.cpp b/GeneralsMD/Code/GameEngine/Source/Common/Recorder.cpp
@@ -1102,8 +1102,8 @@ Bool RecorderClass::playbackFile(AsciiString filename)
 	{
 		return FALSE;
 	}
-#ifdef DEBUG_LOGGING
 
+#ifdef DEBUG_CRASHING
 	Bool versionStringDiff = header.versionString != TheVersion->getUnicodeVersion();
 	Bool versionTimeStringDiff = header.versionTimeString != TheVersion->getUnicodeBuildTime();
 	Bool versionNumberDiff = header.versionNumber != TheVersion->getVersionNumber();
@@ -1115,15 +1115,20 @@ Bool RecorderClass::playbackFile(AsciiString filename)
 	AsciiString tempStr;
 	if (exeDifferent)
 	{
+		// TheSuperHackers @fix helmutbuhler 05/05/2025 No longer attempts to print unicode as ascii
+		// via a call to AsciiString::format with %ls format. It does not work with non-ascii characters.
+		UnicodeString tempStrWide;
 		debugString = "EXE is different:\n";
 		if (versionStringDiff)
 		{
-			tempStr.format("   Version [%ls] vs [%ls]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());
+			tempStrWide.format(L"   Version [%s] vs [%s]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());
+			tempStr.translate(tempStrWide);
 			debugString.concat(tempStr);
 		}
 		if (versionTimeStringDiff)
 		{
-			tempStr.format("   Build Time [%ls] vs [%ls]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());
+			tempStrWide.format(L"   Build Time [%s] vs [%s]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());
+			tempStr.translate(tempStrWide);
 			debugString.concat(tempStr);
 		}
 		if (versionNumberDiff)

Original file line number	Diff line number	Diff line change
`@@ -1099,8 +1099,8 @@ Bool RecorderClass::playbackFile(AsciiString filename)`
`1099`	`1099`	`{`
`1100`	`1100`	`return FALSE;`
`1101`	`1101`	`}`
`1102`		`-#ifdef DEBUG_LOGGING`
`1103`	`1102`
	`1103`	`+#ifdef DEBUG_CRASHING`
`1104`	`1104`	`Bool versionStringDiff = header.versionString != TheVersion->getUnicodeVersion();`
`1105`	`1105`	`Bool versionTimeStringDiff = header.versionTimeString != TheVersion->getUnicodeBuildTime();`
`1106`	`1106`	`Bool versionNumberDiff = header.versionNumber != TheVersion->getVersionNumber();`
`@@ -1112,15 +1112,20 @@ Bool RecorderClass::playbackFile(AsciiString filename)`
`1112`	`1112`	`AsciiString tempStr;`
`1113`	`1113`	`if (exeDifferent)`
`1114`	`1114`	`{`
	`1115`	`+ // TheSuperHackers @fix helmutbuhler 05/05/2025 No longer attempts to print unicode as ascii`
	`1116`	`+ // via a call to AsciiString::format with %ls format. It does not work with non-ascii characters.`
	`1117`	`+ UnicodeString tempStrWide;`
`1115`	`1118`	`debugString = "EXE is different:\n";`
`1116`	`1119`	`if (versionStringDiff)`
`1117`	`1120`	`{`
`1118`		`- tempStr.format(" Version [%ls] vs [%ls]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());`
	`1121`	`+ tempStrWide.format(L" Version [%s] vs [%s]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());`
	`1122`	`+ tempStr.translate(tempStrWide);`
`1119`	`1123`	`debugString.concat(tempStr);`
`1120`	`1124`	`}`
`1121`	`1125`	`if (versionTimeStringDiff)`
`1122`	`1126`	`{`
`1123`		`- tempStr.format(" Build Time [%ls] vs [%ls]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());`
	`1127`	`+ tempStrWide.format(L" Build Time [%s] vs [%s]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());`
	`1128`	`+ tempStr.translate(tempStrWide);`
`1124`	`1129`	`debugString.concat(tempStr);`
`1125`	`1130`	`}`
`1126`	`1131`	`if (versionNumberDiff)`
Original file line number	Diff line number	Diff line change
`@@ -1102,8 +1102,8 @@ Bool RecorderClass::playbackFile(AsciiString filename)`
`1102`	`1102`	`{`
`1103`	`1103`	`return FALSE;`
`1104`	`1104`	`}`
`1105`		`-#ifdef DEBUG_LOGGING`
`1106`	`1105`
	`1106`	`+#ifdef DEBUG_CRASHING`
`1107`	`1107`	`Bool versionStringDiff = header.versionString != TheVersion->getUnicodeVersion();`
`1108`	`1108`	`Bool versionTimeStringDiff = header.versionTimeString != TheVersion->getUnicodeBuildTime();`
`1109`	`1109`	`Bool versionNumberDiff = header.versionNumber != TheVersion->getVersionNumber();`
`@@ -1115,15 +1115,20 @@ Bool RecorderClass::playbackFile(AsciiString filename)`
`1115`	`1115`	`AsciiString tempStr;`
`1116`	`1116`	`if (exeDifferent)`
`1117`	`1117`	`{`
	`1118`	`+ // TheSuperHackers @fix helmutbuhler 05/05/2025 No longer attempts to print unicode as ascii`
	`1119`	`+ // via a call to AsciiString::format with %ls format. It does not work with non-ascii characters.`
	`1120`	`+ UnicodeString tempStrWide;`
`1118`	`1121`	`debugString = "EXE is different:\n";`
`1119`	`1122`	`if (versionStringDiff)`
`1120`	`1123`	`{`
`1121`		`- tempStr.format(" Version [%ls] vs [%ls]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());`
	`1124`	`+ tempStrWide.format(L" Version [%s] vs [%s]\n", TheVersion->getUnicodeVersion().str(), header.versionString.str());`
	`1125`	`+ tempStr.translate(tempStrWide);`
`1122`	`1126`	`debugString.concat(tempStr);`
`1123`	`1127`	`}`
`1124`	`1128`	`if (versionTimeStringDiff)`
`1125`	`1129`	`{`
`1126`		`- tempStr.format(" Build Time [%ls] vs [%ls]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());`
	`1130`	`+ tempStrWide.format(L" Build Time [%s] vs [%s]\n", TheVersion->getUnicodeBuildTime().str(), header.versionTimeString.str());`
	`1131`	`+ tempStr.translate(tempStrWide);`
`1127`	`1132`	`debugString.concat(tempStr);`
`1128`	`1133`	`}`
`1129`	`1134`	`if (versionNumberDiff)`