console.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_FIFECHAN_ADDON_CONSOLE_H
#define FIFE_FIFECHAN_ADDON_CONSOLE_H

// Standard C++ library includes
#include <string>

// 3rd party library includes
#include <fifechan.hpp>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/time/timer.h"

namespace FIFE {

    class CommandLine;
    class GuiFont;

    class ConsoleExecuter {
        public:
            virtual ~ConsoleExecuter() {}

            virtual void onToolsClick() = 0;

            virtual std::string onConsoleCommand(const std::string& command) = 0;
    };


    class Console : public fcn::Container, public fcn::ActionListener, public fcn::FocusListener {
        public:
            Console();

            virtual ~Console();

            void println(const std::string & s);

            void show();

            void hide();

            void clear();

            void toggleShowHide();

            void execute(std::string cmd);

            void updateCaption();

            void updateAnimation();

            void action(const fcn::ActionEvent & event);

            void setConsoleExecuter(ConsoleExecuter* const consoleexec);

            void removeConsoleExecuter();

            void reLayout();

            void setIOFont(GuiFont* font);

            void focusLost(const fcn::Event& event);
        private:

            bool m_isAttached;
            ConsoleExecuter* m_consoleexec;
            
            CommandLine*      m_input;
            fcn::TextBox*     m_output;
            fcn::ScrollArea*  m_outputscrollarea;
            fcn::Label*       m_status;
            fcn::Button*      m_toolsbutton;
            static const unsigned m_maxOutputRows;

            std::string m_prompt;

            int32_t m_hiddenPos;
            int32_t m_animationDelta;

            bool m_hiding;

            Timer m_fpsTimer;
            Timer m_animationTimer;

            void doShow();
            void doHide();
    };
}
#endif