Console.h

 
#ifndef MFRAME_E546E396_90BE_4524_B978_27AD4C166A12
#define MFRAME_E546E396_90BE_4524_B978_27AD4C166A12
 
/* ***************************************************************************************
 * Include
 */
 
//----------------------------------------------------------------------------------------
#include "./../lang/Character.h"
#include "./../lang/Object.h"
#include "./../lang/Updatable.h"
#include "./../util/ElapsedTimer.h"
 
//----------------------------------------------------------------------------------------
 
/* ***************************************************************************************
 * Namespace
 */
namespace ufm::util {
  class Console;
 
}  // namespace ufm::util
 
/* ***************************************************************************************
 * Class/Interface/Struct/Enum
 */
 
class ufm::util::Console : public ufm::lang::Object, public ufm::lang::Updatable {
  /* *************************************************************************************
   * Class/Interface/Struct/Enum
   */
 public:
  enum struct KeyControl : uint8;
  enum struct KeyFunction : uint32;
  struct Event;
 
  /* *************************************************************************************
   * Variable
   */
 public:
  uint32 vEscapedTime;
 
 private:
  ElapsedTimer         vElapsedTimer;
  ufm::lang::Readable& vReadable;
  Console::Event*      vEvent;
  uint32               vSequence;
  uint8                vIndex;
  bool                 vEscaped;
  bool                 vAlt;
  bool                 vFunction;
 
  /* *************************************************************************************
   * Abstract Method
   */
 
  /* *************************************************************************************
   * Construct Method
   */
 public:
  Console(ufm::lang::Readable& readable, Console::Event* event = nullptr) noexcept;
 
  virtual ~Console(void) override;
 
  /* *************************************************************************************
   * Operator Method
   */
 public:
  inline operator ufm::lang::Readable&(void) {
    return this->vReadable;
  }
 
  /* *************************************************************************************
   * Override - ufm::lang::Updatable
   */
 public:
  virtual void update(void) override;
 
  /* *************************************************************************************
   * Public Method
   */
 public:
  inline ufm::lang::Readable& readable(void) {
    return this->vReadable;
  }
 
  inline void setEvent(Console::Event* event) {
    this->vEvent = event;
  }
 
  /* *************************************************************************************
   * Protected Method
   */
 
  /* *************************************************************************************
   * Private Method
   */
 private:
  void wipe(void);
 
  /* *************************************************************************************
   * Static Variable
   */
 
  /* *************************************************************************************
   * Static Method
   */
};
 
enum struct ufm::util::Console::KeyControl : uint8 {
  KEY_SOH      = ufm::lang::Character::KEY_SOH,       // 01
  KEY_STX      = ufm::lang::Character::KEY_STX,       // 02
  KEY_ETX      = ufm::lang::Character::KEY_ETX,       // 03
  KEY_EOT      = ufm::lang::Character::KEY_EOT,       // 04
  KEY_ENQ      = ufm::lang::Character::KEY_ENQ,       // 05
  KEY_ACK      = ufm::lang::Character::KEY_ACK,       // 06
  KEY_BEL      = ufm::lang::Character::KEY_BEL,       // 07
  KEY_BS       = ufm::lang::Character::KEY_BS,        // 08
  KEY_TAB      = ufm::lang::Character::KEY_TAB,       // 09
  KEY_LF       = ufm::lang::Character::KEY_LF,        // 0A
  KEY_VT       = ufm::lang::Character::KEY_VT,        // 0B
  KEY_FF       = ufm::lang::Character::KEY_FF,        // 0C
  KEY_CR       = ufm::lang::Character::KEY_CR,        // 0D
  KEY_SO       = ufm::lang::Character::KEY_SO,        // 0E
  KEY_SI       = ufm::lang::Character::KEY_SI,        // 0F
  KEY_DLE      = ufm::lang::Character::KEY_DLE,       // 10
  KEY_DC1      = ufm::lang::Character::KEY_DC1,       // 11
  KEY_DC2      = ufm::lang::Character::KEY_DC2,       // 12
  KEY_DC3      = ufm::lang::Character::KEY_DC3,       // 13
  KEY_DC4      = ufm::lang::Character::KEY_DC4,       // 14
  KEY_NAK      = ufm::lang::Character::KEY_NAK,       // 15
  KEY_SYN      = ufm::lang::Character::KEY_SYN,       // 16
  KEY_ETB      = ufm::lang::Character::KEY_ETB,       // 17
  KEY_CAN      = ufm::lang::Character::KEY_CAN,       // 18
  KEY_EM       = ufm::lang::Character::KEY_EM,        // 19
  KEY_SUB      = ufm::lang::Character::KEY_SUB,       // 1A
  KEY_ESC      = ufm::lang::Character::KEY_ESC,       // 1B
  KEY_FS       = ufm::lang::Character::KEY_FS,        // 1C
  KEY_GS       = ufm::lang::Character::KEY_GS,        // 1D
  KEY_RS       = ufm::lang::Character::KEY_RS,        // 1E
  KEY_US       = ufm::lang::Character::KEY_US,        // 1F
  KEY_BACKSPAC = ufm::lang::Character::KEY_BACKSPACE  // 7F
};
 
enum struct ufm::util::Console::KeyFunction : uint32 {
  KEY_F1        = 0x007E3131,  // 1B 5B 31 31 7E
  KEY_F2        = 0x007E3231,  // 1B 5B 31 32 7E
  KEY_F3        = 0x007E3331,  // 1B 5B 31 33 7E
  KEY_F4        = 0x007E3431,  // 1B 5B 31 34 7E
  KEY_F5        = 0x007E3531,  // 1B 5B 31 35 7E
  KEY_F6        = 0x007E3731,  // 1B 5B 31 37 7E
  KEY_F7        = 0x007E3831,  // 1B 5B 31 38 7E
  KEY_F8        = 0x007E3931,  // 1B 5B 31 39 7E
  KEY_F9        = 0x007E3032,  // 1B 5B 32 30 7E
  KEY_F10       = 0x007E3132,  // 1B 5B 32 31 7E
  KEY_F11       = 0x007E3332,  // 1B 5B 32 33 7E
  KEY_F12       = 0x007E3432,  // 1B 5B 32 34 7E
  KEY_HOME      = 0x00007E31,  // 1B 5B 31 7E
  KEY_INSERT    = 0x00007E32,  // 1B 5B 32 7E
  KEY_DELETE    = 0x00007E33,  // 1B 5B 33 7E
  KEY_END       = 0x00007E34,  // 1B 5B 34 7E
  KEY_PAGE_UP   = 0x00007E35,  // 1B 5B 35 7E
  KEY_PAGE_DOWN = 0x00007E36,  // 1B 5B 36 7E
  KEY_UP        = 0x00000041,  // 1B 5B 41
  KEY_DOWN      = 0x00000042,  // 1B 5B 42
  KEY_RIGHT     = 0x00000043,  // 1B 5B 43
  KEY_LEFT      = 0x00000044   // 1B 5B 44
 
};
 
struct ufm::util::Console::Event {
  /* *************************************************************************************
   * Method
   */
 
  virtual void onControlKey(ufm::util::Console::KeyControl key, bool alt) abstract;
 
  virtual void onFunctionKey(ufm::util::Console::KeyFunction key, bool alt) abstract;
 
  virtual void onKey(char key, bool alt) abstract;
};
 
/* ***************************************************************************************
 * End of file
 */
 
#endif /* MFRAME_E546E396_90BE_4524_B978_27AD4C166A12 */