sourcemm/convar.h
changeset 232 a86d52ff721c
parent 76 39266faeec97
child 238 c27105949293
     1.1 --- a/sourcemm/convar.h	Wed Aug 09 01:52:49 2006 +0000
     1.2 +++ b/sourcemm/convar.h	Wed Aug 09 02:05:57 2006 +0000
     1.3 @@ -17,18 +17,36 @@
     1.4  
     1.5  #include "tier0/dbg.h"
     1.6  
     1.7 +#ifdef _WIN32
     1.8 +#define FORCEINLINE_CVAR FORCEINLINE
     1.9 +#elif _LINUX
    1.10 +#define FORCEINLINE_CVAR __inline__ FORCEINLINE
    1.11 +#else
    1.12 +#error "implement me"
    1.13 +#endif
    1.14 +
    1.15  // The default, no flags at all
    1.16  #define FCVAR_NONE				0 
    1.17  
    1.18  // Command to ConVars and ConCommands
    1.19 +// ConVar Systems
    1.20  #define FCVAR_UNREGISTERED		(1<<0)	// If this is set, don't add to linked list, etc.
    1.21 -#define FCVAR_LAUNCHER			(1<<1) // defined by launcher
    1.22 +#define FCVAR_LAUNCHER			(1<<1)	// defined by launcher
    1.23  #define FCVAR_GAMEDLL			(1<<2)	// defined by the game DLL
    1.24  #define FCVAR_CLIENTDLL			(1<<3)  // defined by the client DLL
    1.25  #define FCVAR_MATERIAL_SYSTEM	(1<<4)	// Defined by the material system.
    1.26 -#define FCVAR_STUDIORENDER		(1<<15)	// Defined by the material system.
    1.27 +#define FCVAR_DATACACHE			(1<<19)	// Defined by the datacache system.
    1.28 +#define FCVAR_STUDIORENDER		(1<<15)	// Defined by the studiorender system.
    1.29 +#define FCVAR_FILESYSTEM		(1<<21)	// Defined by the file system.
    1.30  #define FCVAR_PLUGIN			(1<<18)	// Defined by a 3rd party plugin.
    1.31 -#define FCVAR_CHEAT				(1<<14) // Only useable in singleplayer / debug / multiplayer & sv_cheats
    1.32 +#define FCVAR_TOOLSYSTEM		(1<<20)	// Defined by an IToolSystem library
    1.33 +#define FCVAR_SOUNDSYSTEM		(1<<23)	// Defined by the soundsystem library
    1.34 +#define FCVAR_INPUTSYSTEM		(1<<25)	// Defined by the inputsystem dll
    1.35 +#define FCVAR_NETWORKSYSTEM		(1<<26) // Defined by the network system
    1.36 +// NOTE!! if you add a cvar system, add it here too!!!!
    1.37 +// the engine lacks a cvar flag, but needs it for xbox
    1.38 +// an engine cvar is thus a cvar not marked with any other system
    1.39 +#define FCVAR_NON_ENGINE		((FCVAR_LAUNCHER|FCVAR_GAMEDLL|FCVAR_CLIENTDLL|FCVAR_MATERIAL_SYSTEM|FCVAR_DATACACHE|FCVAR_STUDIORENDER|FCVAR_FILESYSTEM|FCVAR_PLUGIN|FCVAR_TOOLSYSTEM|FCVAR_SOUNDSYSTEM|FCVAR_INPUTSYSTEM|FCVAR_NETWORKSYSTEM))
    1.40  
    1.41  // ConVar only
    1.42  #define FCVAR_PROTECTED			(1<<5)  // It's a server cvar, but we don't send the data since it's a password, etc.  Sends 1 if it's not bland/zero, 0 otherwise as value
    1.43 @@ -36,6 +54,7 @@
    1.44  #define	FCVAR_ARCHIVE			(1<<7)	// set to cause it to be saved to vars.rc
    1.45  #define	FCVAR_NOTIFY			(1<<8)	// notifies players when changed
    1.46  #define	FCVAR_USERINFO			(1<<9)	// changes the client's info string
    1.47 +#define FCVAR_CHEAT				(1<<14) // Only useable in singleplayer / debug / multiplayer & sv_cheats
    1.48  
    1.49  #define FCVAR_PRINTABLEONLY		(1<<10)  // This cvar's string cannot contain unprintable characters ( e.g., used for player name etc ).
    1.50  #define FCVAR_UNLOGGED			(1<<11)  // If this is a FCVAR_SERVER, don't log changes to the log file / console if we are creating a log
    1.51 @@ -50,7 +69,16 @@
    1.52  #define FCVAR_DEMO				(1<<16)  // record this cvar when starting a demo file
    1.53  #define FCVAR_DONTRECORD		(1<<17)  // don't record these command in demofiles
    1.54  
    1.55 -#define FCVAR_NOT_CONNECTED		(1<<19)	// cvar cannot be changed by a client that is connected to a server
    1.56 +#define FCVAR_NOT_CONNECTED		(1<<22)	// cvar cannot be changed by a client that is connected to a server
    1.57 +
    1.58 +#define FCVAR_ARCHIVE_XBOX		(1<<24) // cvar written to config.cfg on the Xbox
    1.59 +
    1.60 +
    1.61 +// #define FCVAR_AVAILABLE			(1<<27)
    1.62 +// #define FCVAR_AVAILABLE			(1<<28)
    1.63 +// #define FCVAR_AVAILABLE			(1<<29)
    1.64 +// #define FCVAR_AVAILABLE			(1<<30)
    1.65 +// #define FCVAR_AVAILABLE			(1<<31)
    1.66  
    1.67  
    1.68  class ConVar;
    1.69 @@ -75,6 +103,12 @@
    1.70  public:
    1.71  	// Call this ONCE when the executable starts up.
    1.72  	static void	OneTimeInit( IConCommandBaseAccessor *pAccessor );
    1.73 +#ifdef _XBOX
    1.74 +	static bool Fixup( ConCommandBase* pConCommandBase );
    1.75 +#ifndef _RETAIL
    1.76 +	static void PublishCommands( bool bForce );
    1.77 +#endif
    1.78 +#endif
    1.79  };
    1.80  
    1.81  // Called when a ConVar changes value
    1.82 @@ -173,6 +207,13 @@
    1.83  {
    1.84  friend class ConCommandBaseMgr;
    1.85  friend class CCvar;
    1.86 +#ifdef _STATIC_LINKED
    1.87 +friend class G_ConCommand;
    1.88 +friend class C_ConCommand;
    1.89 +friend class M_ConCommand;
    1.90 +friend class S_ConCommand;
    1.91 +friend class D_ConCommand;
    1.92 +#endif
    1.93  
    1.94  public:
    1.95  	typedef ConCommandBase BaseClass;
    1.96 @@ -191,19 +232,17 @@
    1.97  
    1.98  	// Invoke the function
    1.99  	virtual void				Dispatch( void );
   1.100 -
   1.101  private:
   1.102  	virtual void				Create( char const *pName, FnCommandCallback callback, 
   1.103  									char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
   1.104 -public:
   1.105 +
   1.106  	// Call this function when executing the command
   1.107  	FnCommandCallback			m_fnCommandCallback;
   1.108  
   1.109  	FnCommandCompletionCallback	m_fnCompletionCallback;
   1.110  	bool						m_bHasCompletionCallback;
   1.111  public:
   1.112 -//HACKHACK from BAILOPAN - we want to access this okay!
   1.113 -	FnCommandCallback			GetCallback() { return m_fnCommandCallback; }
   1.114 +	FnCommandCallback		GetCallback() { return m_fnCommandCallback; }
   1.115  };
   1.116  
   1.117  //-----------------------------------------------------------------------------
   1.118 @@ -214,6 +253,13 @@
   1.119  friend class ConCommandBaseMgr;
   1.120  friend class CCvar;
   1.121  friend class CDefaultCvar;
   1.122 +#ifdef _STATIC_LINKED
   1.123 +friend class G_ConVar;
   1.124 +friend class C_ConVar;
   1.125 +friend class M_ConVar;
   1.126 +friend class S_ConVar;
   1.127 +friend class D_ConVar;
   1.128 +#endif
   1.129  
   1.130  public:
   1.131  	typedef ConCommandBase BaseClass;
   1.132 @@ -243,10 +289,10 @@
   1.133  	void InstallChangeCallback( FnChangeCallback callback );
   1.134  
   1.135  	// Retrieve value
   1.136 -	FORCEINLINE float			GetFloat( void ) const;
   1.137 -	FORCEINLINE int				GetInt( void ) const;
   1.138 -	FORCEINLINE bool			GetBool() const	{  return !!GetInt(); }
   1.139 -	FORCEINLINE char const	   *GetString( void ) const;
   1.140 +	FORCEINLINE_CVAR float			GetFloat( void ) const;
   1.141 +	FORCEINLINE_CVAR int				GetInt( void ) const;
   1.142 +	FORCEINLINE_CVAR bool			GetBool() const {  return !!GetInt(); }
   1.143 +	FORCEINLINE_CVAR char const	   *GetString( void ) const;
   1.144  
   1.145  	// Any function that allocates/frees memory needs to be virtual or else you'll have crashes
   1.146  	//  from alloc/free across dll/exe boundaries.
   1.147 @@ -311,11 +357,12 @@
   1.148  	FnChangeCallback			m_fnChangeCallback;
   1.149  };
   1.150  
   1.151 +
   1.152  //-----------------------------------------------------------------------------
   1.153  // Purpose: Return ConVar value as a float
   1.154  // Output : float
   1.155  //-----------------------------------------------------------------------------
   1.156 -FORCEINLINE float ConVar::GetFloat( void ) const
   1.157 +FORCEINLINE_CVAR float ConVar::GetFloat( void ) const
   1.158  {
   1.159  	return m_pParent->m_fValue;
   1.160  }
   1.161 @@ -324,7 +371,7 @@
   1.162  // Purpose: Return ConVar value as an int
   1.163  // Output : int
   1.164  //-----------------------------------------------------------------------------
   1.165 -FORCEINLINE int ConVar::GetInt( void ) const 
   1.166 +FORCEINLINE_CVAR int ConVar::GetInt( void ) const 
   1.167  {
   1.168  	return m_pParent->m_nValue;
   1.169  }
   1.170 @@ -334,7 +381,7 @@
   1.171  // Purpose: Return ConVar value as a string, return "" for bogus string pointer, etc.
   1.172  // Output : char const *
   1.173  //-----------------------------------------------------------------------------
   1.174 -FORCEINLINE char const *ConVar::GetString( void ) const 
   1.175 +FORCEINLINE_CVAR char const *ConVar::GetString( void ) const 
   1.176  {
   1.177  	if ( m_nFlags & FCVAR_NEVER_AS_STRING )
   1.178  	{
   1.179 @@ -345,6 +392,117 @@
   1.180  }
   1.181  
   1.182  
   1.183 +#ifdef _STATIC_LINKED
   1.184 +// identifies subsystem via piggybacking constructors with flags
   1.185 +class G_ConCommand : public ConCommand
   1.186 +{
   1.187 +public:
   1.188 +	G_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_GAMEDLL, completionFunc) {}
   1.189 +};
   1.190 +
   1.191 +class C_ConCommand : public ConCommand
   1.192 +{
   1.193 +public:
   1.194 +	C_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_CLIENTDLL, completionFunc) {}
   1.195 +};
   1.196 +
   1.197 +class M_ConCommand : public ConCommand
   1.198 +{
   1.199 +public:
   1.200 +	M_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_MATERIAL_SYSTEM, completionFunc) {}
   1.201 +};
   1.202 +
   1.203 +class S_ConCommand : public ConCommand
   1.204 +{
   1.205 +public:
   1.206 +	S_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_STUDIORENDER, completionFunc) {}
   1.207 +};
   1.208 +
   1.209 +class D_ConCommand : public ConCommand
   1.210 +{
   1.211 +public:
   1.212 +	D_ConCommand(char const *pName, FnCommandCallback callback, char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 ) :	ConCommand(pName, callback, pHelpString, flags|FCVAR_DATACACHE, completionFunc) {}
   1.213 +};
   1.214 +
   1.215 +typedef void ( *G_FnChangeCallback )( G_ConVar *var, char const *pOldString );
   1.216 +typedef void ( *C_FnChangeCallback )( C_ConVar *var, char const *pOldString );
   1.217 +typedef void ( *M_FnChangeCallback )( M_ConVar *var, char const *pOldString );
   1.218 +typedef void ( *S_FnChangeCallback )( S_ConVar *var, char const *pOldString );
   1.219 +typedef void ( *D_FnChangeCallback )( D_ConVar *var, char const *pOldString );
   1.220 +
   1.221 +class G_ConVar : public ConVar
   1.222 +{
   1.223 +public:
   1.224 +	G_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL) {}
   1.225 +	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString ) {}
   1.226 +	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString, bMin, fMin, bMax, fMax) {}
   1.227 +	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, G_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString, (FnChangeCallback)callback ) {}
   1.228 +	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, G_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
   1.229 +};
   1.230 +
   1.231 +class C_ConVar : public ConVar
   1.232 +{
   1.233 +public:
   1.234 +	C_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL) {}
   1.235 +	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString ) {}
   1.236 +	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString, bMin, fMin, bMax, fMax) {}
   1.237 +	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, C_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString, (FnChangeCallback)callback ) {}
   1.238 +	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, C_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
   1.239 +};
   1.240 +
   1.241 +class M_ConVar : public ConVar
   1.242 +{
   1.243 +public:
   1.244 +	M_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM) {}
   1.245 +	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString ) {}
   1.246 +	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString, bMin, fMin, bMax, fMax) {}
   1.247 +	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString, (FnChangeCallback)callback ) {}
   1.248 +	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
   1.249 +};
   1.250 +
   1.251 +class S_ConVar : public ConVar
   1.252 +{
   1.253 +public:
   1.254 +	S_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER) {}
   1.255 +	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString ) {}
   1.256 +	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString, bMin, fMin, bMax, fMax) {}
   1.257 +	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString, (FnChangeCallback)callback ) {}
   1.258 +	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, S_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
   1.259 +};
   1.260 +
   1.261 +class D_ConVar : public ConVar
   1.262 +{
   1.263 +public:
   1.264 +	D_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE) {}
   1.265 +	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString ) {}
   1.266 +	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString, bMin, fMin, bMax, fMax) {}
   1.267 +	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, M_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString, (FnChangeCallback)callback ) {}
   1.268 +	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, D_FnChangeCallback callback ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString, bMin, fMin, bMax, fMax, (FnChangeCallback)callback ) {}
   1.269 +};
   1.270 +
   1.271 +// redirect these declarations to their specific subsystem
   1.272 +#ifdef GAME_DLL
   1.273 +#define ConCommand	G_ConCommand
   1.274 +#define ConVar		G_ConVar
   1.275 +#endif
   1.276 +#ifdef CLIENT_DLL
   1.277 +#define ConCommand	C_ConCommand
   1.278 +#define ConVar		C_ConVar
   1.279 +#endif
   1.280 +#ifdef MATERIALSYSTEM_DLL
   1.281 +#define ConCommand	M_ConCommand
   1.282 +#define ConVar		M_ConVar
   1.283 +#endif
   1.284 +#ifdef STUDIORENDER_DLL
   1.285 +#define ConCommand	S_ConCommand
   1.286 +#define ConVar		S_ConVar
   1.287 +#endif
   1.288 +#ifdef DATACACHE_DLL
   1.289 +#define ConCommand	D_ConCommand
   1.290 +#define ConVar		D_ConVar
   1.291 +#endif
   1.292 +#endif // _STATIC_LINKED
   1.293 +
   1.294  //-----------------------------------------------------------------------------
   1.295  // Purpose: Utility to quicky generate a simple console command
   1.296  //-----------------------------------------------------------------------------