GUIConsole.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef DVD_GUI_CONSOLE_H_
#define DVD_GUI_CONSOLE_H_
 
constexpr size_t CEGUI_MAX_INPUT_HISTORY = 5;
 
#include "Core/Headers/PlatformContextComponent.h"
 
namespace CEGUI {
    class FormattedListboxTextItem;
    class EventArgs;
};
 
namespace Divide {
 
class GUI;
class ResourceCache;
class PlatformContext;
class GUIConsoleCommandParser;
class GUIConsole final : public PlatformContextComponent {
   public:
    explicit GUIConsole(GUI& parent, PlatformContext& context);
    ~GUIConsole() override;
 
    void setVisible(bool visible);
    bool isVisible() const;
 
    void update(U64 deltaTimeUS);
 
    void printText(const Console::OutputEntry& entry);
 
   protected:
    void RegisterHandlers();  
    bool Handle_TextSubmitted(const CEGUI::EventArgs& e);  
    bool Handle_TextInput(const CEGUI::EventArgs& e);  
 
   protected:
    friend class GUI;
    void createCEGUIWindow();  
    // Post the message to the ChatHistory listbox with a white colour default
    void OutputText(const Console::OutputEntry& text) const;
 
   protected:
    GUI& _parent;
    bool _init;
    bool _closing;
    Console::EntryType _lastMsgType;
    CEGUI::String _lastMsg;
    CEGUI::Editbox* _editBox;
    CEGUI::Listbox* _outputWindow;
    std::unique_ptr<GUIConsoleCommandParser> _cmdParser;
    CEGUI::Window* _consoleWindow;
    CEGUI::String _inputBuffer;
    std::deque<CEGUI::String> _inputHistory;
    I16 _inputHistoryIndex;
    
    moodycamel::ConcurrentQueue<Console::OutputEntry> _outputBuffer;
 
    size_t _consoleCallbackIndex;
};
 
};  // namespace Divide
 
#endif //DVD_GUI_CONSOLE_H_