From e584189b8f7c9f1c2658fb539163e8559d7fd037 Mon Sep 17 00:00:00 2001 From: Bastiaan van der Plaat Date: Fri, 8 Sep 2023 17:50:53 +0200 Subject: [PATCH] LibWeb: Reorder MouseEvent items to follow spec more --- .../Libraries/LibWeb/Page/EventHandler.cpp | 16 ++++---- .../Libraries/LibWeb/UIEvents/MouseEvent.cpp | 30 +++++++------- .../Libraries/LibWeb/UIEvents/MouseEvent.h | 40 +++++++++---------- .../Libraries/LibWeb/UIEvents/MouseEvent.idl | 34 +++++++++++----- .../Libraries/LibWeb/UIEvents/WheelEvent.cpp | 18 ++++----- .../Libraries/LibWeb/UIEvents/WheelEvent.h | 6 +-- 6 files changed, 76 insertions(+), 68 deletions(-) diff --git a/Userland/Libraries/LibWeb/Page/EventHandler.cpp b/Userland/Libraries/LibWeb/Page/EventHandler.cpp index f429dd8fc9..95ff7aa80a 100644 --- a/Userland/Libraries/LibWeb/Page/EventHandler.cpp +++ b/Userland/Libraries/LibWeb/Page/EventHandler.cpp @@ -187,7 +187,9 @@ bool EventHandler::handle_mousewheel(CSSPixelPoint position, unsigned button, un return false; auto offset = compute_mouse_event_offset(position, *layout_node); - if (node->dispatch_event(UIEvents::WheelEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::wheel, offset.x(), offset.y(), position.x(), position.y(), wheel_delta_x, wheel_delta_y, buttons, button).release_value_but_fixme_should_propagate_errors())) { + auto client_offset = compute_mouse_event_client_offset(position); + auto page_offset = compute_mouse_event_page_offset(client_offset); + if (node->dispatch_event(UIEvents::WheelEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::wheel, page_offset, client_offset, offset, wheel_delta_x, wheel_delta_y, button, buttons).release_value_but_fixme_should_propagate_errors())) { if (auto* page = m_browsing_context->page()) { if (m_browsing_context == &page->top_level_browsing_context()) page->client().page_did_request_scroll(wheel_delta_x, wheel_delta_y); @@ -248,15 +250,15 @@ bool EventHandler::handle_mouseup(CSSPixelPoint position, unsigned button, unsig auto offset = compute_mouse_event_offset(position, *layout_node); auto client_offset = compute_mouse_event_client_offset(position); auto page_offset = compute_mouse_event_page_offset(client_offset); - node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::mouseup, offset, client_offset, page_offset, {}, buttons, button).release_value_but_fixme_should_propagate_errors()); + node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::mouseup, page_offset, client_offset, offset, {}, button, buttons).release_value_but_fixme_should_propagate_errors()); handled_event = true; bool run_activation_behavior = false; if (node.ptr() == m_mousedown_target) { if (button == GUI::MouseButton::Primary) - run_activation_behavior = node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::click, offset, client_offset, page_offset, {}, button).release_value_but_fixme_should_propagate_errors()); + run_activation_behavior = node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::click, page_offset, client_offset, offset, {}, 1, button).release_value_but_fixme_should_propagate_errors()); else if (button == GUI::MouseButton::Secondary && !(modifiers & Mod_Shift)) // Allow the user to bypass custom context menus by holding shift, like Firefox. - run_activation_behavior = node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::contextmenu, offset, client_offset, page_offset, {}, button).release_value_but_fixme_should_propagate_errors()); + run_activation_behavior = node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::contextmenu, page_offset, client_offset, offset, {}, 1, button).release_value_but_fixme_should_propagate_errors()); } if (run_activation_behavior) { @@ -384,7 +386,7 @@ bool EventHandler::handle_mousedown(CSSPixelPoint position, unsigned button, uns auto offset = compute_mouse_event_offset(position, *layout_node); auto client_offset = compute_mouse_event_client_offset(position); auto page_offset = compute_mouse_event_page_offset(client_offset); - node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::mousedown, offset, client_offset, page_offset, {}, buttons, button).release_value_but_fixme_should_propagate_errors()); + node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::mousedown, page_offset, client_offset, offset, {}, button, buttons).release_value_but_fixme_should_propagate_errors()); } // NOTE: Dispatching an event may have disturbed the world. @@ -498,7 +500,7 @@ bool EventHandler::handle_mousemove(CSSPixelPoint position, unsigned buttons, un auto client_offset = compute_mouse_event_client_offset(position); auto page_offset = compute_mouse_event_page_offset(client_offset); auto movement = compute_mouse_event_movement(client_offset); - node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::mousemove, offset, client_offset, page_offset, movement, buttons).release_value_but_fixme_should_propagate_errors()); + node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::mousemove, page_offset, client_offset, offset, movement, 1, buttons).release_value_but_fixme_should_propagate_errors()); m_mousemove_previous_client_offset = client_offset; // NOTE: Dispatching an event may have disturbed the world. if (!paint_root() || paint_root() != node->document().paintable_box()) @@ -584,7 +586,7 @@ bool EventHandler::handle_doubleclick(CSSPixelPoint position, unsigned button, u auto offset = compute_mouse_event_offset(position, *layout_node); auto client_offset = compute_mouse_event_client_offset(position); auto page_offset = compute_mouse_event_page_offset(client_offset); - node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::dblclick, offset, client_offset, page_offset, {}, buttons, button).release_value_but_fixme_should_propagate_errors()); + node->dispatch_event(UIEvents::MouseEvent::create_from_platform_event(node->realm(), UIEvents::EventNames::dblclick, page_offset, client_offset, offset, {}, button, buttons).release_value_but_fixme_should_propagate_errors()); // NOTE: Dispatching an event may have disturbed the world. if (!paint_root() || paint_root() != node->document().paintable_box()) diff --git a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.cpp b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.cpp index ee3e898de3..bc307dd744 100644 --- a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.cpp +++ b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.cpp @@ -13,14 +13,16 @@ namespace Web::UIEvents { -MouseEvent::MouseEvent(JS::Realm& realm, FlyString const& event_name, MouseEventInit const& event_init) +MouseEvent::MouseEvent(JS::Realm& realm, FlyString const& event_name, MouseEventInit const& event_init, double page_x, double page_y, double offset_x, double offset_y) : UIEvent(realm, event_name, event_init) - , m_offset_x(event_init.offset_x) - , m_offset_y(event_init.offset_y) + , m_screen_x(event_init.screen_x) + , m_screen_y(event_init.screen_y) + , m_page_x(page_x) + , m_page_y(page_y) , m_client_x(event_init.client_x) , m_client_y(event_init.client_y) - , m_page_x(event_init.page_x) - , m_page_y(event_init.page_y) + , m_offset_x(offset_x) + , m_offset_y(offset_y) , m_movement_x(event_init.movement_x) , m_movement_y(event_init.movement_y) , m_button(event_init.button) @@ -56,27 +58,23 @@ static i16 determine_button(unsigned mouse_button) } } -JS::NonnullGCPtr MouseEvent::create(JS::Realm& realm, FlyString const& event_name, MouseEventInit const& event_init) +JS::NonnullGCPtr MouseEvent::create(JS::Realm& realm, FlyString const& event_name, MouseEventInit const& event_init, double page_x, double page_y, double offset_x, double offset_y) { - return realm.heap().allocate(realm, realm, event_name, event_init); + return realm.heap().allocate(realm, realm, event_name, event_init, page_x, page_y, offset_x, offset_y); } -WebIDL::ExceptionOr> MouseEvent::create_from_platform_event(JS::Realm& realm, FlyString const& event_name, CSSPixelPoint offset, CSSPixelPoint client_offset, CSSPixelPoint page_offset, Optional movement, unsigned buttons, unsigned mouse_button) +WebIDL::ExceptionOr> MouseEvent::create_from_platform_event(JS::Realm& realm, FlyString const& event_name, CSSPixelPoint page, CSSPixelPoint client, CSSPixelPoint offset, Optional movement, unsigned button, unsigned buttons) { MouseEventInit event_init {}; - event_init.offset_x = offset.x().to_double(); - event_init.offset_y = offset.y().to_double(); - event_init.client_x = client_offset.x().to_double(); - event_init.client_y = client_offset.y().to_double(); - event_init.page_x = page_offset.x().to_double(); - event_init.page_y = page_offset.y().to_double(); + event_init.client_x = client.x().to_double(); + event_init.client_y = client.y().to_double(); if (movement.has_value()) { event_init.movement_x = movement.value().x().to_double(); event_init.movement_y = movement.value().y().to_double(); } - event_init.button = determine_button(mouse_button); + event_init.button = determine_button(button); event_init.buttons = buttons; - return MouseEvent::create(realm, event_name, event_init); + return MouseEvent::create(realm, event_name, event_init, page.x().to_double(), page.y().to_double(), offset.x().to_double(), offset.y().to_double()); } void MouseEvent::set_event_characteristics() diff --git a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h index d3b7dc3469..f101683bdb 100644 --- a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h +++ b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.h @@ -14,15 +14,12 @@ namespace Web::UIEvents { struct MouseEventInit : public EventModifierInit { - double offset_x = 0; - double offset_y = 0; + double screen_x = 0; + double screen_y = 0; double client_x = 0; double client_y = 0; - double page_x = 0; - double page_y = 0; double movement_x = 0; double movement_y = 0; - i16 button = 0; u16 buttons = 0; }; @@ -31,27 +28,26 @@ class MouseEvent : public UIEvent { WEB_PLATFORM_OBJECT(MouseEvent, UIEvent); public: - [[nodiscard]] static JS::NonnullGCPtr create(JS::Realm&, FlyString const& event_name, MouseEventInit const& = {}); - static WebIDL::ExceptionOr> create_from_platform_event(JS::Realm&, FlyString const& event_name, CSSPixelPoint offset, CSSPixelPoint client_offset, CSSPixelPoint page_offset, Optional movement, unsigned buttons, unsigned mouse_button = 1); + [[nodiscard]] static JS::NonnullGCPtr create(JS::Realm&, FlyString const& event_name, MouseEventInit const& = {}, double page_x = 0, double page_y = 0, double offset_x = 0, double offset_y = 0); + static WebIDL::ExceptionOr> create_from_platform_event(JS::Realm&, FlyString const& event_name, CSSPixelPoint page, CSSPixelPoint client, CSSPixelPoint offset, Optional movement, unsigned button, unsigned buttons); virtual ~MouseEvent() override; - double offset_x() const { return m_offset_x; } - double offset_y() const { return m_offset_y; } - - double client_x() const { return m_client_x; } - double client_y() const { return m_client_y; } - - // FIXME: Make these actually different from clientX and clientY. - double screen_x() const { return m_client_x; } - double screen_y() const { return m_client_y; } + double screen_x() const { return m_screen_x; } + double screen_y() const { return m_screen_y; } double page_x() const { return m_page_x; } double page_y() const { return m_page_y; } + double client_x() const { return m_client_x; } + double client_y() const { return m_client_y; } + double x() const { return client_x(); } double y() const { return client_y(); } + double offset_x() const { return m_offset_x; } + double offset_y() const { return m_offset_y; } + double movement_x() const { return m_movement_x; } double movement_y() const { return m_movement_y; } @@ -61,19 +57,21 @@ public: virtual u32 which() const override { return m_button + 1; } protected: - MouseEvent(JS::Realm&, FlyString const& event_name, MouseEventInit const& event_init); + MouseEvent(JS::Realm&, FlyString const& event_name, MouseEventInit const& event_init, double page_x, double page_y, double offset_x, double offset_y); virtual void initialize(JS::Realm&) override; private: void set_event_characteristics(); - double m_offset_x { 0 }; - double m_offset_y { 0 }; - double m_client_x { 0 }; - double m_client_y { 0 }; + double m_screen_x { 0 }; + double m_screen_y { 0 }; double m_page_x { 0 }; double m_page_y { 0 }; + double m_client_x { 0 }; + double m_client_y { 0 }; + double m_offset_x { 0 }; + double m_offset_y { 0 }; double m_movement_x { 0 }; double m_movement_y { 0 }; i16 m_button { 0 }; diff --git a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.idl b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.idl index 68d3a346d0..b702457f22 100644 --- a/Userland/Libraries/LibWeb/UIEvents/MouseEvent.idl +++ b/Userland/Libraries/LibWeb/UIEvents/MouseEvent.idl @@ -1,17 +1,24 @@ // https://w3c.github.io/uievents/#mouseevent [Exposed=Window] interface MouseEvent : UIEvent { + // FIXME: constructor(DOMString type, optional MouseEventInit eventInitDict = {}); - readonly attribute double offsetX; - readonly attribute double offsetY; - readonly attribute double clientX; - readonly attribute double clientY; + // https://drafts.csswg.org/cssom-view/#extensions-to-the-mouseevent-interface readonly attribute double screenX; readonly attribute double screenY; - readonly attribute double x; - readonly attribute double y; readonly attribute double pageX; readonly attribute double pageY; + readonly attribute double clientX; + readonly attribute double clientY; + readonly attribute double x; + readonly attribute double y; + readonly attribute double offsetX; + readonly attribute double offsetY; + + // FIXME: readonly attribute boolean ctrlKey; + // FIXME: readonly attribute boolean shiftKey; + // FIXME: readonly attribute boolean altKey; + // FIXME: readonly attribute boolean metaKey; // https://w3c.github.io/pointerlock/#extensions-to-the-mouseevent-interface readonly attribute double movementX; @@ -19,13 +26,17 @@ interface MouseEvent : UIEvent { readonly attribute short button; readonly attribute unsigned short buttons; + + // FIXME: readonly attribute EventTarget? relatedTarget; + + // FIXME: boolean getModifierState(DOMString keyArg); }; +// https://w3c.github.io/uievents/#idl-mouseeventinit dictionary MouseEventInit : EventModifierInit { - - // FIXME: offsetX and offsetY shouldn't be here. - double offsetX = 0; - double offsetY = 0; + // https://drafts.csswg.org/cssom-view/#extensions-to-the-mouseevent-interface + double screenX = 0; + double screenY = 0; double clientX = 0; double clientY = 0; @@ -34,5 +45,6 @@ dictionary MouseEventInit : EventModifierInit { double movementY = 0; short button = 0; - + unsigned short buttons = 0; + // FIXME: EventTarget? relatedTarget = null; }; diff --git a/Userland/Libraries/LibWeb/UIEvents/WheelEvent.cpp b/Userland/Libraries/LibWeb/UIEvents/WheelEvent.cpp index 85093dcbda..473d072b64 100644 --- a/Userland/Libraries/LibWeb/UIEvents/WheelEvent.cpp +++ b/Userland/Libraries/LibWeb/UIEvents/WheelEvent.cpp @@ -12,8 +12,8 @@ namespace Web::UIEvents { -WheelEvent::WheelEvent(JS::Realm& realm, FlyString const& event_name, WheelEventInit const& event_init) - : MouseEvent(realm, event_name, event_init) +WheelEvent::WheelEvent(JS::Realm& realm, FlyString const& event_name, WheelEventInit const& event_init, double page_x, double page_y, double offset_x, double offset_y) + : MouseEvent(realm, event_name, event_init, page_x, page_y, offset_x, offset_y) , m_delta_x(event_init.delta_x) , m_delta_y(event_init.delta_y) , m_delta_mode(event_init.delta_mode) @@ -29,24 +29,22 @@ void WheelEvent::initialize(JS::Realm& realm) set_prototype(&Bindings::ensure_web_prototype(realm, "WheelEvent")); } -JS::NonnullGCPtr WheelEvent::create(JS::Realm& realm, FlyString const& event_name, WheelEventInit const& event_init) +JS::NonnullGCPtr WheelEvent::create(JS::Realm& realm, FlyString const& event_name, WheelEventInit const& event_init, double page_x, double page_y, double offset_x, double offset_y) { - return realm.heap().allocate(realm, realm, event_name, event_init); + return realm.heap().allocate(realm, realm, event_name, event_init, page_x, page_y, offset_x, offset_y); } -WebIDL::ExceptionOr> WheelEvent::create_from_platform_event(JS::Realm& realm, FlyString const& event_name, CSSPixels offset_x, CSSPixels offset_y, CSSPixels client_x, CSSPixels client_y, double delta_x, double delta_y, unsigned buttons, unsigned button) +WebIDL::ExceptionOr> WheelEvent::create_from_platform_event(JS::Realm& realm, FlyString const& event_name, CSSPixelPoint page, CSSPixelPoint client, CSSPixelPoint offset, double delta_x, double delta_y, unsigned button, unsigned buttons) { WheelEventInit event_init {}; - event_init.offset_x = offset_x.to_double(); - event_init.offset_y = offset_y.to_double(); - event_init.client_x = client_x.to_double(); - event_init.client_y = client_y.to_double(); + event_init.client_x = client.x().to_double(); + event_init.client_y = client.y().to_double(); event_init.button = button; event_init.buttons = buttons; event_init.delta_x = delta_x; event_init.delta_y = delta_y; event_init.delta_mode = WheelDeltaMode::DOM_DELTA_PIXEL; - return WheelEvent::create(realm, event_name, event_init); + return WheelEvent::create(realm, event_name, event_init, page.x().to_double(), page.y().to_double(), offset.x().to_double(), offset.y().to_double()); } void WheelEvent::set_event_characteristics() diff --git a/Userland/Libraries/LibWeb/UIEvents/WheelEvent.h b/Userland/Libraries/LibWeb/UIEvents/WheelEvent.h index 1a735e2133..f5ace6b424 100644 --- a/Userland/Libraries/LibWeb/UIEvents/WheelEvent.h +++ b/Userland/Libraries/LibWeb/UIEvents/WheelEvent.h @@ -29,8 +29,8 @@ class WheelEvent final : public MouseEvent { WEB_PLATFORM_OBJECT(WheelEvent, MouseEvent); public: - [[nodiscard]] static JS::NonnullGCPtr create(JS::Realm&, FlyString const& event_name, WheelEventInit const& event_init = {}); - static WebIDL::ExceptionOr> create_from_platform_event(JS::Realm&, FlyString const& event_name, CSSPixels offset_x, CSSPixels offset_y, CSSPixels client_x, CSSPixels client_y, double delta_x, double delta_y, unsigned buttons, unsigned button); + [[nodiscard]] static JS::NonnullGCPtr create(JS::Realm&, FlyString const& event_name, WheelEventInit const& event_init = {}, double page_x = 0, double page_y = 0, double offset_x = 0, double offset_y = 0); + static WebIDL::ExceptionOr> create_from_platform_event(JS::Realm&, FlyString const& event_name, CSSPixelPoint page, CSSPixelPoint client, CSSPixelPoint offset, double delta_x, double delta_y, unsigned button, unsigned buttons); virtual ~WheelEvent() override; @@ -40,7 +40,7 @@ public: unsigned long delta_mode() const { return to_underlying(m_delta_mode); } private: - WheelEvent(JS::Realm&, FlyString const& event_name, WheelEventInit const& event_init); + WheelEvent(JS::Realm&, FlyString const& event_name, WheelEventInit const& event_init, double page_x, double page_y, double offset_x, double offset_y); virtual void initialize(JS::Realm&) override;