ikernelinput.h

#pragma once
 
#include "shared/interface/signal.h"
 
namespace itasca {
    class IGUIInput;
    class ITextInput;
 
    class IKernelInput {
    public:
        enum class Key { None=0, Escape = 0x01000000, Tab, Backtab, Backspace, Return, Enter, Insert, Delete, 
                         Pause, Print, SysReq, Clear, Home=0x01000010, End, Left, Up, Right, Down, 
                         PageUp, PageDown, Shift=0x01000020, Control, Meta, Alt, F1=0x01000030,
                         F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, Z=0x5a, Space=0x20 };
        enum class KeyModifier { None=0x0, Shift=0x2000000, Control=0x4000000, Alt=0x8000000,
                                 Meta=0x10000000 };
        struct KeyInfo {
            Key key_ = Key::None;
            KeyModifier mod_ = KeyModifier::None;
            char char_ = '\0';
        };
        using UndoConnect = std::tuple<shared::Signal<bool> *, shared::Signal<bool, double> *>;
 
        virtual ITextInput *getITextInput()=0;
 
        // Kernel specific more detailed input
        virtual KeyInfo getKey()=0;                                           
        virtual uint32 prompt(const string &message,const string &options,const string &keys,uint32 ok,uint32 cancel)=0;
        virtual string getUIName() const=0;
        virtual bool   autoTestMode() const=0;
        virtual string getHelpFileFrontPage() const=0;
        virtual string getDocDirectory() const=0;
 
        // Interrupt functions
        virtual void poll(bool suppressException=false,bool skipTimingTest=false)=0;
        virtual bool hasBeenInterrupted()=0;                
        virtual bool hasBeenSafeInterrupted()=0;            
 
        virtual IGUIInput *getIGUIInput()=0;  
 
        // Undo support
        virtual UndoConnect getUndoConnect() = 0;
        //virtual bool getUndoStartMark()=0; 
 
        virtual string getProjectPath() const = 0;
 
        //virtual bool acceptRedirect() const=0;
        //virtual void setRedirectInput(IKernelInput * ki)=0;
    };
 
    inline IKernelInput::KeyModifier operator&(IKernelInput::KeyModifier m1,IKernelInput::KeyModifier m2) {
        return to<IKernelInput::KeyModifier>(to<uint32>(m1) & to<uint32>(m2));
    }
} // /namespace itasca
// EOF