sourcemm/convar.h
author Christian Hammacher <bmasterc@gmail.com>
Sun Feb 12 21:07:31 2006 +0000 (2006-02-12)
changeset 182 f60d482a6e07
parent 76 39266faeec97
child 232 a86d52ff721c
permissions -rw-r--r--
Changed version number to 1.2.1
dvander@76
     1
//========= Copyright � 1996-2005, Valve Corporation, All rights reserved. ============//
dvander@76
     2
//
dvander@76
     3
// Purpose: 
dvander@76
     4
//
dvander@76
     5
// $Workfile:     $
dvander@76
     6
// $Date$
dvander@76
     7
//
dvander@76
     8
//-----------------------------------------------------------------------------
dvander@76
     9
// $NoKeywords: $
dvander@76
    10
//=============================================================================//
dvander@76
    11
dvander@76
    12
#ifndef CONVAR_H
dvander@76
    13
#define CONVAR_H
dvander@76
    14
#if _WIN32
dvander@76
    15
#pragma once
dvander@76
    16
#endif
dvander@76
    17
dvander@76
    18
#include "tier0/dbg.h"
dvander@76
    19
dvander@76
    20
// The default, no flags at all
dvander@76
    21
#define FCVAR_NONE				0 
dvander@76
    22
dvander@76
    23
// Command to ConVars and ConCommands
dvander@76
    24
#define FCVAR_UNREGISTERED		(1<<0)	// If this is set, don't add to linked list, etc.
dvander@76
    25
#define FCVAR_LAUNCHER			(1<<1) // defined by launcher
dvander@76
    26
#define FCVAR_GAMEDLL			(1<<2)	// defined by the game DLL
dvander@76
    27
#define FCVAR_CLIENTDLL			(1<<3)  // defined by the client DLL
dvander@76
    28
#define FCVAR_MATERIAL_SYSTEM	(1<<4)	// Defined by the material system.
dvander@76
    29
#define FCVAR_STUDIORENDER		(1<<15)	// Defined by the material system.
dvander@76
    30
#define FCVAR_PLUGIN			(1<<18)	// Defined by a 3rd party plugin.
dvander@76
    31
#define FCVAR_CHEAT				(1<<14) // Only useable in singleplayer / debug / multiplayer & sv_cheats
dvander@76
    32
dvander@76
    33
// ConVar only
dvander@76
    34
#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
dvander@76
    35
#define FCVAR_SPONLY			(1<<6)  // This cvar cannot be changed by clients connected to a multiplayer server.
dvander@76
    36
#define	FCVAR_ARCHIVE			(1<<7)	// set to cause it to be saved to vars.rc
dvander@76
    37
#define	FCVAR_NOTIFY			(1<<8)	// notifies players when changed
dvander@76
    38
#define	FCVAR_USERINFO			(1<<9)	// changes the client's info string
dvander@76
    39
dvander@76
    40
#define FCVAR_PRINTABLEONLY		(1<<10)  // This cvar's string cannot contain unprintable characters ( e.g., used for player name etc ).
dvander@76
    41
#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
dvander@76
    42
#define FCVAR_NEVER_AS_STRING	(1<<12)  // never try to print that cvar
dvander@76
    43
dvander@76
    44
// It's a ConVar that's shared between the client and the server.
dvander@76
    45
// At signon, the values of all such ConVars are sent from the server to the client (skipped for local
dvander@76
    46
//  client, of course )
dvander@76
    47
// If a change is requested it must come from the console (i.e., no remote client changes)
dvander@76
    48
// If a value is changed while a server is active, it's replicated to all connected clients
dvander@76
    49
#define FCVAR_REPLICATED		(1<<13)	// server setting enforced on clients, TODO rename to FCAR_SERVER at some time
dvander@76
    50
#define FCVAR_DEMO				(1<<16)  // record this cvar when starting a demo file
dvander@76
    51
#define FCVAR_DONTRECORD		(1<<17)  // don't record these command in demofiles
dvander@76
    52
dvander@76
    53
#define FCVAR_NOT_CONNECTED		(1<<19)	// cvar cannot be changed by a client that is connected to a server
dvander@76
    54
dvander@76
    55
dvander@76
    56
class ConVar;
dvander@76
    57
class ConCommand;
dvander@76
    58
class ConCommandBase;
dvander@76
    59
dvander@76
    60
// Any executable that wants to use ConVars need to implement one of
dvander@76
    61
// these to hook up access to console variables.
dvander@76
    62
class IConCommandBaseAccessor
dvander@76
    63
{
dvander@76
    64
public:
dvander@76
    65
	// Flags is a combination of FCVAR flags in cvar.h.
dvander@76
    66
	// hOut is filled in with a handle to the variable.
dvander@76
    67
	virtual bool RegisterConCommandBase( ConCommandBase *pVar )=0;
dvander@76
    68
};
dvander@76
    69
dvander@76
    70
dvander@76
    71
// You don't have to instantiate one of these, just call its 
dvander@76
    72
// OneTimeInit function when your executable is initializing.
dvander@76
    73
class ConCommandBaseMgr
dvander@76
    74
{
dvander@76
    75
public:
dvander@76
    76
	// Call this ONCE when the executable starts up.
dvander@76
    77
	static void	OneTimeInit( IConCommandBaseAccessor *pAccessor );
dvander@76
    78
};
dvander@76
    79
dvander@76
    80
// Called when a ConVar changes value
dvander@76
    81
typedef void ( *FnChangeCallback )( ConVar *var, char const *pOldString );
dvander@76
    82
dvander@76
    83
// Called when a ConCommand needs to execute
dvander@76
    84
typedef void ( *FnCommandCallback )( void );
dvander@76
    85
dvander@76
    86
#define COMMAND_COMPLETION_MAXITEMS		64
dvander@76
    87
#define COMMAND_COMPLETION_ITEM_LENGTH	64
dvander@76
    88
dvander@76
    89
// Returns 0 to COMMAND_COMPLETION_MAXITEMS worth of completion strings
dvander@76
    90
typedef int  ( *FnCommandCompletionCallback )( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
dvander@76
    91
dvander@76
    92
//-----------------------------------------------------------------------------
dvander@76
    93
// Purpose: The base console invoked command/cvar interface
dvander@76
    94
//-----------------------------------------------------------------------------
dvander@76
    95
class ConCommandBase
dvander@76
    96
{
dvander@76
    97
	friend class ConCommandBaseMgr;
dvander@76
    98
	friend class CCvar;
dvander@76
    99
	friend class ConVar;
dvander@76
   100
	friend class ConCommand;
dvander@76
   101
dvander@76
   102
public:
dvander@76
   103
								ConCommandBase( void );
dvander@76
   104
								ConCommandBase( char const *pName, char const *pHelpString = 0, 
dvander@76
   105
									int flags = 0 );
dvander@76
   106
dvander@76
   107
	virtual						~ConCommandBase( void );
dvander@76
   108
dvander@76
   109
	virtual	bool				IsCommand( void ) const;
dvander@76
   110
dvander@76
   111
	// Check flag
dvander@76
   112
	virtual bool				IsBitSet( int flag ) const;
dvander@76
   113
	// Set flag
dvander@76
   114
	virtual void				AddFlags( int flags );
dvander@76
   115
dvander@76
   116
	// Return name of cvar
dvander@76
   117
	virtual char const			*GetName( void ) const;
dvander@76
   118
dvander@76
   119
	// Return help text for cvar
dvander@76
   120
	virtual char const			*GetHelpText( void ) const;
dvander@76
   121
dvander@76
   122
	// Deal with next pointer
dvander@76
   123
	const ConCommandBase		*GetNext( void ) const;
dvander@76
   124
	void						SetNext( ConCommandBase *next );
dvander@76
   125
	
dvander@76
   126
	virtual bool				IsRegistered( void ) const;
dvander@76
   127
dvander@76
   128
	// Global methods
dvander@76
   129
	static ConCommandBase const	*GetCommands( void );
dvander@76
   130
	static void					AddToList( ConCommandBase *var );
dvander@76
   131
	static void					RemoveFlaggedCommands( int flag );
dvander@76
   132
	static void					RevertFlaggedCvars( int flag );
dvander@76
   133
	static ConCommandBase const	*FindCommand( char const *name );
dvander@76
   134
dvander@76
   135
protected:
dvander@76
   136
	virtual void				Create( char const *pName, char const *pHelpString = 0, 
dvander@76
   137
									int flags = 0 );
dvander@76
   138
dvander@76
   139
	// Used internally by OneTimeInit to initialize.
dvander@76
   140
	virtual void				Init();
dvander@76
   141
dvander@76
   142
	// Internal copy routine ( uses new operator from correct module )
dvander@76
   143
	char						*CopyString( char const *from );
dvander@76
   144
dvander@76
   145
	// Next ConVar in chain
dvander@76
   146
	ConCommandBase				*m_pNext;
dvander@76
   147
dvander@76
   148
private:
dvander@76
   149
	// Has the cvar been added to the global list?
dvander@76
   150
	bool						m_bRegistered;
dvander@76
   151
dvander@76
   152
	// Static data
dvander@76
   153
	char const 					*m_pszName;
dvander@76
   154
	char const 					*m_pszHelpString;
dvander@76
   155
	
dvander@76
   156
	// ConVar flags
dvander@76
   157
	int							m_nFlags;
dvander@76
   158
dvander@76
   159
protected:
dvander@76
   160
dvander@76
   161
	// ConVars add themselves to this list for the executable. Then ConVarMgr::Init() runs through 
dvander@76
   162
	// all the console variables and registers them.
dvander@76
   163
	static ConCommandBase		*s_pConCommandBases;
dvander@76
   164
dvander@76
   165
	// ConVars in this executable use this 'global' to access values.
dvander@76
   166
	static IConCommandBaseAccessor	*s_pAccessor;
dvander@76
   167
};
dvander@76
   168
dvander@76
   169
//-----------------------------------------------------------------------------
dvander@76
   170
// Purpose: The console invoked command
dvander@76
   171
//-----------------------------------------------------------------------------
dvander@76
   172
class ConCommand : public ConCommandBase
dvander@76
   173
{
dvander@76
   174
friend class ConCommandBaseMgr;
dvander@76
   175
friend class CCvar;
dvander@76
   176
dvander@76
   177
public:
dvander@76
   178
	typedef ConCommandBase BaseClass;
dvander@76
   179
dvander@76
   180
								ConCommand( void );
dvander@76
   181
								ConCommand( char const *pName, FnCommandCallback callback, 
dvander@76
   182
									char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
dvander@76
   183
dvander@76
   184
	virtual						~ConCommand( void );
dvander@76
   185
dvander@76
   186
	virtual	bool				IsCommand( void ) const;
dvander@76
   187
dvander@76
   188
	virtual int					AutoCompleteSuggest( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
dvander@76
   189
dvander@76
   190
	virtual bool				CanAutoComplete( void );
dvander@76
   191
dvander@76
   192
	// Invoke the function
dvander@76
   193
	virtual void				Dispatch( void );
dvander@76
   194
dvander@76
   195
private:
dvander@76
   196
	virtual void				Create( char const *pName, FnCommandCallback callback, 
dvander@76
   197
									char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
dvander@76
   198
public:
dvander@76
   199
	// Call this function when executing the command
dvander@76
   200
	FnCommandCallback			m_fnCommandCallback;
dvander@76
   201
dvander@76
   202
	FnCommandCompletionCallback	m_fnCompletionCallback;
dvander@76
   203
	bool						m_bHasCompletionCallback;
dvander@76
   204
public:
dvander@76
   205
//HACKHACK from BAILOPAN - we want to access this okay!
dvander@76
   206
	FnCommandCallback			GetCallback() { return m_fnCommandCallback; }
dvander@76
   207
};
dvander@76
   208
dvander@76
   209
//-----------------------------------------------------------------------------
dvander@76
   210
// Purpose: A console variable
dvander@76
   211
//-----------------------------------------------------------------------------
dvander@76
   212
class ConVar : public ConCommandBase
dvander@76
   213
{
dvander@76
   214
friend class ConCommandBaseMgr;
dvander@76
   215
friend class CCvar;
dvander@76
   216
friend class CDefaultCvar;
dvander@76
   217
dvander@76
   218
public:
dvander@76
   219
	typedef ConCommandBase BaseClass;
dvander@76
   220
dvander@76
   221
								ConVar( char const *pName, char const *pDefaultValue, int flags = 0);
dvander@76
   222
dvander@76
   223
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   224
									char const *pHelpString );
dvander@76
   225
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   226
									char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax );
dvander@76
   227
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   228
									char const *pHelpString, FnChangeCallback callback );
dvander@76
   229
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@76
   230
									char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax,
dvander@76
   231
									FnChangeCallback callback );
dvander@76
   232
dvander@76
   233
	virtual						~ConVar( void );
dvander@76
   234
dvander@76
   235
	virtual bool				IsBitSet( int flag ) const;
dvander@76
   236
	virtual char const*			GetHelpText( void ) const;
dvander@76
   237
	virtual bool				IsRegistered( void ) const;
dvander@76
   238
	virtual char const			*GetName( void ) const;
dvander@76
   239
	virtual void				AddFlags( int flags );
dvander@76
   240
	virtual	bool				IsCommand( void ) const;
dvander@76
   241
dvander@76
   242
	// Install a change callback (there shouldn't already be one....)
dvander@76
   243
	void InstallChangeCallback( FnChangeCallback callback );
dvander@76
   244
dvander@76
   245
	// Retrieve value
dvander@76
   246
	FORCEINLINE float			GetFloat( void ) const;
dvander@76
   247
	FORCEINLINE int				GetInt( void ) const;
dvander@76
   248
	FORCEINLINE bool			GetBool() const	{  return !!GetInt(); }
dvander@76
   249
	FORCEINLINE char const	   *GetString( void ) const;
dvander@76
   250
dvander@76
   251
	// Any function that allocates/frees memory needs to be virtual or else you'll have crashes
dvander@76
   252
	//  from alloc/free across dll/exe boundaries.
dvander@76
   253
	
dvander@76
   254
	// These just call into the IConCommandBaseAccessor to check flags and set the var (which ends up calling InternalSetValue).
dvander@76
   255
	virtual void				SetValue( char const *value );
dvander@76
   256
	virtual void				SetValue( float value );
dvander@76
   257
	virtual void				SetValue( int value );
dvander@76
   258
	
dvander@76
   259
	// Reset to default value
dvander@76
   260
	void						Revert( void );
dvander@76
   261
dvander@76
   262
	// True if it has a min/max setting
dvander@76
   263
	bool						GetMin( float& minVal ) const;
dvander@76
   264
	bool						GetMax( float& maxVal ) const;
dvander@76
   265
	char const					*GetDefault( void ) const;
dvander@76
   266
dvander@76
   267
	static void					RevertAll( void );
dvander@76
   268
private:
dvander@76
   269
	// Called by CCvar when the value of a var is changing.
dvander@76
   270
	virtual void				InternalSetValue(char const *value);
dvander@76
   271
	// For CVARs marked FCVAR_NEVER_AS_STRING
dvander@76
   272
	virtual void				InternalSetFloatValue( float fNewValue );
dvander@76
   273
	virtual void				InternalSetIntValue( int nValue );
dvander@76
   274
dvander@76
   275
	virtual bool				ClampValue( float& value );
dvander@76
   276
	virtual void				ChangeStringValue( char const *tempVal );
dvander@76
   277
dvander@76
   278
	virtual void				Create( char const *pName, char const *pDefaultValue, int flags = 0,
dvander@76
   279
									char const *pHelpString = 0, bool bMin = false, float fMin = 0.0,
dvander@76
   280
									bool bMax = false, float fMax = false, FnChangeCallback callback = 0 );
dvander@76
   281
dvander@76
   282
	// Used internally by OneTimeInit to initialize.
dvander@76
   283
	virtual void				Init();
dvander@76
   284
dvander@76
   285
private:
dvander@76
   286
dvander@76
   287
	// This either points to "this" or it points to the original declaration of a ConVar.
dvander@76
   288
	// This allows ConVars to exist in separate modules, and they all use the first one to be declared.
dvander@76
   289
	// m_pParent->m_pParent must equal m_pParent (ie: m_pParent must be the root, or original, ConVar).
dvander@76
   290
	ConVar						*m_pParent;
dvander@76
   291
dvander@76
   292
	// Static data
dvander@76
   293
	char const					*m_pszDefaultValue;
dvander@76
   294
	
dvander@76
   295
	// Value
dvander@76
   296
	// Dynamically allocated
dvander@76
   297
	char						*m_pszString;
dvander@76
   298
	int							m_StringLength;
dvander@76
   299
dvander@76
   300
	// Values
dvander@76
   301
	float						m_fValue;
dvander@76
   302
	int							m_nValue;
dvander@76
   303
dvander@76
   304
	// Min/Max values
dvander@76
   305
	bool						m_bHasMin;
dvander@76
   306
	float						m_fMinVal;
dvander@76
   307
	bool						m_bHasMax;
dvander@76
   308
	float						m_fMaxVal;
dvander@76
   309
	
dvander@76
   310
	// Call this function when ConVar changes
dvander@76
   311
	FnChangeCallback			m_fnChangeCallback;
dvander@76
   312
};
dvander@76
   313
dvander@76
   314
//-----------------------------------------------------------------------------
dvander@76
   315
// Purpose: Return ConVar value as a float
dvander@76
   316
// Output : float
dvander@76
   317
//-----------------------------------------------------------------------------
dvander@76
   318
FORCEINLINE float ConVar::GetFloat( void ) const
dvander@76
   319
{
dvander@76
   320
	return m_pParent->m_fValue;
dvander@76
   321
}
dvander@76
   322
dvander@76
   323
//-----------------------------------------------------------------------------
dvander@76
   324
// Purpose: Return ConVar value as an int
dvander@76
   325
// Output : int
dvander@76
   326
//-----------------------------------------------------------------------------
dvander@76
   327
FORCEINLINE int ConVar::GetInt( void ) const 
dvander@76
   328
{
dvander@76
   329
	return m_pParent->m_nValue;
dvander@76
   330
}
dvander@76
   331
dvander@76
   332
dvander@76
   333
//-----------------------------------------------------------------------------
dvander@76
   334
// Purpose: Return ConVar value as a string, return "" for bogus string pointer, etc.
dvander@76
   335
// Output : char const *
dvander@76
   336
//-----------------------------------------------------------------------------
dvander@76
   337
FORCEINLINE char const *ConVar::GetString( void ) const 
dvander@76
   338
{
dvander@76
   339
	if ( m_nFlags & FCVAR_NEVER_AS_STRING )
dvander@76
   340
	{
dvander@76
   341
		return "FCVAR_NEVER_AS_STRING";
dvander@76
   342
	}
dvander@76
   343
dvander@76
   344
	return ( m_pParent->m_pszString ) ? m_pParent->m_pszString : "";
dvander@76
   345
}
dvander@76
   346
dvander@76
   347
dvander@76
   348
//-----------------------------------------------------------------------------
dvander@76
   349
// Purpose: Utility to quicky generate a simple console command
dvander@76
   350
//-----------------------------------------------------------------------------
dvander@76
   351
#define CON_COMMAND( name, description ) \
dvander@76
   352
   static void name(); \
dvander@76
   353
   static ConCommand name##_command( #name, name, description ); \
dvander@76
   354
   static void name()
dvander@76
   355
dvander@76
   356
//-----------------------------------------------------------------------------
dvander@76
   357
// Purpose: Utility to quicky generate a simple console command
dvander@76
   358
//-----------------------------------------------------------------------------
dvander@76
   359
#define CON_COMMAND_F( name, description, flags ) \
dvander@76
   360
   static void name(); \
dvander@76
   361
   static ConCommand name##_command( #name, name, description, flags ); \
dvander@76
   362
   static void name()
dvander@76
   363
dvander@76
   364
dvander@76
   365
#endif // CONVAR_H