console.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2000-2022 Inria
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  * Neither the name of the ALICE Project-Team nor the names of its
 *  contributors may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 *  Contact: Bruno Levy
 *
 *     https://www.inria.fr/fr/bruno-levy
 *
 *     Inria,
 *     Domaine de Voluceau,
 *     78150 Le Chesnay - Rocquencourt
 *     FRANCE
 *
 */
 
#ifndef H_GEOGRAM_GFX_GUI_CONSOLE_H
#define H_GEOGRAM_GFX_GUI_CONSOLE_H
 
#include <geogram_gfx/basic/common.h>
#include <geogram_gfx/imgui_ext/imgui_ext.h>
#include <geogram/basic/logger.h>
 
namespace GEO {
 
    class GEOGRAM_GFX_API Console : public GEO::LoggerClient {
 
    public:
 
        Console(bool* visible_flag = nullptr);
 
        void div(const std::string& value) override;
 
        void out(const std::string& value) override;
 
        void warn(const std::string& value) override;
 
        void err(const std::string& value) override;
 
        void status(const std::string& value) override;
 
        void clear();
 
        virtual void printf(const char* fmt, ...) /* IM_FMTARGS(1) */;
 
        virtual void draw(bool* visible=nullptr, bool with_window=true);
 
        int TextEditCallback(ImGuiInputTextCallbackData* data);
 
        void show() {
            *visible_flag_ = true;
        }
 
        void hide() {
            *visible_flag_ = false;
        }
 
        typedef void (*CompletionCallback)(
            Console* console,
            const std::string& line, index_t startw, index_t endw,
            const std::string& cmpword, std::vector<std::string>& matches
        );
 
        void set_completion_callback(CompletionCallback CB) {
            completion_callback_ = CB;
        }
 
        typedef void (*HistoryCallback)(
            Console* console,
            index_t index,
            std::string& command
        );
 
        void set_history_callback(HistoryCallback CB) {
            history_callback_ = CB;
        }
 
        void set_history_size(index_t n) {
            if(n != max_history_index_) {
                history_index_  = n;
            }
            max_history_index_ = n;
        }
 
        void show_command_prompt() {
            command_prompt_ = true;
        }
 
        void hide_command_prompt() {
            command_prompt_ = false;
        }
 
    protected:
        virtual void notify_error(const std::string& err);
 
        virtual bool exec_command(const char* command);
 
        virtual void update();
 
        bool command_prompt_;
        ImGuiTextBuffer buf_;
        ImGuiTextFilter filter_;
        ImVector<int>      line_offsets_;
        index_t            scroll_to_bottom_;
        bool*              visible_flag_;
        char               input_buf_[geo_imgui_string_length];
        CompletionCallback completion_callback_;
        HistoryCallback    history_callback_;
        index_t            history_index_;
        index_t            max_history_index_;
    };
 
    typedef SmartPointer<Console> Console_var;
}
 
#endif