Editor.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Utils_Termlib_Editor_
#define HH_SENF_Utils_Termlib_Editor_ 1

// Custom includes
#include <map>
#include <vector>
#include <string>
#include <senf/Scheduler/ClockService.hh>
#include <senf/Scheduler/TimerEvent.hh>
#include "AbstractTerminal.hh"
#include "Terminfo.hh"

//#include "Editor.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace term {

    class BaseEditor
        : public AbstractTerminal::Callbacks
    {
    public:
        typedef KeyParser::keycode_t keycode_t;

        static unsigned const DEFAULT_KEY_TIMEOUT_MS = 500u;

        explicit BaseEditor(AbstractTerminal & terminal);

        void newline();                 
        void toColumn(unsigned c);      
        void put(char ch);              
        void put(std::string const & text); 
        void clearLine();               
        void setBold();                 
        void setNormal();               
        void maybeClrScr();             

        void toLine(unsigned l);        
        void reset();                   

        unsigned currentColumn() const; 
        unsigned currentLine() const;   
        unsigned width() const;         
        unsigned height() const;        

    protected:
        virtual bool cb_init();         
        virtual void cb_windowSizeChanged();

#ifndef DOXYGEN
    private:
#endif
        virtual void v_keyReceived(keycode_t key) = 0; 

    private:
        virtual void cb_charReceived(char c);

        void keySequenceTimeout();
        void processKeys();

        void write(char ch);
        void write(std::string const & s);

        AbstractTerminal * terminal_;
        Terminfo tifo_;
        KeyParser keyParser_;
        std::string inputBuffer_;
        ClockService::clock_type keyTimeout_;
        scheduler::TimerEvent timer_;
        unsigned column_;
        unsigned displayHeight_;
        unsigned line_;
    };

    class LineEditor
        : public BaseEditor
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        typedef boost::function<void (LineEditor&)> KeyBinding; 
        typedef boost::function<void (std::string const &)> AcceptCallback;

        static unsigned const MAX_HISTORY_SIZE = 1024u;

        //-////////////////////////////////////////////////////////////////////////

        LineEditor(AbstractTerminal & terminal, AcceptCallback cb);

        //-////////////////////////////////////////////////////////////////////////

        //\{

        void show();                    
        void hide();                    
        void accept();                  
        void clear();                   
        void redisplay();               
        void forceRedisplay();          
        void prompt(std::string const & text); 

        //\}

        //\{

        void gotoChar(unsigned n);      
        void scrollTo(unsigned n);      

        //\}

        //\{

        void deleteChar(unsigned n=1);  
        void insert(char ch);           
        void insert(std::string const & text); 
        void set(std::string const & text, unsigned pos = 0u);

        //\}

        //\{

        void pushHistory(std::string const & text, bool accept = false);
        void prevHistory();             
        void nextHistory();             

        //\}

        //\{

        void auxDisplay(unsigned line, std::string const & text);
        unsigned maxAuxDisplayHeight(); 
        void clearAuxDisplay();         

        //\}

        //\{

        std::string const & text();     
        unsigned point();               
        unsigned displayPos();          
        keycode_t lastKey();            

        //\}

        //\{

        void defineKey(keycode_t key, KeyBinding binding);
        void unsetKey(keycode_t key);   

        //\}

    private:
        virtual bool cb_init();
        virtual void cb_windowSizeChanged();
        virtual void v_keyReceived(keycode_t key);

        typedef std::map<keycode_t, KeyBinding> KeyMap;
        typedef std::vector<std::string> History;
        typedef std::vector<std::string> AuxDisplay;

        bool enabled_;
        bool redisplayNeeded_;
        std::string prompt_;
        unsigned promptWidth_;
        unsigned editWidth_;
        std::string text_;
        unsigned point_;
        unsigned displayPos_;
        keycode_t lastKey_;
        AcceptCallback callback_;
        KeyMap bindings_;
        History history_;
        unsigned historyPoint_;
        AuxDisplay auxDisplay_;
    };

namespace bindings {

    void selfInsertCommand   (LineEditor & editor); 
    void forwardChar         (LineEditor & editor); 
    void backwardChar        (LineEditor & editor); 
    void accept              (LineEditor & editor); 
    void acceptWithRepeat    (LineEditor & editor); 
    void backwardDeleteChar  (LineEditor & editor); 
    void deleteChar          (LineEditor & editor); 
    void beginningOfLine     (LineEditor & editor); 
    void endOfLine           (LineEditor & editor); 
    void deleteToEndOfLine   (LineEditor & editor); 
    void restartEdit         (LineEditor & editor); 
    void prevHistory         (LineEditor & editor); 
    void nextHistory         (LineEditor & editor); 
    void clearScreen         (LineEditor & editor); 

    typedef boost::function<void (LineEditor &, unsigned & b, unsigned & e,
                                  std::string & prefix, std::vector<std::string> &)> Completer;
    void complete            (LineEditor & editor, Completer completer);

}

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
//#include "Editor.cci"
//#include "Editor.ct"
//#include "Editor.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: