From 554c344ffeebc29c4d899b0a60813753a8c80093 Mon Sep 17 00:00:00 2001 From: Andreas Kling Date: Mon, 27 Sep 2021 23:22:21 +0200 Subject: LibWeb: Add a basic KeyboardEvent and fire "keydown" events :^) --- Userland/Libraries/LibWeb/UIEvents/EventNames.h | 1 + .../Libraries/LibWeb/UIEvents/KeyboardEvent.cpp | 110 +++++++++++++++++++++ Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.h | 62 ++++++++++++ .../Libraries/LibWeb/UIEvents/KeyboardEvent.idl | 30 ++++++ Userland/Libraries/LibWeb/UIEvents/MouseEvent.h | 2 +- 5 files changed, 204 insertions(+), 1 deletion(-) create mode 100644 Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.cpp create mode 100644 Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.h create mode 100644 Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.idl (limited to 'Userland/Libraries/LibWeb/UIEvents') diff --git a/Userland/Libraries/LibWeb/UIEvents/EventNames.h b/Userland/Libraries/LibWeb/UIEvents/EventNames.h index 31d689015b..66a3bba882 100644 --- a/Userland/Libraries/LibWeb/UIEvents/EventNames.h +++ b/Userland/Libraries/LibWeb/UIEvents/EventNames.h @@ -15,6 +15,7 @@ namespace Web::UIEvents::EventNames { #define ENUMERATE_UI_EVENTS \ __ENUMERATE_UI_EVENT(click) \ + __ENUMERATE_UI_EVENT(keydown) \ __ENUMERATE_UI_EVENT(mousedown) \ __ENUMERATE_UI_EVENT(mouseenter) \ __ENUMERATE_UI_EVENT(mouseleave) \ diff --git a/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.cpp b/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.cpp new file mode 100644 index 0000000000..0e00d17362 --- /dev/null +++ b/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.cpp @@ -0,0 +1,110 @@ +/* + * Copyright (c) 2021, Andreas Kling + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +#include +#include + +namespace Web::UIEvents { + +// https://www.w3.org/TR/uievents/#determine-keydown-keyup-keyCode +static unsigned long determine_key_code(KeyCode platform_key, u32 code_point) +{ + // If input key when pressed without modifiers would insert a numerical character (0-9), return the ASCII code of that numerical character. + if (is_ascii_digit(code_point)) + return code_point; + + // If input key when pressed without modifiers would insert a lower case character in the a-z alphabetical range, return the ASCII code of the upper case equivalent. + if (is_ascii_lower_alpha(code_point)) + return to_ascii_uppercase(code_point); + + // If the key’s function, as determined in an implementation-specific way, corresponds to one of the keys in the §8.3.3 Fixed virtual key codes table, return the corresponding key code. + // https://www.w3.org/TR/uievents/#fixed-virtual-key-codes + switch (platform_key) { + case KeyCode::Key_Backspace: + return 8; + case KeyCode::Key_Tab: + return 9; + case KeyCode::Key_Return: + return 13; + case KeyCode::Key_Shift: + return 16; + case KeyCode::Key_Control: + return 17; + case KeyCode::Key_Alt: + return 18; + case KeyCode::Key_CapsLock: + return 20; + case KeyCode::Key_Escape: + return 27; + case KeyCode::Key_Space: + return 32; + case KeyCode::Key_PageUp: + return 33; + case KeyCode::Key_PageDown: + return 34; + case KeyCode::Key_End: + return 35; + case KeyCode::Key_Home: + return 36; + case KeyCode::Key_Left: + return 37; + case KeyCode::Key_Up: + return 38; + case KeyCode::Key_Right: + return 39; + case KeyCode::Key_Down: + return 40; + default: + break; + } + + // Return the virtual key code from the operating system. + return platform_key; +} + +NonnullRefPtr KeyboardEvent::create_from_platform_event(FlyString event_name, KeyCode platform_key, unsigned modifiers, u32 code_point) +{ + // FIXME: Figure out what these should actually contain. + String event_key = key_code_to_string(platform_key); + String event_code = "FIXME"; + + auto key_code = determine_key_code(platform_key, code_point); + return KeyboardEvent::create(move(event_name), move(event_key), move(event_code), 0, modifiers & Mod_Ctrl, modifiers & Mod_Shift, modifiers & Mod_Alt, false, false, false, key_code, code_point); +} + +KeyboardEvent::KeyboardEvent(FlyString event_name, String key, String code, unsigned long location, bool ctrl_key, bool shift_key, bool alt_key, bool meta_key, bool repeat, bool is_composing, unsigned long key_code, unsigned long char_code) + : UIEvent(move(event_name)) + , m_key(move(key)) + , m_code(move(code)) + , m_location(location) + , m_ctrl_key(ctrl_key) + , m_shift_key(shift_key) + , m_alt_key(alt_key) + , m_meta_key(meta_key) + , m_repeat(repeat) + , m_is_composing(is_composing) + , m_key_code(key_code) + , m_char_code(char_code) +{ +} + +KeyboardEvent::~KeyboardEvent() +{ +} + +bool KeyboardEvent::get_modifier_state(String const& key_arg) +{ + if (key_arg == "Alt") + return m_alt_key; + if (key_arg == "Control") + return m_ctrl_key; + if (key_arg == "Shift") + return m_shift_key; + if (key_arg == "Meta") + return m_meta_key; + return false; +} +} diff --git a/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.h b/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.h new file mode 100644 index 0000000000..14411972ba --- /dev/null +++ b/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.h @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2021, Andreas Kling + * + * SPDX-License-Identifier: BSD-2-Clause + */ + +#pragma once + +#include +#include +#include + +namespace Web::UIEvents { + +// https://www.w3.org/TR/uievents/#interface-keyboardevent +class KeyboardEvent final : public UIEvent { +public: + using WrapperType = Bindings::KeyboardEventWrapper; + + static NonnullRefPtr create(FlyString event_name, String key, String code, unsigned long location, bool ctrl_key, bool shift_key, bool alt_key, bool meta_key, bool repeat, bool is_composing, unsigned long key_code, unsigned long char_code) + { + return adopt_ref(*new KeyboardEvent(move(event_name), move(key), move(code), location, ctrl_key, shift_key, alt_key, meta_key, repeat, is_composing, key_code, char_code)); + } + + static NonnullRefPtr create_from_platform_event(FlyString event_name, KeyCode, unsigned modifiers, u32 code_point); + + virtual ~KeyboardEvent() override; + + unsigned long key_code() const { return m_key_code; } + unsigned long char_code() const { return m_char_code; } + + String key() const { return m_key; } + String code() const { return m_code; } + unsigned long location() const { return m_location; } + + bool ctrl_key() const { return m_ctrl_key; } + bool shift_key() const { return m_shift_key; } + bool alt_key() const { return m_alt_key; } + bool meta_key() const { return m_meta_key; } + + bool repeat() const { return m_repeat; } + bool is_composing() const { return m_is_composing; } + + bool get_modifier_state(String const& key_arg); + +private: + KeyboardEvent(FlyString event_name, String key, String code, unsigned long location, bool ctrl_key, bool shift_key, bool alt_key, bool meta_key, bool repeat, bool is_composing, unsigned long key_code, unsigned long char_code); + + String m_key; + String m_code; + unsigned long m_location { 0 }; + bool m_ctrl_key { false }; + bool m_shift_key { false }; + bool m_alt_key { false }; + bool m_meta_key { false }; + bool m_repeat { false }; + bool m_is_composing { false }; + unsigned long m_key_code { 0 }; + unsigned long m_char_code { 0 }; +}; + +} diff --git a/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.idl b/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.idl new file mode 100644 index 0000000000..94feed15e1 --- /dev/null +++ b/Userland/Libraries/LibWeb/UIEvents/KeyboardEvent.idl @@ -0,0 +1,30 @@ +[Exposed=Window] +interface KeyboardEvent : UIEvent { + + // FIXME: Implement this. + // constructor(DOMString type, optional KeyboardEventInit eventInitDict = {}); + + // KeyLocationCode + const unsigned long DOM_KEY_LOCATION_STANDARD = 0x00; + const unsigned long DOM_KEY_LOCATION_LEFT = 0x01; + const unsigned long DOM_KEY_LOCATION_RIGHT = 0x02; + const unsigned long DOM_KEY_LOCATION_NUMPAD = 0x03; + + readonly attribute DOMString key; + readonly attribute DOMString code; + readonly attribute unsigned long location; + + readonly attribute boolean ctrlKey; + readonly attribute boolean shiftKey; + readonly attribute boolean altKey; + readonly attribute boolean metaKey; + + readonly attribute boolean repeat; + readonly attribute boolean isComposing; + + readonly attribute unsigned long charCode; + readonly attribute unsigned long keyCode; + + boolean getModifierState(DOMString keyArg); + +}; diff --git a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h index 8f56dac9e5..b214e3d199 100644 --- a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h +++ b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h @@ -11,7 +11,7 @@ namespace Web::UIEvents { -class MouseEvent final : public UIEvents::UIEvent { +class MouseEvent final : public UIEvent { public: using WrapperType = Bindings::MouseEventWrapper; -- cgit v1.2.3