HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
keyboard_key.hpp
1// Copyright Take Vos 2020-2022.
2// Distributed under the Boost Software License, Version 1.0.
3// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
4
5#pragma once
6
7#include "keyboard_modifiers.hpp"
8#include "keyboard_virtual_key.hpp"
9#include "../utility/module.hpp"
10#include "../strings.hpp"
11#include <string_view>
12#include <unordered_map>
13
14namespace hi::inline v1 {
15
22 keyboard_modifiers modifiers;
23
31 keyboard_virtual_key virtual_key;
32
33public:
34 constexpr keyboard_key() noexcept : modifiers(keyboard_modifiers::none), virtual_key(keyboard_virtual_key::nul) {}
35
36 constexpr keyboard_key(keyboard_modifiers modifiers, keyboard_virtual_key key) noexcept :
37 modifiers(modifiers), virtual_key(key)
38 {
39 }
40
41 keyboard_key(std::string_view key_combination) : modifiers(keyboard_modifiers::none), virtual_key(keyboard_virtual_key::nul)
42 {
43 hilet modifiers_and_vkey = split(key_combination, '+');
44 hi_assert(modifiers_and_vkey.cbegin() != modifiers_and_vkey.cend());
45
46 hilet end_modifiers = modifiers_and_vkey.cend() - 1;
47 for (auto i = modifiers_and_vkey.cbegin(); i != end_modifiers; ++i) {
48 modifiers |= to_keyboard_modifiers(*i);
49 }
50
51 virtual_key = to_keyboard_virtual_key(modifiers_and_vkey.back());
52 }
53
54 std::size_t hash() const noexcept
55 {
56 return hash_mix(modifiers, virtual_key);
57 }
58
59 [[nodiscard]] friend bool operator==(keyboard_key const &lhs, keyboard_key const &rhs) noexcept
60 {
61 return lhs.modifiers == rhs.modifiers && lhs.virtual_key == rhs.virtual_key;
62 }
63
64 [[nodiscard]] friend std::string to_string(keyboard_key const &rhs) noexcept
65 {
66 return std::format("{}{}", rhs.modifiers, rhs.virtual_key);
67 }
68
69 friend std::ostream &operator<<(std::ostream &lhs, keyboard_key const &rhs)
70 {
71 return lhs << to_string(rhs);
72 }
73};
74
75} // namespace hi::inline v1
76
77template<>
78struct std::hash<hi::keyboard_key> {
79 [[nodiscard]] std::size_t operator()(hi::keyboard_key const &rhs) const noexcept
80 {
81 return rhs.hash();
82 }
83};
#define hi_assert(expression,...)
Assert if expression is true.
Definition assert.hpp:184
#define hilet
Invariant should be the default for variables.
Definition utility.hpp:23
DOXYGEN BUG.
Definition algorithm.hpp:13
keyboard_modifiers
Key modification keys pressed at the same time as another key.
Definition keyboard_modifiers.hpp:18
keyboard_modifiers to_keyboard_modifiers(std::string_view s)
Parse a key-binding modifier name.
Definition keyboard_modifiers.hpp:51
geometry/margins.hpp
Definition cache.hpp:11
A key in combination with modifiers.
Definition keyboard_key.hpp:19
T operator()(T... args)