jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/Traits.h>
30#include <Kernel/KeyCode.h>
31
32namespace GUI {
33
34class Shortcut {
35public:
36 Shortcut() {}
37 Shortcut(u8 modifiers, KeyCode key)
38 : m_modifiers(modifiers)
39 , m_key(key)
40 {
41 }
42
43 bool is_valid() const { return m_key != KeyCode::Key_Invalid; }
44 u8 modifiers() const { return m_modifiers; }
45 KeyCode key() const { return m_key; }
46 String to_string() const;
47
48 bool operator==(const Shortcut& other) const
49 {
50 return m_modifiers == other.m_modifiers
51 && m_key == other.m_key;
52 }
53
54private:
55 u8 m_modifiers { 0 };
56 KeyCode m_key { KeyCode::Key_Invalid };
57};
58
59}
60
61namespace AK {
62
63template<>
64struct Traits<GUI::Shortcut> : public GenericTraits<GUI::Shortcut> {
65 static unsigned hash(const GUI::Shortcut& shortcut)
66 {
67 return pair_int_hash(shortcut.modifiers(), shortcut.key());
68 }
69};
70
71}