CWE-ou-minkata/Sources/Plasma/FeatureLib/pfConsoleCore/pfConsoleContext.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
//////////////////////////////////////////////////////////////////////////////
//                                                                          //
//  pfConsoleContext Header                                                 //
//                                                                          //
//////////////////////////////////////////////////////////////////////////////

#ifndef _pfConsoleContext_h
#define _pfConsoleContext_h

#include "HeadSpin.h"
#include "pfConsoleCmd.h"


//// Class Definition ////////////////////////////////////////////////////////

class pfConsoleContext
{
    protected:

        bool    fAddWhenNotFound;       // Controls whether we add variables on Set() calls if they're not found

        char    *fName;

        hsTArray<char *>            fVarNames;
        hsTArray<pfConsoleCmdParam> fVarValues;

        void    IAddVar( const char *name, const pfConsoleCmdParam &value );

        static pfConsoleContext fRootContext;

    public:

        pfConsoleContext( const char *name );
        virtual ~pfConsoleContext();

        void    Clear( void );

        uint32_t              GetNumVars( void ) const;
        const char          *GetVarName( uint32_t idx ) const;
        pfConsoleCmdParam   &GetVarValue( uint32_t idx ) const;

        int32_t   FindVar( const char *name ) const;
        void    RemoveVar( uint32_t idx );

        void    AddVar( const char *name, const pfConsoleCmdParam &value );
        void    AddVar( const char *name, int value );
        void    AddVar( const char *name, float value );
        void    AddVar( const char *name, const char *value );
        void    AddVar( const char *name, char value );
        void    AddVar( const char *name, bool value );

        bool    SetVar( uint32_t idx, const pfConsoleCmdParam &value );

        bool    SetVar( const char *name, const pfConsoleCmdParam &value );
        bool    SetVar( const char *name, int value );
        bool    SetVar( const char *name, float value );
        bool    SetVar( const char *name, const char *value );
        bool    SetVar( const char *name, char value );
        bool    SetVar( const char *name, bool value );

        // Decide whether Sets() on nonexistant variables will fail or add a new variable
        void    SetAddWhenNotFound( bool f ) { fAddWhenNotFound = f; }
        bool    GetAddWhenNotFound( void ) const { return fAddWhenNotFound; }

        static pfConsoleContext &GetRootContext( void );
};


#endif //_pfConsoleContext_h