[GEN] Backports some debug features from ZH

Author: tomsons26

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

@@ -243,6 +243,7 @@ class GlobalData : public SubsystemInterface
 
 	UnsignedInt m_noDraw;					///< Used to disable drawing, to profile game logic code.
 	AIDebugOptions m_debugAI;			///< Used to display AI debug information
+	Bool m_debugSupplyCenterPlacement; ///< Dumps to log everywhere it thinks about placing a supply center
 	Bool m_debugAIObstacles;			///< Used to display AI obstacle debug information
 	Bool m_showObjectHealth;			///< debug display object health
 	Bool m_scriptDebug;						///< Should we attempt to load the script debugger window (.DLL)
@@ -470,6 +471,7 @@ class GlobalData : public SubsystemInterface
 	Int m_debugProjectileTileDuration;		///< How long should these tiles stay around, in frames?
 	RGBColor m_debugProjectileTileColor;	///< What color should these tiles be?
 	Bool m_showCollisionExtents;	///< Used to display collision extents
+  Bool m_showAudioLocations;    ///< Used to display audio markers and ambient sound radii
 	Bool m_saveStats;
 	Bool m_saveAllStats;
 	Bool m_useLocalMOTD;
@@ -480,6 +482,7 @@ class GlobalData : public SubsystemInterface
 	Int m_latencyPeriod;					///< Period of sinusoidal modulation of latency
 	Int m_latencyNoise;						///< Max amplitude of jitter to throw in
 	Int m_packetLoss;							///< Percent of packets to drop
+	Bool m_extraLogging;					///< More expensive debug logging to catch crashes.
 #endif
 
 #ifdef DEBUG_CRASHING

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

@@ -545,6 +545,7 @@ class Drawable : public Thing,
 	void killIcon(DrawableIconType t) { if (m_iconInfo) m_iconInfo->killIcon(t); }
 	Bool hasIconInfo() const { return m_iconInfo != NULL; }
 
+  const AudioEventRTS * getAmbientSound() const { return m_ambientSound == NULL ? NULL : &m_ambientSound->m_event; }
 protected:
 
 	// snapshot methods

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

@@ -83,6 +83,16 @@ class View : public Snapshot
 		SHAKE_COUNT 
 	};
 
+  // Return values for worldToScreenTriReturn
+  enum WorldToScreenReturn CPP_11(: Int)
+  {
+    WTS_INSIDE_FRUSTUM = 0, // On the screen (inside frustum of camera)
+    WTS_OUTSIDE_FRUSTUM,    // Return is valid but off the screen (outside frustum of camera)
+    WTS_INVALID,            // No transform possible
+
+    WTS_COUNT
+  };
+
 public:
 
 	View( void );
@@ -183,7 +193,8 @@ class View : public Snapshot
 	virtual void setFieldOfView( Real angle ) { m_FOV = angle; }				///< Set the horizontal field of view angle
 	virtual Real getFieldOfView( void ) { return m_FOV; }								///< Get the horizontal field of view angle
 
-	virtual Bool worldToScreen( const Coord3D *w, ICoord2D *s ) = 0;										///< Transform world coordinate "w" into screen coordinate "s"
+  Bool worldToScreen( const Coord3D *w, ICoord2D *s ) { return worldToScreenTriReturn( w, s ) == WTS_INSIDE_FRUSTUM; }	///< Transform world coordinate "w" into screen coordinate "s"
+  virtual WorldToScreenReturn worldToScreenTriReturn(const Coord3D *w, ICoord2D *s ) = 0; ///< Like worldToScreen(), but with a more informative return value
 	virtual void screenToWorld( const ICoord2D *s, Coord3D *w ) = 0;										///< Transform screen coordinate "s" into world coordinate "w"
 	virtual void screenToTerrain( const ICoord2D *screen, Coord3D *world ) = 0;  ///< transform screen coord to a point on the 3D terrain
 	virtual void screenToWorldAtZ( const ICoord2D *s, Coord3D *w, Real z ) = 0;  ///< transform screen point to world point at the specified world Z value

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

@@ -34,6 +34,14 @@
 #include "GameClient/GameText.h"
 #include "GameNetwork/NetworkDefs.h"
 
+#ifdef _INTERNAL
+// for occasional debugging...
+//#pragma optimize("", off)
+//#pragma MESSAGE("************************************** WARNING, optimization disabled for debugging purposes")
+#endif
+
+
+
 Bool TheDebugIgnoreSyncErrors = FALSE;
 extern Int DX8Wrapper_PreserveFPU;
 
@@ -835,6 +843,17 @@ Int parseConstantDebug( char *args[], int num )
 	return 1;
 }
 
+#if (defined(_DEBUG) || defined(_INTERNAL))
+Int parseExtraLogging( char *args[], int num )
+{
+	if (TheWritableGlobalData)
+	{
+		TheWritableGlobalData->m_extraLogging = TRUE;
+	}
+	return 1;
+}
+#endif
+
 Int parseShowTeamDot( char *args[], int num )
 {
 	if( TheWritableGlobalData )
@@ -1247,6 +1266,8 @@ static CommandLineParam params[] =
 	{ "-jumpToFrame", parseJumpToFrame },
 	{ "-updateImages", parseUpdateImages },
 	{ "-showTeamDot", parseShowTeamDot },
+	{ "-extraLogging", parseExtraLogging },
+
 #endif
 
 #ifdef DEBUG_LOGGING

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

@@ -500,6 +500,7 @@ GlobalData* GlobalData::m_theOriginal = NULL;
 	{ "ShroudOn",										INI::parseBool,				NULL,			offsetof( GlobalData, m_shroudOn ) },
 	{ "FogOfWarOn",										INI::parseBool,				NULL,			offsetof( GlobalData, m_fogOfWarOn ) },
 	{ "ShowCollisionExtents",				INI::parseBool,				NULL,			offsetof( GlobalData, m_showCollisionExtents ) },
+  { "ShowAudioLocations",  				INI::parseBool,				NULL,			offsetof( GlobalData, m_showAudioLocations ) },
 	{ "DebugProjectileTileWidth",		INI::parseReal,				NULL,			offsetof( GlobalData, m_debugProjectileTileWidth) },
 	{ "DebugProjectileTileDuration",INI::parseInt,				NULL,			offsetof( GlobalData, m_debugProjectileTileDuration) },
 	{ "DebugProjectileTileColor",		INI::parseRGBColor,		NULL,			offsetof( GlobalData, m_debugProjectileTileColor) },
@@ -518,6 +519,7 @@ GlobalData* GlobalData::m_theOriginal = NULL;
 	{ "UseLocalMOTD",								INI::parseBool,				NULL,			offsetof( GlobalData, m_useLocalMOTD ) },
 	{ "BaseStatsDir",								INI::parseAsciiString,NULL,			offsetof( GlobalData, m_baseStatsDir ) },
 	{ "LocalMOTDPath",							INI::parseAsciiString,NULL,			offsetof( GlobalData, m_MOTDPath ) },
+	{ "ExtraLogging",								INI::parseBool,				NULL,			offsetof( GlobalData, m_extraLogging ) },
 #endif
 
 	{ NULL,					NULL,						NULL,						0 }  // keep this last
@@ -550,6 +552,7 @@ GlobalData::GlobalData()
 	m_jabberOn = FALSE;
 	m_munkeeOn = FALSE;
 	m_showCollisionExtents = FALSE;
+  m_showAudioLocations = FALSE;
 	m_debugCamera = FALSE;
 	m_specialPowerUsesDelay = TRUE;
 	m_debugVisibility = FALSE;
@@ -581,6 +584,7 @@ GlobalData::GlobalData()
 	m_useLocalMOTD = FALSE;
 	m_baseStatsDir = ".\\";
 	m_MOTDPath = "MOTD.txt";
+	m_extraLogging = FALSE;
 #endif
 
 #ifdef DEBUG_CRASHING
@@ -806,6 +810,7 @@ GlobalData::GlobalData()
 	// End Add
 
 	m_debugAI = AI_DEBUG_NONE;
+	m_debugSupplyCenterPlacement = FALSE;
 	m_debugAIObstacles = FALSE;
 	m_showClientPhysics = TRUE;
 	m_showTerrainNormals = FALSE;

Generals/Code/GameEngine/Source/GameLogic/AI/AIPlayer.cpp

@@ -1776,9 +1776,16 @@ void AIPlayer::buildBySupplies(Int minimumCash, const AsciiString& thingName)
 																									 BuildAssistant::NO_OBJECT_OVERLAP,
 																									 NULL, m_player ) != LBC_OK ) {
 			// Warn. 
-			AsciiString bldgName = tTemplate->getName();
-			bldgName.concat(" - buildAISupplyCenter unable to place.  Attempting to adjust position.");
-			TheScriptEngine->AppendDebugMessage(bldgName, false);
+			const Coord3D *warehouseLocation = bestSupplyWarehouse->getPosition();
+			AsciiString debugMessage;
+			debugMessage.format(" %s - buildBySupplies unable to place near dock at (%.2f,%.2f).  Attempting to adjust position.",
+													tTemplate->getName().str(),
+													warehouseLocation->x,
+													warehouseLocation->y
+													);
+			TheScriptEngine->AppendDebugMessage(debugMessage, false);
+			if( TheGlobalData->m_debugSupplyCenterPlacement )
+				DEBUG_LOG(("%s", debugMessage.str()));
 			// try to fix.
 			Real posOffset;
 			// Wiggle it a little :)
@@ -1795,12 +1802,16 @@ void AIPlayer::buildBySupplies(Int minimumCash, const AsciiString& thingName)
 																							 BuildAssistant::NO_OBJECT_OVERLAP,
 																							 NULL, m_player ) == LBC_OK;
 					if (valid) break;
+					if( TheGlobalData->m_debugSupplyCenterPlacement )
+						DEBUG_LOG(("buildBySupplies -- Fail at (%.2f,%.2f)\n", newPos.x, newPos.y));
 					newPos.y = yPos+posOffset;
 					valid = TheBuildAssistant->isLocationLegalToBuild( &newPos, tTemplate, angle,
 																							 BuildAssistant::CLEAR_PATH |
 																							 BuildAssistant::TERRAIN_RESTRICTIONS |
 																							 BuildAssistant::NO_OBJECT_OVERLAP,
 																							 NULL, m_player ) == LBC_OK;
+					if( !valid && TheGlobalData->m_debugSupplyCenterPlacement )
+						DEBUG_LOG(("buildBySupplies -- Fail at (%.2f,%.2f)\n", newPos.x, newPos.y));
 				}
 				if (valid) break;
 				xPos = location.x-offset;
@@ -1813,17 +1824,26 @@ void AIPlayer::buildBySupplies(Int minimumCash, const AsciiString& thingName)
 																							 BuildAssistant::NO_OBJECT_OVERLAP,
 																							 NULL, m_player ) == LBC_OK;
 					if (valid) break;
+					if( TheGlobalData->m_debugSupplyCenterPlacement )
+						DEBUG_LOG(("buildBySupplies -- Fail at (%.2f,%.2f)\n", newPos.x, newPos.y));
 					newPos.x = xPos+posOffset;
 					valid = TheBuildAssistant->isLocationLegalToBuild( &newPos, tTemplate, angle,
 																							 BuildAssistant::CLEAR_PATH |
 																							 BuildAssistant::TERRAIN_RESTRICTIONS |
 																							 BuildAssistant::NO_OBJECT_OVERLAP,
 																							 NULL, m_player ) == LBC_OK;
+					if( !valid && TheGlobalData->m_debugSupplyCenterPlacement )
+						DEBUG_LOG(("buildBySupplies -- Fail at (%.2f,%.2f)\n", newPos.x, newPos.y));
 				}
 				if (valid) break;
 			}
 		}
-		if (valid) location = newPos;
+		if (valid) 
+		{
+			if( TheGlobalData->m_debugSupplyCenterPlacement )
+				DEBUG_LOG(("buildAISupplyCenter -- SUCCESS at (%.2f,%.2f)\n", newPos.x, newPos.y));
+			location = newPos;
+		}
 		TheTerrainVisual->removeAllBibs();	// isLocationLegalToBuild adds bib feedback, turn it off.  jba.
 		location.z = 0; // All build list locations are ground relative.
 		m_player->addToPriorityBuildList(thingName, &location, angle);

Generals/Code/GameEngine/Source/GameLogic/AI/AIStates.cpp

@@ -852,6 +852,14 @@ AsciiString AIStateMachine::getCurrentStateName(void) const
  */
 StateReturnType AIStateMachine::updateStateMachine()
 {
+	//-extraLogging
+	#if (defined(_DEBUG) || defined(_INTERNAL))
+		Bool idle = getOwner()->getAI()->isIdle();
+		if( !idle && TheGlobalData->m_extraLogging )
+			DEBUG_LOG( ("%d - %s::update() start - %s", TheGameLogic->getFrame(), getCurrentStateName().str(), getOwner()->getTemplate()->getName().str() ) );
+	#endif
+	//end -extraLogging 
+
 	if (m_temporaryState)
 	{
 		// execute this state
@@ -862,13 +870,49 @@ StateReturnType AIStateMachine::updateStateMachine()
 				status = STATE_SUCCESS;
 			}
 		}
-		if (status==STATE_CONTINUE)	{
+		if (status==STATE_CONTINUE)	
+		{
+			//-extraLogging
+			#if (defined(_DEBUG) || defined(_INTERNAL))
+				if( !idle && TheGlobalData->m_extraLogging )
+					DEBUG_LOG( (" - RETURN EARLY STATE_CONTINUE\n") );
+			#endif
+			//end -extraLogging 
+
 			return status;
 		}
 		m_temporaryState->onExit(EXIT_NORMAL);
 		m_temporaryState = NULL;
 	}
-	return StateMachine::updateStateMachine();
+	StateReturnType retType = StateMachine::updateStateMachine();
+
+	//-extraLogging 
+	#if (defined(_DEBUG) || defined(_INTERNAL))
+		AsciiString result;
+		if( TheGlobalData->m_extraLogging )
+		{
+			switch( retType )
+			{
+				case STATE_CONTINUE:
+					result.format( "CONTINUE" );
+					break;
+				case STATE_SUCCESS:
+					result.format( "SUCCESS" );
+					break;
+				case STATE_FAILURE:
+					result.format( "FAILURE" );
+					break;
+				default:
+					result.format( "UNKNOWN %d", retType );
+					break;
+			}	
+			if( !idle )
+				DEBUG_LOG( (" - RETURNING %s\n", result.str() ) );
+		}
+	#endif
+	//end -extraLogging 
+
+	return retType;
 }
 
 //----------------------------------------------------------------------------------------------------------

Generals/Code/GameEngine/Source/GameLogic/Object/Weapon.cpp

@@ -743,11 +743,37 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 	ObjectID* projectileID
 ) const
 {
+
+	//-extraLogging 
+	#if (defined(_DEBUG) || defined(_INTERNAL))
+		AsciiString targetStr;
+		if( TheGlobalData->m_extraLogging )
+		{
+			if( victimObj )
+				targetStr.format( "%s", victimObj->getTemplate()->getName().str() );
+			else if( victimPos )
+				targetStr.format( "%d,%d,%d", victimPos->x, victimPos->y, victimPos->z );
+			else
+				targetStr.format( "SELF." );
+
+			DEBUG_LOG( ("%d - WeaponTemplate::fireWeaponTemplate() begin - %s attacking %s - ", 
+				TheGameLogic->getFrame(), sourceObj->getTemplate()->getName().str(), targetStr.str() ) );
+		}
+	#endif
+	//end -extraLogging 
+
 	//CRCDEBUG_LOG(("WeaponTemplate::fireWeaponTemplate() from %s\n", DescribeObject(sourceObj).str()));
 	DEBUG_ASSERTCRASH(specificBarrelToUse >= 0, ("specificBarrelToUse should no longer be -1\n"));
 
 	if (sourceObj == NULL || (victimObj == NULL && victimPos == NULL))
 	{
+		//-extraLogging 
+		#if (defined(_DEBUG) || defined(_INTERNAL))
+			if( TheGlobalData->m_extraLogging )
+				DEBUG_LOG( ("FAIL 1 (sourceObj %d == NULL || (victimObj %d == NULL && victimPos %d == NULL)\n", sourceObj != 0, victimObj != 0, victimPos != 0) );
+		#endif
+		//end -extraLogging 
+
 		return 0;
 	}
 
@@ -819,6 +845,14 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 		if (distSqr > attackRangeSqr)
 		{
 			//DEBUG_ASSERTCRASH(distSqr < 5*5 || distSqr < attackRangeSqr*1.2f, ("*** victim is out of range (%f vs %f) of this weapon -- why did we attempt to fire?\n",sqrtf(distSqr),sqrtf(attackRangeSqr)));
+			
+			//-extraLogging 
+			#if (defined(_DEBUG) || defined(_INTERNAL))
+				if( TheGlobalData->m_extraLogging )
+					DEBUG_LOG( ("FAIL 2 (distSqr %.2f > attackRangeSqr %.2f)\n", distSqr, attackRangeSqr ) );
+			#endif
+			//end -extraLogging 
+
 			return 0;
 		}
 	}
@@ -833,6 +867,14 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 #endif
 		{
 			DEBUG_ASSERTCRASH(distSqr > minAttackRangeSqr*0.8f, ("*** victim is closer than min attack range (%f vs %f) of this weapon -- why did we attempt to fire?\n",sqrtf(distSqr),sqrtf(minAttackRangeSqr)));
+
+			//-extraLogging 
+			#if (defined(_DEBUG) || defined(_INTERNAL))
+				if( TheGlobalData->m_extraLogging )
+					DEBUG_LOG( ("FAIL 3 (distSqr %.2f< minAttackRangeSqr %.2f - 0.5f && !isProjectileDetonation %d)\n", distSqr, minAttackRangeSqr, isProjectileDetonation ) );
+			#endif
+			//end -extraLogging 
+
 			return 0;
 		}
 	}
@@ -921,6 +963,15 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 			// go ahead and do it now
 			//DEBUG_LOG(("WeaponTemplate::fireWeaponTemplate: firing weapon immediately!\n"));
 			dealDamageInternal(sourceID, damageID, damagePos, bonus, isProjectileDetonation);
+
+			//-extraLogging 
+			#if (defined(_DEBUG) || defined(_INTERNAL))
+				if( TheGlobalData->m_extraLogging )
+					DEBUG_LOG( ("EARLY 4 (delayed damage applied now)\n") );
+			#endif
+			//end -extraLogging 
+
+
 			return TheGameLogic->getFrame();
 		}
 		else
@@ -933,6 +984,15 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 				//DEBUG_LOG(("WeaponTemplate::fireWeaponTemplate: firing weapon in %d frames (= %d)!\n", delayInWholeFrames,when));
 				TheWeaponStore->setDelayedDamage(this, damagePos, when, sourceID, damageID, bonus);
 			}
+
+			//-extraLogging 
+			#if (defined(_DEBUG) || defined(_INTERNAL))
+				if( TheGlobalData->m_extraLogging )
+					DEBUG_LOG( ("EARLY 5 (delaying damage applied until frame %d)\n", when ) );
+			#endif
+			//end -extraLogging 
+
+
 			return when;
 		}
 	}
@@ -1040,6 +1100,13 @@ UnsignedInt WeaponTemplate::fireWeaponTemplate
 			// actually, this is ok, for things like Firestorm.... (srj)
 			projectile->setPosition(&projectileDestination);
 		}
+		//-extraLogging 
+		#if (defined(_DEBUG) || defined(_INTERNAL))
+			if( TheGlobalData->m_extraLogging )
+				DEBUG_LOG( ("DONE\n") );
+		#endif
+		//end -extraLogging 
+
 		return 0;
 	}
 }

Generals/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DView.h

@@ -186,7 +186,7 @@ class W3DView : public View, public SubsystemInterface
 
 	virtual void setFieldOfView( Real angle );							///< Set the horizontal field of view angle
 
-	virtual Bool worldToScreen( const Coord3D *w, ICoord2D *s );	///< Transform world coordinate "w" into screen coordinate "s"
+  virtual WorldToScreenReturn worldToScreenTriReturn( const Coord3D *w, ICoord2D *s );	///< Transform world coordinate "w" into screen coordinate "s"
 	virtual void screenToWorld( const ICoord2D *s, Coord3D *w );	///< Transform screen coordinate "s" into world coordinate "w"
 	virtual void screenToTerrain( const ICoord2D *screen, Coord3D *world );  ///< transform screen coord to a point on the 3D terrain
 	virtual void screenToWorldAtZ( const ICoord2D *s, Coord3D *w, Real z );  ///< transform screen point to world point at the specified world Z value