ladybird/Libraries/LibWeb/Painting/SVGSVGPaintable.cpp

/*
 * Copyright (c) 2018-2022, Andreas Kling <andreas@ladybird.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <LibWeb/Layout/ImageBox.h>
#include <LibWeb/Painting/Blending.h>
#include <LibWeb/Painting/DisplayListRecorder.h>
#include <LibWeb/Painting/SVGSVGPaintable.h>
#include <LibWeb/Painting/StackingContext.h>

namespace Web::Painting {

GC_DEFINE_ALLOCATOR(SVGSVGPaintable);

GC::Ref<SVGSVGPaintable> SVGSVGPaintable::create(Layout::SVGSVGBox const& layout_box)
{
    return layout_box.heap().allocate<SVGSVGPaintable>(layout_box);
}

SVGSVGPaintable::SVGSVGPaintable(Layout::SVGSVGBox const& layout_box)
    : PaintableBox(layout_box)
{
}

Layout::SVGSVGBox const& SVGSVGPaintable::layout_box() const
{
    return static_cast<Layout::SVGSVGBox const&>(layout_node());
}

void SVGSVGPaintable::before_children_paint(PaintContext& context, PaintPhase phase) const
{
    PaintableBox::before_children_paint(context, phase);
    if (phase != PaintPhase::Foreground)
        return;
    context.display_list_recorder().push_scroll_frame_id(scroll_frame_id());
}

void SVGSVGPaintable::after_children_paint(PaintContext& context, PaintPhase phase) const
{
    PaintableBox::after_children_paint(context, phase);
    if (phase != PaintPhase::Foreground)
        return;
    context.display_list_recorder().pop_scroll_frame_id();
}

static Gfx::FloatMatrix4x4 matrix_with_scaled_translation(Gfx::FloatMatrix4x4 matrix, float scale)
{
    auto* m = matrix.elements();
    m[0][3] *= scale;
    m[1][3] *= scale;
    m[2][3] *= scale;
    return matrix;
}

void SVGSVGPaintable::paint_svg_box(PaintContext& context, PaintableBox const& svg_box, PaintPhase phase)
{
    auto const& computed_values = svg_box.computed_values();

    auto const& filter = computed_values.filter();
    auto masking_area = svg_box.get_masking_area();

    Gfx::CompositingAndBlendingOperator compositing_and_blending_operator = mix_blend_mode_to_compositing_and_blending_operator(computed_values.mix_blend_mode());

    auto needs_to_save_state = computed_values.isolation() == CSS::Isolation::Isolate || compositing_and_blending_operator != Gfx::CompositingAndBlendingOperator::Normal || svg_box.has_css_transform() || masking_area.has_value();

    if (needs_to_save_state) {
        context.display_list_recorder().save();
    }

    if (computed_values.opacity() < 1) {
        context.display_list_recorder().apply_opacity(computed_values.opacity());
    }

    if (filter.has_value()) {
        context.display_list_recorder().apply_filter(filter.value());
    }

    if (compositing_and_blending_operator != Gfx::CompositingAndBlendingOperator::Normal) {
        context.display_list_recorder().apply_compositing_and_blending_operator(compositing_and_blending_operator);
    }

    if (svg_box.has_css_transform()) {
        auto transform_matrix = svg_box.transform();
        Gfx::FloatPoint transform_origin = svg_box.transform_origin().template to_type<float>();
        auto to_device_pixels_scale = float(context.device_pixels_per_css_pixel());
        context.display_list_recorder().apply_transform(transform_origin.scaled(to_device_pixels_scale), matrix_with_scaled_translation(transform_matrix, to_device_pixels_scale));
    }

    bool skip_painting = false;
    if (masking_area.has_value()) {
        if (masking_area->is_empty()) {
            skip_painting = true;
        } else {
            auto mask_bitmap = svg_box.calculate_mask(context, *masking_area);
            if (mask_bitmap) {
                auto source_paintable_rect = context.enclosing_device_rect(*masking_area).template to_type<int>();
                auto origin = source_paintable_rect.location();
                context.display_list_recorder().apply_mask_bitmap(origin, mask_bitmap.release_nonnull(), *svg_box.get_mask_type());
            }
        }
    }

    if (!skip_painting) {
        svg_box.before_paint(context, PaintPhase::Foreground);
        svg_box.paint(context, PaintPhase::Foreground);
        svg_box.after_paint(context, PaintPhase::Foreground);

        paint_descendants(context, svg_box, phase);
    }

    if (compositing_and_blending_operator != Gfx::CompositingAndBlendingOperator::Normal) {
        context.display_list_recorder().restore();
    }

    if (filter.has_value()) {
        context.display_list_recorder().restore();
    }

    if (computed_values.opacity() < 1) {
        context.display_list_recorder().restore();
    }

    if (needs_to_save_state) {
        context.display_list_recorder().restore();
    }
}

void SVGSVGPaintable::paint_descendants(PaintContext& context, PaintableBox const& paintable, PaintPhase phase)
{
    if (phase != PaintPhase::Foreground)
        return;

    paintable.before_children_paint(context, PaintPhase::Foreground);
    paintable.for_each_child_of_type<PaintableBox>([&](PaintableBox& child) {
        paint_svg_box(context, child, phase);
        return IterationDecision::Continue;
    });
    paintable.after_children_paint(context, PaintPhase::Foreground);
}

}