Term::MetaKey Class Reference

#include <cpp-terminal/key.hpp>

Public Types
enum class	Value : std::int32_t { None = 0 , Alt = (1UL << 22UL) , Ctrl = (1UL << 23UL) }

Public Member Functions
constexpr	MetaKey ()
constexpr	MetaKey (const MetaKey &key)=default
MetaKey &	operator= (const MetaKey &key)=default
constexpr	MetaKey (const Value &v)
MetaKey &	operator= (const Value &v)
constexpr	MetaKey (std::int32_t val)
MetaKey &	operator= (std::int32_t val)
constexpr	operator std::int32_t () const
constexpr bool	hasAlt () const
constexpr bool	hasCtrl () const
MetaKey &	operator+= (MetaKey r)
MetaKey &	operator+= (MetaKey::Value r)

Public Attributes
std::int32_t	value

Friends
constexpr MetaKey	operator+ (MetaKey l, MetaKey r)
constexpr MetaKey	operator+ (MetaKey::Value l, MetaKey::Value r)
constexpr MetaKey	operator+ (MetaKey l, MetaKey::Value r)
constexpr MetaKey	operator+ (MetaKey::Value l, MetaKey r)
constexpr bool	operator== (MetaKey l, MetaKey r)
constexpr bool	operator== (MetaKey l, MetaKey::Value r)
constexpr bool	operator== (MetaKey::Value l, MetaKey r)
constexpr bool	operator!= (MetaKey l, MetaKey r)
constexpr bool	operator!= (MetaKey l, MetaKey::Value r)
constexpr bool	operator!= (MetaKey::Value l, MetaKey r)
constexpr bool	operator< (MetaKey l, MetaKey r)
constexpr bool	operator>= (MetaKey l, MetaKey r)
constexpr bool	operator>= (MetaKey l, MetaKey::Value r)
constexpr bool	operator>= (MetaKey::Value l, MetaKey r)
constexpr bool	operator> (MetaKey l, MetaKey r)
constexpr bool	operator> (MetaKey l, MetaKey::Value r)
constexpr bool	operator> (MetaKey::Value l, MetaKey r)
constexpr bool	operator<= (MetaKey l, MetaKey r)
constexpr bool	operator<= (MetaKey l, MetaKey::Value r)
constexpr bool	operator<= (MetaKey::Value l, MetaKey r)

Detailed Description

Definition at line 18 of file key.hpp.

Member Enumeration Documentation

Value

enum class Term::MetaKey::Value : std::int32_t

strong

Enumerator
None
Alt
Ctrl

Definition at line 21 of file key.hpp.

  {
    // Last utf8 codepoint is U+10FFFF (000100001111111111111111) So:
    None = 0,
    Alt  = (1UL << 22UL),
    Ctrl = (1UL << 23UL),
  };

Constructor & Destructor Documentation

MetaKey() [1/4]

Term::MetaKey::MetaKey ( )

inlineconstexpr

Definition at line 29 of file key.hpp.

: value(static_cast<std::int32_t>(Value::None)) {}

MetaKey() [2/4]

Term::MetaKey::MetaKey ( const MetaKey & key )

constexprdefault

MetaKey() [3/4]

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

inlineconstexpr

Definition at line 33 of file key.hpp.

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

MetaKey() [4/4]

Term::MetaKey::MetaKey ( std::int32_t val )

inlineexplicitconstexpr

Definition at line 40 of file key.hpp.

: value(val) {}

Member Function Documentation

hasAlt()

bool Term::MetaKey::hasAlt ( ) const

inlineconstexpr

Definition at line 49 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::MetaKey::hasCtrl ( ) const

inlineconstexpr

Definition at line 50 of file key.hpp.

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

operator std::int32_t()

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

inlineexplicitconstexpr

Definition at line 47 of file key.hpp.

{ return this->value; }

operator+=() [1/2]

MetaKey & Term::MetaKey::operator+= ( MetaKey r )

inline

Definition at line 57 of file key.hpp.

{ return *this = *this + r; }

operator+=() [2/2]

MetaKey & Term::MetaKey::operator+= ( MetaKey::Value r )

inline

Definition at line 58 of file key.hpp.

{ return *this = *this + r; }

operator=() [1/3]

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

inlinedefault

operator=() [2/3]

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

inline

Definition at line 34 of file key.hpp.

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

operator=() [3/3]

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

inline

Definition at line 41 of file key.hpp.

  {
    this->value = val;
    return *this;
  }

Friends And Related Symbol Documentation

operator!= [1/3]

bool operator!= ( MetaKey l, MetaKey r )

friend

Definition at line 64 of file key.hpp.

{ return !(l == r); }

operator!= [2/3]

bool operator!= ( MetaKey l, MetaKey::Value r )

friend

Definition at line 65 of file key.hpp.

{ return !(l == r); }

operator!= [3/3]

bool operator!= ( MetaKey::Value l, MetaKey r )

friend

Definition at line 66 of file key.hpp.

{ return !(l == r); }

operator+ [1/4]

MetaKey operator+ ( MetaKey l, MetaKey r )

friend

Definition at line 52 of file key.hpp.

{ return MetaKey(l.value | r.value); }

operator+ [2/4]

MetaKey operator+ ( MetaKey l, MetaKey::Value r )

friend

Definition at line 54 of file key.hpp.

{ return l + MetaKey(r); }

operator+ [3/4]

MetaKey operator+ ( MetaKey::Value l, MetaKey r )

friend

Definition at line 55 of file key.hpp.

{ return MetaKey(l) + r; }

operator+ [4/4]

MetaKey operator+ ( MetaKey::Value l, MetaKey::Value r )

friend

Definition at line 53 of file key.hpp.

{ return MetaKey(l) + MetaKey(r); }

operator<

bool operator< ( MetaKey l, MetaKey r )

friend

Definition at line 68 of file key.hpp.

{ return l.value < r.value; }

operator<= [1/3]

bool operator<= ( MetaKey l, MetaKey r )

friend

Definition at line 78 of file key.hpp.

{ return !(l > r); }

operator<= [2/3]

bool operator<= ( MetaKey l, MetaKey::Value r )

friend

Definition at line 79 of file key.hpp.

{ return !(l > r); }

operator<= [3/3]

bool operator<= ( MetaKey::Value l, MetaKey r )

friend

Definition at line 80 of file key.hpp.

{ return !(l > r); }

operator== [1/3]

bool operator== ( MetaKey l, MetaKey r )

friend

Definition at line 60 of file key.hpp.

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

operator== [2/3]

bool operator== ( MetaKey l, MetaKey::Value r )

friend

Definition at line 61 of file key.hpp.

{ return l == MetaKey(r); }

operator== [3/3]

bool operator== ( MetaKey::Value l, MetaKey r )

friend

Definition at line 62 of file key.hpp.

{ return MetaKey(l) == r; }

operator> [1/3]

bool operator> ( MetaKey l, MetaKey r )

friend

Definition at line 74 of file key.hpp.

{ return r < l; }

operator> [2/3]

bool operator> ( MetaKey l, MetaKey::Value r )

friend

Definition at line 75 of file key.hpp.

{ return r < l; }

operator> [3/3]

bool operator> ( MetaKey::Value l, MetaKey r )

friend

Definition at line 76 of file key.hpp.

{ return r < l; }

operator>= [1/3]

bool operator>= ( MetaKey l, MetaKey r )

friend

Definition at line 70 of file key.hpp.

{ return !(l < r); }

operator>= [2/3]

bool operator>= ( MetaKey l, MetaKey::Value r )

friend

Definition at line 71 of file key.hpp.

{ return !(l < r); }

operator>= [3/3]

bool operator>= ( MetaKey::Value l, MetaKey r )

friend

Definition at line 72 of file key.hpp.

{ return !(l < r); }

Member Data Documentation

value

std::int32_t Term::MetaKey::value

Definition at line 82 of file key.hpp.

---

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

• cpp-terminal/key.hpp