/* * Copyright (c) 2020-2021, Andreas Kling * Copyright (c) 2021, Max Wipfli * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Web { static Gfx::StandardCursor cursor_css_to_gfx(Optional cursor) { if (!cursor.has_value()) { return Gfx::StandardCursor::None; } switch (cursor.value()) { case CSS::Cursor::Crosshair: case CSS::Cursor::Cell: return Gfx::StandardCursor::Crosshair; case CSS::Cursor::Grab: case CSS::Cursor::Grabbing: return Gfx::StandardCursor::Drag; case CSS::Cursor::Pointer: return Gfx::StandardCursor::Hand; case CSS::Cursor::Help: return Gfx::StandardCursor::Help; case CSS::Cursor::None: return Gfx::StandardCursor::Hidden; case CSS::Cursor::Text: case CSS::Cursor::VerticalText: return Gfx::StandardCursor::IBeam; case CSS::Cursor::Move: case CSS::Cursor::AllScroll: return Gfx::StandardCursor::Move; case CSS::Cursor::Progress: case CSS::Cursor::Wait: return Gfx::StandardCursor::Wait; case CSS::Cursor::ColResize: return Gfx::StandardCursor::ResizeColumn; case CSS::Cursor::EResize: case CSS::Cursor::WResize: case CSS::Cursor::EwResize: return Gfx::StandardCursor::ResizeHorizontal; case CSS::Cursor::RowResize: return Gfx::StandardCursor::ResizeRow; case CSS::Cursor::NResize: case CSS::Cursor::SResize: case CSS::Cursor::NsResize: return Gfx::StandardCursor::ResizeVertical; case CSS::Cursor::NeResize: case CSS::Cursor::SwResize: case CSS::Cursor::NeswResize: return Gfx::StandardCursor::ResizeDiagonalBLTR; case CSS::Cursor::NwResize: case CSS::Cursor::SeResize: case CSS::Cursor::NwseResize: return Gfx::StandardCursor::ResizeDiagonalTLBR; default: return Gfx::StandardCursor::None; } } static Gfx::IntPoint compute_mouse_event_offset(const Gfx::IntPoint& position, const Layout::Node& layout_node) { auto top_left_of_layout_node = layout_node.box_type_agnostic_position(); return { position.x() - static_cast(top_left_of_layout_node.x()), position.y() - static_cast(top_left_of_layout_node.y()) }; } EventHandler::EventHandler(Badge, HTML::BrowsingContext& browsing_context) : m_browsing_context(browsing_context) , m_edit_event_handler(make(browsing_context)) { } EventHandler::~EventHandler() = default; const Layout::InitialContainingBlock* EventHandler::layout_root() const { if (!m_browsing_context.active_document()) return nullptr; return m_browsing_context.active_document()->layout_node(); } Layout::InitialContainingBlock* EventHandler::layout_root() { if (!m_browsing_context.active_document()) return nullptr; return m_browsing_context.active_document()->layout_node(); } Painting::PaintableBox* EventHandler::paint_root() { if (!m_browsing_context.active_document()) return nullptr; return const_cast(m_browsing_context.active_document()->paint_box()); } Painting::PaintableBox const* EventHandler::paint_root() const { if (!m_browsing_context.active_document()) return nullptr; return const_cast(m_browsing_context.active_document()->paint_box()); } bool EventHandler::handle_mousewheel(const Gfx::IntPoint& position, unsigned int buttons, unsigned int modifiers, int wheel_delta_x, int wheel_delta_y) { if (m_browsing_context.active_document()) m_browsing_context.active_document()->update_layout(); if (!paint_root()) return false; if (modifiers & KeyModifier::Mod_Shift) swap(wheel_delta_x, wheel_delta_y); // FIXME: Support wheel events in nested browsing contexts. auto result = paint_root()->hit_test(position.to_type(), Painting::HitTestType::Exact); if (result.has_value() && result->paintable->handle_mousewheel({}, position, buttons, modifiers, wheel_delta_x, wheel_delta_y)) return true; if (auto* page = m_browsing_context.page()) { page->client().page_did_request_scroll(wheel_delta_x * 20, wheel_delta_y * 20); return true; } return false; } bool EventHandler::handle_mouseup(const Gfx::IntPoint& position, unsigned button, unsigned modifiers) { if (m_browsing_context.active_document()) m_browsing_context.active_document()->update_layout(); if (!paint_root()) return false; bool handled_event = false; RefPtr paintable; if (m_mouse_event_tracking_layout_node) { paintable = m_mouse_event_tracking_layout_node->paintable(); } else { if (auto result = paint_root()->hit_test(position.to_type(), Painting::HitTestType::Exact); result.has_value()) paintable = result->paintable; } if (paintable && paintable->wants_mouse_events()) { if (paintable->handle_mouseup({}, position, button, modifiers) == Painting::Paintable::DispatchEventOfSameName::No) return false; // Things may have changed as a consequence of Layout::Node::handle_mouseup(). Hit test again. if (!paint_root()) return true; if (auto result = paint_root()->hit_test(position.to_type(), Painting::HitTestType::Exact); result.has_value()) paintable = result->paintable; } if (paintable) { RefPtr node = paintable->mouse_event_target(); if (!node) node = paintable->dom_node(); if (node) { if (is(*node)) { if (auto* nested_browsing_context = static_cast(*node).nested_browsing_context()) return nested_browsing_context->event_handler().handle_mouseup(position.translated(compute_mouse_event_offset({}, paintable->layout_node())), button, modifiers); return false; } auto offset = compute_mouse_event_offset(position, paintable->layout_node()); node->dispatch_event(UIEvents::MouseEvent::create(UIEvents::EventNames::mouseup, offset.x(), offset.y(), position.x(), position.y())); handled_event = true; // FIXME: This is ad-hoc and incorrect. The reason this exists is // because we are missing browsing context navigation: // // https://html.spec.whatwg.org/multipage/browsing-the-web.html#navigate // // Additionally, we currently cannot spawn a new top-level // browsing context for new tab operations, because the new // top-level browsing context would be in another process. To // fix this, there needs to be some way to be able to // communicate with browsing contexts in remote WebContent // processes, and then step 8 of this algorithm needs to be // implemented in BrowsingContext::choose_a_browsing_context: // // https://html.spec.whatwg.org/multipage/browsers.html#the-rules-for-choosing-a-browsing-context-given-a-browsing-context-name if (RefPtr link = node->enclosing_link_element()) { NonnullRefPtr document = *m_browsing_context.active_document(); auto href = link->href(); auto url = document->parse_url(href); dbgln("Web::EventHandler: Clicking on a link to {}", url); if (button == GUI::MouseButton::Primary) { if (href.starts_with("javascript:")) { document->run_javascript(href.substring_view(11, href.length() - 11)); } else if (!url.fragment().is_null() && url.equals(document->url(), AK::URL::ExcludeFragment::Yes)) { m_browsing_context.scroll_to_anchor(url.fragment()); } else if (modifiers != 0) { if (m_browsing_context.is_top_level()) { if (auto* page = m_browsing_context.page()) page->client().page_did_click_link(url, link->target(), modifiers); } } } else if (button == GUI::MouseButton::Middle) { if (auto* page = m_browsing_context.page()) page->client().page_did_middle_click_link(url, link->target(), modifiers); } else if (button == GUI::MouseButton::Secondary) { if (auto* page = m_browsing_context.page()) page->client().page_did_request_link_context_menu(m_browsing_context.to_top_level_position(position), url, link->target(), modifiers); } } else if (button == GUI::MouseButton::Secondary) { if (auto* page = m_browsing_context.page()) page->client().page_did_request_context_menu(m_browsing_context.to_top_level_position(position)); } if (node.ptr() == m_mousedown_target && button == GUI::MouseButton::Primary) { node->dispatch_event(UIEvents::MouseEvent::create(UIEvents::EventNames::click, offset.x(), offset.y(), position.x(), position.y())); } } } if (button == GUI::MouseButton::Primary) m_in_mouse_selection = false; return handled_event; } bool EventHandler::handle_mousedown(const Gfx::IntPoint& position, unsigned button, unsigned modifiers) { if (m_browsing_context.active_document()) m_browsing_context.active_document()->update_layout(); if (!paint_root()) return false; NonnullRefPtr document = *m_browsing_context.active_document(); RefPtr node; { // TODO: Allow selecting element behind if one on top has pointer-events set to none. RefPtr paintable; if (m_mouse_event_tracking_layout_node) { paintable = m_mouse_event_tracking_layout_node->paintable(); } else { auto result = paint_root()->hit_test(position.to_type(), Painting::HitTestType::Exact); if (!result.has_value()) return false; paintable = result->paintable; } auto pointer_events = paintable->computed_values().pointer_events(); // FIXME: Handle other values for pointer-events. if (pointer_events == CSS::PointerEvents::None) return false; node = paintable->mouse_event_target(); if (!node) node = paintable->dom_node(); document->set_hovered_node(node); if (paintable->wants_mouse_events()) { if (paintable->handle_mousedown({}, position, button, modifiers) == Painting::Paintable::DispatchEventOfSameName::No) return false; } if (!node) return false; if (is(*node)) { if (auto* nested_browsing_context = static_cast(*node).nested_browsing_context()) return nested_browsing_context->event_handler().handle_mousedown(position.translated(compute_mouse_event_offset({}, paintable->layout_node())), button, modifiers); return false; } if (auto* page = m_browsing_context.page()) page->set_focused_browsing_context({}, m_browsing_context); m_mousedown_target = node; auto offset = compute_mouse_event_offset(position, paintable->layout_node()); node->dispatch_event(UIEvents::MouseEvent::create(UIEvents::EventNames::mousedown, offset.x(), offset.y(), position.x(), position.y())); } // NOTE: Dispatching an event may have disturbed the world. if (!paint_root() || paint_root() != node->document().paint_box()) return true; if (button == GUI::MouseButton::Secondary && is(*node)) { auto& image_element = verify_cast(*node); auto image_url = image_element.document().parse_url(image_element.src()); if (auto* page = m_browsing_context.page()) page->client().page_did_request_image_context_menu(m_browsing_context.to_top_level_position(position), image_url, "", modifiers, image_element.bitmap()); return true; } if (button == GUI::MouseButton::Primary) { if (auto result = paint_root()->hit_test(position.to_type(), Painting::HitTestType::TextCursor); result.has_value()) { auto paintable = result->paintable; if (paintable->dom_node()) { // See if we want to focus something. bool did_focus_something = false; for (auto candidate = node; candidate; candidate = candidate->parent()) { if (candidate->is_focusable()) { document->set_focused_element(verify_cast(candidate.ptr())); did_focus_something = true; break; } } // If we didn't focus anything, place the document text cursor at the mouse position. // FIXME: This is all rather strange. Find a better solution. if (!did_focus_something) { m_browsing_context.set_cursor_position(DOM::Position(*paintable->dom_node(), result->index_in_node)); layout_root()->set_selection({ { paintable->layout_node(), result->index_in_node }, {} }); m_in_mouse_selection = true; } } } } return true; } bool EventHandler::handle_mousemove(const Gfx::IntPoint& position, unsigned buttons, unsigned modifiers) { if (m_browsing_context.active_document()) m_browsing_context.active_document()->update_layout(); if (!paint_root()) return false; auto& document = *m_browsing_context.active_document(); bool hovered_node_changed = false; bool is_hovering_link = false; Gfx::StandardCursor hovered_node_cursor = Gfx::StandardCursor::None; RefPtr paintable; Optional start_index; if (m_mouse_event_tracking_layout_node) { paintable = m_mouse_event_tracking_layout_node->paintable(); } else { if (auto result = paint_root()->hit_test(position.to_type(), Painting::HitTestType::Exact); result.has_value()) { paintable = result->paintable; start_index = result->index_in_node; } } const HTML::HTMLAnchorElement* hovered_link_element = nullptr; if (paintable) { if (paintable->wants_mouse_events()) { document.set_hovered_node(paintable->dom_node()); if (paintable->handle_mousemove({}, position, buttons, modifiers) == Painting::Paintable::DispatchEventOfSameName::No) return false; // FIXME: It feels a bit aggressive to always update the cursor like this. if (auto* page = m_browsing_context.page()) page->client().page_did_request_cursor_change(Gfx::StandardCursor::None); } RefPtr node = paintable->mouse_event_target(); if (!node) node = paintable->dom_node(); if (node && is(*node)) { if (auto* nested_browsing_context = static_cast(*node).nested_browsing_context()) return nested_browsing_context->event_handler().handle_mousemove(position.translated(compute_mouse_event_offset({}, paintable->layout_node())), buttons, modifiers); return false; } auto pointer_events = paintable->computed_values().pointer_events(); // FIXME: Handle other values for pointer-events. if (pointer_events == CSS::PointerEvents::None) return false; hovered_node_changed = node != document.hovered_node(); document.set_hovered_node(node); if (node) { hovered_link_element = node->enclosing_link_element(); if (hovered_link_element) is_hovering_link = true; if (node->is_text()) { auto cursor = paintable->computed_values().cursor(); if (cursor == CSS::Cursor::Auto) hovered_node_cursor = Gfx::StandardCursor::IBeam; else hovered_node_cursor = cursor_css_to_gfx(cursor); } else if (node->is_element()) { auto cursor = paintable->computed_values().cursor(); if (cursor == CSS::Cursor::Auto) hovered_node_cursor = Gfx::StandardCursor::Arrow; else hovered_node_cursor = cursor_css_to_gfx(cursor); } auto offset = compute_mouse_event_offset(position, paintable->layout_node()); node->dispatch_event(UIEvents::MouseEvent::create(UIEvents::EventNames::mousemove, offset.x(), offset.y(), position.x(), position.y())); // NOTE: Dispatching an event may have disturbed the world. if (!paint_root() || paint_root() != node->document().paint_box()) return true; } if (m_in_mouse_selection) { auto hit = paint_root()->hit_test(position.to_type(), Painting::HitTestType::TextCursor); if (start_index.has_value() && hit.has_value() && hit->dom_node()) { m_browsing_context.set_cursor_position(DOM::Position(*hit->dom_node(), *start_index)); layout_root()->set_selection_end({ hit->paintable->layout_node(), hit->index_in_node }); } if (auto* page = m_browsing_context.page()) page->client().page_did_change_selection(); } } if (auto* page = m_browsing_context.page()) { page->client().page_did_request_cursor_change(hovered_node_cursor); if (hovered_node_changed) { RefPtr hovered_html_element = document.hovered_node() ? document.hovered_node()->enclosing_html_element_with_attribute(HTML::AttributeNames::title) : nullptr; if (hovered_html_element && !hovered_html_element->title().is_null()) { page->client().page_did_enter_tooltip_area(m_browsing_context.to_top_level_position(position), hovered_html_element->title()); } else { page->client().page_did_leave_tooltip_area(); } if (is_hovering_link) page->client().page_did_hover_link(document.parse_url(hovered_link_element->href())); else page->client().page_did_unhover_link(); } } return true; } bool EventHandler::focus_next_element() { if (!m_browsing_context.active_document()) return false; auto* element = m_browsing_context.active_document()->focused_element(); if (!element) { element = m_browsing_context.active_document()->first_child_of_type(); if (element && element->is_focusable()) { m_browsing_context.active_document()->set_focused_element(element); return true; } } for (element = element->next_element_in_pre_order(); element && !element->is_focusable(); element = element->next_element_in_pre_order()) ; m_browsing_context.active_document()->set_focused_element(element); return element; } bool EventHandler::focus_previous_element() { if (!m_browsing_context.active_document()) return false; auto* element = m_browsing_context.active_document()->focused_element(); if (!element) { element = m_browsing_context.active_document()->last_child_of_type(); if (element && element->is_focusable()) { m_browsing_context.active_document()->set_focused_element(element); return true; } } for (element = element->previous_element_in_pre_order(); element && !element->is_focusable(); element = element->previous_element_in_pre_order()) ; m_browsing_context.active_document()->set_focused_element(element); return element; } constexpr bool should_ignore_keydown_event(u32 code_point) { // FIXME: There are probably also keys with non-zero code points that should be filtered out. return code_point == 0 || code_point == 27; } bool EventHandler::handle_keydown(KeyCode key, unsigned modifiers, u32 code_point) { if (!m_browsing_context.active_document()) return false; NonnullRefPtr document = *m_browsing_context.active_document(); if (!document->layout_node()) return false; NonnullRefPtr layout_root = *document->layout_node(); if (key == KeyCode::Key_Tab) { if (modifiers & KeyModifier::Mod_Shift) return focus_previous_element(); return focus_next_element(); } if (layout_root->selection().is_valid()) { auto range = layout_root->selection().to_dom_range()->normalized(); if (range->start_container()->is_editable()) { layout_root->set_selection({}); // FIXME: This doesn't work for some reason? m_browsing_context.set_cursor_position({ *range->start_container(), range->start_offset() }); if (key == KeyCode::Key_Backspace || key == KeyCode::Key_Delete) { m_edit_event_handler->handle_delete(range); return true; } if (!should_ignore_keydown_event(code_point)) { m_edit_event_handler->handle_delete(range); m_edit_event_handler->handle_insert(m_browsing_context.cursor_position(), code_point); m_browsing_context.increment_cursor_position_offset(); return true; } } } if (m_browsing_context.cursor_position().is_valid() && m_browsing_context.cursor_position().node()->is_editable()) { if (key == KeyCode::Key_Backspace) { if (!m_browsing_context.decrement_cursor_position_offset()) { // FIXME: Move to the previous node and delete the last character there. return true; } m_edit_event_handler->handle_delete_character_after(m_browsing_context.cursor_position()); return true; } if (key == KeyCode::Key_Delete) { if (m_browsing_context.cursor_position().offset_is_at_end_of_node()) { // FIXME: Move to the next node and delete the first character there. return true; } m_edit_event_handler->handle_delete_character_after(m_browsing_context.cursor_position()); return true; } if (key == KeyCode::Key_Right) { if (!m_browsing_context.increment_cursor_position_offset()) { // FIXME: Move to the next node. } return true; } if (key == KeyCode::Key_Left) { if (!m_browsing_context.decrement_cursor_position_offset()) { // FIXME: Move to the previous node. } return true; } if (key == KeyCode::Key_Home) { auto& node = *static_cast(const_cast(m_browsing_context.cursor_position().node())); m_browsing_context.set_cursor_position(DOM::Position { node, 0 }); return true; } if (key == KeyCode::Key_End) { auto& node = *static_cast(const_cast(m_browsing_context.cursor_position().node())); m_browsing_context.set_cursor_position(DOM::Position { node, (unsigned)node.data().length() }); return true; } if (!should_ignore_keydown_event(code_point)) { m_edit_event_handler->handle_insert(m_browsing_context.cursor_position(), code_point); m_browsing_context.increment_cursor_position_offset(); return true; } // NOTE: Because modifier keys should be ignored, we need to return true. return true; } auto event = UIEvents::KeyboardEvent::create_from_platform_event(UIEvents::EventNames::keydown, key, modifiers, code_point); if (RefPtr focused_element = document->focused_element()) return focused_element->dispatch_event(move(event)); if (RefPtr body = m_browsing_context.active_document()->body()) return body->dispatch_event(move(event)); return document->root().dispatch_event(move(event)); } bool EventHandler::handle_keyup(KeyCode key, unsigned modifiers, u32 code_point) { RefPtr document = m_browsing_context.active_document(); if (!document) return false; auto event = UIEvents::KeyboardEvent::create_from_platform_event(UIEvents::EventNames::keyup, key, modifiers, code_point); if (RefPtr focused_element = document->focused_element()) return document->focused_element()->dispatch_event(move(event)); if (RefPtr body = document->body()) return body->dispatch_event(move(event)); return document->root().dispatch_event(move(event)); } void EventHandler::set_mouse_event_tracking_layout_node(Layout::Node* layout_node) { if (layout_node) m_mouse_event_tracking_layout_node = layout_node->make_weak_ptr(); else m_mouse_event_tracking_layout_node = nullptr; } }