ladybird/Userland/Libraries/LibGUI/Shortcut.h
Ali Mohammad Pur 5e1499d104 Everywhere: Rename {Deprecated => Byte}String
This commit un-deprecates DeprecatedString, and repurposes it as a byte
string.
As the null state has already been removed, there are no other
particularly hairy blockers in repurposing this type as a byte string
(what it _really_ is).

This commit is auto-generated:
  $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \
    Meta Ports Ladybird Tests Kernel)
  $ perl -pie 's/\bDeprecatedString\b/ByteString/g;
    s/deprecated_string/byte_string/g' $xs
  $ clang-format --style=file -i \
    $(git diff --name-only | grep \.cpp\|\.h)
  $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-17 18:25:10 +03:30

96 lines
2.3 KiB
C++

/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
* Copyright (c) 2022, Geordie Hall <me@geordiehall.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Traits.h>
#include <Kernel/API/KeyCode.h>
#include <LibGUI/Event.h>
namespace GUI {
class Shortcut {
public:
Shortcut() = default;
Shortcut(u8 modifiers, KeyCode key)
: m_type(Type::Keyboard)
, m_modifiers(modifiers)
, m_keyboard_key(key)
{
}
Shortcut(KeyCode key)
: m_type(Type::Keyboard)
, m_modifiers(0)
, m_keyboard_key(key)
{
}
Shortcut(u8 modifiers, MouseButton button)
: m_type(Type::Mouse)
, m_modifiers(modifiers)
, m_mouse_button(button)
{
}
Shortcut(MouseButton button)
: m_type(Type::Mouse)
, m_modifiers(0)
, m_mouse_button(button)
{
}
enum class Type : u8 {
Keyboard,
Mouse,
};
ByteString to_byte_string() const;
Type type() const { return m_type; }
bool is_valid() const { return m_type == Type::Keyboard ? (m_keyboard_key != Key_Invalid) : (m_mouse_button != MouseButton::None); }
u8 modifiers() const { return m_modifiers; }
KeyCode key() const
{
VERIFY(m_type == Type::Keyboard);
return m_keyboard_key;
}
MouseButton mouse_button() const
{
VERIFY(m_type == Type::Mouse);
return m_mouse_button;
}
bool operator==(Shortcut const& other) const
{
return m_modifiers == other.m_modifiers && m_type == other.m_type && m_keyboard_key == other.m_keyboard_key && m_mouse_button == other.m_mouse_button;
}
private:
Type m_type { Type::Keyboard };
u8 m_modifiers { 0 };
KeyCode m_keyboard_key { KeyCode::Key_Invalid };
MouseButton m_mouse_button { MouseButton::None };
};
}
namespace AK {
template<>
struct Traits<GUI::Shortcut> : public DefaultTraits<GUI::Shortcut> {
static unsigned hash(const GUI::Shortcut& shortcut)
{
auto base_hash = pair_int_hash(shortcut.modifiers(), (u32)shortcut.type());
if (shortcut.type() == GUI::Shortcut::Type::Keyboard) {
return pair_int_hash(base_hash, shortcut.key());
} else {
return pair_int_hash(base_hash, shortcut.mouse_button());
}
}
};
}