/* * Copyright (c) 2020-2022, Andreas Kling * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include namespace Web::Painting { static void paint_node(Layout::Node const& layout_node, PaintContext& context, PaintPhase phase) { if (auto const* paintable = layout_node.paintable()) paintable->paint(context, phase); } StackingContext::StackingContext(Layout::Box& box, StackingContext* parent) : m_box(box) , m_parent(parent) { VERIFY(m_parent != this); if (m_parent) m_parent->m_children.append(this); } void StackingContext::sort() { quick_sort(m_children, [](auto& a, auto& b) { auto a_z_index = a->m_box.computed_values().z_index().value_or(0); auto b_z_index = b->m_box.computed_values().z_index().value_or(0); if (a_z_index == b_z_index) return a->m_box.is_before(b->m_box); return a_z_index < b_z_index; }); for (auto* child : m_children) child->sort(); } void StackingContext::paint_descendants(PaintContext& context, Layout::Node& box, StackingContextPaintPhase phase) const { if (phase == StackingContextPaintPhase::Foreground) { if (auto* paintable = box.paintable()) paintable->before_children_paint(context, PaintPhase::Foreground); } box.for_each_child([&](auto& child) { // If `child` establishes its own stacking context, skip over it. if (is(child) && child.paintable() && static_cast(child).paint_box()->stacking_context()) return; bool child_is_inline_or_replaced = child.is_inline() || is(child); switch (phase) { case StackingContextPaintPhase::BackgroundAndBorders: if (!child_is_inline_or_replaced && !child.is_floating() && !child.is_positioned()) { paint_node(child, context, PaintPhase::Background); paint_node(child, context, PaintPhase::Border); paint_descendants(context, child, phase); } break; case StackingContextPaintPhase::Floats: if (!child.is_positioned()) { if (child.is_floating()) { paint_node(child, context, PaintPhase::Background); paint_node(child, context, PaintPhase::Border); paint_descendants(context, child, StackingContextPaintPhase::BackgroundAndBorders); } paint_descendants(context, child, phase); } break; case StackingContextPaintPhase::BackgroundAndBordersForInlineLevelAndReplaced: if (!child.is_positioned()) { if (child_is_inline_or_replaced) { paint_node(child, context, PaintPhase::Background); paint_node(child, context, PaintPhase::Border); paint_descendants(context, child, StackingContextPaintPhase::BackgroundAndBorders); } paint_descendants(context, child, phase); } break; case StackingContextPaintPhase::Foreground: if (!child.is_positioned()) { paint_node(child, context, PaintPhase::Foreground); paint_descendants(context, child, phase); } break; case StackingContextPaintPhase::FocusAndOverlay: if (context.has_focus()) { paint_node(child, context, PaintPhase::FocusOutline); } paint_node(child, context, PaintPhase::Overlay); paint_descendants(context, child, phase); break; } }); if (phase == StackingContextPaintPhase::Foreground) { if (auto* paintable = box.paintable()) paintable->after_children_paint(context, PaintPhase::Foreground); } } void StackingContext::paint_internal(PaintContext& context) const { // For a more elaborate description of the algorithm, see CSS 2.1 Appendix E // Draw the background and borders for the context root (steps 1, 2) paint_node(m_box, context, PaintPhase::Background); paint_node(m_box, context, PaintPhase::Border); // Draw positioned descendants with negative z-indices (step 3) for (auto* child : m_children) { if (child->m_box.computed_values().z_index().has_value() && child->m_box.computed_values().z_index().value() < 0) child->paint(context); } // Draw the background and borders for block-level children (step 4) paint_descendants(context, m_box, StackingContextPaintPhase::BackgroundAndBorders); // Draw the non-positioned floats (step 5) paint_descendants(context, m_box, StackingContextPaintPhase::Floats); // Draw inline content, replaced content, etc. (steps 6, 7) paint_descendants(context, m_box, StackingContextPaintPhase::BackgroundAndBordersForInlineLevelAndReplaced); paint_node(m_box, context, PaintPhase::Foreground); paint_descendants(context, m_box, StackingContextPaintPhase::Foreground); // Draw other positioned descendants (steps 8, 9) for (auto* child : m_children) { if (child->m_box.computed_values().z_index().has_value() && child->m_box.computed_values().z_index().value() < 0) continue; child->paint(context); } paint_node(m_box, context, PaintPhase::FocusOutline); paint_node(m_box, context, PaintPhase::Overlay); paint_descendants(context, m_box, StackingContextPaintPhase::FocusAndOverlay); } Gfx::FloatMatrix4x4 StackingContext::get_transformation_matrix(CSS::Transformation const& transformation) const { auto count = transformation.values.size(); auto value = [this, transformation](size_t index, CSS::Length& reference) -> float { return transformation.values[index].visit( [this, reference](CSS::LengthPercentage const& value) { return value.resolved(m_box, reference).to_px(m_box); }, [](float value) { return value; }); }; auto reference_box = m_box.paint_box()->absolute_rect(); auto width = CSS::Length::make_px(reference_box.width()); auto height = CSS::Length::make_px(reference_box.height()); switch (transformation.function) { case CSS::TransformFunction::Matrix: if (count == 6) return Gfx::FloatMatrix4x4(value(0, width), value(2, width), 0, value(4, width), value(1, height), value(3, height), 0, value(5, height), 0, 0, 1, 0, 0, 0, 0, 1); break; case CSS::TransformFunction::Translate: if (count == 1) return Gfx::FloatMatrix4x4(1, 0, 0, value(0, width), 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1); if (count == 2) return Gfx::FloatMatrix4x4(1, 0, 0, value(0, width), 0, 1, 0, value(1, height), 0, 0, 1, 0, 0, 0, 0, 1); break; case CSS::TransformFunction::TranslateX: if (count == 1) return Gfx::FloatMatrix4x4(1, 0, 0, value(0, width), 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1); break; case CSS::TransformFunction::TranslateY: if (count == 1) return Gfx::FloatMatrix4x4(1, 0, 0, 0, 0, 1, 0, value(0, height), 0, 0, 1, 0, 0, 0, 0, 1); break; case CSS::TransformFunction::Scale: if (count == 1) return Gfx::FloatMatrix4x4(value(0, width), 0, 0, 0, 0, value(0, height), 0, 0, 0, 0, 1, 0, 0, 0, 0, 1); if (count == 2) return Gfx::FloatMatrix4x4(value(0, width), 0, 0, 0, 0, value(0, height), 0, 0, 0, 0, 1, 0, 0, 0, 0, 1); break; case CSS::TransformFunction::ScaleX: if (count == 1) return Gfx::FloatMatrix4x4(value(0, width), 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1); break; case CSS::TransformFunction::ScaleY: if (count == 1) return Gfx::FloatMatrix4x4(1, 0, 0, 0, 0, value(0, height), 0, 0, 0, 0, 1, 0, 0, 0, 0, 1); break; default: dbgln_if(LIBWEB_CSS_DEBUG, "FIXME: Unhandled transformation function {}", CSS::TransformationStyleValue::create(transformation.function, {})->to_string()); } return Gfx::FloatMatrix4x4::identity(); } Gfx::FloatMatrix4x4 StackingContext::combine_transformations(Vector const& transformations) const { auto matrix = Gfx::FloatMatrix4x4::identity(); for (auto const& transform : transformations) matrix = matrix * get_transformation_matrix(transform); return matrix; } // FIXME: This extracts the affine 2D part of the full transformation matrix. // Use the whole matrix when we get better transformation support in LibGfx or use LibGL for drawing the bitmap Gfx::AffineTransform StackingContext::combine_transformations_2d(Vector const& transformations) const { auto matrix = combine_transformations(transformations); auto* m = matrix.elements(); return Gfx::AffineTransform(m[0][0], m[1][0], m[0][1], m[1][1], m[0][3], m[1][3]); } void StackingContext::paint(PaintContext& context) const { Gfx::PainterStateSaver saver(context.painter()); if (m_box.is_fixed_position()) { context.painter().translate(context.scroll_offset()); } auto opacity = m_box.computed_values().opacity(); if (opacity == 0.0f) return; auto affine_transform = combine_transformations_2d(m_box.computed_values().transformations()); if (opacity < 1.0f || !affine_transform.is_identity()) { auto bitmap_or_error = Gfx::Bitmap::try_create(Gfx::BitmapFormat::BGRA8888, context.painter().target()->size()); if (bitmap_or_error.is_error()) return; auto bitmap = bitmap_or_error.release_value_but_fixme_should_propagate_errors(); Gfx::Painter painter(bitmap); auto paint_context = context.clone(painter); paint_internal(paint_context); auto transform_origin = this->transform_origin(); auto source_rect = m_box.paint_box()->absolute_border_box_rect().translated(-transform_origin); auto transformed_destination_rect = affine_transform.map(source_rect).translated(transform_origin); source_rect.translate_by(transform_origin); context.painter().draw_scaled_bitmap(transformed_destination_rect.to_rounded(), *bitmap, source_rect, opacity, Gfx::Painter::ScalingMode::BilinearBlend); } else { paint_internal(context); } } Gfx::FloatPoint StackingContext::transform_origin() const { auto style_value = m_box.computed_values().transform_origin(); // FIXME: respect transform-box property auto reference_box = m_box.paint_box()->absolute_border_box_rect(); auto x = reference_box.left() + style_value.x.resolved(m_box, CSS::Length::make_px(reference_box.width())).to_px(m_box); auto y = reference_box.top() + style_value.y.resolved(m_box, CSS::Length::make_px(reference_box.height())).to_px(m_box); return { x, y }; } Optional StackingContext::hit_test(Gfx::FloatPoint const& position, HitTestType type) const { auto transform_origin = this->transform_origin(); auto affine_transform = combine_transformations_2d(m_box.computed_values().transformations()); auto transformed_position = affine_transform.inverse().value_or({}).map(position - transform_origin) + transform_origin; // NOTE: Hit testing basically happens in reverse painting order. // https://www.w3.org/TR/CSS22/visuren.html#z-index // 7. the child stacking contexts with positive stack levels (least positive first). for (ssize_t i = m_children.size() - 1; i >= 0; --i) { auto const& child = *m_children[i]; if (!child.m_box.is_visible()) continue; if (child.m_box.computed_values().z_index().value_or(0) < 0) continue; auto result = child.hit_test(transformed_position, type); if (result.has_value()) return result; } Optional result; // 6. the child stacking contexts with stack level 0 and the positioned descendants with stack level 0. m_box.for_each_in_subtree_of_type([&](Layout::Box const& box) { if (box.is_positioned() && !box.paint_box()->stacking_context()) { if (auto candidate = box.paint_box()->hit_test(transformed_position, type); candidate.has_value()) result = move(candidate); } return IterationDecision::Continue; }); if (result.has_value()) return result; // 5. the in-flow, inline-level, non-positioned descendants, including inline tables and inline blocks. if (m_box.children_are_inline() && is(m_box)) { auto result = m_box.paint_box()->hit_test(transformed_position, type); if (result.has_value()) return result; } // 4. the non-positioned floats. m_box.for_each_in_subtree_of_type([&](Layout::Box const& box) { if (box.is_floating()) { if (auto candidate = box.paint_box()->hit_test(transformed_position, type); candidate.has_value()) result = move(candidate); } return IterationDecision::Continue; }); if (result.has_value()) return result; // 3. the in-flow, non-inline-level, non-positioned descendants. if (!m_box.children_are_inline()) { m_box.for_each_in_subtree_of_type([&](Layout::Box const& box) { if (!box.is_absolutely_positioned() && !box.is_floating()) { if (!box.paint_box()) return IterationDecision::Continue; if (auto candidate = box.paint_box()->hit_test(transformed_position, type); candidate.has_value()) result = move(candidate); } return IterationDecision::Continue; }); if (result.has_value()) return result; } // 2. the child stacking contexts with negative stack levels (most negative first). for (ssize_t i = m_children.size() - 1; i >= 0; --i) { auto const& child = *m_children[i]; if (child.m_box.computed_values().z_index().value_or(0) < 0) continue; if (!child.m_box.is_visible()) continue; auto result = child.hit_test(transformed_position, type); if (result.has_value()) return result; } // 1. the background and borders of the element forming the stacking context. if (m_box.paint_box()->absolute_border_box_rect().contains(transformed_position)) { return HitTestResult { .paintable = *m_box.paintable(), }; } return {}; } void StackingContext::dump(int indent) const { StringBuilder builder; for (int i = 0; i < indent; ++i) builder.append(' '); builder.appendff("SC for {} {} [children: {}] (z-index: ", m_box.debug_description(), m_box.paint_box()->absolute_rect(), m_children.size()); if (m_box.computed_values().z_index().has_value()) builder.appendff("{}", m_box.computed_values().z_index().value()); else builder.append("auto"); builder.append(')'); auto affine_transform = combine_transformations_2d(m_box.computed_values().transformations()); if (!affine_transform.is_identity()) { builder.appendff(", transform: {}", affine_transform); } dbgln("{}", builder.string_view()); for (auto& child : m_children) child->dump(indent + 1); } }