1 //========= Copyright � 1996-2005, Valve Corporation, All rights reserved. ============//
8 //-----------------------------------------------------------------------------
10 //=============================================================================//
18 #include "tier0/dbg.h"
21 #define FORCEINLINE_CVAR FORCEINLINE
23 #define FORCEINLINE_CVAR __inline__ FORCEINLINE
28 // The default, no flags at all
31 // Command to ConVars and ConCommands
33 #define FCVAR_UNREGISTERED (1<<0) // If this is set, don't add to linked list, etc.
34 #define FCVAR_LAUNCHER (1<<1) // defined by launcher
35 #define FCVAR_GAMEDLL (1<<2) // defined by the game DLL
36 #define FCVAR_CLIENTDLL (1<<3) // defined by the client DLL
37 #define FCVAR_MATERIAL_SYSTEM (1<<4) // Defined by the material system.
38 #define FCVAR_DATACACHE (1<<19) // Defined by the datacache system.
39 #define FCVAR_STUDIORENDER (1<<15) // Defined by the studiorender system.
40 #define FCVAR_FILESYSTEM (1<<21) // Defined by the file system.
41 #define FCVAR_PLUGIN (1<<18) // Defined by a 3rd party plugin.
42 #define FCVAR_TOOLSYSTEM (1<<20) // Defined by an IToolSystem library
43 #define FCVAR_SOUNDSYSTEM (1<<23) // Defined by the soundsystem library
44 #define FCVAR_INPUTSYSTEM (1<<25) // Defined by the inputsystem dll
45 #define FCVAR_NETWORKSYSTEM (1<<26) // Defined by the network system
46 // NOTE!! if you add a cvar system, add it here too!!!!
47 // the engine lacks a cvar flag, but needs it for xbox
48 // an engine cvar is thus a cvar not marked with any other system
49 #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))
52 #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
53 #define FCVAR_SPONLY (1<<6) // This cvar cannot be changed by clients connected to a multiplayer server.
54 #define FCVAR_ARCHIVE (1<<7) // set to cause it to be saved to vars.rc
55 #define FCVAR_NOTIFY (1<<8) // notifies players when changed
56 #define FCVAR_USERINFO (1<<9) // changes the client's info string
57 #define FCVAR_CHEAT (1<<14) // Only useable in singleplayer / debug / multiplayer & sv_cheats
59 #define FCVAR_PRINTABLEONLY (1<<10) // This cvar's string cannot contain unprintable characters ( e.g., used for player name etc ).
60 #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
61 #define FCVAR_NEVER_AS_STRING (1<<12) // never try to print that cvar
63 // It's a ConVar that's shared between the client and the server.
64 // At signon, the values of all such ConVars are sent from the server to the client (skipped for local
65 // client, of course )
66 // If a change is requested it must come from the console (i.e., no remote client changes)
67 // If a value is changed while a server is active, it's replicated to all connected clients
68 #define FCVAR_REPLICATED (1<<13) // server setting enforced on clients, TODO rename to FCAR_SERVER at some time
69 #define FCVAR_DEMO (1<<16) // record this cvar when starting a demo file
70 #define FCVAR_DONTRECORD (1<<17) // don't record these command in demofiles
72 #define FCVAR_NOT_CONNECTED (1<<22) // cvar cannot be changed by a client that is connected to a server
74 #define FCVAR_ARCHIVE_XBOX (1<<24) // cvar written to config.cfg on the Xbox
77 // #define FCVAR_AVAILABLE (1<<27)
78 // #define FCVAR_AVAILABLE (1<<28)
79 // #define FCVAR_AVAILABLE (1<<29)
80 // #define FCVAR_AVAILABLE (1<<30)
81 // #define FCVAR_AVAILABLE (1<<31)
88 // Any executable that wants to use ConVars need to implement one of
89 // these to hook up access to console variables.
90 class IConCommandBaseAccessor
93 // Flags is a combination of FCVAR flags in cvar.h.
94 // hOut is filled in with a handle to the variable.
95 virtual bool RegisterConCommandBase( ConCommandBase *pVar )=0;
99 // You don't have to instantiate one of these, just call its
100 // OneTimeInit function when your executable is initializing.
101 class ConCommandBaseMgr
104 // Call this ONCE when the executable starts up.
105 static void OneTimeInit( IConCommandBaseAccessor *pAccessor );
107 static bool Fixup( ConCommandBase* pConCommandBase );
109 static void PublishCommands( bool bForce );
114 // Called when a ConVar changes value
115 typedef void ( *FnChangeCallback )( ConVar *var, char const *pOldString );
117 // Called when a ConCommand needs to execute
118 typedef void ( *FnCommandCallback )( void );
120 #define COMMAND_COMPLETION_MAXITEMS 64
121 #define COMMAND_COMPLETION_ITEM_LENGTH 64
123 // Returns 0 to COMMAND_COMPLETION_MAXITEMS worth of completion strings
124 typedef int ( *FnCommandCompletionCallback )( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
126 //-----------------------------------------------------------------------------
127 // Purpose: The base console invoked command/cvar interface
128 //-----------------------------------------------------------------------------
131 friend class ConCommandBaseMgr;
134 friend class ConCommand;
137 ConCommandBase( void );
138 ConCommandBase( char const *pName, char const *pHelpString = 0,
141 virtual ~ConCommandBase( void );
143 virtual bool IsCommand( void ) const;
146 virtual bool IsBitSet( int flag ) const;
148 virtual void AddFlags( int flags );
150 // Return name of cvar
151 virtual char const *GetName( void ) const;
153 // Return help text for cvar
154 virtual char const *GetHelpText( void ) const;
156 // Deal with next pointer
157 const ConCommandBase *GetNext( void ) const;
158 void SetNext( ConCommandBase *next );
160 virtual bool IsRegistered( void ) const;
163 static ConCommandBase const *GetCommands( void );
164 static void AddToList( ConCommandBase *var );
165 static void RemoveFlaggedCommands( int flag );
166 static void RevertFlaggedCvars( int flag );
167 static ConCommandBase const *FindCommand( char const *name );
170 virtual void Create( char const *pName, char const *pHelpString = 0,
173 // Used internally by OneTimeInit to initialize.
176 // Internal copy routine ( uses new operator from correct module )
177 char *CopyString( char const *from );
179 // Next ConVar in chain
180 ConCommandBase *m_pNext;
183 // Has the cvar been added to the global list?
187 char const *m_pszName;
188 char const *m_pszHelpString;
195 // ConVars add themselves to this list for the executable. Then ConVarMgr::Init() runs through
196 // all the console variables and registers them.
197 static ConCommandBase *s_pConCommandBases;
199 // ConVars in this executable use this 'global' to access values.
200 static IConCommandBaseAccessor *s_pAccessor;
203 //-----------------------------------------------------------------------------
204 // Purpose: The console invoked command
205 //-----------------------------------------------------------------------------
206 class ConCommand : public ConCommandBase
208 friend class ConCommandBaseMgr;
210 #ifdef _STATIC_LINKED
211 friend class G_ConCommand;
212 friend class C_ConCommand;
213 friend class M_ConCommand;
214 friend class S_ConCommand;
215 friend class D_ConCommand;
219 typedef ConCommandBase BaseClass;
222 ConCommand( char const *pName, FnCommandCallback callback,
223 char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
225 virtual ~ConCommand( void );
227 virtual bool IsCommand( void ) const;
229 virtual int AutoCompleteSuggest( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
231 virtual bool CanAutoComplete( void );
233 // Invoke the function
234 virtual void Dispatch( void );
236 virtual void Create( char const *pName, FnCommandCallback callback,
237 char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
239 // Call this function when executing the command
240 FnCommandCallback m_fnCommandCallback;
242 FnCommandCompletionCallback m_fnCompletionCallback;
243 bool m_bHasCompletionCallback;
245 FnCommandCallback GetCallback() { return m_fnCommandCallback; }
248 //-----------------------------------------------------------------------------
249 // Purpose: A console variable
250 //-----------------------------------------------------------------------------
251 class ConVar : public ConCommandBase
253 friend class ConCommandBaseMgr;
255 friend class CDefaultCvar;
256 #ifdef _STATIC_LINKED
257 friend class G_ConVar;
258 friend class C_ConVar;
259 friend class M_ConVar;
260 friend class S_ConVar;
261 friend class D_ConVar;
265 typedef ConCommandBase BaseClass;
267 ConVar( char const *pName, char const *pDefaultValue, int flags = 0);
269 ConVar( char const *pName, char const *pDefaultValue, int flags,
270 char const *pHelpString );
271 ConVar( char const *pName, char const *pDefaultValue, int flags,
272 char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax );
273 ConVar( char const *pName, char const *pDefaultValue, int flags,
274 char const *pHelpString, FnChangeCallback callback );
275 ConVar( char const *pName, char const *pDefaultValue, int flags,
276 char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax,
277 FnChangeCallback callback );
279 virtual ~ConVar( void );
281 virtual bool IsBitSet( int flag ) const;
282 virtual char const* GetHelpText( void ) const;
283 virtual bool IsRegistered( void ) const;
284 virtual char const *GetName( void ) const;
285 virtual void AddFlags( int flags );
286 virtual bool IsCommand( void ) const;
288 // Install a change callback (there shouldn't already be one....)
289 void InstallChangeCallback( FnChangeCallback callback );
292 FORCEINLINE_CVAR float GetFloat( void ) const;
293 FORCEINLINE_CVAR int GetInt( void ) const;
294 FORCEINLINE_CVAR bool GetBool() const { return !!GetInt(); }
295 FORCEINLINE_CVAR char const *GetString( void ) const;
297 // Any function that allocates/frees memory needs to be virtual or else you'll have crashes
298 // from alloc/free across dll/exe boundaries.
300 // These just call into the IConCommandBaseAccessor to check flags and set the var (which ends up calling InternalSetValue).
301 virtual void SetValue( char const *value );
302 virtual void SetValue( float value );
303 virtual void SetValue( int value );
305 // Reset to default value
308 // True if it has a min/max setting
309 bool GetMin( float& minVal ) const;
310 bool GetMax( float& maxVal ) const;
311 char const *GetDefault( void ) const;
313 static void RevertAll( void );
315 // Called by CCvar when the value of a var is changing.
316 virtual void InternalSetValue(char const *value);
317 // For CVARs marked FCVAR_NEVER_AS_STRING
318 virtual void InternalSetFloatValue( float fNewValue );
319 virtual void InternalSetIntValue( int nValue );
321 virtual bool ClampValue( float& value );
322 virtual void ChangeStringValue( char const *tempVal );
324 virtual void Create( char const *pName, char const *pDefaultValue, int flags = 0,
325 char const *pHelpString = 0, bool bMin = false, float fMin = 0.0,
326 bool bMax = false, float fMax = false, FnChangeCallback callback = 0 );
328 // Used internally by OneTimeInit to initialize.
333 // This either points to "this" or it points to the original declaration of a ConVar.
334 // This allows ConVars to exist in separate modules, and they all use the first one to be declared.
335 // m_pParent->m_pParent must equal m_pParent (ie: m_pParent must be the root, or original, ConVar).
339 char const *m_pszDefaultValue;
342 // Dynamically allocated
356 // Call this function when ConVar changes
357 FnChangeCallback m_fnChangeCallback;
361 //-----------------------------------------------------------------------------
362 // Purpose: Return ConVar value as a float
364 //-----------------------------------------------------------------------------
365 FORCEINLINE_CVAR float ConVar::GetFloat( void ) const
367 return m_pParent->m_fValue;
370 //-----------------------------------------------------------------------------
371 // Purpose: Return ConVar value as an int
373 //-----------------------------------------------------------------------------
374 FORCEINLINE_CVAR int ConVar::GetInt( void ) const
376 return m_pParent->m_nValue;
380 //-----------------------------------------------------------------------------
381 // Purpose: Return ConVar value as a string, return "" for bogus string pointer, etc.
382 // Output : char const *
383 //-----------------------------------------------------------------------------
384 FORCEINLINE_CVAR char const *ConVar::GetString( void ) const
386 if ( m_nFlags & FCVAR_NEVER_AS_STRING )
388 return "FCVAR_NEVER_AS_STRING";
391 return ( m_pParent->m_pszString ) ? m_pParent->m_pszString : "";
395 #ifdef _STATIC_LINKED
396 // identifies subsystem via piggybacking constructors with flags
397 class G_ConCommand : public ConCommand
400 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) {}
403 class C_ConCommand : public ConCommand
406 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) {}
409 class M_ConCommand : public ConCommand
412 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) {}
415 class S_ConCommand : public ConCommand
418 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) {}
421 class D_ConCommand : public ConCommand
424 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) {}
427 typedef void ( *G_FnChangeCallback )( G_ConVar *var, char const *pOldString );
428 typedef void ( *C_FnChangeCallback )( C_ConVar *var, char const *pOldString );
429 typedef void ( *M_FnChangeCallback )( M_ConVar *var, char const *pOldString );
430 typedef void ( *S_FnChangeCallback )( S_ConVar *var, char const *pOldString );
431 typedef void ( *D_FnChangeCallback )( D_ConVar *var, char const *pOldString );
433 class G_ConVar : public ConVar
436 G_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL) {}
437 G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString ) {}
438 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) {}
439 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 ) {}
440 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 ) {}
443 class C_ConVar : public ConVar
446 C_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL) {}
447 C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString ) {}
448 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) {}
449 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 ) {}
450 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 ) {}
453 class M_ConVar : public ConVar
456 M_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM) {}
457 M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString ) {}
458 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) {}
459 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 ) {}
460 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 ) {}
463 class S_ConVar : public ConVar
466 S_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER) {}
467 S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString ) {}
468 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) {}
469 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 ) {}
470 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 ) {}
473 class D_ConVar : public ConVar
476 D_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE) {}
477 D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString ) {}
478 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) {}
479 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 ) {}
480 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 ) {}
483 // redirect these declarations to their specific subsystem
485 #define ConCommand G_ConCommand
486 #define ConVar G_ConVar
489 #define ConCommand C_ConCommand
490 #define ConVar C_ConVar
492 #ifdef MATERIALSYSTEM_DLL
493 #define ConCommand M_ConCommand
494 #define ConVar M_ConVar
496 #ifdef STUDIORENDER_DLL
497 #define ConCommand S_ConCommand
498 #define ConVar S_ConVar
501 #define ConCommand D_ConCommand
502 #define ConVar D_ConVar
504 #endif // _STATIC_LINKED
506 //-----------------------------------------------------------------------------
507 // Purpose: Utility to quicky generate a simple console command
508 //-----------------------------------------------------------------------------
509 #define CON_COMMAND( name, description ) \
510 static void name(); \
511 static ConCommand name##_command( #name, name, description ); \
514 //-----------------------------------------------------------------------------
515 // Purpose: Utility to quicky generate a simple console command
516 //-----------------------------------------------------------------------------
517 #define CON_COMMAND_F( name, description, flags ) \
518 static void name(); \
519 static ConCommand name##_command( #name, name, description, flags ); \