0001804: cvar difference description for dmflags

Chat on our Discord Server Get the latest version: 3.2.1
Source Code

View Issue Details [ Jump to Notes ]

[ Issue History ] [ Print ]

Project

Category

View Status

Date Submitted

Last Update

0001804

Zandronum

[All Projects] Suggestion

public

2014-05-17 21:37

2024-03-11 06:53

Reporter

Dusk

Assigned To

Kaminsky

Priority

normal

Severity

minor

Reproducibility

N/A

Status

resolved

Resolution

fixed

Platform

OS Version

Product Version

Target Version

Fixed in Version

3.1

Summary

0001804: cvar difference description for dmflags

Description

oh_no duskie has been doing science again, TAKE COVER.

Basically I hacked in a little algorithm thing that shows exactly what changed in dmflags/compatflags/whatever when the server prints the "dmflags changed to blah". If too many flags change (i.e. more than 5) it just prints the amount of flags that changed so that the chat doesn't get flooded.

Quote

*** MAP01: entryway ***

sv_nojump 1
dmflags changed to 65536 (sv_nojump ON)
dmflags 123
dmflags changed to 123 (7 flags changed)
dmflags 1234
dmflags changed to 1234 (sv_nohealth OFF, sv_oldfalldamage OFF, sv_spawnfarthest ON, sv_noexit ON)
compat_limited_airmovement 1
compatflags changed to 131072 (compat_limited_airmovement ON)

Diff attached. What do you guys think?

Attached Files

dmflags-data.diff [^] (7,253 bytes) 2014-05-17 21:37 [Show Content] [Hide Content]

diff -r 7bd5059677f1 src/c_cvars.cpp
--- a/src/c_cvars.cpp	Sun May 04 23:57:26 2014 +0300
+++ b/src/c_cvars.cpp	Sun May 18 00:28:47 2014 +0300
@@ -688,7 +688,7 @@
 {
 	DefaultValue = def;
 	if (Flags & CVAR_ISDEFAULT)
-		Value = def;
+		Value = PastValue = def; // [Dusk] Store PastValue here
 }
 
 ECVarType FIntCVar::GetRealType () const
@@ -734,6 +734,7 @@
 
 void FIntCVar::DoSet (UCVarValue value, ECVarType type)
 {
+	PastValue = Value; // [Dusk]
 	Value = ToInt (value, type);
 }
 
@@ -1447,6 +1448,12 @@
 	}
 }
 
+// [Dusk]
+FBaseCVar* C_GetRootCVar()
+{
+	return CVars;
+}
+
 void FBaseCVar::CmdSet (const char *newval)
 {
 	UCVarValue val;
diff -r 7bd5059677f1 src/c_cvars.h
--- a/src/c_cvars.h	Sun May 04 23:57:26 2014 +0300
+++ b/src/c_cvars.h	Sun May 18 00:28:47 2014 +0300
@@ -130,6 +130,8 @@
 
 	static void ListVars (const char *filter, bool plain);
 
+	inline FBaseCVar* GetNext() const { return m_Next; } // [Dusk]
+
 protected:
 	FBaseCVar () {}
 	virtual void DoSet (UCVarValue value, ECVarType type) = 0;
@@ -241,11 +243,15 @@
 	inline operator int () const { return Value; }
 	inline int operator *() const { return Value; }
 
+	// [Dusk]
+	inline int const& GetPastValue() const { return PastValue; }
+
 protected:
 	virtual void DoSet (UCVarValue value, ECVarType type);
 
 	int Value;
 	int DefaultValue;
+	int PastValue; // [Dusk] What was this CVar before?
 
 	friend class FFlagCVar;
 };
@@ -338,6 +344,9 @@
 	virtual UCVarValue GetFavoriteRepDefault (ECVarType *type) const;
 	virtual void SetGenericRepDefault (UCVarValue value, ECVarType type);
 
+	inline FIntCVar const& GetValueVar() const { return ValueVar; } // [Dusk]
+	inline uint32 const& GetBitVal() const { return BitVal; } // [Dusk]
+
 	bool operator= (bool boolval)
 		{ UCVarValue val; val.Bool = boolval; SetGenericRep (val, CVAR_Bool); return boolval; }
 	bool operator= (FFlagCVar &flag)
@@ -399,6 +408,8 @@
 
 void C_ForgetCVars (void);
 
+// [Dusk] For CVar iteration
+FBaseCVar* C_GetRootCVar();
 
 #define CUSTOM_CVAR(type,name,def,flags) \
 	static void cvarfunc_##name(F##type##CVar &); \
diff -r 7bd5059677f1 src/d_main.cpp
--- a/src/d_main.cpp	Sun May 04 23:57:26 2014 +0300
+++ b/src/d_main.cpp	Sun May 18 00:28:47 2014 +0300
@@ -311,6 +311,73 @@
 
 //==========================================================================
 //
+// [Dusk] D_CompareFlagsets
+//
+// Describes the differences between the flagset and its past value.
+//
+//==========================================================================
+
+static FString D_CompareFlagsets( FIntCVar& flagset, int maxflags = 5 )
+{
+	FString result;
+	int flagschanged = 0;
+	int oldValue = flagset.GetPastValue();
+
+	for ( int i = 0; i < 32; ++i )
+	{
+		uint32 bit = ( 1 << i );
+
+		// [Dusk] Skip flags that haven't changed
+		if ((( flagset ^ oldValue ) & bit ) == 0 )
+			continue;
+
+		flagschanged++;
+
+		if ( flagschanged <= maxflags )
+		{
+			bool isOn = ( flagset & bit ) != 0;
+
+			// [Dusk] Find the CVar for this flag
+			FFlagCVar* flag = NULL;
+
+			for ( FBaseCVar* var = C_GetRootCVar(); var != NULL; var = var->GetNext() )
+			{
+				FFlagCVar* varflag = static_cast<FFlagCVar*>( var );
+
+				if (( var->GetRealType() == CVAR_Dummy ) &&
+					( &varflag->GetValueVar() == &flagset ) &&
+					( varflag->GetBitVal() == bit ))
+				{
+					flag = varflag;
+					break;
+				}
+			}
+
+			// [Dusk] If we found the flag, write the change down
+			if ( flag != NULL )
+			{
+				if ( result.IsNotEmpty() )
+					result += ", ";
+
+				result.AppendFormat( "%s %s", flag->GetName(), isOn ? "ON" : "OFF" );
+			}
+		}
+	}
+
+	if ( flagschanged > maxflags )
+	{
+		// [Dusk] Too much changes, just give a number on how many changed, we
+		// don't want to spam the messages.
+		FString msg;
+		msg.Format( "%d flags changed", flagschanged );
+		return msg;
+	}
+
+	return result;
+}
+
+//==========================================================================
+//
 // CVAR dmflags
 //
 //==========================================================================
@@ -352,9 +419,12 @@
 	}
 
 	// [BC] If we're the server, tell clients that the dmflags changed.
-	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ))
+	// [Dusk] Not if the flagset didn't change. Also include a description of
+	// what changed.
+	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ) && ( self != self.GetPastValue() ))
 	{
-		SERVER_Printf( PRINT_HIGH, "%s changed to: %d\n", self.GetName( ), (LONG)self );
+		SERVER_Printf( PRINT_HIGH, "%s changed to %d (%s)\n",
+			self.GetName( ), (LONG)self, D_CompareFlagsets( self ).GetChars() );
 		SERVERCOMMANDS_SetGameDMFlags( );
 	}
 }
@@ -408,9 +478,12 @@
 CUSTOM_CVAR (Int, dmflags2, 0, CVAR_SERVERINFO | CVAR_CAMPAIGNLOCK)
 {
 	// [BC] If we're the server, tell clients that the dmflags changed.
-	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ))
+	// [Dusk] Not if the flagset didn't change. Also include a description of
+	// what changed.
+	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ) && ( self != self.GetPastValue() ))
 	{
-		SERVER_Printf( PRINT_HIGH, "%s changed to: %d\n", self.GetName( ), (LONG)self );
+		SERVER_Printf( PRINT_HIGH, "%s changed to %d (%s)\n",
+			self.GetName( ), (LONG)self, D_CompareFlagsets( self ).GetChars() );
 		SERVERCOMMANDS_SetGameDMFlags( );
 	}
 
@@ -502,9 +575,12 @@
 CUSTOM_CVAR (Int, dmflags3, 0, CVAR_SERVERINFO)
 {
 	// [BB] If we're the server, tell clients that the dmflags changed.
-	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ))
+	// [Dusk] Not if the flagset didn't change. Also include a description of
+	// what changed.
+	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ) && ( self != self.GetPastValue() ))
 	{
-		SERVER_Printf( PRINT_HIGH, "%s changed to: %d\n", self.GetName( ), (LONG)self );
+		SERVER_Printf( PRINT_HIGH, "%s changed to %d (%s)\n",
+			self.GetName( ), (LONG)self, D_CompareFlagsets( self ).GetChars() );
 		SERVERCOMMANDS_SetGameDMFlags( );
 	}
 }
@@ -539,9 +615,12 @@
 	i_compatflags = GetCompatibility(self) | ii_compatflags;
 
 	// [BC] If we're the server, tell clients that the dmflags changed.
-	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ))
+	// [Dusk] Not if the flagset didn't change. Also include a description of
+	// what changed.
+	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ) && ( self != self.GetPastValue() ))
 	{
-		SERVER_Printf( PRINT_HIGH, "%s changed to: %d\n", self.GetName( ), (LONG)self );
+		SERVER_Printf( PRINT_HIGH, "%s changed to %d (%s)\n",
+			self.GetName( ), (LONG)self, D_CompareFlagsets( self ).GetChars() );
 		SERVERCOMMANDS_SetGameDMFlags( );
 	}
 }
@@ -557,7 +636,8 @@
 	// [BC] If we're the server, tell clients that the dmflags changed.
 	if (( NETWORK_GetState( ) == NETSTATE_SERVER ) && ( gamestate != GS_STARTUP ))
 	{
-		SERVER_Printf( PRINT_HIGH, "%s changed to: %d\n", self.GetName( ), (LONG)self );
+		SERVER_Printf( PRINT_HIGH, "%s changed to %d (%s)\n",
+			self.GetName( ), (LONG)self, D_CompareFlagsets( self ).GetChars() );
 		SERVERCOMMANDS_SetGameDMFlags( );
 	}
 }

Relationships

Notes
(0008803) Watermelon (developer) 2014-05-17 22:33	This is pretty cool

(0008810) ZzZombo (reporter) 2014-05-19 05:07	I think if there more than 5 flags changed it should list the first 5 and then just add a remark about that not all were listed. Would be neat IMO.

(0009612) Torr Samaho (administrator) 2014-06-21 13:31	As we found out during an IRC discussion a while ago, the workaround of using CVAR_Dummy to determine whether a flag is of type FFlagCVar doesn't work with recent ZDoom versions anymore. Before we can add this, we need to find a way to identify these flags that also works with the current ZDoom versions.

(0021587) Torr Samaho (administrator) 2021-01-10 20:34	I added Kaminski patch for this that is building on Dusk's original patch.

(0023344) unknownna (updater) 2024-03-11 06:53	IF more than 2 flags are changed, it says the amount of flags instead of which ones. Based on that, it works fine.

**Issue Community Support**
This issue is already marked as resolved. If you feel that is not the case, please reopen it and explain why.
Supporters:	Catastrophe Leonard ZzZombo WaTaKiD Frits Combinebobnt Korshun
Opponents:	No one explicitly opposes this issue yet.

Issue History
Date Modified	Username	Field	Change
2014-05-17 21:37	Dusk	New Issue
2014-05-17 21:37	Dusk	Status	new => assigned
2014-05-17 21:37	Dusk	Assigned To	=> Dusk
2014-05-17 21:37	Dusk	File Added: dmflags-data.diff
2014-05-17 21:37	Dusk	Status	assigned => needs review
2014-05-17 22:33	Watermelon	Note Added: 0008803
2014-05-18 07:42	Frits	Note Added: 0008807
2014-05-18 07:42	Frits	Note Deleted: 0008807
2014-05-19 05:07	ZzZombo	Note Added: 0008810
2014-06-21 13:31	Torr Samaho	Note Added: 0009612
2014-06-21 13:31	Torr Samaho	Status	needs review => feedback
2021-01-10 20:34	Torr Samaho	Note Added: 0021587
2021-01-10 20:35	Torr Samaho	Status	feedback => needs testing
2024-03-11 06:53	unknownna	Note Added: 0023344
2024-03-11 06:53	unknownna	Assigned To	Dusk => Kaminsky
2024-03-11 06:53	unknownna	Status	needs testing => resolved
2024-03-11 06:53	unknownna	Resolution	open => fixed
2024-03-11 06:53	unknownna	Fixed in Version	=> 3.1

Questions or other issues? Contact Us.

Links

Doom and Doom II are the property of id Software.