CUI_Console.h

Go to the documentation of this file.

#ifndef CUI_CONSOLE_H
#define CUI_CONSOLE_H

#include <string>
#include <map>

#include "UI_Lib.h"
#include "UI_types.h"
#include "CUI_Control.h"
#include "CUI_TextField.h"
#include "CUI_ScrollableTextBox.h"

class CUI_ConsoleVar;
class CUI_ConsoleFun;


class GLGUI_ENTRY CUI_Console : public CUI_Control
{
public:
        typedef bool (cfun)( CUI_Console *con, const char *param );

        typedef enum cvartype_t { UI_TYPE_INT, UI_TYPE_UINT, UI_TYPE_FLOAT, UI_TYPE_STRING };

        CUI_Console(  CUI_UI *ui = NULL, float x = 0, float y = 0, float x2 = 1, float y2 = 1,
                                CUI_Frame *parent = NULL, IUI_Shader *shader = NULL,
                                IUI_Shader *cursor = NULL, CUI_CoordSys *coordsys = NULL,
                                // control
                                // console
                                unsigned int m_historyLength = 30, const char *prompt = "%" );

        virtual ~CUI_Console();

        virtual bool SetUI( CUI_UI *ui );


        virtual bool ProcessKey( unsigned long key );

        // Catch commands from the text field
        virtual bool CallbackFunc( int id, int numparam, void *param );

        virtual bool AddCvar( const char *name, cvartype_t type, void *data );

        virtual bool AddCfun( const char *name, cfun *function );

        virtual bool DeleteCfun( const char *name );


        virtual bool Exec( char *name, char *param );

        virtual bool ExecLine( const char *line );

        virtual bool ExecFun( CUI_ConsoleFun *cfun, char *param );

        virtual bool ExecAlias( const char *param );


        virtual bool ExecBuffer( char *buffer );


        virtual bool Complete();

        virtual bool SetPrompt( const char *prompt );



        virtual bool Echo( const char *string );
        
        virtual bool PrintCvarList( );

        virtual bool PrintCfunList( );


        virtual bool Alias( const char *name, const char *string );

        virtual CUI_TextField * GetTextField( )
        { return m_textField; }

        virtual bool SetHistoryLength( unsigned int length )
        { m_historyLength = length; return false; }

        virtual bool SetFieldWidth( unsigned short width )
        { return m_textField->SetWidth(width); }

        virtual bool SetFont( IUI_Font *font )
        { m_textField->SetFont(font); return m_textBox->SetFont(font); }

        virtual bool SetScrollShader( IUI_Shader *shader )
        { return m_textBox->SetScrollShader(shader); }

        virtual bool SetSliderShader( IUI_Shader *shader )
        { return m_textBox->SetSliderShader(shader); }

        virtual bool SetTextBoxSize( int columns, int rows )
        { return m_textBox->SetTextBoxSize( columns, rows ); }

        virtual bool SetWordWrap( bool wordwrap )
        { return m_textBox->SetWordWrap( wordwrap ); }

        virtual bool SetFieldHeight( float height )
        { m_textBox->Move( 0.0, height, 1.0, 1.0 ); return m_textField->Move( 0.0, 0.0, 1.0, height ); }

        virtual bool CatText( const char *text )
        { return m_textBox->CatText( text ); }

protected:

        CUI_TextField *m_textField;

        CUI_ScrollableTextBox *m_textBox;
        

        char *m_prompt;

        unsigned m_promptLength;
        
        unsigned int m_historyLength;

        typedef std::map<std::string, CUI_ConsoleVar*, std::less<std::string> > CVARMAP;

        CVARMAP m_cvarMap;
        
        typedef std::map<std::string, CUI_ConsoleFun*, std::less<std::string> > CFUNMAP;

        CFUNMAP m_cfunMap;

        typedef std::map<std::string, std::string, std::less<std::string> > CALIASMAP;

        CALIASMAP m_caliasMap;

        typedef std::list<std::string> HISTORYLIST;

        HISTORYLIST m_historyList;


        unsigned int m_historyPosition;

};


class CUI_ConsoleVar
{
public:
        CUI_ConsoleVar( const char * name, CUI_Console::cvartype_t type, void *data );

        ~CUI_ConsoleVar();

        bool SetValue( char *val );

        char *GetValue( );

protected:
        std::string m_name;


        CUI_Console::cvartype_t m_type;

        void *m_data;

};


class CUI_ConsoleFun
{
public:
        CUI_ConsoleFun( const char * name, CUI_Console::cfun *function );

        ~CUI_ConsoleFun();

        bool Execute( CUI_Console *con, char *param );

protected:
        std::string m_name;

        CUI_Console::cfun *m_function;

};


#endif

---