ConsoleGump.cpp

Go to the documentation of this file.

/*
 *  Copyright (C) 2003-2004  The Pentagram Team
 *
 *  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 2 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, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#include "pent_include.h"
#include "ConsoleGump.h"
#include "IDataSource.h"
#include "ODataSource.h"

#include "GUIApp.h"

DEFINE_RUNTIME_CLASSTYPE_CODE(ConsoleGump,Gump);

using Pentagram::istring;

//Pentagram::istring    ConsoleGump::commandBuffer;
//std::map<Pentagram::istring,ConsoleGump::ConsoleFunction> ConsoleGump::ConsoleCommands;

ConsoleGump::ConsoleGump()
        : Gump()
{
        con.AddConsoleCommand("ConsoleGump::toggle",
                                                  ConsoleGump::ConCmd_toggle);
}

ConsoleGump::ConsoleGump(int X, int Y, int Width, int Height) :
        Gump(X,Y,Width,Height, 0, FLAG_DONT_SAVE | FLAG_CORE_GUMP, LAYER_CONSOLE),
        scroll_state(NORMAL_DISPLAY)
{
        con.ClearCommandBuffer();

        // Resize it
        con.CheckResize(Width);

        con.AddConsoleCommand("ConsoleGump::toggle",
                                                  ConsoleGump::ConCmd_toggle);
}

ConsoleGump::~ConsoleGump()
{
        con.RemoveConsoleCommand(ConsoleGump::ConCmd_toggle);
}

void ConsoleGump::RenderSurfaceChanged()
{
        // Resize the desktop gump to match the RenderSurface
        Pentagram::Rect new_dims;
        parent->GetDims(new_dims);
        con.CheckResize(new_dims.w);
        dims.w = new_dims.w;
        dims.h = new_dims.h;

        Gump::RenderSurfaceChanged();
}

void ConsoleGump::PaintThis(RenderSurface *surf, sint32 lerp_factor, bool scaled)
{
        Gump::PaintThis(surf,lerp_factor, scaled);

        if (scroll_state == NOTIFY_OVERLAY)
        {
#ifdef DEBUG
                con.DrawConsoleNotify(surf);
#endif
        }
        else if (scroll_state != WAITING_TO_SHOW)
        {
                int h = dims.h;
                if (scroll_state == SCROLLING_TO_SHOW_1) 
                        h = (h*(000+lerp_factor))/1024;
                else if (scroll_state == SCROLLING_TO_SHOW_2) 
                        h = (h*(256+lerp_factor))/1024;
                else if (scroll_state == SCROLLING_TO_SHOW_3) 
                        h = (h*(512+lerp_factor))/1024;
                else if (scroll_state == SCROLLING_TO_SHOW_4) 
                        h = (h*(768+lerp_factor))/1024;

                else if (scroll_state == SCROLLING_TO_HIDE_1) 
                        h = (h*(1024-lerp_factor))/1024;
                else if (scroll_state == SCROLLING_TO_HIDE_2)
                        h = (h*(768-lerp_factor))/1024;
                else if (scroll_state == SCROLLING_TO_HIDE_3)
                        h = (h*(512-lerp_factor))/1024;
                else if (scroll_state == SCROLLING_TO_HIDE_4)
                        h = (h*(256-lerp_factor))/1024;

                con.DrawConsole(surf,h);
        }
}

void ConsoleGump::ToggleConsole()
{
        switch (scroll_state)
        {
        case WAITING_TO_HIDE:
                scroll_state = SCROLLING_TO_SHOW_4;
                break;

        case SCROLLING_TO_HIDE_1:
                scroll_state = SCROLLING_TO_SHOW_3;
                break;

        case SCROLLING_TO_HIDE_2:
                scroll_state = SCROLLING_TO_SHOW_2;
                break;

        case SCROLLING_TO_HIDE_3:
                scroll_state = SCROLLING_TO_SHOW_1;
                break;

        case SCROLLING_TO_HIDE_4:
                scroll_state = WAITING_TO_SHOW;
                break;

        case NOTIFY_OVERLAY:
                scroll_state = WAITING_TO_SHOW;
                break;

        case WAITING_TO_SHOW:
                scroll_state = SCROLLING_TO_HIDE_4;
                break;

        case SCROLLING_TO_SHOW_1:
                scroll_state = SCROLLING_TO_HIDE_3;
                break;

        case SCROLLING_TO_SHOW_2:
                scroll_state = SCROLLING_TO_HIDE_2;
                break;

        case SCROLLING_TO_SHOW_3:
                scroll_state = SCROLLING_TO_HIDE_1;
                break;

        case SCROLLING_TO_SHOW_4:
                scroll_state = WAITING_TO_HIDE;
                break;

        case NORMAL_DISPLAY:
                scroll_state = WAITING_TO_HIDE;
                GUIApp::get_instance()->leaveTextMode(this);
                con.ClearCommandBuffer();
                break;

        default:
                break;
        }
}


void ConsoleGump::HideConsole()
{
        switch (scroll_state)
        {
        case WAITING_TO_SHOW:
                scroll_state = SCROLLING_TO_HIDE_4;
                break;

        case SCROLLING_TO_SHOW_1:
                scroll_state = SCROLLING_TO_HIDE_3;
                break;

        case SCROLLING_TO_SHOW_2:
                scroll_state = SCROLLING_TO_HIDE_2;
                break;

        case SCROLLING_TO_SHOW_3:
                scroll_state = SCROLLING_TO_HIDE_1;
                break;

        case SCROLLING_TO_SHOW_4:
                scroll_state = WAITING_TO_HIDE;
                break;

        case NORMAL_DISPLAY:
                scroll_state = WAITING_TO_HIDE;
                GUIApp::get_instance()->leaveTextMode(this);
                con.ClearCommandBuffer();
                break;

        default:
                break;
        }
}


void ConsoleGump::ShowConsole()
{
        switch (scroll_state)
        {
        case WAITING_TO_HIDE:
                scroll_state = SCROLLING_TO_SHOW_4;
                break;

        case SCROLLING_TO_HIDE_1:
                scroll_state = SCROLLING_TO_SHOW_3;
                break;

        case SCROLLING_TO_HIDE_2:
                scroll_state = SCROLLING_TO_SHOW_2;
                break;

        case SCROLLING_TO_HIDE_3:
                scroll_state = SCROLLING_TO_SHOW_1;
                break;

        case SCROLLING_TO_HIDE_4:
                scroll_state = WAITING_TO_SHOW;
                break;

        case NOTIFY_OVERLAY:
                scroll_state = WAITING_TO_SHOW;
                break;

        default:
                break;
        }
}

bool ConsoleGump::ConsoleIsVisible()
{
        return scroll_state != NOTIFY_OVERLAY;
}

bool ConsoleGump::Run(const uint32 framenum)
{
        Gump::Run(framenum);

        con.setFrameNum(framenum);

        switch (scroll_state)
        {
        case WAITING_TO_HIDE:
                scroll_state = SCROLLING_TO_HIDE_1;
                break;

        case SCROLLING_TO_HIDE_1:
                scroll_state = SCROLLING_TO_HIDE_2;
                break;

        case SCROLLING_TO_HIDE_2:
                scroll_state = SCROLLING_TO_HIDE_3;
                break;

        case SCROLLING_TO_HIDE_3:
                scroll_state = SCROLLING_TO_HIDE_4;
                break;

        case SCROLLING_TO_HIDE_4:
                scroll_state = NOTIFY_OVERLAY;
                break;

        case WAITING_TO_SHOW:
                scroll_state = SCROLLING_TO_SHOW_1;
                break;

        case SCROLLING_TO_SHOW_1:
                scroll_state = SCROLLING_TO_SHOW_2;
                break;

        case SCROLLING_TO_SHOW_2:
                scroll_state = SCROLLING_TO_SHOW_3;
                break;

        case SCROLLING_TO_SHOW_3:
                scroll_state = SCROLLING_TO_SHOW_4;
                break;

        case SCROLLING_TO_SHOW_4:
                scroll_state = NORMAL_DISPLAY;
                GUIApp::get_instance()->enterTextMode(this);
                con.ClearCommandBuffer();
                break;

        default:
                break;
        }

        return true;    // Always repaint, even though we really could just try to detect it
}

void ConsoleGump::ConCmd_toggle(const Console::ArgvType &argv)
{
        ConsoleGump * consoleGump = GUIApp::get_instance()->getConsoleGump();
        consoleGump->ToggleConsole();
}

void ConsoleGump::saveData(ODataSource* ods)
{
        CANT_HAPPEN_MSG("Trying to save ConsoleGump");
}

bool ConsoleGump::loadData(IDataSource* ids, uint32 version)
{
        CANT_HAPPEN_MSG("Trying to save ConsoleGump");

        return false;
}

bool ConsoleGump::OnTextInput(int unicode)
{
        bool handled = false;
        if (scroll_state == NORMAL_DISPLAY) {

                con.AddCharacterToCommandBuffer(unicode);
                handled = true;
        }
        return handled;
}


bool ConsoleGump::OnKeyDown(int key, int mod)
{
        bool handled = false;
        if (scroll_state == NORMAL_DISPLAY)
        {
                switch(key)
                {
                        // Command completion
                case SDLK_TAB:
                        con.AddCharacterToCommandBuffer(Console::Tab);
                        break;

                case SDLK_RETURN:
                case SDLK_KP_ENTER:
                        con.AddCharacterToCommandBuffer(Console::Enter);
                        break;

                case SDLK_BACKSPACE:
                        con.DeleteCommandBufferChars(-1);
                        break;

                case SDLK_DELETE:
                        con.DeleteCommandBufferChars(1);
                        break;

                case SDLK_PAGEUP:
                        con.ScrollConsole(-3);
                        break;

                case SDLK_PAGEDOWN:
                        con.ScrollConsole(3); 
                        break;

                case SDLK_UP:
                        con.ScrollCommandHistory(-1);
                        break;

                case SDLK_DOWN:
                        con.ScrollCommandHistory(1);
                        break;

                case SDLK_LEFT:
                        con.MoveCommandCursor(-1);
                        break;

                case SDLK_RIGHT:
                        con.MoveCommandCursor(1);
                        break;

                case SDLK_INSERT:
                        con.ToggleCommandInsert();
                        break;

                case SDLK_KP0:
                case SDLK_KP1:
                case SDLK_KP2:
                case SDLK_KP3:
                case SDLK_KP4:
                case SDLK_KP5:
                case SDLK_KP6:
                case SDLK_KP7:
                case SDLK_KP8:
                case SDLK_KP9:
                        OnTextInput(key - SDLK_KP0 + '0');
                        break;

                default:
                        break;
                }
                handled = true;
        }
        return handled;
}

void ConsoleGump::OnFocus(bool gain)
{
        /*
        if (scroll_state == NORMAL_DISPLAY) {
                if (gain)
                        GUIApp::get_instance()->enterTextMode(this);
                else
                        GUIApp::get_instance()->leaveTextMode(this);
        }
        */

}

// Colourless Protection

---