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