sourcemm/convar_smm.h
author David Anderson <dvander@alliedmods.net>
Tue Sep 18 20:03:47 2007 +0000 (2007-09-18)
branchsourcemm-1.6.0
changeset 347 e82968c21606
permissions -rw-r--r--
branched 1.4.2 to 1.6.0
dvander@347
     1
//========= Copyright � 1996-2005, Valve Corporation, All rights reserved. ============//
dvander@347
     2
//
dvander@347
     3
// Purpose: 
dvander@347
     4
//
dvander@347
     5
// $Workfile:     $
dvander@347
     6
// $Date$
dvander@347
     7
//
dvander@347
     8
//-----------------------------------------------------------------------------
dvander@347
     9
// $NoKeywords: $
dvander@347
    10
//=============================================================================//
dvander@347
    11
dvander@347
    12
#ifndef CONVAR_H
dvander@347
    13
#define CONVAR_H
dvander@347
    14
#if _WIN32
dvander@347
    15
#pragma once
dvander@347
    16
#endif
dvander@347
    17
dvander@347
    18
#include "tier0/dbg.h"
dvander@347
    19
dvander@347
    20
#ifdef _WIN32
dvander@347
    21
#define FORCEINLINE_CVAR FORCEINLINE
dvander@347
    22
#elif _LINUX
dvander@347
    23
#define FORCEINLINE_CVAR __inline__ FORCEINLINE
dvander@347
    24
#else
dvander@347
    25
#error "implement me"
dvander@347
    26
#endif
dvander@347
    27
dvander@347
    28
// The default, no flags at all
dvander@347
    29
#define FCVAR_NONE				0 
dvander@347
    30
dvander@347
    31
// Command to ConVars and ConCommands
dvander@347
    32
// ConVar Systems
dvander@347
    33
#define FCVAR_UNREGISTERED		(1<<0)	// If this is set, don't add to linked list, etc.
dvander@347
    34
#define FCVAR_LAUNCHER			(1<<1)	// defined by launcher
dvander@347
    35
#define FCVAR_GAMEDLL			(1<<2)	// defined by the game DLL
dvander@347
    36
#define FCVAR_CLIENTDLL			(1<<3)  // defined by the client DLL
dvander@347
    37
#define FCVAR_MATERIAL_SYSTEM	(1<<4)	// Defined by the material system.
dvander@347
    38
#define FCVAR_DATACACHE			(1<<19)	// Defined by the datacache system.
dvander@347
    39
#define FCVAR_STUDIORENDER		(1<<15)	// Defined by the studiorender system.
dvander@347
    40
#define FCVAR_FILESYSTEM		(1<<21)	// Defined by the file system.
dvander@347
    41
#define FCVAR_PLUGIN			(1<<18)	// Defined by a 3rd party plugin.
dvander@347
    42
#define FCVAR_TOOLSYSTEM		(1<<20)	// Defined by an IToolSystem library
dvander@347
    43
#define FCVAR_SOUNDSYSTEM		(1<<23)	// Defined by the soundsystem library
dvander@347
    44
#define FCVAR_INPUTSYSTEM		(1<<25)	// Defined by the inputsystem dll
dvander@347
    45
#define FCVAR_NETWORKSYSTEM		(1<<26) // Defined by the network system
dvander@347
    46
// NOTE!! if you add a cvar system, add it here too!!!!
dvander@347
    47
// the engine lacks a cvar flag, but needs it for xbox
dvander@347
    48
// an engine cvar is thus a cvar not marked with any other system
dvander@347
    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))
dvander@347
    50
dvander@347
    51
// ConVar only
dvander@347
    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
dvander@347
    53
#define FCVAR_SPONLY			(1<<6)  // This cvar cannot be changed by clients connected to a multiplayer server.
dvander@347
    54
#define	FCVAR_ARCHIVE			(1<<7)	// set to cause it to be saved to vars.rc
dvander@347
    55
#define	FCVAR_NOTIFY			(1<<8)	// notifies players when changed
dvander@347
    56
#define	FCVAR_USERINFO			(1<<9)	// changes the client's info string
dvander@347
    57
#define FCVAR_CHEAT				(1<<14) // Only useable in singleplayer / debug / multiplayer & sv_cheats
dvander@347
    58
dvander@347
    59
#define FCVAR_PRINTABLEONLY		(1<<10)  // This cvar's string cannot contain unprintable characters ( e.g., used for player name etc ).
dvander@347
    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
dvander@347
    61
#define FCVAR_NEVER_AS_STRING	(1<<12)  // never try to print that cvar
dvander@347
    62
dvander@347
    63
// It's a ConVar that's shared between the client and the server.
dvander@347
    64
// At signon, the values of all such ConVars are sent from the server to the client (skipped for local
dvander@347
    65
//  client, of course )
dvander@347
    66
// If a change is requested it must come from the console (i.e., no remote client changes)
dvander@347
    67
// If a value is changed while a server is active, it's replicated to all connected clients
dvander@347
    68
#define FCVAR_REPLICATED		(1<<13)	// server setting enforced on clients, TODO rename to FCAR_SERVER at some time
dvander@347
    69
#define FCVAR_DEMO				(1<<16)  // record this cvar when starting a demo file
dvander@347
    70
#define FCVAR_DONTRECORD		(1<<17)  // don't record these command in demofiles
dvander@347
    71
dvander@347
    72
#define FCVAR_NOT_CONNECTED		(1<<22)	// cvar cannot be changed by a client that is connected to a server
dvander@347
    73
dvander@347
    74
#define FCVAR_ARCHIVE_XBOX		(1<<24) // cvar written to config.cfg on the Xbox
dvander@347
    75
dvander@347
    76
dvander@347
    77
// #define FCVAR_AVAILABLE			(1<<27)
dvander@347
    78
// #define FCVAR_AVAILABLE			(1<<28)
dvander@347
    79
// #define FCVAR_AVAILABLE			(1<<29)
dvander@347
    80
// #define FCVAR_AVAILABLE			(1<<30)
dvander@347
    81
// #define FCVAR_AVAILABLE			(1<<31)
dvander@347
    82
dvander@347
    83
dvander@347
    84
class ConVar;
dvander@347
    85
class ConCommand;
dvander@347
    86
class ConCommandBase;
dvander@347
    87
dvander@347
    88
// Any executable that wants to use ConVars need to implement one of
dvander@347
    89
// these to hook up access to console variables.
dvander@347
    90
class IConCommandBaseAccessor
dvander@347
    91
{
dvander@347
    92
public:
dvander@347
    93
	// Flags is a combination of FCVAR flags in cvar.h.
dvander@347
    94
	// hOut is filled in with a handle to the variable.
dvander@347
    95
	virtual bool RegisterConCommandBase( ConCommandBase *pVar )=0;
dvander@347
    96
};
dvander@347
    97
dvander@347
    98
dvander@347
    99
// You don't have to instantiate one of these, just call its 
dvander@347
   100
// OneTimeInit function when your executable is initializing.
dvander@347
   101
class ConCommandBaseMgr
dvander@347
   102
{
dvander@347
   103
public:
dvander@347
   104
	// Call this ONCE when the executable starts up.
dvander@347
   105
	static void	OneTimeInit( IConCommandBaseAccessor *pAccessor );
dvander@347
   106
#ifdef _XBOX
dvander@347
   107
	static bool Fixup( ConCommandBase* pConCommandBase );
dvander@347
   108
#ifndef _RETAIL
dvander@347
   109
	static void PublishCommands( bool bForce );
dvander@347
   110
#endif
dvander@347
   111
#endif
dvander@347
   112
};
dvander@347
   113
dvander@347
   114
// Called when a ConVar changes value
dvander@347
   115
typedef void ( *FnChangeCallback )( ConVar *var, char const *pOldString );
dvander@347
   116
dvander@347
   117
// Called when a ConCommand needs to execute
dvander@347
   118
typedef void ( *FnCommandCallback )( void );
dvander@347
   119
dvander@347
   120
#define COMMAND_COMPLETION_MAXITEMS		64
dvander@347
   121
#define COMMAND_COMPLETION_ITEM_LENGTH	64
dvander@347
   122
dvander@347
   123
// Returns 0 to COMMAND_COMPLETION_MAXITEMS worth of completion strings
dvander@347
   124
typedef int  ( *FnCommandCompletionCallback )( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
dvander@347
   125
dvander@347
   126
//-----------------------------------------------------------------------------
dvander@347
   127
// Purpose: The base console invoked command/cvar interface
dvander@347
   128
//-----------------------------------------------------------------------------
dvander@347
   129
class ConCommandBase
dvander@347
   130
{
dvander@347
   131
	friend class ConCommandBaseMgr;
dvander@347
   132
	friend class CCvar;
dvander@347
   133
	friend class ConVar;
dvander@347
   134
	friend class ConCommand;
dvander@347
   135
dvander@347
   136
public:
dvander@347
   137
								ConCommandBase( void );
dvander@347
   138
								ConCommandBase( char const *pName, char const *pHelpString = 0, 
dvander@347
   139
									int flags = 0 );
dvander@347
   140
dvander@347
   141
	virtual						~ConCommandBase( void );
dvander@347
   142
dvander@347
   143
	virtual	bool				IsCommand( void ) const;
dvander@347
   144
dvander@347
   145
	// Check flag
dvander@347
   146
	virtual bool				IsBitSet( int flag ) const;
dvander@347
   147
	// Set flag
dvander@347
   148
	virtual void				AddFlags( int flags );
dvander@347
   149
dvander@347
   150
	// Return name of cvar
dvander@347
   151
	virtual char const			*GetName( void ) const;
dvander@347
   152
dvander@347
   153
	// Return help text for cvar
dvander@347
   154
	virtual char const			*GetHelpText( void ) const;
dvander@347
   155
dvander@347
   156
	// Deal with next pointer
dvander@347
   157
	const ConCommandBase		*GetNext( void ) const;
dvander@347
   158
	void						SetNext( ConCommandBase *next );
dvander@347
   159
	
dvander@347
   160
	virtual bool				IsRegistered( void ) const;
dvander@347
   161
dvander@347
   162
	// Global methods
dvander@347
   163
	static ConCommandBase const	*GetCommands( void );
dvander@347
   164
	static void					AddToList( ConCommandBase *var );
dvander@347
   165
	static void					RemoveFlaggedCommands( int flag );
dvander@347
   166
	static void					RevertFlaggedCvars( int flag );
dvander@347
   167
	static ConCommandBase const	*FindCommand( char const *name );
dvander@347
   168
dvander@347
   169
protected:
dvander@347
   170
	virtual void				Create( char const *pName, char const *pHelpString = 0, 
dvander@347
   171
									int flags = 0 );
dvander@347
   172
dvander@347
   173
	// Used internally by OneTimeInit to initialize.
dvander@347
   174
	virtual void				Init();
dvander@347
   175
dvander@347
   176
	// Internal copy routine ( uses new operator from correct module )
dvander@347
   177
	char						*CopyString( char const *from );
dvander@347
   178
dvander@347
   179
	// Next ConVar in chain
dvander@347
   180
	ConCommandBase				*m_pNext;
dvander@347
   181
dvander@347
   182
private:
dvander@347
   183
	// Has the cvar been added to the global list?
dvander@347
   184
	bool						m_bRegistered;
dvander@347
   185
dvander@347
   186
	// Static data
dvander@347
   187
	char const 					*m_pszName;
dvander@347
   188
	char const 					*m_pszHelpString;
dvander@347
   189
	
dvander@347
   190
	// ConVar flags
dvander@347
   191
	int							m_nFlags;
dvander@347
   192
dvander@347
   193
protected:
dvander@347
   194
dvander@347
   195
	// ConVars add themselves to this list for the executable. Then ConVarMgr::Init() runs through 
dvander@347
   196
	// all the console variables and registers them.
dvander@347
   197
	static ConCommandBase		*s_pConCommandBases;
dvander@347
   198
dvander@347
   199
	// ConVars in this executable use this 'global' to access values.
dvander@347
   200
	static IConCommandBaseAccessor	*s_pAccessor;
dvander@347
   201
};
dvander@347
   202
dvander@347
   203
//-----------------------------------------------------------------------------
dvander@347
   204
// Purpose: The console invoked command
dvander@347
   205
//-----------------------------------------------------------------------------
dvander@347
   206
class ConCommand : public ConCommandBase
dvander@347
   207
{
dvander@347
   208
friend class ConCommandBaseMgr;
dvander@347
   209
friend class CCvar;
dvander@347
   210
#ifdef _STATIC_LINKED
dvander@347
   211
friend class G_ConCommand;
dvander@347
   212
friend class C_ConCommand;
dvander@347
   213
friend class M_ConCommand;
dvander@347
   214
friend class S_ConCommand;
dvander@347
   215
friend class D_ConCommand;
dvander@347
   216
#endif
dvander@347
   217
dvander@347
   218
public:
dvander@347
   219
	typedef ConCommandBase BaseClass;
dvander@347
   220
dvander@347
   221
								ConCommand( void );
dvander@347
   222
								ConCommand( char const *pName, FnCommandCallback callback, 
dvander@347
   223
									char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
dvander@347
   224
dvander@347
   225
	virtual						~ConCommand( void );
dvander@347
   226
dvander@347
   227
	virtual	bool				IsCommand( void ) const;
dvander@347
   228
dvander@347
   229
	virtual int					AutoCompleteSuggest( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] );
dvander@347
   230
dvander@347
   231
	virtual bool				CanAutoComplete( void );
dvander@347
   232
dvander@347
   233
	// Invoke the function
dvander@347
   234
	virtual void				Dispatch( void );
dvander@347
   235
private:
dvander@347
   236
	virtual void				Create( char const *pName, FnCommandCallback callback, 
dvander@347
   237
									char const *pHelpString = 0, int flags = 0, FnCommandCompletionCallback completionFunc = 0 );
dvander@347
   238
dvander@347
   239
	// Call this function when executing the command
dvander@347
   240
	FnCommandCallback			m_fnCommandCallback;
dvander@347
   241
dvander@347
   242
	FnCommandCompletionCallback	m_fnCompletionCallback;
dvander@347
   243
	bool						m_bHasCompletionCallback;
dvander@347
   244
public:
dvander@347
   245
	FnCommandCallback			GetCallback() { return m_fnCommandCallback; }
dvander@347
   246
};
dvander@347
   247
dvander@347
   248
//-----------------------------------------------------------------------------
dvander@347
   249
// Purpose: A console variable
dvander@347
   250
//-----------------------------------------------------------------------------
dvander@347
   251
class ConVar : public ConCommandBase
dvander@347
   252
{
dvander@347
   253
friend class ConCommandBaseMgr;
dvander@347
   254
friend class CCvar;
dvander@347
   255
friend class CDefaultCvar;
dvander@347
   256
#ifdef _STATIC_LINKED
dvander@347
   257
friend class G_ConVar;
dvander@347
   258
friend class C_ConVar;
dvander@347
   259
friend class M_ConVar;
dvander@347
   260
friend class S_ConVar;
dvander@347
   261
friend class D_ConVar;
dvander@347
   262
#endif
dvander@347
   263
dvander@347
   264
public:
dvander@347
   265
	typedef ConCommandBase BaseClass;
dvander@347
   266
dvander@347
   267
								ConVar( char const *pName, char const *pDefaultValue, int flags = 0);
dvander@347
   268
dvander@347
   269
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@347
   270
									char const *pHelpString );
dvander@347
   271
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@347
   272
									char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax );
dvander@347
   273
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@347
   274
									char const *pHelpString, FnChangeCallback callback );
dvander@347
   275
								ConVar( char const *pName, char const *pDefaultValue, int flags, 
dvander@347
   276
									char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax,
dvander@347
   277
									FnChangeCallback callback );
dvander@347
   278
dvander@347
   279
	virtual						~ConVar( void );
dvander@347
   280
dvander@347
   281
	virtual bool				IsBitSet( int flag ) const;
dvander@347
   282
	virtual char const*			GetHelpText( void ) const;
dvander@347
   283
	virtual bool				IsRegistered( void ) const;
dvander@347
   284
	virtual char const			*GetName( void ) const;
dvander@347
   285
	virtual void				AddFlags( int flags );
dvander@347
   286
	virtual	bool				IsCommand( void ) const;
dvander@347
   287
dvander@347
   288
	// Install a change callback (there shouldn't already be one....)
dvander@347
   289
	void InstallChangeCallback( FnChangeCallback callback );
dvander@347
   290
dvander@347
   291
	// Retrieve value
dvander@347
   292
	FORCEINLINE_CVAR float			GetFloat( void ) const;
dvander@347
   293
	FORCEINLINE_CVAR int				GetInt( void ) const;
dvander@347
   294
	FORCEINLINE_CVAR bool			GetBool() const {  return !!GetInt(); }
dvander@347
   295
	FORCEINLINE_CVAR char const	   *GetString( void ) const;
dvander@347
   296
dvander@347
   297
	// Any function that allocates/frees memory needs to be virtual or else you'll have crashes
dvander@347
   298
	//  from alloc/free across dll/exe boundaries.
dvander@347
   299
	
dvander@347
   300
	// These just call into the IConCommandBaseAccessor to check flags and set the var (which ends up calling InternalSetValue).
dvander@347
   301
	virtual void				SetValue( char const *value );
dvander@347
   302
	virtual void				SetValue( float value );
dvander@347
   303
	virtual void				SetValue( int value );
dvander@347
   304
	
dvander@347
   305
	// Reset to default value
dvander@347
   306
	void						Revert( void );
dvander@347
   307
dvander@347
   308
	// True if it has a min/max setting
dvander@347
   309
	bool						GetMin( float& minVal ) const;
dvander@347
   310
	bool						GetMax( float& maxVal ) const;
dvander@347
   311
	char const					*GetDefault( void ) const;
dvander@347
   312
dvander@347
   313
	static void					RevertAll( void );
dvander@347
   314
private:
dvander@347
   315
	// Called by CCvar when the value of a var is changing.
dvander@347
   316
	virtual void				InternalSetValue(char const *value);
dvander@347
   317
	// For CVARs marked FCVAR_NEVER_AS_STRING
dvander@347
   318
	virtual void				InternalSetFloatValue( float fNewValue );
dvander@347
   319
	virtual void				InternalSetIntValue( int nValue );
dvander@347
   320
dvander@347
   321
	virtual bool				ClampValue( float& value );
dvander@347
   322
	virtual void				ChangeStringValue( char const *tempVal );
dvander@347
   323
dvander@347
   324
	virtual void				Create( char const *pName, char const *pDefaultValue, int flags = 0,
dvander@347
   325
									char const *pHelpString = 0, bool bMin = false, float fMin = 0.0,
dvander@347
   326
									bool bMax = false, float fMax = false, FnChangeCallback callback = 0 );
dvander@347
   327
dvander@347
   328
	// Used internally by OneTimeInit to initialize.
dvander@347
   329
	virtual void				Init();
dvander@347
   330
dvander@347
   331
private:
dvander@347
   332
dvander@347
   333
	// This either points to "this" or it points to the original declaration of a ConVar.
dvander@347
   334
	// This allows ConVars to exist in separate modules, and they all use the first one to be declared.
dvander@347
   335
	// m_pParent->m_pParent must equal m_pParent (ie: m_pParent must be the root, or original, ConVar).
dvander@347
   336
	ConVar						*m_pParent;
dvander@347
   337
dvander@347
   338
	// Static data
dvander@347
   339
	char const					*m_pszDefaultValue;
dvander@347
   340
	
dvander@347
   341
	// Value
dvander@347
   342
	// Dynamically allocated
dvander@347
   343
	char						*m_pszString;
dvander@347
   344
	int							m_StringLength;
dvander@347
   345
dvander@347
   346
	// Values
dvander@347
   347
	float						m_fValue;
dvander@347
   348
	int							m_nValue;
dvander@347
   349
dvander@347
   350
	// Min/Max values
dvander@347
   351
	bool						m_bHasMin;
dvander@347
   352
	float						m_fMinVal;
dvander@347
   353
	bool						m_bHasMax;
dvander@347
   354
	float						m_fMaxVal;
dvander@347
   355
	
dvander@347
   356
	// Call this function when ConVar changes
dvander@347
   357
	FnChangeCallback			m_fnChangeCallback;
dvander@347
   358
};
dvander@347
   359
dvander@347
   360
dvander@347
   361
//-----------------------------------------------------------------------------
dvander@347
   362
// Purpose: Return ConVar value as a float
dvander@347
   363
// Output : float
dvander@347
   364
//-----------------------------------------------------------------------------
dvander@347
   365
FORCEINLINE_CVAR float ConVar::GetFloat( void ) const
dvander@347
   366
{
dvander@347
   367
	return m_pParent->m_fValue;
dvander@347
   368
}
dvander@347
   369
dvander@347
   370
//-----------------------------------------------------------------------------
dvander@347
   371
// Purpose: Return ConVar value as an int
dvander@347
   372
// Output : int
dvander@347
   373
//-----------------------------------------------------------------------------
dvander@347
   374
FORCEINLINE_CVAR int ConVar::GetInt( void ) const 
dvander@347
   375
{
dvander@347
   376
	return m_pParent->m_nValue;
dvander@347
   377
}
dvander@347
   378
dvander@347
   379
dvander@347
   380
//-----------------------------------------------------------------------------
dvander@347
   381
// Purpose: Return ConVar value as a string, return "" for bogus string pointer, etc.
dvander@347
   382
// Output : char const *
dvander@347
   383
//-----------------------------------------------------------------------------
dvander@347
   384
FORCEINLINE_CVAR char const *ConVar::GetString( void ) const 
dvander@347
   385
{
dvander@347
   386
	if ( m_nFlags & FCVAR_NEVER_AS_STRING )
dvander@347
   387
	{
dvander@347
   388
		return "FCVAR_NEVER_AS_STRING";
dvander@347
   389
	}
dvander@347
   390
dvander@347
   391
	return ( m_pParent->m_pszString ) ? m_pParent->m_pszString : "";
dvander@347
   392
}
dvander@347
   393
dvander@347
   394
dvander@347
   395
#ifdef _STATIC_LINKED
dvander@347
   396
// identifies subsystem via piggybacking constructors with flags
dvander@347
   397
class G_ConCommand : public ConCommand
dvander@347
   398
{
dvander@347
   399
public:
dvander@347
   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) {}
dvander@347
   401
};
dvander@347
   402
dvander@347
   403
class C_ConCommand : public ConCommand
dvander@347
   404
{
dvander@347
   405
public:
dvander@347
   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) {}
dvander@347
   407
};
dvander@347
   408
dvander@347
   409
class M_ConCommand : public ConCommand
dvander@347
   410
{
dvander@347
   411
public:
dvander@347
   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) {}
dvander@347
   413
};
dvander@347
   414
dvander@347
   415
class S_ConCommand : public ConCommand
dvander@347
   416
{
dvander@347
   417
public:
dvander@347
   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) {}
dvander@347
   419
};
dvander@347
   420
dvander@347
   421
class D_ConCommand : public ConCommand
dvander@347
   422
{
dvander@347
   423
public:
dvander@347
   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) {}
dvander@347
   425
};
dvander@347
   426
dvander@347
   427
typedef void ( *G_FnChangeCallback )( G_ConVar *var, char const *pOldString );
dvander@347
   428
typedef void ( *C_FnChangeCallback )( C_ConVar *var, char const *pOldString );
dvander@347
   429
typedef void ( *M_FnChangeCallback )( M_ConVar *var, char const *pOldString );
dvander@347
   430
typedef void ( *S_FnChangeCallback )( S_ConVar *var, char const *pOldString );
dvander@347
   431
typedef void ( *D_FnChangeCallback )( D_ConVar *var, char const *pOldString );
dvander@347
   432
dvander@347
   433
class G_ConVar : public ConVar
dvander@347
   434
{
dvander@347
   435
public:
dvander@347
   436
	G_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL) {}
dvander@347
   437
	G_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_GAMEDLL, pHelpString ) {}
dvander@347
   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) {}
dvander@347
   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 ) {}
dvander@347
   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 ) {}
dvander@347
   441
};
dvander@347
   442
dvander@347
   443
class C_ConVar : public ConVar
dvander@347
   444
{
dvander@347
   445
public:
dvander@347
   446
	C_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL) {}
dvander@347
   447
	C_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_CLIENTDLL, pHelpString ) {}
dvander@347
   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) {}
dvander@347
   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 ) {}
dvander@347
   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 ) {}
dvander@347
   451
};
dvander@347
   452
dvander@347
   453
class M_ConVar : public ConVar
dvander@347
   454
{
dvander@347
   455
public:
dvander@347
   456
	M_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM) {}
dvander@347
   457
	M_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_MATERIAL_SYSTEM, pHelpString ) {}
dvander@347
   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) {}
dvander@347
   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 ) {}
dvander@347
   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 ) {}
dvander@347
   461
};
dvander@347
   462
dvander@347
   463
class S_ConVar : public ConVar
dvander@347
   464
{
dvander@347
   465
public:
dvander@347
   466
	S_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER) {}
dvander@347
   467
	S_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_STUDIORENDER, pHelpString ) {}
dvander@347
   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) {}
dvander@347
   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 ) {}
dvander@347
   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 ) {}
dvander@347
   471
};
dvander@347
   472
dvander@347
   473
class D_ConVar : public ConVar
dvander@347
   474
{
dvander@347
   475
public:
dvander@347
   476
	D_ConVar( char const *pName, char const *pDefaultValue, int flags = 0) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE) {}
dvander@347
   477
	D_ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) : ConVar(pName, pDefaultValue, flags|FCVAR_DATACACHE, pHelpString ) {}
dvander@347
   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) {}
dvander@347
   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 ) {}
dvander@347
   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 ) {}
dvander@347
   481
};
dvander@347
   482
dvander@347
   483
// redirect these declarations to their specific subsystem
dvander@347
   484
#ifdef GAME_DLL
dvander@347
   485
#define ConCommand	G_ConCommand
dvander@347
   486
#define ConVar		G_ConVar
dvander@347
   487
#endif
dvander@347
   488
#ifdef CLIENT_DLL
dvander@347
   489
#define ConCommand	C_ConCommand
dvander@347
   490
#define ConVar		C_ConVar
dvander@347
   491
#endif
dvander@347
   492
#ifdef MATERIALSYSTEM_DLL
dvander@347
   493
#define ConCommand	M_ConCommand
dvander@347
   494
#define ConVar		M_ConVar
dvander@347
   495
#endif
dvander@347
   496
#ifdef STUDIORENDER_DLL
dvander@347
   497
#define ConCommand	S_ConCommand
dvander@347
   498
#define ConVar		S_ConVar
dvander@347
   499
#endif
dvander@347
   500
#ifdef DATACACHE_DLL
dvander@347
   501
#define ConCommand	D_ConCommand
dvander@347
   502
#define ConVar		D_ConVar
dvander@347
   503
#endif
dvander@347
   504
#endif // _STATIC_LINKED
dvander@347
   505
dvander@347
   506
//-----------------------------------------------------------------------------
dvander@347
   507
// Purpose: Utility to quicky generate a simple console command
dvander@347
   508
//-----------------------------------------------------------------------------
dvander@347
   509
#define CON_COMMAND( name, description ) \
dvander@347
   510
   static void name(); \
dvander@347
   511
   static ConCommand name##_command( #name, name, description ); \
dvander@347
   512
   static void name()
dvander@347
   513
dvander@347
   514
//-----------------------------------------------------------------------------
dvander@347
   515
// Purpose: Utility to quicky generate a simple console command
dvander@347
   516
//-----------------------------------------------------------------------------
dvander@347
   517
#define CON_COMMAND_F( name, description, flags ) \
dvander@347
   518
   static void name(); \
dvander@347
   519
   static ConCommand name##_command( #name, name, description, flags ); \
dvander@347
   520
   static void name()
dvander@347
   521
dvander@347
   522
dvander@347
   523
#endif // CONVAR_H