sourcemm/convar.cpp
author David Anderson <dvander@alliedmods.net>
Thu Feb 09 08:34:31 2006 +0000 (2006-02-09)
changeset 181 50e55881d8c2
parent 7 8ef11f6189e4
child 232 a86d52ff721c
permissions -rw-r--r--
fixed bug where cproto pointers could be stale from removed plugins
dvander@7
     1
//========= Copyright � 1996-2005, Valve Corporation, All rights reserved. ============//
dvander@7
     2
//
dvander@7
     3
// Purpose: 
dvander@7
     4
//
dvander@7
     5
// $NoKeywords: $
dvander@7
     6
//
dvander@7
     7
//=============================================================================//
dvander@7
     8
dvander@7
     9
#include <stdio.h>
dvander@7
    10
#include <stdlib.h>
dvander@7
    11
#include <string.h>
dvander@7
    12
#include "basetypes.h"
dvander@7
    13
#include "convar.h"
dvander@7
    14
#include "vstdlib/strtools.h"
dvander@7
    15
#include "tier0/dbg.h"
dvander@7
    16
#include "tier0/memdbgon.h"
dvander@7
    17
dvander@7
    18
dvander@7
    19
ConCommandBase			*ConCommandBase::s_pConCommandBases = NULL;
dvander@7
    20
IConCommandBaseAccessor	*ConCommandBase::s_pAccessor = NULL;
dvander@7
    21
dvander@7
    22
// ----------------------------------------------------------------------------- //
dvander@7
    23
// ConCommandBaseMgr.
dvander@7
    24
// ----------------------------------------------------------------------------- //
dvander@7
    25
void ConCommandBaseMgr::OneTimeInit( IConCommandBaseAccessor *pAccessor )
dvander@7
    26
{
dvander@7
    27
	ConCommandBase *pCur, *pNext;
dvander@7
    28
dvander@7
    29
	ConCommandBase::s_pAccessor = pAccessor;
dvander@7
    30
dvander@7
    31
	pCur = ConCommandBase::s_pConCommandBases;
dvander@7
    32
	while ( pCur )
dvander@7
    33
	{
dvander@7
    34
		pNext = pCur->m_pNext;
dvander@7
    35
		pCur->Init();
dvander@7
    36
		pCur = pNext;
dvander@7
    37
	}
dvander@7
    38
}
dvander@7
    39
dvander@7
    40
//-----------------------------------------------------------------------------
dvander@7
    41
// Purpose: Default constructor
dvander@7
    42
//-----------------------------------------------------------------------------
dvander@7
    43
ConCommandBase::ConCommandBase( void )
dvander@7
    44
{
dvander@7
    45
	m_bRegistered			= false;
dvander@7
    46
	m_pszName				= NULL;
dvander@7
    47
	m_pszHelpString			= NULL;
dvander@7
    48
dvander@7
    49
	m_nFlags				= 0;
dvander@7
    50
	m_pNext					= NULL;
dvander@7
    51
}
dvander@7
    52
dvander@7
    53
//-----------------------------------------------------------------------------
dvander@7
    54
// Purpose: The base console invoked command/cvar interface
dvander@7
    55
// Input  : *pName - name of variable/command
dvander@7
    56
//			*pHelpString - help text
dvander@7
    57
//			flags - flags
dvander@7
    58
//-----------------------------------------------------------------------------
dvander@7
    59
ConCommandBase::ConCommandBase( char const *pName, char const *pHelpString /*=0*/, int flags /*= 0*/ )
dvander@7
    60
{
dvander@7
    61
	Create( pName, pHelpString, flags );
dvander@7
    62
}
dvander@7
    63
dvander@7
    64
//-----------------------------------------------------------------------------
dvander@7
    65
// Purpose: 
dvander@7
    66
//-----------------------------------------------------------------------------
dvander@7
    67
ConCommandBase::~ConCommandBase( void )
dvander@7
    68
{
dvander@7
    69
}
dvander@7
    70
dvander@7
    71
//-----------------------------------------------------------------------------
dvander@7
    72
// Purpose: 
dvander@7
    73
// Output : Returns true on success, false on failure.
dvander@7
    74
//-----------------------------------------------------------------------------
dvander@7
    75
bool ConCommandBase::IsCommand( void ) const
dvander@7
    76
{ 
dvander@7
    77
//	Assert( 0 ); This can't assert. . causes a recursive assert in Sys_Printf, etc.
dvander@7
    78
	return true;
dvander@7
    79
}
dvander@7
    80
	
dvander@7
    81
//-----------------------------------------------------------------------------
dvander@7
    82
// Purpose: 
dvander@7
    83
// Input  : *pName - 
dvander@7
    84
//			callback - 
dvander@7
    85
//			*pHelpString - 
dvander@7
    86
//			flags - 
dvander@7
    87
//-----------------------------------------------------------------------------
dvander@7
    88
void ConCommandBase::Create( char const *pName, char const *pHelpString /*= 0*/, int flags /*= 0*/ )
dvander@7
    89
{
dvander@7
    90
	static char *empty_string = "";
dvander@7
    91
dvander@7
    92
	m_bRegistered		= false;
dvander@7
    93
dvander@7
    94
	// Name should be static data
dvander@7
    95
	Assert( pName );
dvander@7
    96
	m_pszName			= pName;
dvander@7
    97
	m_pszHelpString		= pHelpString ? pHelpString : empty_string;
dvander@7
    98
dvander@7
    99
	m_nFlags = flags;
dvander@7
   100
dvander@7
   101
	if ( !( m_nFlags & FCVAR_UNREGISTERED ) )
dvander@7
   102
	{
dvander@7
   103
		m_pNext		= s_pConCommandBases;
dvander@7
   104
		s_pConCommandBases	= this;
dvander@7
   105
	}
dvander@7
   106
	else
dvander@7
   107
	{
dvander@7
   108
		// It's unregistered
dvander@7
   109
		m_pNext		= NULL;
dvander@7
   110
	}
dvander@7
   111
dvander@7
   112
	// If s_pAccessor is already set (this ConVar is not a global variable),
dvander@7
   113
	//  register it.
dvander@7
   114
	if ( s_pAccessor )
dvander@7
   115
	{
dvander@7
   116
		Init();
dvander@7
   117
	}
dvander@7
   118
}
dvander@7
   119
dvander@7
   120
//-----------------------------------------------------------------------------
dvander@7
   121
// Purpose: Used internally by OneTimeInit to initialize.
dvander@7
   122
//-----------------------------------------------------------------------------
dvander@7
   123
void ConCommandBase::Init()
dvander@7
   124
{
dvander@7
   125
	if ( !s_pAccessor )
dvander@7
   126
		return;
dvander@7
   127
	
dvander@7
   128
	if ( m_bRegistered )
dvander@7
   129
		return;
dvander@7
   130
dvander@7
   131
	s_pAccessor->RegisterConCommandBase( this );
dvander@7
   132
dvander@7
   133
	m_bRegistered = true;
dvander@7
   134
}
dvander@7
   135
dvander@7
   136
//-----------------------------------------------------------------------------
dvander@7
   137
// Purpose: 
dvander@7
   138
// Input  : *name - 
dvander@7
   139
// Output : ConCommandBase
dvander@7
   140
//-----------------------------------------------------------------------------
dvander@7
   141
ConCommandBase const *ConCommandBase::FindCommand( char const *name )
dvander@7
   142
{
dvander@7
   143
	ConCommandBase const *cmd = GetCommands();
dvander@7
   144
	for ( ; cmd; cmd = cmd->GetNext() )
dvander@7
   145
	{
dvander@7
   146
		if ( !stricmp( name, cmd->GetName() ) )
dvander@7
   147
			return cmd;
dvander@7
   148
	}
dvander@7
   149
	return NULL;
dvander@7
   150
}
dvander@7
   151
dvander@7
   152
//-----------------------------------------------------------------------------
dvander@7
   153
// Purpose: 
dvander@7
   154
// Output : ConCommandBase
dvander@7
   155
//-----------------------------------------------------------------------------
dvander@7
   156
const ConCommandBase *ConCommandBase::GetCommands( void )
dvander@7
   157
{
dvander@7
   158
	return s_pConCommandBases;
dvander@7
   159
}
dvander@7
   160
dvander@7
   161
//-----------------------------------------------------------------------------
dvander@7
   162
// Purpose: 
dvander@7
   163
// Input  : *var - 
dvander@7
   164
// Output : static
dvander@7
   165
//-----------------------------------------------------------------------------
dvander@7
   166
void ConCommandBase::AddToList( ConCommandBase *var )
dvander@7
   167
{
dvander@7
   168
	// This routine is only valid on root ConCommandBases
dvander@7
   169
	var->m_pNext = s_pConCommandBases;
dvander@7
   170
	s_pConCommandBases = var;
dvander@7
   171
}
dvander@7
   172
dvander@7
   173
//-----------------------------------------------------------------------------
dvander@7
   174
// Purpose: Return name of the command/var
dvander@7
   175
// Output : char const
dvander@7
   176
//-----------------------------------------------------------------------------
dvander@7
   177
char const *ConCommandBase::GetName( void ) const
dvander@7
   178
{
dvander@7
   179
	return m_pszName;
dvander@7
   180
}
dvander@7
   181
dvander@7
   182
//-----------------------------------------------------------------------------
dvander@7
   183
// Purpose: 
dvander@7
   184
// Input  : flag - 
dvander@7
   185
//-----------------------------------------------------------------------------
dvander@7
   186
void ConCommandBase::RemoveFlaggedCommands( int flag )
dvander@7
   187
{
dvander@7
   188
	ConCommandBase	*pNewList;
dvander@7
   189
	ConCommandBase  *pCommand, *pNext;
dvander@7
   190
dvander@7
   191
	pNewList = NULL;
dvander@7
   192
dvander@7
   193
	pCommand = s_pConCommandBases;
dvander@7
   194
	while ( pCommand )
dvander@7
   195
	{
dvander@7
   196
		pNext = pCommand->m_pNext;
dvander@7
   197
		if ( !( pCommand->m_nFlags & flag ) )
dvander@7
   198
		{
dvander@7
   199
			pCommand->m_pNext = pNewList;
dvander@7
   200
			pNewList = pCommand;
dvander@7
   201
		}
dvander@7
   202
		else
dvander@7
   203
		{
dvander@7
   204
			// Unlink
dvander@7
   205
			pCommand->m_pNext = NULL;
dvander@7
   206
		}
dvander@7
   207
dvander@7
   208
		pCommand = pNext;
dvander@7
   209
	}
dvander@7
   210
	
dvander@7
   211
	s_pConCommandBases = pNewList;
dvander@7
   212
}
dvander@7
   213
dvander@7
   214
void ConCommandBase::RevertFlaggedCvars( int flag )
dvander@7
   215
{
dvander@7
   216
	for (const ConCommandBase *var= GetCommands() ; var ; var=var->GetNext())
dvander@7
   217
	{
dvander@7
   218
		if ( var->IsCommand() )
dvander@7
   219
			continue;
dvander@7
   220
dvander@7
   221
		ConVar *cvar = ( ConVar * )var;
dvander@7
   222
dvander@7
   223
		if ( !cvar->IsBitSet( flag ) )
dvander@7
   224
			continue;
dvander@7
   225
dvander@7
   226
		// It's == to the default value, don't count
dvander@7
   227
		if ( !Q_strcasecmp( cvar->GetDefault(), cvar->GetString() ) )
dvander@7
   228
			continue;
dvander@7
   229
dvander@7
   230
		cvar->Revert();
dvander@7
   231
dvander@7
   232
		// DevMsg( "%s = \"%s\" (reverted)\n", cvar->GetName(), cvar->GetString() );
dvander@7
   233
	}
dvander@7
   234
}
dvander@7
   235
dvander@7
   236
//-----------------------------------------------------------------------------
dvander@7
   237
// Purpose: 
dvander@7
   238
// Input  : flag - 
dvander@7
   239
// Output : Returns true on success, false on failure.
dvander@7
   240
//-----------------------------------------------------------------------------
dvander@7
   241
bool ConCommandBase::IsBitSet( int flag ) const
dvander@7
   242
{
dvander@7
   243
	return ( flag & m_nFlags ) ? true : false;
dvander@7
   244
}
dvander@7
   245
dvander@7
   246
//-----------------------------------------------------------------------------
dvander@7
   247
// Purpose: 
dvander@7
   248
// Input  : flags - 
dvander@7
   249
//-----------------------------------------------------------------------------
dvander@7
   250
void ConCommandBase::AddFlags( int flags )
dvander@7
   251
{
dvander@7
   252
	m_nFlags |= flags;
dvander@7
   253
}
dvander@7
   254
dvander@7
   255
//-----------------------------------------------------------------------------
dvander@7
   256
// Purpose: 
dvander@7
   257
// Output : const ConCommandBase
dvander@7
   258
//-----------------------------------------------------------------------------
dvander@7
   259
const ConCommandBase *ConCommandBase::GetNext( void ) const
dvander@7
   260
{
dvander@7
   261
	return m_pNext;
dvander@7
   262
}
dvander@7
   263
dvander@7
   264
//-----------------------------------------------------------------------------
dvander@7
   265
// Purpose: 
dvander@7
   266
// Input  : *next - 
dvander@7
   267
//-----------------------------------------------------------------------------
dvander@7
   268
void ConCommandBase::SetNext( ConCommandBase *next )
dvander@7
   269
{
dvander@7
   270
	m_pNext = next;
dvander@7
   271
}
dvander@7
   272
dvander@7
   273
//-----------------------------------------------------------------------------
dvander@7
   274
// Purpose: Copies string using local new/delete operators
dvander@7
   275
// Input  : *from - 
dvander@7
   276
// Output : char
dvander@7
   277
//-----------------------------------------------------------------------------
dvander@7
   278
char *ConCommandBase::CopyString( char const *from )
dvander@7
   279
{
dvander@7
   280
	int		len;
dvander@7
   281
	char	*to;
dvander@7
   282
dvander@7
   283
	len = strlen( from );
dvander@7
   284
	if ( len <= 0 )
dvander@7
   285
	{
dvander@7
   286
		to = new char[1];
dvander@7
   287
		to[0] = 0;
dvander@7
   288
	}
dvander@7
   289
	else
dvander@7
   290
	{
dvander@7
   291
		to = new char[len+1];
dvander@7
   292
		Q_strncpy( to, from, len+1 );
dvander@7
   293
	}
dvander@7
   294
	return to;
dvander@7
   295
}
dvander@7
   296
dvander@7
   297
//-----------------------------------------------------------------------------
dvander@7
   298
// Purpose: 
dvander@7
   299
// Output : char const
dvander@7
   300
//-----------------------------------------------------------------------------
dvander@7
   301
char const *ConCommandBase::GetHelpText( void ) const
dvander@7
   302
{
dvander@7
   303
	return m_pszHelpString;
dvander@7
   304
}
dvander@7
   305
dvander@7
   306
//-----------------------------------------------------------------------------
dvander@7
   307
// Purpose: Has this cvar been registered
dvander@7
   308
// Output : Returns true on success, false on failure.
dvander@7
   309
//-----------------------------------------------------------------------------
dvander@7
   310
bool ConCommandBase::IsRegistered( void ) const
dvander@7
   311
{
dvander@7
   312
	return m_bRegistered;
dvander@7
   313
}
dvander@7
   314
dvander@7
   315
//-----------------------------------------------------------------------------
dvander@7
   316
// Purpose: Constructs a console command
dvander@7
   317
// Input  : *pName - name of command
dvander@7
   318
//			callback - function to call upon execution
dvander@7
   319
//			*pHelpString - help text for command
dvander@7
   320
//			flags - command flags, if any
dvander@7
   321
//-----------------------------------------------------------------------------
dvander@7
   322
ConCommand::ConCommand( char const *pName, FnCommandCallback callback, char const *pHelpString /*= 0*/, int flags /*= 0*/, FnCommandCompletionCallback completionFunc /*= 0*/ )
dvander@7
   323
{
dvander@7
   324
	Create( pName, callback, pHelpString, flags, completionFunc );
dvander@7
   325
}
dvander@7
   326
dvander@7
   327
//-----------------------------------------------------------------------------
dvander@7
   328
// Purpose: 
dvander@7
   329
//-----------------------------------------------------------------------------
dvander@7
   330
ConCommand::~ConCommand( void )
dvander@7
   331
{
dvander@7
   332
dvander@7
   333
}
dvander@7
   334
dvander@7
   335
//-----------------------------------------------------------------------------
dvander@7
   336
// Purpose: 
dvander@7
   337
// Output : Returns true on success, false on failure.
dvander@7
   338
//-----------------------------------------------------------------------------
dvander@7
   339
bool ConCommand::IsCommand( void ) const
dvander@7
   340
{ 
dvander@7
   341
	return true;
dvander@7
   342
}
dvander@7
   343
dvander@7
   344
//-----------------------------------------------------------------------------
dvander@7
   345
// Purpose: Invoke the function if there is one
dvander@7
   346
//-----------------------------------------------------------------------------
dvander@7
   347
void ConCommand::Dispatch( void )
dvander@7
   348
{
dvander@7
   349
	if ( m_fnCommandCallback )
dvander@7
   350
	{
dvander@7
   351
		( *m_fnCommandCallback )();
dvander@7
   352
	}
dvander@7
   353
	else
dvander@7
   354
	{
dvander@7
   355
		// Command without callback!!!
dvander@7
   356
		Assert( 0 );
dvander@7
   357
	}
dvander@7
   358
}
dvander@7
   359
dvander@7
   360
//-----------------------------------------------------------------------------
dvander@7
   361
// Purpose: 
dvander@7
   362
// Input  : *partial - 
dvander@7
   363
//			context - 
dvander@7
   364
//			longest - 
dvander@7
   365
//			maxcommands - 
dvander@7
   366
//			**commands - 
dvander@7
   367
// Output : int
dvander@7
   368
//-----------------------------------------------------------------------------
dvander@7
   369
int DefaultCompletionFunc( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] )
dvander@7
   370
{
dvander@7
   371
	return 0;
dvander@7
   372
}
dvander@7
   373
dvander@7
   374
//-----------------------------------------------------------------------------
dvander@7
   375
// Purpose: Create the named command
dvander@7
   376
// Input  : *pName - 
dvander@7
   377
//			callback - 
dvander@7
   378
//			*pHelpString - 
dvander@7
   379
//			flags - 
dvander@7
   380
//-----------------------------------------------------------------------------
dvander@7
   381
void ConCommand::Create( char const *pName, FnCommandCallback callback, char const *pHelpString /*= 0*/, int flags /*= 0*/, FnCommandCompletionCallback completionFunc /*=0*/ )
dvander@7
   382
{
dvander@7
   383
	// Set the callback
dvander@7
   384
	m_fnCommandCallback = callback;
dvander@7
   385
dvander@7
   386
	m_fnCompletionCallback = completionFunc ? completionFunc : DefaultCompletionFunc;
dvander@7
   387
	m_bHasCompletionCallback = completionFunc != 0 ? true : false;
dvander@7
   388
dvander@7
   389
	// Setup the rest
dvander@7
   390
	BaseClass::Create( pName, pHelpString, flags );
dvander@7
   391
}
dvander@7
   392
dvander@7
   393
//-----------------------------------------------------------------------------
dvander@7
   394
// Purpose: 
dvander@7
   395
// Input  : *partial - 
dvander@7
   396
//			context - 
dvander@7
   397
//			longest - 
dvander@7
   398
//			maxcommands - 
dvander@7
   399
//			**commands - 
dvander@7
   400
//-----------------------------------------------------------------------------
dvander@7
   401
int	ConCommand::AutoCompleteSuggest( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] )
dvander@7
   402
{
dvander@7
   403
	Assert( m_fnCompletionCallback );
dvander@7
   404
	if ( !m_fnCompletionCallback )
dvander@7
   405
		return 0;
dvander@7
   406
dvander@7
   407
	return ( m_fnCompletionCallback )( partial, commands );
dvander@7
   408
}
dvander@7
   409
dvander@7
   410
//-----------------------------------------------------------------------------
dvander@7
   411
// Purpose: 
dvander@7
   412
// Output : Returns true on success, false on failure.
dvander@7
   413
//-----------------------------------------------------------------------------
dvander@7
   414
bool ConCommand::CanAutoComplete( void )
dvander@7
   415
{
dvander@7
   416
	return m_bHasCompletionCallback;
dvander@7
   417
}
dvander@7
   418
dvander@7
   419
// ----------------------------------------------------------------------------- //
dvander@7
   420
// ConVar.
dvander@7
   421
// ----------------------------------------------------------------------------- //
dvander@7
   422
ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags /* = 0 */ )
dvander@7
   423
{
dvander@7
   424
	Create( pName, pDefaultValue, flags );
dvander@7
   425
}
dvander@7
   426
dvander@7
   427
// ----------------------------------------------------------------------------- //
dvander@7
   428
// ConVar.
dvander@7
   429
// ----------------------------------------------------------------------------- //
dvander@7
   430
ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString )
dvander@7
   431
{
dvander@7
   432
	Create( pName, pDefaultValue, flags, pHelpString );
dvander@7
   433
}
dvander@7
   434
dvander@7
   435
// ----------------------------------------------------------------------------- //
dvander@7
   436
// ConVar.
dvander@7
   437
// ----------------------------------------------------------------------------- //
dvander@7
   438
ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax )
dvander@7
   439
{
dvander@7
   440
	Create( pName, pDefaultValue, flags, pHelpString, bMin, fMin, bMax, fMax );
dvander@7
   441
}
dvander@7
   442
dvander@7
   443
// ----------------------------------------------------------------------------- //
dvander@7
   444
// ConVar.
dvander@7
   445
// ----------------------------------------------------------------------------- //
dvander@7
   446
ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, FnChangeCallback callback )
dvander@7
   447
{
dvander@7
   448
	Create( pName, pDefaultValue, flags, pHelpString, false, 0.0, false, 0.0, callback );
dvander@7
   449
}
dvander@7
   450
dvander@7
   451
// ----------------------------------------------------------------------------- //
dvander@7
   452
// ConVar.
dvander@7
   453
// ----------------------------------------------------------------------------- //
dvander@7
   454
ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, FnChangeCallback callback )
dvander@7
   455
{
dvander@7
   456
	Create( pName, pDefaultValue, flags, pHelpString, bMin, fMin, bMax, fMax, callback );
dvander@7
   457
}
dvander@7
   458
dvander@7
   459
//-----------------------------------------------------------------------------
dvander@7
   460
// Purpose: Free dynamic memory
dvander@7
   461
//-----------------------------------------------------------------------------
dvander@7
   462
ConVar::~ConVar( void )
dvander@7
   463
{
dvander@7
   464
	if ( m_pszString )
dvander@7
   465
	{
dvander@7
   466
		delete[] m_pszString;
dvander@7
   467
		m_pszString = NULL;
dvander@7
   468
	}
dvander@7
   469
}
dvander@7
   470
dvander@7
   471
dvander@7
   472
//-----------------------------------------------------------------------------
dvander@7
   473
// Install a change callback (there shouldn't already be one....)
dvander@7
   474
//-----------------------------------------------------------------------------
dvander@7
   475
dvander@7
   476
void ConVar::InstallChangeCallback( FnChangeCallback callback )
dvander@7
   477
{
dvander@7
   478
	Assert( !m_fnChangeCallback || !callback );
dvander@7
   479
	m_fnChangeCallback = callback;
dvander@7
   480
dvander@7
   481
	if (m_fnChangeCallback)
dvander@7
   482
	{
dvander@7
   483
		// Call it immediately to set the initial value...
dvander@7
   484
		m_fnChangeCallback( this, m_pszString );
dvander@7
   485
	}
dvander@7
   486
}
dvander@7
   487
dvander@7
   488
bool ConVar::IsBitSet( int flag ) const
dvander@7
   489
{
dvander@7
   490
	return ( flag & m_pParent->m_nFlags ) ? true : false;
dvander@7
   491
}
dvander@7
   492
dvander@7
   493
char const *ConVar::GetHelpText( void ) const
dvander@7
   494
{
dvander@7
   495
	return m_pParent->m_pszHelpString;
dvander@7
   496
}
dvander@7
   497
dvander@7
   498
void ConVar::AddFlags( int flags )
dvander@7
   499
{
dvander@7
   500
	m_pParent->m_nFlags |= flags;
dvander@7
   501
}
dvander@7
   502
dvander@7
   503
bool ConVar::IsRegistered( void ) const
dvander@7
   504
{
dvander@7
   505
	return m_pParent->m_bRegistered;
dvander@7
   506
}
dvander@7
   507
dvander@7
   508
char const *ConVar::GetName( void ) const
dvander@7
   509
{
dvander@7
   510
	return m_pParent->m_pszName;
dvander@7
   511
}
dvander@7
   512
dvander@7
   513
//-----------------------------------------------------------------------------
dvander@7
   514
// Purpose: 
dvander@7
   515
// Output : Returns true on success, false on failure.
dvander@7
   516
//-----------------------------------------------------------------------------
dvander@7
   517
bool ConVar::IsCommand( void ) const
dvander@7
   518
{ 
dvander@7
   519
	return false;
dvander@7
   520
}
dvander@7
   521
dvander@7
   522
//-----------------------------------------------------------------------------
dvander@7
   523
// Purpose: 
dvander@7
   524
// Input  : 
dvander@7
   525
//-----------------------------------------------------------------------------
dvander@7
   526
void ConVar::Init()
dvander@7
   527
{
dvander@7
   528
	BaseClass::Init();
dvander@7
   529
}
dvander@7
   530
dvander@7
   531
//-----------------------------------------------------------------------------
dvander@7
   532
// Purpose: 
dvander@7
   533
// Input  : *value - 
dvander@7
   534
//-----------------------------------------------------------------------------
dvander@7
   535
void ConVar::InternalSetValue( char const *value )
dvander@7
   536
{
dvander@7
   537
	float fNewValue;
dvander@7
   538
	char  tempVal[ 32 ];
dvander@7
   539
	char  *val;
dvander@7
   540
dvander@7
   541
	Assert(m_pParent == this); // Only valid for root convars.
dvander@7
   542
dvander@7
   543
	val = (char *)value;
dvander@7
   544
	fNewValue = ( float )atof( value );
dvander@7
   545
dvander@7
   546
	if ( ClampValue( fNewValue ) )
dvander@7
   547
	{
dvander@7
   548
		Q_snprintf( tempVal,sizeof(tempVal), "%f", fNewValue );
dvander@7
   549
		val = tempVal;
dvander@7
   550
	}
dvander@7
   551
	
dvander@7
   552
	// Redetermine value
dvander@7
   553
	m_fValue		= fNewValue;
dvander@7
   554
	m_nValue		= ( int )( m_fValue );
dvander@7
   555
dvander@7
   556
	if ( !(m_nFlags & FCVAR_NEVER_AS_STRING) )
dvander@7
   557
		ChangeStringValue( val );
dvander@7
   558
}
dvander@7
   559
dvander@7
   560
//-----------------------------------------------------------------------------
dvander@7
   561
// Purpose: 
dvander@7
   562
// Input  : *tempVal - 
dvander@7
   563
//-----------------------------------------------------------------------------
dvander@7
   564
void ConVar::ChangeStringValue( char const *tempVal )
dvander@7
   565
{
dvander@7
   566
	Assert( !( m_nFlags & FCVAR_NEVER_AS_STRING ) );
dvander@7
   567
dvander@7
   568
	char* pszOldValue = (char*)stackalloc( m_StringLength );
dvander@7
   569
dvander@7
   570
	if ( m_fnChangeCallback )
dvander@7
   571
	{
dvander@7
   572
		memcpy( pszOldValue, m_pszString, m_StringLength );
dvander@7
   573
	}
dvander@7
   574
	
dvander@7
   575
	int len = Q_strlen(tempVal) + 1;
dvander@7
   576
dvander@7
   577
	if ( len > m_StringLength)
dvander@7
   578
	{
dvander@7
   579
		if (m_pszString)
dvander@7
   580
			delete[] m_pszString;
dvander@7
   581
dvander@7
   582
		m_pszString	= new char[len];
dvander@7
   583
		m_StringLength = len;
dvander@7
   584
	}
dvander@7
   585
dvander@7
   586
	memcpy( m_pszString, tempVal, len );
dvander@7
   587
dvander@7
   588
	// Invoke any necessary callback function
dvander@7
   589
	if ( m_fnChangeCallback )
dvander@7
   590
	{
dvander@7
   591
		m_fnChangeCallback( this, pszOldValue );
dvander@7
   592
	}
dvander@7
   593
dvander@7
   594
	stackfree( pszOldValue );
dvander@7
   595
}
dvander@7
   596
dvander@7
   597
//-----------------------------------------------------------------------------
dvander@7
   598
// Purpose: Check whether to clamp and then perform clamp
dvander@7
   599
// Input  : value - 
dvander@7
   600
// Output : Returns true if value changed
dvander@7
   601
//-----------------------------------------------------------------------------
dvander@7
   602
bool ConVar::ClampValue( float& value )
dvander@7
   603
{
dvander@7
   604
	if ( m_bHasMin && ( value < m_fMinVal ) )
dvander@7
   605
	{
dvander@7
   606
		value = m_fMinVal;
dvander@7
   607
		return true;
dvander@7
   608
	}
dvander@7
   609
	
dvander@7
   610
	if ( m_bHasMax && ( value > m_fMaxVal ) )
dvander@7
   611
	{
dvander@7
   612
		value = m_fMaxVal;
dvander@7
   613
		return true;
dvander@7
   614
	}
dvander@7
   615
dvander@7
   616
	return false;
dvander@7
   617
}
dvander@7
   618
dvander@7
   619
//-----------------------------------------------------------------------------
dvander@7
   620
// Purpose: 
dvander@7
   621
// Input  : *value - 
dvander@7
   622
//-----------------------------------------------------------------------------
dvander@7
   623
void ConVar::InternalSetFloatValue( float fNewValue )
dvander@7
   624
{
dvander@7
   625
	if ( fNewValue == m_fValue )
dvander@7
   626
		return;
dvander@7
   627
dvander@7
   628
	Assert( m_pParent == this ); // Only valid for root convars.
dvander@7
   629
dvander@7
   630
	// Check bounds
dvander@7
   631
	ClampValue( fNewValue );
dvander@7
   632
dvander@7
   633
	// Redetermine value
dvander@7
   634
	m_fValue		= fNewValue;
dvander@7
   635
	m_nValue		= ( int )m_fValue;
dvander@7
   636
dvander@7
   637
	if ( !( m_nFlags & FCVAR_NEVER_AS_STRING ) )
dvander@7
   638
	{
dvander@7
   639
		char tempVal[ 32 ];
dvander@7
   640
		Q_snprintf( tempVal, sizeof( tempVal), "%f", m_fValue );
dvander@7
   641
		ChangeStringValue( tempVal );
dvander@7
   642
	}
dvander@7
   643
	else
dvander@7
   644
	{
dvander@7
   645
		Assert( !m_fnChangeCallback );
dvander@7
   646
	}
dvander@7
   647
}
dvander@7
   648
dvander@7
   649
//-----------------------------------------------------------------------------
dvander@7
   650
// Purpose: 
dvander@7
   651
// Input  : *value - 
dvander@7
   652
//-----------------------------------------------------------------------------
dvander@7
   653
void ConVar::InternalSetIntValue( int nValue )
dvander@7
   654
{
dvander@7
   655
	if ( nValue == m_nValue )
dvander@7
   656
		return;
dvander@7
   657
dvander@7
   658
	Assert( m_pParent == this ); // Only valid for root convars.
dvander@7
   659
dvander@7
   660
	float fValue = (float)nValue;
dvander@7
   661
	if ( ClampValue( fValue ) )
dvander@7
   662
	{
dvander@7
   663
		nValue = ( int )( fValue );
dvander@7
   664
	}
dvander@7
   665
dvander@7
   666
	// Redetermine value
dvander@7
   667
	m_fValue		= fValue;
dvander@7
   668
	m_nValue		= nValue;
dvander@7
   669
dvander@7
   670
	if ( !( m_nFlags & FCVAR_NEVER_AS_STRING ) )
dvander@7
   671
	{
dvander@7
   672
		char tempVal[ 32 ];
dvander@7
   673
		Q_snprintf( tempVal, sizeof( tempVal ), "%d", m_nValue );
dvander@7
   674
		ChangeStringValue( tempVal );
dvander@7
   675
	}
dvander@7
   676
	else
dvander@7
   677
	{
dvander@7
   678
		Assert( !m_fnChangeCallback );
dvander@7
   679
	}
dvander@7
   680
}
dvander@7
   681
dvander@7
   682
//-----------------------------------------------------------------------------
dvander@7
   683
// Purpose: Private creation
dvander@7
   684
//-----------------------------------------------------------------------------
dvander@7
   685
void ConVar::Create( char const *pName, char const *pDefaultValue, int flags /*= 0*/,
dvander@7
   686
	char const *pHelpString /*= NULL*/, bool bMin /*= false*/, float fMin /*= 0.0*/,
dvander@7
   687
	bool bMax /*= false*/, float fMax /*= false*/, FnChangeCallback callback /*= NULL*/ )
dvander@7
   688
{
dvander@7
   689
	static char *empty_string = "";
dvander@7
   690
dvander@7
   691
	m_pParent = this;
dvander@7
   692
dvander@7
   693
	// Name should be static data
dvander@7
   694
	m_pszDefaultValue	= pDefaultValue ? pDefaultValue : empty_string;
dvander@7
   695
	Assert( pDefaultValue );
dvander@7
   696
dvander@7
   697
	m_StringLength = strlen( m_pszDefaultValue ) + 1;
dvander@7
   698
	m_pszString = new char[m_StringLength];
dvander@7
   699
	memcpy( m_pszString, m_pszDefaultValue, m_StringLength );
dvander@7
   700
	
dvander@7
   701
	m_bHasMin = bMin;
dvander@7
   702
	m_fMinVal = fMin;
dvander@7
   703
	m_bHasMax = bMax;
dvander@7
   704
	m_fMaxVal = fMax;
dvander@7
   705
	
dvander@7
   706
	m_fnChangeCallback = callback;
dvander@7
   707
dvander@7
   708
	m_fValue = ( float )atof( m_pszString );
dvander@7
   709
dvander@7
   710
	// Bounds Check, should never happen, if it does, no big deal
dvander@7
   711
	if ( m_bHasMin && ( m_fValue < m_fMinVal ) )
dvander@7
   712
	{
dvander@7
   713
		Assert( 0 );
dvander@7
   714
	}
dvander@7
   715
dvander@7
   716
	if ( m_bHasMax && ( m_fValue > m_fMaxVal ) )
dvander@7
   717
	{
dvander@7
   718
		Assert( 0 );
dvander@7
   719
	}
dvander@7
   720
dvander@7
   721
	m_nValue = ( int )m_fValue;
dvander@7
   722
dvander@7
   723
	BaseClass::Create( pName, pHelpString, flags );
dvander@7
   724
}
dvander@7
   725
dvander@7
   726
//-----------------------------------------------------------------------------
dvander@7
   727
// Purpose: 
dvander@7
   728
// Input  : *value - 
dvander@7
   729
//-----------------------------------------------------------------------------
dvander@7
   730
void ConVar::SetValue(char const *value)
dvander@7
   731
{
dvander@7
   732
	ConVar *var = ( ConVar * )m_pParent;
dvander@7
   733
	var->InternalSetValue( value );
dvander@7
   734
}
dvander@7
   735
dvander@7
   736
//-----------------------------------------------------------------------------
dvander@7
   737
// Purpose: 
dvander@7
   738
// Input  : value - 
dvander@7
   739
//-----------------------------------------------------------------------------
dvander@7
   740
void ConVar::SetValue( float value )
dvander@7
   741
{
dvander@7
   742
	ConVar *var = ( ConVar * )m_pParent;
dvander@7
   743
	var->InternalSetFloatValue( value );
dvander@7
   744
}
dvander@7
   745
dvander@7
   746
//-----------------------------------------------------------------------------
dvander@7
   747
// Purpose: 
dvander@7
   748
// Input  : value - 
dvander@7
   749
//-----------------------------------------------------------------------------
dvander@7
   750
void ConVar::SetValue( int value )
dvander@7
   751
{
dvander@7
   752
	ConVar *var = ( ConVar * )m_pParent;
dvander@7
   753
	var->InternalSetIntValue( value );
dvander@7
   754
}
dvander@7
   755
dvander@7
   756
//-----------------------------------------------------------------------------
dvander@7
   757
// Purpose: Reset to default value
dvander@7
   758
//-----------------------------------------------------------------------------
dvander@7
   759
void ConVar::Revert( void )
dvander@7
   760
{
dvander@7
   761
	// Force default value again
dvander@7
   762
	ConVar *var = ( ConVar * )m_pParent;
dvander@7
   763
	var->SetValue( var->m_pszDefaultValue );
dvander@7
   764
}
dvander@7
   765
dvander@7
   766
//-----------------------------------------------------------------------------
dvander@7
   767
// Purpose: 
dvander@7
   768
//-----------------------------------------------------------------------------
dvander@7
   769
void ConVar::RevertAll( void )
dvander@7
   770
{
dvander@7
   771
	ConCommandBase *p = s_pConCommandBases;
dvander@7
   772
	while ( p  )
dvander@7
   773
	{
dvander@7
   774
		if ( !p->IsCommand() )
dvander@7
   775
		{
dvander@7
   776
			ConVar *var = ( ConVar * )p;
dvander@7
   777
			var->Revert();
dvander@7
   778
		}
dvander@7
   779
		p = p->m_pNext;
dvander@7
   780
	}
dvander@7
   781
}
dvander@7
   782
dvander@7
   783
//-----------------------------------------------------------------------------
dvander@7
   784
// Purpose: 
dvander@7
   785
// Input  : minVal - 
dvander@7
   786
// Output : true if there is a min set
dvander@7
   787
//-----------------------------------------------------------------------------
dvander@7
   788
bool ConVar::GetMin( float& minVal ) const
dvander@7
   789
{
dvander@7
   790
	minVal = m_pParent->m_fMinVal;
dvander@7
   791
	return m_pParent->m_bHasMin;
dvander@7
   792
}
dvander@7
   793
dvander@7
   794
//-----------------------------------------------------------------------------
dvander@7
   795
// Purpose: 
dvander@7
   796
// Input  : maxVal - 
dvander@7
   797
//-----------------------------------------------------------------------------
dvander@7
   798
bool ConVar::GetMax( float& maxVal ) const
dvander@7
   799
{
dvander@7
   800
	maxVal = m_pParent->m_fMaxVal;
dvander@7
   801
	return m_pParent->m_bHasMax;
dvander@7
   802
}
dvander@7
   803
dvander@7
   804
//-----------------------------------------------------------------------------
dvander@7
   805
// Purpose: 
dvander@7
   806
// Output : char const
dvander@7
   807
//-----------------------------------------------------------------------------
dvander@7
   808
char const *ConVar::GetDefault( void ) const
dvander@7
   809
{
dvander@7
   810
	return m_pParent->m_pszDefaultValue;
dvander@7
   811
}
dvander@7
   812