mirror of
				https://github.com/RGBCube/serenity
				synced 2025-10-31 20:22:45 +00:00 
			
		
		
		
	 9c99182b1e
			
		
	
	
		9c99182b1e
		
	
	
	
	
		
			
			This change modifies hit_test() to no longer return the first paintable encountered at a specified position. Instead, this function accepts a callback that is invoked for each paintable located at a position, in hit-testing order. This modification will allow us to reuse this call for `Document.elementsFromPoint()` in upcoming changes.
		
			
				
	
	
		
			256 lines
		
	
	
	
		
			11 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			256 lines
		
	
	
	
		
			11 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
| /*
 | |
|  * Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
 | |
|  *
 | |
|  * SPDX-License-Identifier: BSD-2-Clause
 | |
|  */
 | |
| 
 | |
| #include <LibGfx/AntiAliasingPainter.h>
 | |
| #include <LibWeb/DOM/Document.h>
 | |
| #include <LibWeb/Layout/BlockContainer.h>
 | |
| #include <LibWeb/Painting/BackgroundPainting.h>
 | |
| #include <LibWeb/Painting/InlinePaintable.h>
 | |
| 
 | |
| namespace Web::Painting {
 | |
| 
 | |
| JS::NonnullGCPtr<InlinePaintable> InlinePaintable::create(Layout::InlineNode const& layout_node)
 | |
| {
 | |
|     return layout_node.heap().allocate_without_realm<InlinePaintable>(layout_node);
 | |
| }
 | |
| 
 | |
| InlinePaintable::InlinePaintable(Layout::InlineNode const& layout_node)
 | |
|     : Paintable(layout_node)
 | |
| {
 | |
| }
 | |
| 
 | |
| Layout::InlineNode const& InlinePaintable::layout_node() const
 | |
| {
 | |
|     return static_cast<Layout::InlineNode const&>(Paintable::layout_node());
 | |
| }
 | |
| 
 | |
| Optional<int> InlinePaintable::scroll_frame_id() const
 | |
| {
 | |
|     if (m_enclosing_scroll_frame)
 | |
|         return m_enclosing_scroll_frame->id;
 | |
|     return {};
 | |
| }
 | |
| 
 | |
| Optional<CSSPixelPoint> InlinePaintable::enclosing_scroll_frame_offset() const
 | |
| {
 | |
|     if (m_enclosing_scroll_frame)
 | |
|         return m_enclosing_scroll_frame->offset;
 | |
|     return {};
 | |
| }
 | |
| 
 | |
| Optional<CSSPixelRect> InlinePaintable::clip_rect() const
 | |
| {
 | |
|     if (m_enclosing_clip_frame)
 | |
|         return m_enclosing_clip_frame->rect();
 | |
|     return {};
 | |
| }
 | |
| 
 | |
| void InlinePaintable::before_paint(PaintContext& context, PaintPhase) const
 | |
| {
 | |
|     if (scroll_frame_id().has_value()) {
 | |
|         context.recording_painter().save();
 | |
|         context.recording_painter().set_scroll_frame_id(scroll_frame_id().value());
 | |
|     }
 | |
|     if (clip_rect().has_value()) {
 | |
|         context.recording_painter().save();
 | |
|         context.recording_painter().add_clip_rect(context.enclosing_device_rect(*clip_rect()).to_type<int>());
 | |
|     }
 | |
| }
 | |
| 
 | |
| void InlinePaintable::after_paint(PaintContext& context, PaintPhase) const
 | |
| {
 | |
|     if (clip_rect().has_value())
 | |
|         context.recording_painter().restore();
 | |
|     if (scroll_frame_id().has_value())
 | |
|         context.recording_painter().restore();
 | |
| }
 | |
| 
 | |
| void InlinePaintable::paint(PaintContext& context, PaintPhase phase) const
 | |
| {
 | |
|     auto& painter = context.recording_painter();
 | |
| 
 | |
|     if (phase == PaintPhase::Background) {
 | |
|         auto containing_block_position_in_absolute_coordinates = containing_block()->paintable_box()->absolute_position();
 | |
| 
 | |
|         for_each_fragment([&](auto const& fragment, bool is_first_fragment, bool is_last_fragment) {
 | |
|             CSSPixelRect absolute_fragment_rect { containing_block_position_in_absolute_coordinates.translated(fragment.offset()), fragment.size() };
 | |
| 
 | |
|             if (is_first_fragment) {
 | |
|                 auto extra_start_width = box_model().padding.left;
 | |
|                 absolute_fragment_rect.translate_by(-extra_start_width, 0);
 | |
|                 absolute_fragment_rect.set_width(absolute_fragment_rect.width() + extra_start_width);
 | |
|             }
 | |
| 
 | |
|             if (is_last_fragment) {
 | |
|                 auto extra_end_width = box_model().padding.right;
 | |
|                 absolute_fragment_rect.set_width(absolute_fragment_rect.width() + extra_end_width);
 | |
|             }
 | |
| 
 | |
|             auto const& border_radii_data = fragment.border_radii_data();
 | |
|             paint_background(context, layout_node(), absolute_fragment_rect, computed_values().background_color(), computed_values().image_rendering(), &computed_values().background_layers(), border_radii_data);
 | |
| 
 | |
|             if (!box_shadow_data().is_empty()) {
 | |
|                 auto borders_data = BordersData {
 | |
|                     .top = computed_values().border_top(),
 | |
|                     .right = computed_values().border_right(),
 | |
|                     .bottom = computed_values().border_bottom(),
 | |
|                     .left = computed_values().border_left(),
 | |
|                 };
 | |
|                 auto absolute_fragment_rect_bordered = absolute_fragment_rect.inflated(
 | |
|                     borders_data.top.width, borders_data.right.width,
 | |
|                     borders_data.bottom.width, borders_data.left.width);
 | |
|                 paint_box_shadow(context, absolute_fragment_rect_bordered, absolute_fragment_rect,
 | |
|                     borders_data, border_radii_data, box_shadow_data());
 | |
|             }
 | |
| 
 | |
|             return IterationDecision::Continue;
 | |
|         });
 | |
|     }
 | |
| 
 | |
|     auto paint_border_or_outline = [&](Optional<BordersData> outline_data = {}, CSSPixels outline_offset = 0) {
 | |
|         auto borders_data = BordersData {
 | |
|             .top = computed_values().border_top(),
 | |
|             .right = computed_values().border_right(),
 | |
|             .bottom = computed_values().border_bottom(),
 | |
|             .left = computed_values().border_left(),
 | |
|         };
 | |
| 
 | |
|         auto containing_block_position_in_absolute_coordinates = containing_block()->paintable_box()->absolute_position();
 | |
| 
 | |
|         for_each_fragment([&](auto const& fragment, bool is_first_fragment, bool is_last_fragment) {
 | |
|             CSSPixelRect absolute_fragment_rect { containing_block_position_in_absolute_coordinates.translated(fragment.offset()), fragment.size() };
 | |
| 
 | |
|             if (is_first_fragment) {
 | |
|                 auto extra_start_width = box_model().padding.left;
 | |
|                 absolute_fragment_rect.translate_by(-extra_start_width, 0);
 | |
|                 absolute_fragment_rect.set_width(absolute_fragment_rect.width() + extra_start_width);
 | |
|             }
 | |
| 
 | |
|             if (is_last_fragment) {
 | |
|                 auto extra_end_width = box_model().padding.right;
 | |
|                 absolute_fragment_rect.set_width(absolute_fragment_rect.width() + extra_end_width);
 | |
|             }
 | |
| 
 | |
|             auto borders_rect = absolute_fragment_rect.inflated(borders_data.top.width, borders_data.right.width, borders_data.bottom.width, borders_data.left.width);
 | |
|             auto border_radii_data = fragment.border_radii_data();
 | |
| 
 | |
|             if (outline_data.has_value()) {
 | |
|                 auto outline_offset_x = outline_offset;
 | |
|                 auto outline_offset_y = outline_offset;
 | |
|                 // "Both the height and the width of the outside of the shape drawn by the outline should not
 | |
|                 // become smaller than twice the computed value of the outline-width property to make sure
 | |
|                 // that an outline can be rendered even with large negative values."
 | |
|                 // https://www.w3.org/TR/css-ui-4/#outline-offset
 | |
|                 // So, if the horizontal outline offset is > half the borders_rect's width then we set it to that.
 | |
|                 // (And the same for y)
 | |
|                 if ((borders_rect.width() / 2) + outline_offset_x < 0)
 | |
|                     outline_offset_x = -borders_rect.width() / 2;
 | |
|                 if ((borders_rect.height() / 2) + outline_offset_y < 0)
 | |
|                     outline_offset_y = -borders_rect.height() / 2;
 | |
| 
 | |
|                 border_radii_data.inflate(outline_data->top.width + outline_offset_y, outline_data->right.width + outline_offset_x, outline_data->bottom.width + outline_offset_y, outline_data->left.width + outline_offset_x);
 | |
|                 borders_rect.inflate(outline_data->top.width + outline_offset_y, outline_data->right.width + outline_offset_x, outline_data->bottom.width + outline_offset_y, outline_data->left.width + outline_offset_x);
 | |
|                 context.recording_painter().paint_borders(context.rounded_device_rect(borders_rect), border_radii_data.as_corners(context), outline_data->to_device_pixels(context));
 | |
|             } else {
 | |
|                 context.recording_painter().paint_borders(context.rounded_device_rect(borders_rect), border_radii_data.as_corners(context), borders_data.to_device_pixels(context));
 | |
|             }
 | |
| 
 | |
|             return IterationDecision::Continue;
 | |
|         });
 | |
|     };
 | |
| 
 | |
|     if (phase == PaintPhase::Border) {
 | |
|         paint_border_or_outline();
 | |
|     }
 | |
| 
 | |
|     if (phase == PaintPhase::Outline) {
 | |
|         auto maybe_outline_data = this->outline_data();
 | |
|         if (maybe_outline_data.has_value())
 | |
|             paint_border_or_outline(maybe_outline_data.value(), computed_values().outline_offset().to_px(layout_node()));
 | |
|     }
 | |
| 
 | |
|     if (phase == PaintPhase::Foreground) {
 | |
|         for_each_fragment([&](auto const& fragment, bool, bool) {
 | |
|             if (is<Layout::TextNode>(fragment.layout_node()))
 | |
|                 paint_text_fragment(context, static_cast<Layout::TextNode const&>(fragment.layout_node()), fragment, phase);
 | |
|         });
 | |
|     }
 | |
| 
 | |
|     if (phase == PaintPhase::Overlay && layout_node().document().inspected_layout_node() == &layout_node()) {
 | |
|         // FIXME: This paints a double-thick border between adjacent fragments, where ideally there
 | |
|         //        would be none. Once we implement non-rectangular outlines for the `outline` CSS
 | |
|         //        property, we can use that here instead.
 | |
|         for_each_fragment([&](auto const& fragment, bool, bool) {
 | |
|             painter.draw_rect(context.enclosing_device_rect(fragment.absolute_rect()).template to_type<int>(), Color::Magenta);
 | |
|             return IterationDecision::Continue;
 | |
|         });
 | |
|     }
 | |
| }
 | |
| 
 | |
| template<typename Callback>
 | |
| void InlinePaintable::for_each_fragment(Callback callback) const
 | |
| {
 | |
|     for (size_t i = 0; i < m_fragments.size(); ++i) {
 | |
|         auto const& fragment = m_fragments[i];
 | |
|         callback(fragment, i == 0, i == m_fragments.size() - 1);
 | |
|     }
 | |
| }
 | |
| 
 | |
| TraversalDecision InlinePaintable::hit_test(CSSPixelPoint position, HitTestType type, Function<TraversalDecision(HitTestResult)> const& callback) const
 | |
| {
 | |
|     if (m_clip_rect.has_value() && !m_clip_rect.value().contains(position))
 | |
|         return TraversalDecision::Continue;
 | |
| 
 | |
|     auto position_adjusted_by_scroll_offset = position;
 | |
|     if (enclosing_scroll_frame_offset().has_value())
 | |
|         position_adjusted_by_scroll_offset.translate_by(-enclosing_scroll_frame_offset().value());
 | |
| 
 | |
|     for (auto const& fragment : m_fragments) {
 | |
|         if (fragment.paintable().stacking_context())
 | |
|             continue;
 | |
|         auto fragment_absolute_rect = fragment.absolute_rect();
 | |
|         if (fragment_absolute_rect.contains(position_adjusted_by_scroll_offset)) {
 | |
|             if (fragment.paintable().hit_test(position, type, callback) == TraversalDecision::Break)
 | |
|                 return TraversalDecision::Break;
 | |
|             auto hit_test_result = HitTestResult { const_cast<Paintable&>(fragment.paintable()), fragment.text_index_at(position_adjusted_by_scroll_offset.x()) };
 | |
|             if (callback(hit_test_result) == TraversalDecision::Break)
 | |
|                 return TraversalDecision::Break;
 | |
|         }
 | |
|     }
 | |
| 
 | |
|     bool should_exit = false;
 | |
|     for_each_child([&](Paintable const& child) {
 | |
|         if (should_exit)
 | |
|             return;
 | |
|         if (child.stacking_context())
 | |
|             return;
 | |
|         if (child.hit_test(position, type, callback) == TraversalDecision::Break)
 | |
|             should_exit = true;
 | |
|     });
 | |
| 
 | |
|     if (should_exit)
 | |
|         return TraversalDecision::Break;
 | |
| 
 | |
|     return TraversalDecision::Continue;
 | |
| }
 | |
| 
 | |
| CSSPixelRect InlinePaintable::bounding_rect() const
 | |
| {
 | |
|     CSSPixelRect bounding_rect;
 | |
|     for_each_fragment([&](auto const& fragment, bool, bool) {
 | |
|         auto fragment_absolute_rect = fragment.absolute_rect();
 | |
|         bounding_rect = bounding_rect.united(fragment_absolute_rect);
 | |
|     });
 | |
| 
 | |
|     if (bounding_rect.is_empty()) {
 | |
|         // FIXME: This is adhoc, and we should return rect of empty fragment instead.
 | |
|         auto containing_block_position_in_absolute_coordinates = containing_block()->paintable_box()->absolute_position();
 | |
|         return { containing_block_position_in_absolute_coordinates, { 0, 0 } };
 | |
|     }
 | |
|     return bounding_rect;
 | |
| }
 | |
| 
 | |
| }
 |