Merge branch 'TheSuperHackers:main' into okji/feat/deterministic-math

Author: Okladnoj

Core/GameEngine/Include/Common/GameAudio.h

@@ -383,55 +383,4 @@ class AudioManager : public SubsystemInterface
 		Bool m_disallowSpeech			: 1;
 };
 
-// TheSuperHackers @feature helmutbuhler 17/05/2025
-// AudioManager that does nothing. Used for Headless Mode.
-class AudioManagerDummy : public AudioManager
-{
-#if defined(RTS_DEBUG)
-	virtual void audioDebugDisplay(DebugDisplayInterface* dd, void* userData, FILE* fp) {}
-#endif
-	virtual void stopAudio(AudioAffect which) override {}
-	virtual void pauseAudio(AudioAffect which) override {}
-	virtual void resumeAudio(AudioAffect which) override {}
-	virtual void pauseAmbient(Bool shouldPause) override {}
-	virtual void killAudioEventImmediately(AudioHandle audioEvent) override {}
-	virtual void nextMusicTrack() override {}
-	virtual void prevMusicTrack() override {}
-	virtual Bool isMusicPlaying() const override { return false; }
-	virtual Bool hasMusicTrackCompleted(const AsciiString& trackName, Int numberOfTimes) const override { return false; }
-	virtual AsciiString getMusicTrackName() const override { return ""; }
-	virtual void openDevice() override {}
-	virtual void closeDevice() override {}
-	virtual void* getDevice() override { return nullptr; }
-	virtual void notifyOfAudioCompletion(UnsignedInt audioCompleted, UnsignedInt flags) override {}
-	virtual UnsignedInt getProviderCount() const override { return 0; };
-	virtual AsciiString getProviderName(UnsignedInt providerNum) const override { return ""; }
-	virtual UnsignedInt getProviderIndex(AsciiString providerName) const override { return 0; }
-	virtual void selectProvider(UnsignedInt providerNdx) override {}
-	virtual void unselectProvider() override {}
-	virtual UnsignedInt getSelectedProvider() const override { return 0; }
-	virtual void setSpeakerType(UnsignedInt speakerType) override {}
-	virtual UnsignedInt getSpeakerType() override { return 0; }
-	virtual UnsignedInt getNum2DSamples() const override { return 0; }
-	virtual UnsignedInt getNum3DSamples() const override { return 0; }
-	virtual UnsignedInt getNumStreams() const override { return 0; }
-	virtual Bool doesViolateLimit(AudioEventRTS* event) const override { return false; }
-	virtual Bool isPlayingLowerPriority(AudioEventRTS* event) const override { return false; }
-	virtual Bool isPlayingAlready(AudioEventRTS* event) const override { return false; }
-	virtual Bool isObjectPlayingVoice(UnsignedInt objID) const override { return false; }
-	virtual void adjustVolumeOfPlayingAudio(AsciiString eventName, Real newVolume) override {}
-	virtual void removePlayingAudio(AsciiString eventName) override {}
-	virtual void removeAllDisabledAudio() override {}
-	virtual Bool has3DSensitiveStreamsPlaying() const override { return false; }
-	virtual void* getHandleForBink() override { return nullptr; }
-	virtual void releaseHandleForBink() override {}
-	virtual void friend_forcePlayAudioEventRTS(const AudioEventRTS* eventToPlay) override {}
-	virtual void setPreferredProvider(AsciiString providerNdx) override {}
-	virtual void setPreferredSpeaker(AsciiString speakerType) override {}
-	virtual Real getFileLengthMS(AsciiString strToLoad) const override { return -1; }
-	virtual void closeAnySamplesUsingFile(const void* fileToClose) override {}
-	virtual void setDeviceListenerPosition() override {}
-};
-
-
 extern AudioManager *TheAudio;

Core/GameEngine/Include/Common/INI.h

@@ -160,13 +160,11 @@ typedef void (*BuildMultiIniFieldProc)(MultiIniFieldParse& p);
 //-------------------------------------------------------------------------------------------------
 class INI
 {
-  INI(const INI&);
-  INI& operator=(const INI&);
+	INI(const INI&) CPP_11(= delete);
+	INI& operator=(const INI&) CPP_11(= delete);
 
 public:
-
 	INI();
-	~INI();
 
 	// TheSuperHackers @feature xezon 19/08/2025
 	// Load a specific INI file by name and/or INI files from a directory (and its subdirectories).
@@ -251,11 +249,12 @@ class INI
 	AsciiString getFilename() const { return m_filename; }
 	INILoadType getLoadType() const { return m_loadType; }
 	UnsignedInt getLineNum() const { return m_lineNum; }
-	const char *getSeps() const { return m_seps; }
-	const char *getSepsPercent() const { return m_sepsPercent; }
-	const char *getSepsColon() const { return m_sepsColon; }
-	const char *getSepsQuote() { return m_sepsQuote; }
 	Bool isEOF() const { return m_endOfFile; }
+	static const char *getSeps()        { return " \n\r\t="; }   ///< default delimiters for strtok parsing
+	static const char *getSepsPercent() { return " \n\r\t=%%"; } ///< default delimiters & percent delimiter
+	static const char *getSepsColon()   { return " \n\r\t=:"; }  ///< default delimiters & colon delimiter
+	static const char *getSepsQuote()   { return "\"\n="; }      ///< delimiters to represent a quoted ascii string
+	static const char *getEndToken()    { return "End"; }        ///< token to represent an end of data block
 
 	void initFromINI( void *what, const FieldParse* parseTable );
 	void initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList );
@@ -321,20 +320,19 @@ class INI
 	static void parseVeterancyLevelFlags(INI* ini, void* instance, void* store, const void* userData);
 	static void parseSoundsList( INI* ini, void *instance, void *store, const void* /*userData*/ );
 
-
 	/**
-		return the next token. if seps is null (or omitted), the standard seps are used.
+		return the next token. if seps is not specified, the standard seps are used.
 
 		this will *never* return null; if there are no more tokens, an exception will be thrown.
 	*/
-	const char* getNextToken(const char* seps = nullptr);
+	static const char* getNextToken(const char* seps = getSeps());
 
 	/**
 		just like getNextToken(), except that null is returned if no more tokens are present
 		(rather than throwing an exception). usually you should call getNextToken(),
 		but for some cases this is handier (ie, parsing a variable-length number of tokens).
 	*/
-	const char* getNextTokenOrNull(const char* seps = nullptr);
+	static const char* getNextTokenOrNull(const char* seps = getSeps());
 
 	/**
 		This is called when the next thing you expect is something like:
@@ -346,7 +344,7 @@ class INI
 
 		If "Tag" is not the next token, an error is thrown.
 	*/
-	const char* getNextSubToken(const char* expected);
+	static const char* getNextSubToken(const char* expected);
 
 	/**
 		return the next ascii string. this is usually the same the result of getNextToken(),
@@ -400,14 +398,9 @@ class INI
 	unsigned m_readBufferUsed;                ///< number of bytes in read buffer
 
 	AsciiString m_filename;										///< filename of file currently loading
-	INILoadType m_loadType;										///< load time for current file
+	INILoadType m_loadType;										///< load type for current file
 	UnsignedInt m_lineNum;										///< current line number that's been read
 	char m_buffer[ INI_MAX_CHARS_PER_LINE+1 ];///< buffer to read file contents into
-	const char *m_seps;												///< for strtok parsing
-	const char *m_sepsPercent;								///< m_seps with percent delimiter as well
-	const char *m_sepsColon;									///< m_seps with colon delimiter as well
-	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
 #ifdef DEBUG_CRASHING
 	char m_curBlockStart[ INI_MAX_CHARS_PER_LINE+1 ];	///< first line of cur block

Core/GameEngine/Include/GameClient/View.h

@@ -34,6 +34,7 @@
 #include "Common/Snapshot.h"
 #include "Lib/BaseType.h"
 #include "WW3D2/coltype.h"			///< we don't generally do this, but we need the W3D collision types
+#include "WWMath/wwmath.h"
 
 #define DEFAULT_VIEW_WIDTH 640
 #define DEFAULT_VIEW_HEIGHT 480
@@ -50,7 +51,9 @@ enum FilterTypes CPP_11(: Int);
 enum FilterModes CPP_11(: Int);
 
 // ------------------------------------------------------------------------------------------------
-// ------------------------------------------------------------------------------------------------
+constexpr const Real ViewDefaultPitchRadians = DEG_TO_RADF(37.5f);
+constexpr const Real ViewDefaultYawRadians = DEG_TO_RADF(0.0f);
+
 // ------------------------------------------------------------------------------------------------
 enum PickType CPP_11(: Int)
 {
@@ -177,8 +180,11 @@ class View : public Snapshot
 
 	virtual void setAngle( Real radians );															///< Rotate the view around the vertical axis to the given angle (yaw)
 	virtual Real getAngle() { return m_angle; }										///< Return current camera angle
+	virtual Real getDefaultAngle() { return m_defaultAngle; }			///< Return current default camera angle
 	virtual void setPitch( Real radians );															///< Rotate the view around the horizontal axis to the given angle (pitch)
 	virtual Real getPitch() { return m_pitch; }										///< Return current camera pitch
+	virtual void setDefaultPitch( Real radians );												///< Set new default camera pitch. It affects the camera distance to the ground
+	virtual Real getDefaultPitch() { return m_defaultPitch; }						///< Return current default camera pitch
 	virtual void setAngleToDefault();															///< Set the view angle back to default
 	virtual void setPitchToDefault();															///< Set the view pitch back to default
 	void setPosition( const Coord3D *pos ) { m_pos = *pos; }
@@ -199,6 +205,7 @@ class View : public Snapshot
 	Bool userSetAngle(Real radians)                      { return doUserAction(&View::setAngle, radians); }
 	Bool userSetAngleToDefault()                         { return doUserAction(&View::setAngleToDefault); }
 	Bool userSetPitch(Real radians)                      { return doUserAction(&View::setPitch, radians); }
+	Bool userSetDefaultPitch(Real radians)               { return doUserAction(&View::setDefaultPitch, radians); }
 	Bool userSetPitchToDefault()                         { return doUserAction(&View::setPitchToDefault); }
 	Bool userZoom(Real height)                           { return doUserAction(&View::zoom, height); }
 	Bool userSetZoom(Real z)                             { return doUserAction(&View::setZoom, z); }
@@ -401,8 +408,8 @@ class ViewDummy : public View
 	}
 	virtual void screenToTerrain( const ICoord2D *screen, Coord3D *world ) override {}
 	virtual void screenToWorldAtZ( const ICoord2D *s, Coord3D *w, Real z ) override {}
-	virtual void drawView( void ) override {}
-	virtual void updateView(void) override {}
+	virtual void drawView() override {}
+	virtual void updateView() override {}
 	virtual void stepView() override {}
 	virtual void setGuardBandBias( const Coord2D *gb ) override {}
 	virtual Bool isDoingScriptedCamera() override { return false; }

Core/GameEngine/Source/Common/INI/INI.cpp

@@ -180,26 +180,14 @@ INI::INI()
 	m_filename					= "None";
 	m_loadType					= INI_LOAD_INVALID;
 	m_lineNum						= 0;
-	m_seps							= " \n\r\t=";			///< make sure you update m_sepsPercent/m_sepsColon as well
-	m_sepsPercent				= " \n\r\t=%%";
-	m_sepsColon					= " \n\r\t=:";
-	m_sepsQuote					= "\"\n=";				///< stop at " = EOL
-	m_blockEndToken			= "END";
-	m_endOfFile					= FALSE;
 	m_buffer[0]					= 0;
+	m_endOfFile					= FALSE;
 #ifdef DEBUG_CRASHING
 	m_curBlockStart[0]	= 0;
 #endif
 
 }
 
-//-------------------------------------------------------------------------------------------------
-//-------------------------------------------------------------------------------------------------
-INI::~INI()
-{
-
-}
-
 //-------------------------------------------------------------------------------------------------
 UnsignedInt INI::loadFileDirectory( AsciiString fileDirName, INILoadType loadType, Xfer *pXfer, Bool subdirs )
 {
@@ -397,7 +385,7 @@ UnsignedInt INI::load( AsciiString filename, INILoadType loadType, Xfer *pXfer )
 			AsciiString currentLine = m_buffer;
 
 			// the first word is the type of data we're processing
-			const char *token = strtok( m_buffer, m_seps );
+			const char *token = strtok( m_buffer, getSeps() );
 			if( token )
 			{
 				INIBlockParse parse = findBlockParse(token);
@@ -710,7 +698,7 @@ void INI::parseAsciiStringVector( INI* ini, void * /*instance*/, void *store, co
 {
 	std::vector<AsciiString>* asv = (std::vector<AsciiString>*)store;
 	asv->clear();
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		asv->push_back(token);
 	}
@@ -723,7 +711,7 @@ void INI::parseAsciiStringVectorAppend( INI* ini, void * /*instance*/, void *sto
 	std::vector<AsciiString>* asv = (std::vector<AsciiString>*)store;
 	// nope, don't clear. duh.
 	// asv->clear();
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		asv->push_back(token);
 	}
@@ -735,7 +723,7 @@ void INI::parseAsciiStringVectorAppend( INI* ini, void * /*instance*/, void *sto
 {
 	ScienceVec* asv = (ScienceVec*)store;
 	asv->clear();
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		if (stricmp(token, "None") == 0)
 		{
@@ -952,7 +940,7 @@ void INI::parseBitString32( INI* ini, void * /*instance*/, void *store, const vo
 	Bool foundAddOrSub = false;
 
 	// loop through all tokens
-	for (const char *token = ini->getNextTokenOrNull(); token != nullptr; token = ini->getNextTokenOrNull())
+	for (const char *token = ini->getNextTokenOrNull(); token; token = ini->getNextTokenOrNull())
 	{
 		if (stricmp(token, "NONE") == 0)
 		{
@@ -1528,7 +1516,7 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 		if( field )
 		{
 
-			if( stricmp( field, m_blockEndToken ) == 0 )
+			if( stricmp( field, getEndToken() ) == 0 )
 			{
 				done = TRUE;
 			}
@@ -1580,7 +1568,7 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 
 			done = TRUE;
 			DEBUG_CRASH( ("Error parsing block '%s', in INI file '%s'.  Missing '%s' token",
-												 m_curBlockStart, getFilename().str(), m_blockEndToken) );
+												 m_curBlockStart, getFilename().str(), getEndToken()) );
 			throw INI_MISSING_END_TOKEN;
 
 		}
@@ -1592,7 +1580,6 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 //-------------------------------------------------------------------------------------------------
 /*static*/ const char* INI::getNextToken(const char* seps)
 {
-	if (!seps) seps = getSeps();
 	const char *token = ::strtok(nullptr, seps);
 	if (!token)
 		throw INI_INVALID_DATA;
@@ -1602,7 +1589,6 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 //-------------------------------------------------------------------------------------------------
 /*static*/ const char* INI::getNextTokenOrNull(const char* seps)
 {
-	if (!seps) seps = getSeps();
 	const char *token = ::strtok(nullptr, seps);
 	return token;
 }
@@ -1618,8 +1604,17 @@ void INI::initFromINIMulti( void *what, const MultiIniFieldParse& parseTableList
 template <typename Type>
 Type scanType(std::string_view token)
 {
-	// TheSuperHackers @info std::from_chars cannot parse "-1" as uint32 so the result needs to be int64 for integers.
-	std::conditional_t<std::is_integral_v<Type>, Int64, Real> result{};
+	DEBUG_ASSERTCRASH(!token.empty(), ("token is not expected to be empty"));
+
+	// Unlike sscanf, std::from_chars cannot parse "+".
+	// Consume the plus symbol to accommodate custom ini files that have numbers prefixed with a plus.
+	if (token[0] == '+')
+	{
+		token.remove_prefix(1);
+	}
+
+	// Unlike sscanf, std::from_chars cannot parse "-" as unsigned integer.
+	std::conditional_t<std::is_integral_v<Type>, Int64, Type> result{};
 	const auto [ptr, ec] = std::from_chars(token.data(), token.data() + token.size(), result);
 
 	if (ec != std::errc{})
@@ -1867,12 +1862,10 @@ void INI::parseSoundsList( INI* ini, void *instance, void *store, const void* /*
 	std::vector<AsciiString> *vec = (std::vector<AsciiString>*) store;
 	vec->clear();
 
-	const char* SEPS = " \t,=";
-	const char *c = ini->getNextTokenOrNull(SEPS);
-	while ( c )
+	constexpr const char* Seps = " \t,=";
+	for (const char* token = ini->getNextTokenOrNull(Seps); token; token = ini->getNextTokenOrNull(Seps))
 	{
-		vec->push_back( c );
-		c = ini->getNextTokenOrNull(SEPS);
+		vec->push_back(token);
 	}
 }
 

Core/GameEngine/Source/GameClient/GUI/GameWindow.cpp

@@ -1579,7 +1579,6 @@ void GameWinDefaultTooltip( GameWindow *window,
 														WinInstanceData *instData,
 														UnsignedInt mouse )
 {
-	return;
 
 }
 
@@ -1589,8 +1588,6 @@ void GameWinDefaultTooltip( GameWindow *window,
 void GameWinDefaultDraw( GameWindow *window, WinInstanceData *instData )
 {
 
-	return;
-
 }
 
 // GameWindow::winSetEnabledImage =============================================

Core/GameEngine/Source/GameClient/Input/Mouse.cpp

@@ -824,7 +824,8 @@ void Mouse::createStreamMessages()
 		{
 			msg = TheMessageStream->appendMessage( GameMessage::MSG_RAW_MOUSE_WHEEL );
 			msg->appendPixelArgument( m_currMouse.pos );
-			msg->appendIntegerArgument( m_currMouse.wheelPos / 120 );  // wheel delta
+			// TheSuperHackers @bugfix Use float wheel delta to preserve fractional values from touchpad input
+			msg->appendRealArgument( m_currMouse.wheelPos / (Real)MOUSE_WHEEL_DELTA );
 			msg->appendIntegerArgument( TheKeyboard->getModifierFlags() );
 		}
 

Core/GameEngine/Source/GameClient/System/ParticleSys.cpp

@@ -3384,6 +3384,8 @@ void ParticleSystemManager::xfer( Xfer *xfer )
 	}
 	else
 	{
+		DEBUG_ASSERTCRASH(m_allParticleSystemList.empty(), ("ParticleSystemManager: particle systems list is expected empty at start of xfer-load."));
+
 		const ParticleSystemTemplate *systemTemplate;
 
 		// read each particle system