Refactor Debug::Log to call LogGame with formatted message

Author: Belonit

src/CnCNetYR/Misc.cpp

@@ -32,7 +32,7 @@ DEFINE_JUMP(LJMP, 0x69A797, 0x69A937);
 void __fastcall IDTooLong(char* id)
 {
 	if (strlen(id) > 24)
-		Debug::Log("[Developer error] Tried to create a type with ID '%s' which is longer than the maximum length of 24.\n", id);
+		Debug::LogGame("[Developer error] Tried to create a type with ID '%s' which is longer than the maximum length of 24.\n", id);
 }
 
 DEFINE_NAKED_HOOK(0x41088D, AbstractTypeClass_CTOR_IDTooLong)

src/Misc/NoCD.cpp

@@ -90,7 +90,7 @@ DEFINE_HOOK(0x6BD7CB, WinMain_NoCDPatches, 0x5)
 	}
 	else if (!GetCDClass::Instance.Count)
 	{
-		Debug::Log("[Spawner] No CD drives detected. Switching to NoCD mode.\n");
+		Debug::Log("No CD drives detected. Switching to NoCD mode.\n");
 		ApplyNoCDPatches();
 	}
 

src/Misc/SavedGamesInSubdir.cpp

@@ -30,13 +30,14 @@ namespace SavedGames
 	{
 		if (!std::filesystem::exists(Spawner::GetConfig()->SavedGameDir))
 		{
-			Debug::Log("\n[Spawner] Folder Saved Games does not exist, creating...\n");
+			Debug::LogGame("\n");
+			Debug::Log("Folder Saved Games does not exist, creating...\n");
 			if (!std::filesystem::create_directories(Spawner::GetConfig()->SavedGameDir))
 			{
-				Debug::Log("\tCannot create folder Saved Games!\n");
+				Debug::LogGame("\tCannot create folder Saved Games!\n");
 				return false;
 			}
-			Debug::Log("\tDone.\n");
+			Debug::LogGame("\tDone.\n");
 		}
 		return true;
 	}

src/Spawner/ProtocolZero.Hook.cpp

@@ -105,7 +105,7 @@ DEFINE_HOOK(0x647E6B, QueueAIMultiplayer__ProtocolZero_SetTiming, 0x5)
 		GET(int, NewRetryDelta, EBP);
 		GET(int, NewRetryTimeout, EAX);
 
-		Debug::Log("[Spawner] NewRetryDelta = %d, NewRetryTimeout = %d, FrameSendRate = %d, CurentLatencyLevel = %d\n"
+		Debug::Log("NewRetryDelta = %d, NewRetryTimeout = %d, FrameSendRate = %d, CurentLatencyLevel = %d\n"
 			, NewRetryDelta
 			, NewRetryTimeout
 			, (int)Game::Network::FrameSendRate

src/Spawner/ProtocolZero.LatencyLevel.cpp

@@ -40,7 +40,7 @@ void LatencyLevel::Apply(LatencyLevelEnum newLatencyLevel)
 	if (newLatencyLevel <= CurentLatencyLevel)
 		return;
 
-	Debug::Log("[Spawner] Player %ls, Loss mode (%d, %d) Frame = %d\n"
+	Debug::Log("Player %ls, Loss mode (%d, %d) Frame = %d\n"
 		, HouseClass::CurrentPlayer->UIName
 		, newLatencyLevel
 		, CurentLatencyLevel

src/Spawner/ProtocolZero.cpp

@@ -62,7 +62,7 @@ void ProtocolZero::SendResponseTime2()
 	if (event.AddEvent())
 	{
 		ProtocolZero::NextSendFrame = currentFrame + ProtocolZero::SendResponseTimeInterval;
-		Debug::Log("[Spawner] Player %d sending response time of %d, LatencyMode = %d, Frame = %d\n"
+		Debug::Log("Player %d sending response time of %d, LatencyMode = %d, Frame = %d\n"
 			, event.HouseIndex
 			, event.ResponseTime2.MaxAhead
 			, event.ResponseTime2.LatencyLevel
@@ -82,7 +82,7 @@ void ProtocolZero::HandleResponseTime2(EventExt* event)
 
 	if (event->ResponseTime2.MaxAhead == 0)
 	{
-		Debug::Log("[Spawner] Returning because event->MaxAhead == 0\n");
+		Debug::Log("Returning because event->MaxAhead == 0\n");
 		return;
 	}
 

src/Spawner/Spawner.Hook.cpp

@@ -148,7 +148,7 @@ DEFINE_HOOK(0x4FC551, HouseClass__MPlayerDefeated_NoEnemies, 0x5)
 
 		if ((pHouse->IsHumanPlayer || Spawner::GetConfig()->ContinueWithoutHumans) && pHouse->IsMutualAlly(MPlayerDefeated::pThis))
 		{
-			Debug::Log("[Spawner] MPlayer_Defeated() - Defeated player has a living ally");
+			Debug::Log("MPlayer_Defeated() - Defeated player has a living ally");
 			if (Spawner::GetConfig()->DefeatedBecomesObserver)
 				MPlayerDefeated::pThis->MakeObserver();
 

src/Spawner/Spawner.cpp

@@ -176,7 +176,7 @@ bool Spawner::StartScenario(const char* pScenarioName)
 {
 	if (pScenarioName[0] == 0 && !Config->LoadSaveGame)
 	{
-		Debug::Log("[Spawner] Failed Read Scenario [%s]\n", pScenarioName);
+		Debug::Log("Failed Read Scenario [%s]\n", pScenarioName);
 
 		WWMessageBox::Instance.Process(
 			StringTable::LoadString(GameStrings::TXT_UNABLE_READ_SCENARIO),
@@ -360,7 +360,7 @@ bool Spawner::LoadSavedGame(const char* saveGameName)
 {
 	if (!saveGameName[0] || !LoadOptionsClass::LoadMission(saveGameName))
 	{
-		Debug::Log("[Spawner] Failed Load Game [%s]\n", saveGameName);
+		Debug::Log("Failed Load Game [%s]\n", saveGameName);
 
 		WWMessageBox::Instance.Process(
 			StringTable::LoadString(GameStrings::TXT_ERROR_LOADING_GAME),

src/Spawner/Statistics.cpp

@@ -221,7 +221,7 @@ DEFINE_HOOK(0x647AE8, QueueAIMultiplayer_SendStatistics_1, 0x7)
 
 DEFINE_HOOK(0x64823C, QueueAIMultiplayer_SendStatistics_2, 0x5)
 {
-	Debug::Log(reinterpret_cast<char*>(0x8373BC) /* "Failure executing DoList\n" */);
+	Debug::LogGame(reinterpret_cast<char*>(0x8373BC) /* "Failure executing DoList\n" */);
 
 	enum { Send = 0x648257, DontSend = 0x64825C };
 

src/Utilities/Debug.cpp

@@ -25,10 +25,17 @@
 #include <MessageListClass.h>
 #include <Utilities/Macro.h>
 
-
 char Debug::StringBuffer[0x1000];
 
 void Debug::Log(const char* pFormat, ...)
+{
+	va_list args;
+	Debug::LogGame("[Spawner] ");
+	Debug::LogGame(pFormat, args);
+	va_end(args);
+}
+
+void Debug::LogGame(const char* pFormat, ...)
 {
 	JMP_STD(0x4068E0);
 }
@@ -38,7 +45,7 @@ void Debug::LogAndMessage(const char* pFormat, ...)
 	va_list args;
 	va_start(args, pFormat);
 	vsprintf_s(StringBuffer, pFormat, args);
-	Log("%s", StringBuffer);
+	Debug::Log("%s", StringBuffer);
 	va_end(args);
 	wchar_t buffer[0x1000];
 	CRT::mbstowcs(buffer, StringBuffer, 0x1000);
@@ -48,7 +55,7 @@ void Debug::LogAndMessage(const char* pFormat, ...)
 void Debug::LogWithVArgs(const char* pFormat, va_list args)
 {
 	vsprintf_s(StringBuffer, pFormat, args);
-	Log("%s", StringBuffer);
+	Debug::Log("%s", StringBuffer);
 }
 
 void Debug::INIParseFailed(const char* section, const char* flag, const char* value, const char* Message)
@@ -65,7 +72,7 @@ void Debug::FatalErrorAndExit(const char* pFormat, ...)
 {
 	va_list args;
 	va_start(args, pFormat);
-	LogWithVArgs(pFormat, args);
+	Debug::LogWithVArgs(pFormat, args);
 	va_end(args);
 	FatalExit(static_cast<int>(ExitCode::Undefined));
 }
@@ -74,7 +81,7 @@ void Debug::FatalErrorAndExit(ExitCode nExitCode, const char* pFormat, ...)
 {
 	va_list args;
 	va_start(args, pFormat);
-	LogWithVArgs(pFormat, args);
+	Debug::LogWithVArgs(pFormat, args);
 	va_end(args);
 	FatalExit(static_cast<int>(nExitCode));
 }