dvander@68: //========= Copyright © 1996-2005, Valve Corporation, All rights reserved. ============// dvander@68: // dvander@68: // Purpose: dvander@68: // dvander@68: // $NoKeywords: $ dvander@68: // dvander@68: //=============================================================================// dvander@68: ds@238: #ifdef _XBOX ds@238: #include "xbox/xbox_platform.h" ds@238: #include "xbox/xbox_win32stubs.h" ds@238: #include "xbox/xbox_core.h" ds@238: #endif dvander@68: #include dvander@68: #include dvander@68: #include dvander@68: #include "basetypes.h" dvander@68: #include "convar.h" dvander@68: #include "vstdlib/strtools.h" ds@238: #include "icvar.h" dvander@68: #include "tier0/dbg.h" ds@238: #ifdef _XBOX ds@238: #include "vstdlib/ICommandLine.h" ds@238: #endif dvander@68: #include "tier0/memdbgon.h" dvander@68: dvander@68: ConCommandBase *ConCommandBase::s_pConCommandBases = NULL; dvander@68: IConCommandBaseAccessor *ConCommandBase::s_pAccessor = NULL; dvander@68: ds@238: #ifdef _XBOX ds@238: static char const* GetCommandLineValue( char const *pVariableName ) ds@238: { ds@238: int nLen = Q_strlen(pVariableName); ds@238: char *pSearch = (char*)stackalloc(nLen + 2); ds@238: pSearch[0] = '+'; ds@238: memcpy(&pSearch[1], pVariableName, nLen + 1); ds@238: return CommandLine()->ParmValue(pSearch); ds@238: } ds@238: #endif ds@238: ds@238: #if defined( _XBOX ) && !defined( _RETAIL ) ds@238: void ConCommandBaseMgr::PublishCommands( bool bForce ) ds@238: { ds@238: ConCommandBase *pCur; ds@238: const char *commands[2048]; ds@238: const char *helptext[2048]; ds@238: int numCommands = 0; ds@238: ds@238: if ( bForce ) ds@238: { ds@238: for ( pCur=ConCommandBase::s_pConCommandBases; pCur; pCur=pCur->m_pNext ) ds@238: { ds@238: pCur->m_bRegistered = false; ds@238: } ds@238: } ds@238: ds@238: // iterate and publish commands to the remote console ds@238: for ( pCur=ConCommandBase::s_pConCommandBases; pCur; pCur=pCur->m_pNext ) ds@238: { ds@238: if ( !pCur->m_bRegistered ) ds@238: { ds@238: // add unregistered commands to list ds@238: if ( numCommands < sizeof(commands)/sizeof(commands[0]) ) ds@238: { ds@238: commands[numCommands] = pCur->m_pszName; ds@238: helptext[numCommands] = pCur->m_pszHelpString; ds@238: numCommands++; ds@238: } ds@238: ds@238: // mark as registered ds@238: pCur->m_bRegistered = true; ds@238: } ds@238: } ds@238: if ( numCommands ) ds@238: { ds@238: XBX_rAddCommands( numCommands, commands, helptext ); ds@238: } ds@238: } ds@238: #endif ds@238: ds@238: #ifdef _XBOX ds@238: bool ConCommandBaseMgr::Fixup(ConCommandBase* pConCommand) ds@238: { ds@238: ConCommandBase *pCur; ds@238: ConCommandBase *pPrev2; ds@238: ConCommandBase *pCur2; ds@238: ConCommandBase *pNext2; ds@238: const char *name; ds@238: static int initCount = 0; ds@238: ds@238: // xboxissue - cvars and its class hierarchy could not be made to instance per subsystem ds@238: // without massive mangling and re-arranging, instead... ds@238: // there is only a single chain and therefore single /init/fixup ds@238: // missing: need to identify which subsystem ds@238: // could pass as part of declaration in constructor, but how to hide parameter for pc ds@238: // the accessors (aka callbacks to subsystems) to register with engine ds@238: // cannot be invoked as their unlink logic expect private lists ds@238: // so this just mimics the expected end result ds@238: // must handle early and late constructors ds@238: // late constructors are usually function scoped static ds@238: if (!pConCommand) ds@238: { ds@238: // the caller is one-time-init ds@238: if (++initCount > 1) ds@238: { ds@238: // the list has already been fixed ds@238: return true; ds@238: } ds@238: } ds@238: else ds@238: { ds@238: // the caller is a console command constructor ds@238: if (!initCount) ds@238: { ds@238: // the list has not been fixed yet ds@238: // no special behavior ds@238: return false; ds@238: } ds@238: else ds@238: { ds@238: // the list has already been fixed ds@238: // the console command is a late constructor ds@238: // add in to fixed list ds@238: bool hasParent = false; ds@238: if (!pConCommand->IsCommand()) ds@238: { ds@238: pCur = ConCommandBase::s_pConCommandBases; ds@238: while (pCur) ds@238: { ds@238: if (pCur->IsCommand() && !stricmp(pCur->m_pszName, pConCommand->m_pszName)) ds@238: { ds@238: // set its parent ds@238: ((ConVar*)pConCommand)->m_pParent = ((ConVar*)pCur)->m_pParent; ds@238: hasParent = true; ds@238: break; ds@238: } ds@238: pCur = pCur->m_pNext; ds@238: } ds@238: } ds@238: if (!hasParent) ds@238: { ds@238: // add to head of list ds@238: pConCommand->m_pNext = ConCommandBase::s_pConCommandBases; ds@238: ConCommandBase::s_pConCommandBases = pConCommand; ds@238: } ds@238: else ds@238: return true; ds@238: } ds@238: } ds@238: ds@238: if (initCount == 1) ds@238: { ds@238: // iterate the cvars and set their possible proxy parents ds@238: // skip over registered (fixed) entries ds@238: pCur = ConCommandBase::s_pConCommandBases; ds@238: while (pCur) ds@238: { ds@238: if (!pCur->IsCommand() && !pCur->m_bRegistered) ds@238: { ds@238: // iterate from the next node until end of list ds@238: name = pCur->m_pszName; ds@238: pPrev2 = pCur; ds@238: pCur2 = pCur->m_pNext; ds@238: while (pCur2) ds@238: { ds@238: pNext2 = pCur2->m_pNext; ds@238: if (!pCur2->IsCommand() && !stricmp(pCur2->m_pszName, name)) ds@238: { ds@238: // found duplicate ds@238: // unlink and fixup ds@238: pCur2->m_pNext = NULL; ds@238: pPrev2->m_pNext = pNext2; ds@238: ds@238: // set its parent ds@238: ((ConVar*)pCur2)->m_pParent = ((ConVar*)pCur)->m_pParent; ds@238: } ds@238: else ds@238: { ds@238: // no unlink, advance to next node ds@238: pPrev2 = pCur2; ds@238: } ds@238: ds@238: pCur2 = pNext2; ds@238: } ds@238: ds@238: char const *pValue = GetCommandLineValue(name); ds@238: if (pValue) ds@238: ((ConVar*)pCur)->SetValue(pValue); ds@238: } ds@238: pCur = pCur->m_pNext; ds@238: } ds@238: } ds@238: ds@238: #if !defined( _RETAIL ) ds@238: XBX_rTimeStampLog( Plat_FloatTime(), "xbx PublishCommands:Start" ); ds@238: ds@238: PublishCommands( false ); ds@238: ds@238: XBX_rTimeStampLog( Plat_FloatTime(), "xbx PublishCommands:Done" ); ds@238: #endif ds@238: ds@238: // fixup has been performed ds@238: return true; ds@238: } ds@238: #endif ds@238: dvander@68: // ----------------------------------------------------------------------------- // dvander@68: // ConCommandBaseMgr. dvander@68: // ----------------------------------------------------------------------------- // dvander@68: void ConCommandBaseMgr::OneTimeInit( IConCommandBaseAccessor *pAccessor ) dvander@68: { ds@238: #ifdef _XBOX ds@238: // fixup the list ds@238: ConCommandBaseMgr::Fixup(NULL); ds@238: #else dvander@68: ConCommandBase *pCur, *pNext; dvander@68: dvander@68: ConCommandBase::s_pAccessor = pAccessor; dvander@68: pCur = ConCommandBase::s_pConCommandBases; dvander@68: while ( pCur ) dvander@68: { dvander@68: pNext = pCur->m_pNext; dvander@68: pCur->Init(); dvander@68: pCur = pNext; dvander@68: } ds@238: #endif dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Default constructor dvander@68: //----------------------------------------------------------------------------- dvander@68: ConCommandBase::ConCommandBase( void ) dvander@68: { ds@238: m_bRegistered = false; ds@238: m_pszName = NULL; ds@238: m_pszHelpString = NULL; dvander@68: ds@238: m_nFlags = 0; ds@238: m_pNext = NULL; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: The base console invoked command/cvar interface dvander@68: // Input : *pName - name of variable/command dvander@68: // *pHelpString - help text dvander@68: // flags - flags dvander@68: //----------------------------------------------------------------------------- dvander@68: ConCommandBase::ConCommandBase( char const *pName, char const *pHelpString /*=0*/, int flags /*= 0*/ ) dvander@68: { dvander@68: Create( pName, pHelpString, flags ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: //----------------------------------------------------------------------------- dvander@68: ConCommandBase::~ConCommandBase( void ) dvander@68: { dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : Returns true on success, false on failure. dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConCommandBase::IsCommand( void ) const dvander@68: { dvander@68: // Assert( 0 ); This can't assert. . causes a recursive assert in Sys_Printf, etc. dvander@68: return true; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *pName - dvander@68: // callback - dvander@68: // *pHelpString - dvander@68: // flags - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommandBase::Create( char const *pName, char const *pHelpString /*= 0*/, int flags /*= 0*/ ) dvander@68: { dvander@68: static char *empty_string = ""; dvander@68: ds@238: m_bRegistered = false; dvander@68: dvander@68: // Name should be static data dvander@68: Assert( pName ); ds@238: m_pszName = pName; ds@238: m_pszHelpString = pHelpString ? pHelpString : empty_string; dvander@68: dvander@68: m_nFlags = flags; dvander@68: ds@238: #ifdef _XBOX ds@238: if (ConCommandBaseMgr::Fixup(this)) ds@238: return; ds@238: #endif ds@238: dvander@68: if ( !( m_nFlags & FCVAR_UNREGISTERED ) ) dvander@68: { ds@238: #ifndef _XBOX ds@238: m_pNext = s_pConCommandBases; ds@238: s_pConCommandBases = this; ds@238: #else ds@238: // xboxissue - engine cvars should be at head of list to ds@238: // ensure they are set as the cvar master/parent during fixup ds@238: if (!s_pConCommandBases || !(flags & FCVAR_NON_ENGINE)) ds@238: { ds@238: // engine cvars, place at head of list ds@238: m_pNext = s_pConCommandBases; ds@238: s_pConCommandBases = this; ds@238: } ds@238: else ds@238: { ds@238: // non-engine cvars, place at end of list ds@238: ConCommandBase *cur = s_pConCommandBases; ds@238: while (1) ds@238: { ds@238: if (!cur->m_pNext) ds@238: { ds@238: cur->m_pNext = this; ds@238: m_pNext = NULL; ds@238: break; ds@238: } ds@238: cur = cur->m_pNext; ds@238: } ds@238: } ds@238: #endif dvander@68: } dvander@68: else dvander@68: { dvander@68: // It's unregistered ds@238: m_pNext = NULL; dvander@68: } dvander@68: dvander@68: // If s_pAccessor is already set (this ConVar is not a global variable), dvander@68: // register it. dvander@68: if ( s_pAccessor ) dvander@68: { dvander@68: Init(); dvander@68: } dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Used internally by OneTimeInit to initialize. dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommandBase::Init() dvander@68: { dvander@68: if ( !s_pAccessor ) dvander@68: return; dvander@68: dvander@68: if ( m_bRegistered ) dvander@68: return; dvander@68: dvander@68: s_pAccessor->RegisterConCommandBase( this ); dvander@68: dvander@68: m_bRegistered = true; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *name - dvander@68: // Output : ConCommandBase dvander@68: //----------------------------------------------------------------------------- dvander@68: ConCommandBase const *ConCommandBase::FindCommand( char const *name ) dvander@68: { dvander@68: ConCommandBase const *cmd = GetCommands(); dvander@68: for ( ; cmd; cmd = cmd->GetNext() ) dvander@68: { dvander@68: if ( !stricmp( name, cmd->GetName() ) ) dvander@68: return cmd; dvander@68: } dvander@68: return NULL; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : ConCommandBase dvander@68: //----------------------------------------------------------------------------- dvander@68: const ConCommandBase *ConCommandBase::GetCommands( void ) dvander@68: { dvander@68: return s_pConCommandBases; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *var - dvander@68: // Output : static dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommandBase::AddToList( ConCommandBase *var ) dvander@68: { dvander@68: // This routine is only valid on root ConCommandBases dvander@68: var->m_pNext = s_pConCommandBases; dvander@68: s_pConCommandBases = var; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Return name of the command/var dvander@68: // Output : char const dvander@68: //----------------------------------------------------------------------------- dvander@68: char const *ConCommandBase::GetName( void ) const dvander@68: { dvander@68: return m_pszName; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : flag - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommandBase::RemoveFlaggedCommands( int flag ) dvander@68: { dvander@68: ConCommandBase *pNewList; dvander@68: ConCommandBase *pCommand, *pNext; dvander@68: dvander@68: pNewList = NULL; dvander@68: dvander@68: pCommand = s_pConCommandBases; dvander@68: while ( pCommand ) dvander@68: { dvander@68: pNext = pCommand->m_pNext; dvander@68: if ( !( pCommand->m_nFlags & flag ) ) dvander@68: { dvander@68: pCommand->m_pNext = pNewList; dvander@68: pNewList = pCommand; dvander@68: } dvander@68: else dvander@68: { dvander@68: // Unlink dvander@68: pCommand->m_pNext = NULL; dvander@68: } dvander@68: dvander@68: pCommand = pNext; dvander@68: } dvander@68: dvander@68: s_pConCommandBases = pNewList; dvander@68: } dvander@68: dvander@68: void ConCommandBase::RevertFlaggedCvars( int flag ) dvander@68: { dvander@68: for (const ConCommandBase *var= GetCommands() ; var ; var=var->GetNext()) dvander@68: { dvander@68: if ( var->IsCommand() ) dvander@68: continue; dvander@68: dvander@68: ConVar *cvar = ( ConVar * )var; dvander@68: dvander@68: if ( !cvar->IsBitSet( flag ) ) dvander@68: continue; dvander@68: dvander@68: // It's == to the default value, don't count dvander@68: if ( !Q_strcasecmp( cvar->GetDefault(), cvar->GetString() ) ) dvander@68: continue; dvander@68: dvander@68: cvar->Revert(); dvander@68: dvander@68: // DevMsg( "%s = \"%s\" (reverted)\n", cvar->GetName(), cvar->GetString() ); dvander@68: } dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : flag - dvander@68: // Output : Returns true on success, false on failure. dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConCommandBase::IsBitSet( int flag ) const dvander@68: { dvander@68: return ( flag & m_nFlags ) ? true : false; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : flags - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommandBase::AddFlags( int flags ) dvander@68: { dvander@68: m_nFlags |= flags; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : const ConCommandBase dvander@68: //----------------------------------------------------------------------------- dvander@68: const ConCommandBase *ConCommandBase::GetNext( void ) const dvander@68: { dvander@68: return m_pNext; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *next - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommandBase::SetNext( ConCommandBase *next ) dvander@68: { dvander@68: m_pNext = next; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Copies string using local new/delete operators dvander@68: // Input : *from - dvander@68: // Output : char dvander@68: //----------------------------------------------------------------------------- dvander@68: char *ConCommandBase::CopyString( char const *from ) dvander@68: { dvander@68: int len; dvander@68: char *to; dvander@68: dvander@68: len = strlen( from ); dvander@68: if ( len <= 0 ) dvander@68: { dvander@68: to = new char[1]; dvander@68: to[0] = 0; dvander@68: } dvander@68: else dvander@68: { dvander@68: to = new char[len+1]; dvander@68: Q_strncpy( to, from, len+1 ); dvander@68: } dvander@68: return to; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : char const dvander@68: //----------------------------------------------------------------------------- dvander@68: char const *ConCommandBase::GetHelpText( void ) const dvander@68: { dvander@68: return m_pszHelpString; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Has this cvar been registered dvander@68: // Output : Returns true on success, false on failure. dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConCommandBase::IsRegistered( void ) const dvander@68: { dvander@68: return m_bRegistered; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Constructs a console command dvander@68: // Input : *pName - name of command dvander@68: // callback - function to call upon execution dvander@68: // *pHelpString - help text for command dvander@68: // flags - command flags, if any dvander@68: //----------------------------------------------------------------------------- dvander@68: ConCommand::ConCommand( char const *pName, FnCommandCallback callback, char const *pHelpString /*= 0*/, int flags /*= 0*/, FnCommandCompletionCallback completionFunc /*= 0*/ ) dvander@68: { dvander@68: Create( pName, callback, pHelpString, flags, completionFunc ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: //----------------------------------------------------------------------------- dvander@68: ConCommand::~ConCommand( void ) dvander@68: { dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : Returns true on success, false on failure. dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConCommand::IsCommand( void ) const dvander@68: { dvander@68: return true; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Invoke the function if there is one dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommand::Dispatch( void ) dvander@68: { dvander@68: if ( m_fnCommandCallback ) dvander@68: { dvander@68: ( *m_fnCommandCallback )(); dvander@68: } dvander@68: else dvander@68: { dvander@68: // Command without callback!!! dvander@68: Assert( 0 ); dvander@68: } dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *partial - dvander@68: // context - dvander@68: // longest - dvander@68: // maxcommands - dvander@68: // **commands - dvander@68: // Output : int dvander@68: //----------------------------------------------------------------------------- dvander@68: int DefaultCompletionFunc( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] ) dvander@68: { dvander@68: return 0; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Create the named command dvander@68: // Input : *pName - dvander@68: // callback - dvander@68: // *pHelpString - dvander@68: // flags - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConCommand::Create( char const *pName, FnCommandCallback callback, char const *pHelpString /*= 0*/, int flags /*= 0*/, FnCommandCompletionCallback completionFunc /*=0*/ ) dvander@68: { dvander@68: // Set the callback dvander@68: m_fnCommandCallback = callback; dvander@68: dvander@68: m_fnCompletionCallback = completionFunc ? completionFunc : DefaultCompletionFunc; dvander@68: m_bHasCompletionCallback = completionFunc != 0 ? true : false; dvander@68: dvander@68: // Setup the rest dvander@68: BaseClass::Create( pName, pHelpString, flags ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *partial - dvander@68: // context - dvander@68: // longest - dvander@68: // maxcommands - dvander@68: // **commands - dvander@68: //----------------------------------------------------------------------------- dvander@68: int ConCommand::AutoCompleteSuggest( char const *partial, char commands[ COMMAND_COMPLETION_MAXITEMS ][ COMMAND_COMPLETION_ITEM_LENGTH ] ) dvander@68: { dvander@68: Assert( m_fnCompletionCallback ); dvander@68: if ( !m_fnCompletionCallback ) dvander@68: return 0; dvander@68: dvander@68: return ( m_fnCompletionCallback )( partial, commands ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : Returns true on success, false on failure. dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConCommand::CanAutoComplete( void ) dvander@68: { dvander@68: return m_bHasCompletionCallback; dvander@68: } dvander@68: dvander@68: // ----------------------------------------------------------------------------- // dvander@68: // ConVar. dvander@68: // ----------------------------------------------------------------------------- // dvander@68: ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags /* = 0 */ ) dvander@68: { dvander@68: Create( pName, pDefaultValue, flags ); dvander@68: } dvander@68: dvander@68: // ----------------------------------------------------------------------------- // dvander@68: // ConVar. dvander@68: // ----------------------------------------------------------------------------- // dvander@68: ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString ) dvander@68: { dvander@68: Create( pName, pDefaultValue, flags, pHelpString ); dvander@68: } dvander@68: dvander@68: // ----------------------------------------------------------------------------- // dvander@68: // ConVar. dvander@68: // ----------------------------------------------------------------------------- // dvander@68: ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax ) dvander@68: { dvander@68: Create( pName, pDefaultValue, flags, pHelpString, bMin, fMin, bMax, fMax ); dvander@68: } dvander@68: dvander@68: // ----------------------------------------------------------------------------- // dvander@68: // ConVar. dvander@68: // ----------------------------------------------------------------------------- // dvander@68: ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, FnChangeCallback callback ) dvander@68: { dvander@68: Create( pName, pDefaultValue, flags, pHelpString, false, 0.0, false, 0.0, callback ); dvander@68: } dvander@68: dvander@68: // ----------------------------------------------------------------------------- // dvander@68: // ConVar. dvander@68: // ----------------------------------------------------------------------------- // dvander@68: ConVar::ConVar( char const *pName, char const *pDefaultValue, int flags, char const *pHelpString, bool bMin, float fMin, bool bMax, float fMax, FnChangeCallback callback ) dvander@68: { dvander@68: Create( pName, pDefaultValue, flags, pHelpString, bMin, fMin, bMax, fMax, callback ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Free dynamic memory dvander@68: //----------------------------------------------------------------------------- dvander@68: ConVar::~ConVar( void ) dvander@68: { dvander@68: if ( m_pszString ) dvander@68: { dvander@68: delete[] m_pszString; dvander@68: m_pszString = NULL; dvander@68: } dvander@68: } dvander@68: dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Install a change callback (there shouldn't already be one....) dvander@68: //----------------------------------------------------------------------------- dvander@68: dvander@68: void ConVar::InstallChangeCallback( FnChangeCallback callback ) dvander@68: { dvander@68: Assert( !m_fnChangeCallback || !callback ); dvander@68: m_fnChangeCallback = callback; dvander@68: dvander@68: if (m_fnChangeCallback) dvander@68: { dvander@68: // Call it immediately to set the initial value... dvander@68: m_fnChangeCallback( this, m_pszString ); dvander@68: } dvander@68: } dvander@68: dvander@68: bool ConVar::IsBitSet( int flag ) const dvander@68: { dvander@68: return ( flag & m_pParent->m_nFlags ) ? true : false; dvander@68: } dvander@68: dvander@68: char const *ConVar::GetHelpText( void ) const dvander@68: { dvander@68: return m_pParent->m_pszHelpString; dvander@68: } dvander@68: dvander@68: void ConVar::AddFlags( int flags ) dvander@68: { dvander@68: m_pParent->m_nFlags |= flags; dvander@68: } dvander@68: dvander@68: bool ConVar::IsRegistered( void ) const dvander@68: { dvander@68: return m_pParent->m_bRegistered; dvander@68: } dvander@68: dvander@68: char const *ConVar::GetName( void ) const dvander@68: { dvander@68: return m_pParent->m_pszName; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : Returns true on success, false on failure. dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConVar::IsCommand( void ) const dvander@68: { dvander@68: return false; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::Init() dvander@68: { dvander@68: BaseClass::Init(); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *value - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::InternalSetValue( char const *value ) dvander@68: { dvander@68: float fNewValue; dvander@68: char tempVal[ 32 ]; dvander@68: char *val; dvander@68: dvander@68: Assert(m_pParent == this); // Only valid for root convars. dvander@68: dvander@68: val = (char *)value; dvander@68: fNewValue = ( float )atof( value ); dvander@68: dvander@68: if ( ClampValue( fNewValue ) ) dvander@68: { dvander@68: Q_snprintf( tempVal,sizeof(tempVal), "%f", fNewValue ); dvander@68: val = tempVal; dvander@68: } dvander@68: dvander@68: // Redetermine value dvander@68: m_fValue = fNewValue; dvander@68: m_nValue = ( int )( m_fValue ); dvander@68: dvander@68: if ( !(m_nFlags & FCVAR_NEVER_AS_STRING) ) dvander@68: ChangeStringValue( val ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *tempVal - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::ChangeStringValue( char const *tempVal ) dvander@68: { dvander@68: Assert( !( m_nFlags & FCVAR_NEVER_AS_STRING ) ); dvander@68: ds@238: char* pszOldValue = (char*)stackalloc( m_StringLength ); ds@238: memcpy( pszOldValue, m_pszString, m_StringLength ); dvander@68: dvander@68: int len = Q_strlen(tempVal) + 1; dvander@68: dvander@68: if ( len > m_StringLength) dvander@68: { dvander@68: if (m_pszString) dvander@68: delete[] m_pszString; dvander@68: dvander@68: m_pszString = new char[len]; dvander@68: m_StringLength = len; dvander@68: } dvander@68: dvander@68: memcpy( m_pszString, tempVal, len ); dvander@68: dvander@68: // Invoke any necessary callback function dvander@68: if ( m_fnChangeCallback ) dvander@68: { dvander@68: m_fnChangeCallback( this, pszOldValue ); dvander@68: } dvander@68: ds@238: GetCVarIF()->CallGlobalChangeCallback( this, pszOldValue ); ds@238: dvander@68: stackfree( pszOldValue ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Check whether to clamp and then perform clamp dvander@68: // Input : value - dvander@68: // Output : Returns true if value changed dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConVar::ClampValue( float& value ) dvander@68: { dvander@68: if ( m_bHasMin && ( value < m_fMinVal ) ) dvander@68: { dvander@68: value = m_fMinVal; dvander@68: return true; dvander@68: } dvander@68: dvander@68: if ( m_bHasMax && ( value > m_fMaxVal ) ) dvander@68: { dvander@68: value = m_fMaxVal; dvander@68: return true; dvander@68: } dvander@68: dvander@68: return false; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *value - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::InternalSetFloatValue( float fNewValue ) dvander@68: { dvander@68: if ( fNewValue == m_fValue ) dvander@68: return; dvander@68: dvander@68: Assert( m_pParent == this ); // Only valid for root convars. dvander@68: dvander@68: // Check bounds dvander@68: ClampValue( fNewValue ); dvander@68: dvander@68: // Redetermine value dvander@68: m_fValue = fNewValue; dvander@68: m_nValue = ( int )m_fValue; dvander@68: dvander@68: if ( !( m_nFlags & FCVAR_NEVER_AS_STRING ) ) dvander@68: { dvander@68: char tempVal[ 32 ]; dvander@68: Q_snprintf( tempVal, sizeof( tempVal), "%f", m_fValue ); dvander@68: ChangeStringValue( tempVal ); dvander@68: } dvander@68: else dvander@68: { dvander@68: Assert( !m_fnChangeCallback ); dvander@68: } dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *value - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::InternalSetIntValue( int nValue ) dvander@68: { dvander@68: if ( nValue == m_nValue ) dvander@68: return; dvander@68: dvander@68: Assert( m_pParent == this ); // Only valid for root convars. dvander@68: dvander@68: float fValue = (float)nValue; dvander@68: if ( ClampValue( fValue ) ) dvander@68: { dvander@68: nValue = ( int )( fValue ); dvander@68: } dvander@68: dvander@68: // Redetermine value dvander@68: m_fValue = fValue; dvander@68: m_nValue = nValue; dvander@68: dvander@68: if ( !( m_nFlags & FCVAR_NEVER_AS_STRING ) ) dvander@68: { dvander@68: char tempVal[ 32 ]; dvander@68: Q_snprintf( tempVal, sizeof( tempVal ), "%d", m_nValue ); dvander@68: ChangeStringValue( tempVal ); dvander@68: } dvander@68: else dvander@68: { dvander@68: Assert( !m_fnChangeCallback ); dvander@68: } dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Private creation dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::Create( char const *pName, char const *pDefaultValue, int flags /*= 0*/, dvander@68: char const *pHelpString /*= NULL*/, bool bMin /*= false*/, float fMin /*= 0.0*/, dvander@68: bool bMax /*= false*/, float fMax /*= false*/, FnChangeCallback callback /*= NULL*/ ) dvander@68: { dvander@68: static char *empty_string = ""; dvander@68: dvander@68: m_pParent = this; dvander@68: dvander@68: // Name should be static data dvander@68: m_pszDefaultValue = pDefaultValue ? pDefaultValue : empty_string; dvander@68: Assert( pDefaultValue ); dvander@68: dvander@68: m_StringLength = strlen( m_pszDefaultValue ) + 1; dvander@68: m_pszString = new char[m_StringLength]; dvander@68: memcpy( m_pszString, m_pszDefaultValue, m_StringLength ); dvander@68: dvander@68: m_bHasMin = bMin; dvander@68: m_fMinVal = fMin; dvander@68: m_bHasMax = bMax; dvander@68: m_fMaxVal = fMax; dvander@68: dvander@68: m_fnChangeCallback = callback; dvander@68: dvander@68: m_fValue = ( float )atof( m_pszString ); dvander@68: dvander@68: // Bounds Check, should never happen, if it does, no big deal dvander@68: if ( m_bHasMin && ( m_fValue < m_fMinVal ) ) dvander@68: { dvander@68: Assert( 0 ); dvander@68: } dvander@68: dvander@68: if ( m_bHasMax && ( m_fValue > m_fMaxVal ) ) dvander@68: { dvander@68: Assert( 0 ); dvander@68: } dvander@68: dvander@68: m_nValue = ( int )m_fValue; dvander@68: dvander@68: BaseClass::Create( pName, pHelpString, flags ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : *value - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::SetValue(char const *value) dvander@68: { dvander@68: ConVar *var = ( ConVar * )m_pParent; dvander@68: var->InternalSetValue( value ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : value - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::SetValue( float value ) dvander@68: { dvander@68: ConVar *var = ( ConVar * )m_pParent; dvander@68: var->InternalSetFloatValue( value ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : value - dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::SetValue( int value ) dvander@68: { dvander@68: ConVar *var = ( ConVar * )m_pParent; dvander@68: var->InternalSetIntValue( value ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: Reset to default value dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::Revert( void ) dvander@68: { dvander@68: // Force default value again dvander@68: ConVar *var = ( ConVar * )m_pParent; dvander@68: var->SetValue( var->m_pszDefaultValue ); dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: //----------------------------------------------------------------------------- dvander@68: void ConVar::RevertAll( void ) dvander@68: { dvander@68: ConCommandBase *p = s_pConCommandBases; dvander@68: while ( p ) dvander@68: { dvander@68: if ( !p->IsCommand() ) dvander@68: { dvander@68: ConVar *var = ( ConVar * )p; dvander@68: var->Revert(); dvander@68: } dvander@68: p = p->m_pNext; dvander@68: } dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : minVal - dvander@68: // Output : true if there is a min set dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConVar::GetMin( float& minVal ) const dvander@68: { dvander@68: minVal = m_pParent->m_fMinVal; dvander@68: return m_pParent->m_bHasMin; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Input : maxVal - dvander@68: //----------------------------------------------------------------------------- dvander@68: bool ConVar::GetMax( float& maxVal ) const dvander@68: { dvander@68: maxVal = m_pParent->m_fMaxVal; dvander@68: return m_pParent->m_bHasMax; dvander@68: } dvander@68: dvander@68: //----------------------------------------------------------------------------- dvander@68: // Purpose: dvander@68: // Output : char const dvander@68: //----------------------------------------------------------------------------- dvander@68: char const *ConVar::GetDefault( void ) const dvander@68: { dvander@68: return m_pParent->m_pszDefaultValue; dvander@68: } dvander@68: