Term::Key Class Reference

#include <cpp-terminal/key.hpp>

Public Types
enum	Value : std::int32_t {   NoKey = -1 , Ctrl_Arobase = 0 , Ctrl_A = 1 , Ctrl_B = 2 ,   Ctrl_C = 3 , Ctrl_D = 4 , Ctrl_E = 5 , Ctrl_F = 6 ,   Ctrl_G = 7 , Ctrl_H = 8 , Ctrl_I = 9 , Ctrl_J = 10 ,   Ctrl_K = 11 , Ctrl_L = 12 , Ctrl_M = 13 , Ctrl_N = 14 ,   Ctrl_O = 15 , Ctrl_P = 16 , Ctrl_Q = 17 , Ctrl_R = 18 ,   Ctrl_S = 19 , Ctrl_T = 20 , Ctrl_U = 21 , Ctrl_V = 22 ,   Ctrl_W = 23 , Ctrl_X = 24 , Ctrl_Y = 25 , Ctrl_Z = 26 ,   Ctrl_OpenBracket = 27 , Ctrl_BackSlash = 28 , Ctrl_CloseBracket = 29 , Ctrl_Caret = 30 ,   Ctrl_Underscore = 31 , Space = 32 , ExclamationMark = 33 , Quote = 34 ,   Hash = 35 , Dollar = 36 , Percent = 37 , Ampersand = 38 ,   Apostrophe = 39 , OpenParenthesis = 40 , CloseParenthesis = 41 , Asterisk = 42 ,   Plus = 43 , Comma = 44 , Hyphen = 45 , Minus = 45 ,   Period = 46 , Slash = 47 , Zero = 48 , One = 49 ,   Two = 50 , Three = 51 , Four = 52 , Five = 53 ,   Six = 54 , Seven = 55 , Eight = 56 , Nine = 57 ,   Colon = 58 , Semicolon = 59 , LessThan = 60 , OpenChevron = 60 ,   Equal = 61 , GreaterThan = 62 , CloseChevron = 62 , QuestionMark = 63 ,   Arobase = 64 , A = 65 , B = 66 , C = 67 ,   D = 68 , E = 69 , F = 70 , G = 71 ,   H = 72 , I = 73 , J = 74 , K = 75 ,   L = 76 , M = 77 , N = 78 , O = 79 ,   P = 80 , Q = 81 , R = 82 , S = 83 ,   T = 84 , U = 85 , V = 86 , W = 87 ,   X = 88 , Y = 89 , Z = 90 , OpenBracket = 91 ,   Backslash = 92 , CloseBracket = 93 , Caret = 94 , Underscore = 95 ,   GraveAccent = 96 , a = 97 , b = 98 , c = 99 ,   d = 100 , e = 101 , f = 102 , g = 103 ,   h = 104 , i = 105 , j = 106 , k = 107 ,   l = 108 , m = 109 , n = 110 , o = 111 ,   p = 112 , q = 113 , r = 114 , s = 115 ,   t = 116 , u = 117 , v = 118 , w = 119 ,   x = 120 , y = 121 , z = 122 , OpenBrace = 123 ,   VerticalBar = 124 , Close_Brace = 125 , Tilde = 126 , CTRL_QuestionMark = 127 ,   Null = 0 , Backspace = 8 , Tab = 9 , Enter = 13 ,   Esc = 27 , Del = 127 , ArrowLeft = 0x10FFFF + 1 , ArrowRight = 0x10FFFF + 2 ,   ArrowUp = 0x10FFFF + 3 , ArrowDown = 0x10FFFF + 4 , Numeric5 = 0x10FFFF + 5 , Home = 0x10FFFF + 6 ,   Insert = 0x10FFFF + 7 , End = 0x10FFFF + 8 , PageUp = 0x10FFFF + 9 , PageDown = 0x10FFFF + 10 ,   F1 = 0x10FFFF + 11 , F2 = 0x10FFFF + 12 , F3 = 0x10FFFF + 13 , F4 = 0x10FFFF + 14 ,   F5 = 0x10FFFF + 15 , F6 = 0x10FFFF + 16 , F7 = 0x10FFFF + 17 , F8 = 0x10FFFF + 18 ,   F9 = 0x10FFFF + 19 , F10 = 0x10FFFF + 20 , F11 = 0x10FFFF + 21 , F12 = 0x10FFFF + 22 ,   F13 = 0x10FFFF + 23 , F14 = 0x10FFFF + 24 , F15 = 0x10FFFF + 25 , F16 = 0x10FFFF + 26 ,   F17 = 0x10FFFF + 27 , F18 = 0x10FFFF + 28 , F19 = 0x10FFFF + 29 , F20 = 0x10FFFF + 30 ,   F21 = 0x10FFFF + 31 , F22 = 0x10FFFF + 32 , F23 = 0x10FFFF + 33 , F24 = 0x10FFFF + 34 ,   PrintScreen = 0x10FFFF + 35 , Menu = 0x10FFFF + 36 }
using	value_type = std::int32_t

Public Member Functions
constexpr	Key ()
constexpr	Key (const Key &key)=default
Key &	operator= (const Key &key)=default
constexpr	Key (const Value &v)
Key &	operator= (const Value &v)
constexpr	Key (char val)
Key &	operator= (char val)
constexpr	Key (std::int32_t val)
Key &	operator= (std::int32_t val)
constexpr	Key (std::size_t val)
Key &	operator= (std::size_t val)
constexpr	Key (char32_t val)
Key &	operator= (char32_t val)
constexpr	operator std::int32_t () const
constexpr bool	iscntrl () const
constexpr bool	isblank () const
constexpr bool	isspace () const
constexpr bool	isupper () const
constexpr bool	islower () const
constexpr bool	isalpha () const
constexpr bool	isdigit () const
constexpr bool	isxdigit () const
constexpr bool	isalnum () const
constexpr bool	ispunct () const
constexpr bool	isgraph () const
constexpr bool	isprint () const
constexpr bool	isunicode () const
constexpr Key	tolower () const
constexpr Key	toupper () const
constexpr bool	isASCII () const
constexpr bool	isExtendedASCII () const
constexpr bool	hasCtrlAll () const
constexpr bool	hasCtrl () const
constexpr bool	hasAlt () const
constexpr bool	empty () const
void	append_name (std::string &strOut) const
std::string	name () const
std::string	str () const

Public Attributes
std::int32_t	value

Friends
constexpr bool	operator== (Key l, Key r)
constexpr bool	operator== (Key l, char r)
constexpr bool	operator== (char l, Key r)
constexpr bool	operator== (Key l, char32_t r)
constexpr bool	operator== (char32_t l, Key r)
constexpr bool	operator== (Key l, std::int32_t r)
constexpr bool	operator== (std::int32_t l, Key r)
constexpr bool	operator== (Key l, std::size_t r)
constexpr bool	operator== (std::size_t l, Key r)
constexpr bool	operator!= (Key l, Key r)
constexpr bool	operator!= (Key l, char r)
constexpr bool	operator!= (char l, Key r)
constexpr bool	operator!= (Key l, char32_t r)
constexpr bool	operator!= (char32_t l, Key r)
constexpr bool	operator!= (Key l, std::int32_t r)
constexpr bool	operator!= (std::int32_t l, Key r)
constexpr bool	operator!= (Key l, std::size_t r)
constexpr bool	operator!= (std::size_t l, Key r)
constexpr bool	operator< (Key l, Key r)
constexpr bool	operator< (Key l, char r)
constexpr bool	operator< (char l, Key r)
constexpr bool	operator< (Key l, char32_t r)
constexpr bool	operator< (char32_t l, Key r)
constexpr bool	operator< (Key l, std::int32_t r)
constexpr bool	operator< (std::int32_t l, Key r)
constexpr bool	operator< (Key l, std::size_t r)
constexpr bool	operator< (std::size_t l, Key r)
constexpr bool	operator>= (Key l, Key r)
constexpr bool	operator>= (Key l, char r)
constexpr bool	operator>= (char l, Key r)
constexpr bool	operator>= (Key l, char32_t r)
constexpr bool	operator>= (char32_t l, Key r)
constexpr bool	operator>= (Key l, std::int32_t r)
constexpr bool	operator>= (std::int32_t l, Key r)
constexpr bool	operator>= (Key l, std::size_t r)
constexpr bool	operator>= (std::size_t l, Key r)
constexpr bool	operator> (Key l, Key r)
constexpr bool	operator> (Key l, char r)
constexpr bool	operator> (char l, Key r)
constexpr bool	operator> (Key l, char32_t r)
constexpr bool	operator> (char32_t l, Key r)
constexpr bool	operator> (Key l, std::int32_t r)
constexpr bool	operator> (std::int32_t l, Key r)
constexpr bool	operator> (Key l, std::size_t r)
constexpr bool	operator> (std::size_t l, Key r)
constexpr bool	operator<= (Key l, Key r)
constexpr bool	operator<= (Key l, char r)
constexpr bool	operator<= (char l, Key r)
constexpr bool	operator<= (Key l, char32_t r)
constexpr bool	operator<= (char32_t l, Key r)
constexpr bool	operator<= (Key l, std::int32_t r)
constexpr bool	operator<= (std::int32_t l, Key r)
constexpr bool	operator<= (Key l, std::size_t r)
constexpr bool	operator<= (std::size_t l, Key r)

Detailed Description

Definition at line 85 of file key.hpp.

Member Typedef Documentation

value_type

using Term::Key::value_type = std::int32_t

Definition at line 88 of file key.hpp.

Member Enumeration Documentation

Value

enum Term::Key::Value : std::int32_t

Enumerator
NoKey
Ctrl_Arobase
Ctrl_A
Ctrl_B
Ctrl_C
Ctrl_D
Ctrl_E
Ctrl_F
Ctrl_G
Ctrl_H
Ctrl_I
Ctrl_J
Ctrl_K
Ctrl_L
Ctrl_M
Ctrl_N
Ctrl_O
Ctrl_P
Ctrl_Q
Ctrl_R
Ctrl_S
Ctrl_T
Ctrl_U
Ctrl_V
Ctrl_W
Ctrl_X
Ctrl_Y
Ctrl_Z
Ctrl_OpenBracket
Ctrl_BackSlash
Ctrl_CloseBracket
Ctrl_Caret
Ctrl_Underscore
Space
ExclamationMark
Quote
Hash
Dollar
Percent
Ampersand
Apostrophe
OpenParenthesis
CloseParenthesis
Asterisk
Plus
Comma
Hyphen
Minus
Period
Slash
Zero
One
Two
Three
Four
Five
Six
Seven
Eight
Nine
Colon
Semicolon
LessThan
OpenChevron
Equal
GreaterThan
CloseChevron
QuestionMark
Arobase
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
OpenBracket
Backslash
CloseBracket
Caret
Underscore
GraveAccent
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
OpenBrace
VerticalBar
Close_Brace
Tilde
CTRL_QuestionMark
Null
Backspace
Tab
Enter
Esc
Del
ArrowLeft
ArrowRight
ArrowUp
ArrowDown
Numeric5
Home
Insert
End
PageUp
PageDown
F1
F2
F3
F4
F5
F6
F7
F8
F9
F10
F11
F12
F13
F14
F15
F16
F17
F18
F19
F20
F21
F22
F23
F24
PrintScreen
Menu

Definition at line 90 of file key.hpp.

  {
    NoKey = -1,
    // Now use << to for detecting special key + key press
 
    // Begin ASCII (some ASCII names has been change to their Ctrl_+key part) the value is different to be able to do
    Ctrl_Arobase      = 0,
    Ctrl_A            = 1,
    Ctrl_B            = 2,
    Ctrl_C            = 3,
    Ctrl_D            = 4,
    Ctrl_E            = 5,
    Ctrl_F            = 6,
    Ctrl_G            = 7,
    Ctrl_H            = 8, /*corresponds to Backspace*/
    Ctrl_I            = 9, /*corresponds to Tab*/
    Ctrl_J            = 10,
    Ctrl_K            = 11,
    Ctrl_L            = 12,
    Ctrl_M            = 13, /*corresponds to Enter*/
    Ctrl_N            = 14,
    Ctrl_O            = 15,
    Ctrl_P            = 16,
    Ctrl_Q            = 17,
    Ctrl_R            = 18,
    Ctrl_S            = 19,
    Ctrl_T            = 20,
    Ctrl_U            = 21,
    Ctrl_V            = 22,
    Ctrl_W            = 23,
    Ctrl_X            = 24,
    Ctrl_Y            = 25,
    Ctrl_Z            = 26,
    Ctrl_OpenBracket  = 27, /*corresponds to Escape*/
    Ctrl_BackSlash    = 28,
    Ctrl_CloseBracket = 29,
    Ctrl_Caret        = 30,
    Ctrl_Underscore   = 31,
    Space             = 32,
    ExclamationMark   = 33,
    Quote             = 34,
    Hash              = 35,
    Dollar            = 36,
    Percent           = 37,
    Ampersand         = 38,
    Apostrophe        = 39,
    OpenParenthesis   = 40,
    CloseParenthesis  = 41,
    Asterisk          = 42,
    Plus              = 43,
    Comma             = 44,
    Hyphen            = 45,
    Minus             = 45,
    Period            = 46,
    Slash             = 47,
    Zero              = 48,
    One               = 49,
    Two               = 50,
    Three             = 51,
    Four              = 52,
    Five              = 53,
    Six               = 54,
    Seven             = 55,
    Eight             = 56,
    Nine              = 57,
    Colon             = 58,
    Semicolon         = 59,
    LessThan          = 60,
    OpenChevron       = 60,
    Equal             = 61,
    GreaterThan       = 62,
    CloseChevron      = 62,
    QuestionMark      = 63,
    Arobase           = 64,
    A                 = 65,
    B                 = 66,
    C                 = 67,
    D                 = 68,
    E                 = 69,
    F                 = 70,
    G                 = 71,
    H                 = 72,
    I                 = 73,
    J                 = 74,
    K                 = 75,
    L                 = 76,
    M                 = 77,
    N                 = 78,
    O                 = 79,
    P                 = 80,
    Q                 = 81,
    R                 = 82,
    S                 = 83,
    T                 = 84,
    U                 = 85,
    V                 = 86,
    W                 = 87,
    X                 = 88,
    Y                 = 89,
    Z                 = 90,
    OpenBracket       = 91,
    Backslash         = 92,
    CloseBracket      = 93,
    Caret             = 94,
    Underscore        = 95,
    GraveAccent       = 96,
    a                 = 97,
    b                 = 98,
    c                 = 99,
    d                 = 100,
    e                 = 101,
    f                 = 102,
    g                 = 103,
    h                 = 104,
    i                 = 105,
    j                 = 106,
    k                 = 107,
    l                 = 108,
    m                 = 109,
    n                 = 110,
    o                 = 111,
    p                 = 112,
    q                 = 113,
    r                 = 114,
    s                 = 115,
    t                 = 116,
    u                 = 117,
    v                 = 118,
    w                 = 119,
    x                 = 120,
    y                 = 121,
    z                 = 122,
    OpenBrace         = 123,
    VerticalBar       = 124,
    Close_Brace       = 125,
    Tilde             = 126,
    CTRL_QuestionMark = 127, /*corresponds to DEL*/
    // Very useful CTRL_* alternative names
    Null              = 0,
    Backspace         = 8,
    Tab               = 9,
    Enter             = 13,
    Esc               = 27,
    Del               = 127,
    //
    // End ASCII
    // Extended ASCII goes up to 255
    // Last Unicode codepage 0x10FFFF
    ArrowLeft         = 0x10FFFF + 1,
    ArrowRight        = 0x10FFFF + 2,
    ArrowUp           = 0x10FFFF + 3,
    ArrowDown         = 0x10FFFF + 4,
    Numeric5          = 0x10FFFF + 5,
    Home              = 0x10FFFF + 6,
    Insert            = 0x10FFFF + 7,
    End               = 0x10FFFF + 8,
    PageUp            = 0x10FFFF + 9,
    PageDown          = 0x10FFFF + 10,
    F1                = 0x10FFFF + 11,
    F2                = 0x10FFFF + 12,
    F3                = 0x10FFFF + 13,
    F4                = 0x10FFFF + 14,
    F5                = 0x10FFFF + 15,
    F6                = 0x10FFFF + 16,
    F7                = 0x10FFFF + 17,
    F8                = 0x10FFFF + 18,
    F9                = 0x10FFFF + 19,
    F10               = 0x10FFFF + 20,
    F11               = 0x10FFFF + 21,
    F12               = 0x10FFFF + 22,
    F13               = 0x10FFFF + 23,
    F14               = 0x10FFFF + 24,
    F15               = 0x10FFFF + 25,
    F16               = 0x10FFFF + 26,
    F17               = 0x10FFFF + 27,
    F18               = 0x10FFFF + 28,
    F19               = 0x10FFFF + 29,
    F20               = 0x10FFFF + 30,
    F21               = 0x10FFFF + 31,
    F22               = 0x10FFFF + 32,
    F23               = 0x10FFFF + 33,
    F24               = 0x10FFFF + 34,
    PrintScreen       = 0x10FFFF + 35,
    Menu              = 0x10FFFF + 36,
  };

Constructor & Destructor Documentation

Key() [1/7]

Term::Key::Key ( )

inlineconstexpr

Definition at line 276 of file key.hpp.

: value(NoKey) {}

Key() [2/7]

Term::Key::Key ( const Key & key )

constexprdefault

Key() [3/7]

Term::Key::Key ( const Value & v )

inlineconstexpr

Definition at line 280 of file key.hpp.

: value(static_cast<std::int32_t>(v)) {}

Key() [4/7]

Term::Key::Key ( char val )

inlineexplicitconstexpr

Definition at line 287 of file key.hpp.

: value(static_cast<std::int32_t>(val)) {}

Key() [5/7]

Term::Key::Key ( std::int32_t val )

inlineconstexpr

Definition at line 294 of file key.hpp.

: value(val) {}

Key() [6/7]

Term::Key::Key ( std::size_t val )

inlineexplicitconstexpr

Definition at line 301 of file key.hpp.

: value(static_cast<std::int32_t>(val)) {}

Key() [7/7]

Term::Key::Key ( char32_t val )

inlineexplicitconstexpr

Definition at line 308 of file key.hpp.

: value(static_cast<std::int32_t>(val)) {}

Member Function Documentation

append_name()

void Term::Key::append_name

(

std::string &

strOut

)

const

Definition at line 16 of file key.cpp.

{
  Term::Key key = *this;
  if(key == Term::Key::NoKey) return;
  if(key.hasAlt())
  {
    strOut += "Alt+";
    key = static_cast<Term::Key>(key.value - static_cast<std::int32_t>(Term::MetaKey::Value::Alt));
  }
  if(key.hasCtrl())
  {
    strOut += "Ctrl+";
    if(!key.iscntrl()) key = static_cast<Term::Key>(key.value - static_cast<std::int32_t>(Term::MetaKey::Value::Ctrl));
  }
  if(key == Term::Key::Tab) strOut += "Tab";
  else if(key == Term::Key::Enter)
    strOut += "Enter";
  else if(key == Term::Key::Esc)
    strOut += "Esc";
  else if(key == Term::Key::Backspace)
    strOut += "Backspace";
  else if(key == Term::Key::Del)
    strOut += "Del";
  else if(key.iscntrl())
    strOut += static_cast<char>(key.value + 64);
  else if(key == Term::Key::Space)
    strOut += "Space";
  else if(key.isunicode()) { strOut += Term::Private::utf32_to_utf8(static_cast<char32_t>(this->value)); }
  else
  {
    switch(key)
    {
      case Term::Key::ArrowLeft: strOut += "Left Arrow"; break;
      case Term::Key::ArrowRight: strOut += "Right Arrow"; break;
      case Term::Key::ArrowUp: strOut += "Up arrow"; break;
      case Term::Key::ArrowDown: strOut += "Down arrow"; break;
      case Term::Key::Numeric5: strOut += "5 Numeric pad"; break;
      case Term::Key::Home: strOut += "Home"; break;
      case Term::Key::Insert: strOut += "Insert"; break;
      case Term::Key::End: strOut += "End"; break;
      case Term::Key::PageUp: strOut += "Page up"; break;
      case Term::Key::PageDown: strOut += "Page down"; break;
      case Term::Key::F1: strOut += "F1"; break;
      case Term::Key::F2: strOut += "F2"; break;
      case Term::Key::F3: strOut += "F3"; break;
      case Term::Key::F4: strOut += "F4"; break;
      case Term::Key::F5: strOut += "F5"; break;
      case Term::Key::F6: strOut += "F6"; break;
      case Term::Key::F7: strOut += "F7"; break;
      case Term::Key::F8: strOut += "F8"; break;
      case Term::Key::F9: strOut += "F9"; break;
      case Term::Key::F10: strOut += "F10"; break;
      case Term::Key::F11: strOut += "F11"; break;
      case Term::Key::F12: strOut += "F12"; break;
      case Term::Key::F13: strOut += "F13"; break;
      case Term::Key::F14: strOut += "F14"; break;
      case Term::Key::F15: strOut += "F15"; break;
      case Term::Key::F16: strOut += "F16"; break;
      case Term::Key::F17: strOut += "F17"; break;
      case Term::Key::F18: strOut += "F18"; break;
      case Term::Key::F19: strOut += "F19"; break;
      case Term::Key::F20: strOut += "F20"; break;
      case Term::Key::F21: strOut += "F21"; break;
      case Term::Key::F22: strOut += "F22"; break;
      case Term::Key::F23: strOut += "F23"; break;
      case Term::Key::F24: strOut += "F24"; break;
      case Term::Key::PrintScreen: strOut += "Print Screen"; break;
      case Term::Key::Menu: strOut += "Menu"; break;
      default: break;
    }
  }
}

empty()

bool Term::Key::empty ( ) const

inlineconstexpr

Definition at line 412 of file key.hpp.

{ return (this->value == Key::NoKey); }

hasAlt()

bool Term::Key::hasAlt ( ) const

inlineconstexpr

Definition at line 410 of file key.hpp.

{ return (this->value & static_cast<std::int32_t>(MetaKey::Value::Alt)) == static_cast<std::int32_t>(MetaKey::Value::Alt); }

hasCtrl()

bool Term::Key::hasCtrl ( ) const

inlineconstexpr

Definition at line 403 of file key.hpp.

  {
    // Need to suppress the TAB etc...
    return ((this->iscntrl() || this->hasCtrlAll()) && *this != Key::Backspace && *this != Key::Tab && *this != Key::Esc && *this != Key::Enter && *this != Key::Del);
  }

hasCtrlAll()

bool Term::Key::hasCtrlAll ( ) const

inlineconstexpr

Definition at line 400 of file key.hpp.

{ return this->iscntrl() || ((this->value & static_cast<std::int32_t>(MetaKey::Value::Ctrl)) == static_cast<std::int32_t>(MetaKey::Value::Ctrl)); }

isalnum()

bool Term::Key::isalnum ( ) const

inlineconstexpr

Definition at line 385 of file key.hpp.

{ return (this->isdigit() || this->isalpha()); }

isalpha()

bool Term::Key::isalpha ( ) const

inlineconstexpr

Definition at line 382 of file key.hpp.

{ return (this->isupper() || this->islower()); }

isASCII()

bool Term::Key::isASCII ( ) const

inlineconstexpr

Definition at line 394 of file key.hpp.

{ return *this >= Key::Null && *this <= Key::Del; }

isblank()

bool Term::Key::isblank ( ) const

inlineconstexpr

Definition at line 378 of file key.hpp.

{ return *this == Key::Tab || *this == Key::Space; }

iscntrl()

bool Term::Key::iscntrl ( ) const

inlineconstexpr

Definition at line 377 of file key.hpp.

{ return (*this >= Key::Null && *this <= Key::Ctrl_Underscore) || *this == Key::Del; }

isdigit()

bool Term::Key::isdigit ( ) const

inlineconstexpr

Definition at line 383 of file key.hpp.

{ return *this >= Key::Zero && *this <= Key::Nine; }

isExtendedASCII()

bool Term::Key::isExtendedASCII ( ) const

inlineconstexpr

Definition at line 397 of file key.hpp.

{ return *this >= Key::Null && this->value <= 255L; }

isgraph()

bool Term::Key::isgraph ( ) const

inlineconstexpr

Definition at line 387 of file key.hpp.

{ return (this->isalnum() || this->ispunct()); }

islower()

bool Term::Key::islower ( ) const

inlineconstexpr

Definition at line 381 of file key.hpp.

{ return *this >= Key::a && *this <= Key::z; }

isprint()

bool Term::Key::isprint ( ) const

inlineconstexpr

Definition at line 388 of file key.hpp.

{ return (this->isgraph() || *this == Key::Space); }

ispunct()

bool Term::Key::ispunct ( ) const

inlineconstexpr

Definition at line 386 of file key.hpp.

{ return (*this >= Key::ExclamationMark && *this <= Key::Slash) || (*this >= Key::Colon && *this <= Key::Arobase) || (*this >= Key::OpenBracket && *this <= Key::GraveAccent) || (*this >= Key::OpenBrace && *this <= Key::Tilde); }

isspace()

bool Term::Key::isspace ( ) const

inlineconstexpr

Definition at line 379 of file key.hpp.

{ return this->isblank() || (*this >= Key::Ctrl_J && *this <= Key::Enter); }

isunicode()

bool Term::Key::isunicode ( ) const

inlineconstexpr

Definition at line 389 of file key.hpp.

{ return *this >= Key::Null && this->value <= 0x10FFFFL; }

isupper()

bool Term::Key::isupper ( ) const

inlineconstexpr

Definition at line 380 of file key.hpp.

{ return *this >= Key::A && *this <= Key::Z; }

isxdigit()

bool Term::Key::isxdigit ( ) const

inlineconstexpr

Definition at line 384 of file key.hpp.

{ return this->isdigit() || (*this >= Key::A && *this <= Key::F) || (*this >= Key::a && *this <= Key::f); }

name()

std::string Term::Key::name

(

)

const

Definition at line 89 of file key.cpp.

{
  std::string str;
  this->append_name(str);
  return str;
}

operator std::int32_t()

Term::Key::operator std::int32_t ( ) const

inlineconstexpr

Definition at line 315 of file key.hpp.

{ return this->value; }

operator=() [1/6]

Key & Term::Key::operator= ( char val )

inline

Definition at line 288 of file key.hpp.

  {
    value = static_cast<std::int32_t>(val);
    return *this;
  }

operator=() [2/6]

Key & Term::Key::operator= ( char32_t val )

inline

Definition at line 309 of file key.hpp.

  {
    value = static_cast<std::int32_t>(val);
    return *this;
  }

operator=() [3/6]

Key & Term::Key::operator= ( const Key & key )

inlinedefault

operator=() [4/6]

Key & Term::Key::operator= ( const Value & v )

inline

Definition at line 281 of file key.hpp.

  {
    this->value = static_cast<std::int32_t>(v);
    return *this;
  }

operator=() [5/6]

Key & Term::Key::operator= ( std::int32_t val )

inline

Definition at line 295 of file key.hpp.

  {
    value = val;
    return *this;
  }

operator=() [6/6]

Key & Term::Key::operator= ( std::size_t val )

inline

Definition at line 302 of file key.hpp.

  {
    value = static_cast<std::int32_t>(val);
    return *this;
  }

str()

std::string Term::Key::str

(

)

const

Definition at line 96 of file key.cpp.

{ return Term::Private::utf32_to_utf8(static_cast<char32_t>(this->value)); }

tolower()

Key Term::Key::tolower ( ) const

inlineconstexpr

Definition at line 390 of file key.hpp.

{ return (this->isalpha() && this->isupper()) ? Key(this->value + 32) : *this; }

toupper()

Key Term::Key::toupper ( ) const

inlineconstexpr

Definition at line 391 of file key.hpp.

{ return (this->isalpha() && this->islower()) ? Key(this->value - 32) : *this; }

Friends And Related Symbol Documentation

operator!= [1/9]

bool operator!= ( char l, Key r )

friend

Definition at line 329 of file key.hpp.

{ return !(l == r); }

operator!= [2/9]

bool operator!= ( char32_t l, Key r )

friend

Definition at line 331 of file key.hpp.

{ return !(l == r); }

operator!= [3/9]

bool operator!= ( Key l, char r )

friend

Definition at line 328 of file key.hpp.

{ return !(l == r); }

operator!= [4/9]

bool operator!= ( Key l, char32_t r )

friend

Definition at line 330 of file key.hpp.

{ return !(l == r); }

operator!= [5/9]

bool operator!= ( Key l, Key r )

friend

Definition at line 327 of file key.hpp.

{ return !(l == r); }

operator!= [6/9]

bool operator!= ( Key l, std::int32_t r )

friend

Definition at line 332 of file key.hpp.

{ return !(l == r); }

operator!= [7/9]

bool operator!= ( Key l, std::size_t r )

friend

Definition at line 334 of file key.hpp.

{ return !(l == r); }

operator!= [8/9]

bool operator!= ( std::int32_t l, Key r )

friend

Definition at line 333 of file key.hpp.

{ return !(l == r); }

operator!= [9/9]

bool operator!= ( std::size_t l, Key r )

friend

Definition at line 335 of file key.hpp.

{ return !(l == r); }

operator< [1/9]

bool operator< ( char l, Key r )

friend

Definition at line 339 of file key.hpp.

{ return Key(l) < r; }

operator< [2/9]

bool operator< ( char32_t l, Key r )

friend

Definition at line 341 of file key.hpp.

{ return Key(l) < r; }

operator< [3/9]

bool operator< ( Key l, char r )

friend

Definition at line 338 of file key.hpp.

{ return l < Key(r); }

operator< [4/9]

bool operator< ( Key l, char32_t r )

friend

Definition at line 340 of file key.hpp.

{ return l < Key(r); }

operator< [5/9]

bool operator< ( Key l, Key r )

friend

Definition at line 337 of file key.hpp.

{ return l.value < r.value; }

operator< [6/9]

bool operator< ( Key l, std::int32_t r )

friend

Definition at line 342 of file key.hpp.

{ return l < Key(r); }

operator< [7/9]

bool operator< ( Key l, std::size_t r )

friend

Definition at line 344 of file key.hpp.

{ return static_cast<std::size_t>(l.value) < r; }

operator< [8/9]

bool operator< ( std::int32_t l, Key r )

friend

Definition at line 343 of file key.hpp.

{ return Key(l) < r; }

operator< [9/9]

bool operator< ( std::size_t l, Key r )

friend

Definition at line 345 of file key.hpp.

{ return l < static_cast<std::size_t>(r.value); }

operator<= [1/9]

bool operator<= ( char l, Key r )

friend

Definition at line 369 of file key.hpp.

{ return !(l > r); }

operator<= [2/9]

bool operator<= ( char32_t l, Key r )

friend

Definition at line 371 of file key.hpp.

{ return !(l > r); }

operator<= [3/9]

bool operator<= ( Key l, char r )

friend

Definition at line 368 of file key.hpp.

{ return !(l > r); }

operator<= [4/9]

bool operator<= ( Key l, char32_t r )

friend

Definition at line 370 of file key.hpp.

{ return !(l > r); }

operator<= [5/9]

bool operator<= ( Key l, Key r )

friend

Definition at line 367 of file key.hpp.

{ return !(l > r); }

operator<= [6/9]

bool operator<= ( Key l, std::int32_t r )

friend

Definition at line 372 of file key.hpp.

{ return !(l > r); }

operator<= [7/9]

bool operator<= ( Key l, std::size_t r )

friend

Definition at line 374 of file key.hpp.

{ return !(l > r); }

operator<= [8/9]

bool operator<= ( std::int32_t l, Key r )

friend

Definition at line 373 of file key.hpp.

{ return !(l > r); }

operator<= [9/9]

bool operator<= ( std::size_t l, Key r )

friend

Definition at line 375 of file key.hpp.

{ return !(l > r); }

operator== [1/9]

bool operator== ( char l, Key r )

friend

Definition at line 319 of file key.hpp.

{ return Key(l) == r; }

operator== [2/9]

bool operator== ( char32_t l, Key r )

friend

Definition at line 321 of file key.hpp.

{ return Key(l) == r; }

operator== [3/9]

bool operator== ( Key l, char r )

friend

Definition at line 318 of file key.hpp.

{ return l == Key(r); }

operator== [4/9]

bool operator== ( Key l, char32_t r )

friend

Definition at line 320 of file key.hpp.

{ return l == Key(r); }

operator== [5/9]

bool operator== ( Key l, Key r )

friend

Definition at line 317 of file key.hpp.

{ return l.value == r.value; }

operator== [6/9]

bool operator== ( Key l, std::int32_t r )

friend

Definition at line 322 of file key.hpp.

{ return l == Key(r); }

operator== [7/9]

bool operator== ( Key l, std::size_t r )

friend

Definition at line 324 of file key.hpp.

{ return static_cast<std::size_t>(l.value) == r; }

operator== [8/9]

bool operator== ( std::int32_t l, Key r )

friend

Definition at line 323 of file key.hpp.

{ return Key(l) == r; }

operator== [9/9]

bool operator== ( std::size_t l, Key r )

friend

Definition at line 325 of file key.hpp.

{ return l == static_cast<std::size_t>(r.value); }

operator> [1/9]

bool operator> ( char l, Key r )

friend

Definition at line 359 of file key.hpp.

{ return r < l; }

operator> [2/9]

bool operator> ( char32_t l, Key r )

friend

Definition at line 361 of file key.hpp.

{ return r < l; }

operator> [3/9]

bool operator> ( Key l, char r )

friend

Definition at line 358 of file key.hpp.

{ return r < l; }

operator> [4/9]

bool operator> ( Key l, char32_t r )

friend

Definition at line 360 of file key.hpp.

{ return r < l; }

operator> [5/9]

bool operator> ( Key l, Key r )

friend

Definition at line 357 of file key.hpp.

{ return r < l; }

operator> [6/9]

bool operator> ( Key l, std::int32_t r )

friend

Definition at line 362 of file key.hpp.

{ return r < l; }

operator> [7/9]

bool operator> ( Key l, std::size_t r )

friend

Definition at line 364 of file key.hpp.

{ return r < l; }

operator> [8/9]

bool operator> ( std::int32_t l, Key r )

friend

Definition at line 363 of file key.hpp.

{ return r < l; }

operator> [9/9]

bool operator> ( std::size_t l, Key r )

friend

Definition at line 365 of file key.hpp.

{ return r < l; }

operator>= [1/9]

bool operator>= ( char l, Key r )

friend

Definition at line 349 of file key.hpp.

{ return !(l < r); }

operator>= [2/9]

bool operator>= ( char32_t l, Key r )

friend

Definition at line 351 of file key.hpp.

{ return !(l < r); }

operator>= [3/9]

bool operator>= ( Key l, char r )

friend

Definition at line 348 of file key.hpp.

{ return !(l < r); }

operator>= [4/9]

bool operator>= ( Key l, char32_t r )

friend

Definition at line 350 of file key.hpp.

{ return !(l < r); }

operator>= [5/9]

bool operator>= ( Key l, Key r )

friend

Definition at line 347 of file key.hpp.

{ return !(l < r); }

operator>= [6/9]

bool operator>= ( Key l, std::int32_t r )

friend

Definition at line 352 of file key.hpp.

{ return !(l < r); }

operator>= [7/9]

bool operator>= ( Key l, std::size_t r )

friend

Definition at line 354 of file key.hpp.

{ return !(l < r); }

operator>= [8/9]

bool operator>= ( std::int32_t l, Key r )

friend

Definition at line 353 of file key.hpp.

{ return !(l < r); }

operator>= [9/9]

bool operator>= ( std::size_t l, Key r )

friend

Definition at line 355 of file key.hpp.

{ return !(l < r); }

Member Data Documentation

value

std::int32_t Term::Key::value

Definition at line 421 of file key.hpp.

---

The documentation for this class was generated from the following files:

• cpp-terminal/key.hpp
• cpp-terminal/key.cpp