[CMAKE][ZH] Fix compile errors and add cmake options for DEBUG_LOGGING, DEBUG_CRASHING, DEBUG_STACKTRACE, DEBUG_PROFILE (TheSuperHackers#667)

Author: xezon

Core/Libraries/Source/Compression/CompressionManager.cpp

@@ -37,6 +37,7 @@ extern "C" {
 //#pragma message("************************************** WARNING, optimization disabled for debugging purposes")
 #endif
 
+// TheSuperHackers @todo Recover debug logging in this file?
 #define DEBUG_LOG(x) {}
 
 const char *CompressionManager::getCompressionNameByType( CompressionType compType )
@@ -328,10 +329,6 @@ Int CompressionManager::decompressData( void *srcVoid, Int srcLen, void *destVoi
 
 	if (compType >= COMPRESSION_ZLIB1 && compType <= COMPRESSION_ZLIB9)
 	{
-#ifdef DEBUG_LOGGING
-		Int level = compType - COMPRESSION_ZLIB1 + 1; // 1-9
-#endif
-
 		unsigned long outLen = destLen;
 		Int err = z_uncompress(dest, &outLen, src+8, srcLen-8);
 		if (err == Z_OK || err == Z_STREAM_END)
@@ -340,7 +337,8 @@ Int CompressionManager::decompressData( void *srcVoid, Int srcLen, void *destVoi
 		}
 		else
 		{
-			DEBUG_LOG(("ZLib decompression error (src is level %d, %d bytes long) %d\n", level, srcLen, err));
+			DEBUG_LOG(("ZLib decompression error (src is level %d, %d bytes long) %d\n",
+				compType - COMPRESSION_ZLIB1 + 1 /* 1-9 */, srcLen, err));
 			return 0;
 		}
 	}

Generals/Code/GameEngine/Include/Common/Debug.h

@@ -66,6 +66,9 @@ class AsciiString;
 // by default, turn on ALLOW_DEBUG_UTILS if _DEBUG is turned on.
 #if (defined(_DEBUG) || defined(_INTERNAL)) && !defined(ALLOW_DEBUG_UTILS) && !defined(DISABLE_ALLOW_DEBUG_UTILS)
 	#define ALLOW_DEBUG_UTILS 1
+#elif defined(DEBUG_LOGGING) || defined(DEBUG_CRASHING) || defined(DEBUG_STACKTRACE) || defined(DEBUG_PROFILE)
+	// TheSuperHackers @tweak also turn on when any of the above options is already set.
+	#define ALLOW_DEBUG_UTILS 1
 #endif
 
 // these are predicated on ALLOW_DEBUG_UTILS, not _DEBUG, and allow you to selectively disable
@@ -76,10 +79,11 @@ class AsciiString;
 #if defined(ALLOW_DEBUG_UTILS) && !defined(DEBUG_CRASHING) && !defined(DISABLE_DEBUG_CRASHING)
 	#define DEBUG_CRASHING 1
 #endif
-
-// BGC - added the DEBUG_LOGGING term...doesn't make sense to do stack debugging without a debug log to print to.
-#if defined(ALLOW_DEBUG_UTILS) && !defined(DEBUG_STACKTRACE) && !defined(DISABLE_DEBUG_STACKTRACE) && defined(DEBUG_LOGGING)
+#if defined(ALLOW_DEBUG_UTILS) && !defined(DEBUG_STACKTRACE) && !defined(DISABLE_DEBUG_STACKTRACE)
 	#define DEBUG_STACKTRACE 1
+	#ifndef DEBUG_LOGGING
+		#define DEBUG_LOGGING 1 // TheSuperHackers @compile Stack trace requires logging.
+	#endif
 #endif
 #if defined(ALLOW_DEBUG_UTILS) && !defined(DEBUG_PROFILE) && !defined(DISABLE_DEBUG_PROFILE)
 	#define DEBUG_PROFILE 1

Generals/Code/GameEngine/Include/Common/GlobalData.h

@@ -469,8 +469,6 @@ class GlobalData : public SubsystemInterface
 	Real m_debugProjectileTileWidth;			///< How wide should these tiles be?
 	Int m_debugProjectileTileDuration;		///< How long should these tiles stay around, in frames?
 	RGBColor m_debugProjectileTileColor;	///< What color should these tiles be?
-	Bool m_debugIgnoreAsserts;						///< Ignore all asserts.
-	Bool m_debugIgnoreStackTrace;					///< No stacktraces for asserts.
 	Bool m_showCollisionExtents;	///< Used to display collision extents
 	Bool m_saveStats;
 	Bool m_saveAllStats;
@@ -484,6 +482,14 @@ class GlobalData : public SubsystemInterface
 	Int m_packetLoss;							///< Percent of packets to drop
 #endif
 
+#ifdef DEBUG_CRASHING
+	Bool m_debugIgnoreAsserts;						///< Ignore all asserts.
+#endif
+
+#ifdef DEBUG_STACKTRACE
+	Bool m_debugIgnoreStackTrace;					///< No stacktraces for asserts.
+#endif
+
 	Bool				m_isBreakableMovie;							///< if we enter a breakable movie, set this flag
 	Bool				m_breakTheMovie;								///< The user has hit escape!
 

Generals/Code/GameEngine/Include/Common/INI.h

@@ -399,7 +399,7 @@ class INI
 	const char *m_sepsQuote;									///< token to represent a quoted ascii string
 	const char *m_blockEndToken;							///< token to represent end of data block
 	Bool m_endOfFile;													///< TRUE when we've hit EOF
-#if defined(_DEBUG) || defined(_INTERNAL)
+#ifdef DEBUG_CRASHING
 	char m_curBlockStart[ INI_MAX_CHARS_PER_LINE ];	///< first line of cur block
 #endif
 };

Generals/Code/GameEngine/Include/GameLogic/Module/AIUpdate.h

@@ -629,7 +629,7 @@ class AIUpdateInterface : public UpdateModule, public AICommandInterface
 
 	// this is intended for use ONLY by AIFollowPathState.
 	inline void friend_setCurrentGoalPathIndex( Int index ) { m_nextGoalPathIndex = index; }
-#if defined(_DEBUG) || defined(_INTERNAL)	
+#ifdef DEBUG_LOGGING
 	inline const Coord3D *friend_getRequestedDestination() const { return &m_requestedDestination; }
 	inline const Coord3D *friend_getRequestedDestination2() const { return &m_requestedDestination2; }
 #endif

Generals/Code/GameEngine/Include/GameNetwork/udp.h

@@ -124,6 +124,8 @@ class UDP
 	Int						AllowBroadcasts(Bool status);
 };
 
+#ifdef DEBUG_LOGGING
 AsciiString GetWSAErrorString( Int error );
+#endif
 
 #endif

Generals/Code/GameEngine/Source/Common/CommandLine.cpp

@@ -32,6 +32,7 @@
 #include "Common/version.h"
 #include "GameClient/TerrainVisual.h" // for TERRAIN_LOD_MIN definition
 #include "GameClient/GameText.h"
+#include "GameNetwork/NetworkDefs.h"
 
 Bool TheDebugIgnoreSyncErrors = FALSE;
 extern Int DX8Wrapper_PreserveFPU;
@@ -103,9 +104,7 @@ static void ConvertShortMapPathToLongMapPath(AsciiString &mapName)
 //=============================================================================
 Int parseNoLogOrCrash(char *args[], int)
 {
-#ifdef ALLOW_DEBUG_UTILS
 	DEBUG_CRASH(("-NoLogOrCrash not supported in this build\n"));
-#endif
 	return 1;
 }
 
@@ -325,7 +324,9 @@ Int parseNoDraw(char *args[], int argc)
 //=============================================================================
 Int parseLogToConsole(char *args[], int)
 {
+#ifdef ALLOW_DEBUG_UTILS
 	DebugSetFlags(DebugGetFlags() | DEBUG_FLAG_LOG_TO_CONSOLE);
+#endif
 	return 1;
 }
 
@@ -950,7 +951,7 @@ Int parseBenchmark(char *args[], int num)
 }
 #endif
 
-#if defined(_DEBUG) || defined(_INTERNAL)
+#ifdef DEBUG_CRASHING
 Int parseIgnoreAsserts(char *args[], int num)
 {
 	if (TheWritableGlobalData && num > 0)
@@ -961,7 +962,7 @@ Int parseIgnoreAsserts(char *args[], int num)
 }
 #endif
 
-#if defined(_DEBUG) || defined(_INTERNAL)
+#ifdef DEBUG_STACKTRACE
 Int parseIgnoreStackTrace(char *args[], int num)
 {
 	if (TheWritableGlobalData && num > 0)
@@ -1058,7 +1059,7 @@ Int parseMod(char *args[], Int num)
 	return 1;
 }
 
-#if defined(_DEBUG) || defined(_INTERNAL)
+#ifdef DEBUG_LOGGING
 Int parseSetDebugLevel(char *args[], int num)
 {
 	if (num > 1)
@@ -1113,7 +1114,6 @@ static CommandLineParam params[] =
 	{ "-novideo", parseNoVideo },
 	{ "-noLogOrCrash", parseNoLogOrCrash },
 	{ "-FPUPreserve", parseFPUPreserve },
-#if defined(_DEBUG) || defined(_INTERNAL)
 	{ "-benchmark", parseBenchmark },
 	{ "-saveStats", parseSaveStats },
 	{ "-localMOTD", parseLocalMOTD },
@@ -1161,16 +1161,11 @@ static CommandLineParam params[] =
 	{ "-netMinPlayers", parseNetMinPlayers },
 	{ "-DemoLoadScreen", parseDemoLoadScreen },
 	{ "-cameraDebug", parseCameraDebug },
-	{ "-ignoreAsserts", parseIgnoreAsserts },
-	{ "-ignoreStackTrace", parseIgnoreStackTrace },
 	{ "-logToCon", parseLogToConsole },
 	{ "-vTune", parseVTune },
 	{ "-selectTheUnselectable", parseSelectAll },
 	{ "-RunAhead", parseRunAhead },
 	{ "-noshroud", parseNoShroud },
-	{ "-setDebugLevel", parseSetDebugLevel },
-	{ "-clearDebugLevel", parseClearDebugLevel },
-#endif
 	{ "-forceBenchmark", parseForceBenchmark },
 	{ "-buildmapcache", parseBuildMapCache },
 	{ "-noshadowvolumes", parseNoShadows },
@@ -1190,6 +1185,19 @@ static CommandLineParam params[] =
 	{ "-updateImages", parseUpdateImages },
 	{ "-showTeamDot", parseShowTeamDot },
 #endif
+
+#ifdef DEBUG_LOGGING
+	{ "-setDebugLevel", parseSetDebugLevel },
+	{ "-clearDebugLevel", parseClearDebugLevel },
+#endif
+
+#ifdef DEBUG_CRASHING
+	{ "-ignoreAsserts", parseIgnoreAsserts },
+#endif
+
+#ifdef DEBUG_STACKTRACE
+	{ "-ignoreStackTrace", parseIgnoreStackTrace },
+#endif
 };
 
 // parseCommandLine ===========================================================

Generals/Code/GameEngine/Source/Common/GameEngine.cpp

@@ -262,7 +262,7 @@ void GameEngine::init( int argc, char *argv[] )
 	#elif defined _INTERNAL
 			const char *buildType = "Internal";
 	#else
-	//	const char *buildType = "Release";
+			const char *buildType = "Release";
 	#endif
 #endif // DEBUG_LOGGING
 			DEBUG_LOG(("Generals version %s (%s)\n", TheVersion->getAsciiVersion().str(), buildType));

Generals/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -564,8 +564,6 @@ GlobalData::GlobalData()
 	m_debugCashValueMap = FALSE;
 	m_maxDebugValue = 10000;
 	m_debugCashValueMapTileDuration = LOGICFRAMES_PER_SECOND; // Changed By Sadullah Nader
-	m_debugIgnoreAsserts = FALSE;
-	m_debugIgnoreStackTrace = FALSE;
 	m_vTune = false;
 	m_checkForLeaks = TRUE;
 	m_benchmarkTimer = -1;
@@ -585,6 +583,14 @@ GlobalData::GlobalData()
 	m_MOTDPath = "MOTD.txt";
 #endif
 
+#ifdef DEBUG_CRASHING
+	m_debugIgnoreAsserts = FALSE;
+#endif
+
+#ifdef DEBUG_STACKTRACE
+	m_debugIgnoreStackTrace = FALSE;
+#endif
+
 	m_playStats = -1;
 	m_incrementalAGPBuf = FALSE;
 	m_mapName.clear();

Generals/Code/GameEngine/Source/Common/INI/INI.cpp

@@ -190,7 +190,7 @@ INI::INI( void )
 	m_blockEndToken			= "END";
 	m_endOfFile					= FALSE;
 	m_buffer[0]					= 0;
-#if defined(_DEBUG) || defined(_INTERNAL)
+#ifdef DEBUG_CRASHING
 	m_curBlockStart[0]	= 0;
 #endif
 
@@ -368,7 +368,7 @@ void INI::load( AsciiString filename, INILoadType loadType, Xfer *pXfer )
 				INIBlockParse parse = findBlockParse(token);
 				if (parse)
 				{
-					#if defined(_DEBUG) || defined(_INTERNAL)
+					#ifdef DEBUG_CRASHING
 					strcpy(m_curBlockStart, m_buffer);
 					#endif
 					try {
@@ -381,7 +381,7 @@ void INI::load( AsciiString filename, INILoadType loadType, Xfer *pXfer )
 
 						throw INIException(buff);
 					}
-					#if defined(_DEBUG) || defined(_INTERNAL)
+					#ifdef DEBUG_CRASHING
 						strcpy(m_curBlockStart, "NO_BLOCK");
 					#endif
 				}