Luce packages
LuceLuce BaseLuciaOS

dymokomi/luce-browser-engine

Source of release 0.6.0

0.6.0 / src / web / painting / viewport_paintable_1.lucb

#==============================================================================================
#
#   viewport_paintable_1 - Painting::ViewportPaintable: the root of the paint tree
#
#   DESCRIPTION:
#       Port of LibWeb/Painting/ViewportPaintable.cpp (lines 1-174) and ViewportPaintable.h:
#       creation and relayout reset, the stacking context tree (built on demand over the
#       paintable boxes in tree order), painting every phase into a display list, and the
#       assignment of scroll frames (with the sticky constraints of sticky boxes).
#
#       Copyright (c) 2023, Andreas Kling <andreas@ladybird.org>
#       Copyright (c) 2024-2026, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
#       SPDX-License-Identifier: BSD-2-Clause
#
#==============================================================================================

# mark: ViewportPaintable.h =======================================================================

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:37 Web::Painting::ViewportPaintable::set_needs_to_refresh_scroll_state.
pub func paint_viewport_paintable_set_needs_to_refresh_scroll_state(this: PaintViewportPaintable*, value: bool):
    this.m_needs_to_refresh_scroll_state = value

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:39 Web::Painting::ViewportPaintable::scroll_state.
pub func paint_viewport_paintable_scroll_state(this: PaintViewportPaintable*) -> display_list.ScrollState:
    return this.m_scroll_state

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:40 Web::Painting::ViewportPaintable::scroll_state_snapshot.
pub func paint_viewport_paintable_scroll_state_snapshot(this: PaintViewportPaintable*) -> display_list.ScrollStateSnapshot:
    return this.m_scroll_state_snapshot

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:42 Web::Painting::ViewportPaintable::set_paintable_boxes_with_auto_content_visibility.
pub func paint_viewport_paintable_set_paintable_boxes_with_auto_content_visibility(this: PaintViewportPaintable*, paintable_boxes: ak.Vector[PaintPaintableBox*]):
    this.m_paintable_boxes_with_auto_content_visibility = paintable_boxes

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:43 Web::Painting::ViewportPaintable::paintable_boxes_with_auto_content_visibility.
pub func paint_viewport_paintable_paintable_boxes_with_auto_content_visibility(this: PaintViewportPaintable*) -> const (PaintPaintableBox*)[]:
    return ak.vector_span_const(&this.m_paintable_boxes_with_auto_content_visibility)

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:45 Web::Painting::ViewportPaintable::visual_context_tree.
pub func paint_viewport_paintable_visual_context_tree_const(this: PaintViewportPaintable*) -> display_list.AccumulatedVisualContextTree:
    let tree = this.m_visual_context_tree else trap("VERIFY: no visual context tree")
    return *tree

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:50 Web::Painting::ViewportPaintable::visual_context_tree.
pub func paint_viewport_paintable_visual_context_tree(this: PaintViewportPaintable*) -> display_list.AccumulatedVisualContextTree*:
    return this.m_visual_context_tree else trap("VERIFY: no visual context tree")

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.h:57 Web::Painting::ViewportPaintable::is_viewport_paintable (override).
pub func paint_viewport_paintable_is_viewport_paintable_impl(base: PaintPaintable*) -> bool:
    _ = base
    return true

# mark: Creation ===================================================================================

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:27 Web::Painting::ViewportPaintable::create.
pub func paint_viewport_paintable_create(layout_viewport: LayoutViewport*) -> PaintViewportPaintable*:
    let heap = gc.cell_heap(layout_viewport.cell())
    let this = (PaintViewportPaintable*)web_heap_allocate_cell(heap, &paint_viewport_paintable_class)
    gc.heap_defer_gc(heap)
    paint_viewport_paintable_construct(this, layout_viewport)
    gc.heap_undefer_gc(heap)
    return this

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:32 Web::Painting::ViewportPaintable::ViewportPaintable,
## with the default member initializers.
pub func paint_viewport_paintable_construct(this: PaintViewportPaintable*, layout_viewport: LayoutViewport*):
    paint_paintable_with_lines_construct_layout_block_container(this.paint_paintable_with_lines(), layout_viewport.layout_block_container())
    display_list.scroll_state_construct(&this.m_scroll_state)
    paint_viewport_paintable_init_fields(this)

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:39 Web::Painting::ViewportPaintable::reset_for_relayout (override).
pub func paint_viewport_paintable_reset_for_relayout_impl(base: PaintPaintableBox*):
    let this = (PaintViewportPaintable*)base
    paint_paintable_with_lines_reset_for_relayout_impl(base)
    display_list.scroll_state_clear(&this.m_scroll_state)
    this.m_scroll_state_snapshot = display_list.ScrollStateSnapshot()
    this.m_needs_to_refresh_scroll_state = true
    ak.vector_clear(&this.m_paintable_boxes_with_auto_content_visibility)
    this.m_visual_context_tree = none
    this.m_visual_viewport_context_index = 0

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:590 Web::Painting::ViewportPaintable::visit_edges (override).
pub func paint_viewport_paintable_visit_edges_impl(base: gc.Cell*, visitor: gc.CellVisitor*):
    let this = (PaintViewportPaintable*)base
    paint_paintable_with_lines_visit_edges_impl(base, visitor)
    gc.cell_visitor_visit_vector(visitor, &this.m_paintable_boxes_with_auto_content_visibility)

# mark: The stacking context tree ==================================================================

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:50 Web::Painting::ViewportPaintable::build_stacking_context_tree_if_needed.
pub func paint_viewport_paintable_build_stacking_context_tree_if_needed(this: PaintViewportPaintable*):
    if paint_paintable_box_stacking_context(this.paint_paintable_box()) != none:
        return
    paint_viewport_paintable_build_stacking_context_tree(this)

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:57 Web::Painting::ViewportPaintable::build_stacking_context_tree.
func paint_viewport_paintable_build_stacking_context_tree(this: PaintViewportPaintable*):
    let heap = gc.cell_heap(this.cell())
    paint_paintable_box_set_stacking_context(this.paint_paintable_box(), paint_stacking_context_create(heap, this.paint_paintable_box(), none, 0))

    var index_in_tree_order: usize = 1
    # for_each_in_subtree_of_type<PaintableBox>
    for paintable in paint_paintable_subtree(this.paint_paintable()):
        let paintable_box = as_if_paint_paintable_box(paintable) else continue
        paint_paintable_box_invalidate_stacking_context(paintable_box)
        let parent_context = paint_paintable_enclosing_stacking_context(paintable) else trap("VERIFY: no enclosing stacking context")
        let establishes_stacking_context = layout_node_establishes_stacking_context(paint_paintable_layout_node(paintable))
        if (paint_paintable_is_positioned(paintable) or establishes_stacking_context) and (paint_paintable_box_effective_z_index(paintable_box) else 0) == 0:
            ak.vector_append_t(&parent_context.m_positioned_descendants_and_stacking_contexts_with_stack_level_0, paintable_box)
        if not paint_paintable_is_positioned(paintable) and paint_paintable_is_floating(paintable):
            ak.vector_append_t(&parent_context.m_non_positioned_floating_descendants, paintable_box)
        if not establishes_stacking_context:
            assert(paint_paintable_box_stacking_context(paintable_box) == none)
            continue
        paint_paintable_box_set_stacking_context(paintable_box, paint_stacking_context_create(heap, paintable_box, parent_context, index_in_tree_order))
        index_in_tree_order += 1

    let stacking_context = paint_paintable_box_stacking_context(this.paint_paintable_box()) else trap("unreachable: set above")
    paint_stacking_context_sort(stacking_context)

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:80 Web::Painting::ViewportPaintable::paint_all_phases.
pub func paint_viewport_paintable_paint_all_phases(this: PaintViewportPaintable*, context: DisplayListRecordingContext*):
    paint_viewport_paintable_build_stacking_context_tree_if_needed(this)
    let recorder = display_list_recording_context_display_list_recorder(context)
    display_list.display_list_recorder_save_layer(recorder)
    let stacking_context = paint_paintable_box_stacking_context(this.paint_paintable_box()) else trap("the viewport has no stacking context")
    paint_stacking_context_paint(stacking_context, context)
    display_list.display_list_recorder_restore(recorder)

# mark: Scroll frames ==============================================================================

## The `precompute_sticky_constraints` lambda of ViewportPaintable::assign_scroll_frames.
func paint_viewport_paintable_precompute_sticky_constraints(this: PaintViewportPaintable*, sticky_frame_index: u64, paintable_box: PaintPaintableBox*):
    let nearest_scrolling_ancestor_index = display_list.scroll_state_nearest_scrolling_ancestor(&this.m_scroll_state, sticky_frame_index)
    if nearest_scrolling_ancestor_index == 0:
        return

    let scroll_ancestor_paintable = scroll_frame_paintable_box(display_list.scroll_state_frame_at(&this.m_scroll_state, nearest_scrolling_ancestor_index))
    let sticky_border_box_rect = paint_paintable_box_absolute_border_box_rect(paintable_box)
    let containing_block_of_sticky = paint_paintable_containing_block(paintable_box.paint_paintable()) else trap("a sticky box without a containing block")
    let scroll_ancestor_rect = paint_paintable_box_absolute_rect(scroll_ancestor_paintable)
    let scroll_ancestor_top_left = gfx.css_pixel_rect_top_left(&scroll_ancestor_rect)

    var containing_block_region = gfx.CssPixelRect()
    var needs_parent_offset_adjustment = false
    if containing_block_of_sticky == scroll_ancestor_paintable:
        let overflow_rect = paint_paintable_box_scrollable_overflow_rect(containing_block_of_sticky) else trap("the scroll ancestor has no scrollable overflow rect")
        containing_block_region = gfx.CssPixelRect(gfx.CssPixelPoint(), gfx.css_pixel_rect_size(&overflow_rect))
    else:
        let containing_border_box_rect = paint_paintable_box_absolute_border_box_rect(containing_block_of_sticky)
        containing_block_region = gfx.css_pixel_rect_translated_css_pixel_point(&containing_border_box_rect, gfx.css_pixel_point_neg(&scroll_ancestor_top_left))
        needs_parent_offset_adjustment = true

    let sticky_top_left = gfx.css_pixel_rect_top_left(&sticky_border_box_rect)
    display_list.scroll_frame_set_sticky_constraints(display_list.scroll_state_frame_at(&this.m_scroll_state, sticky_frame_index), display_list.StickyConstraints(
        position_relative_to_scroll_ancestor = gfx.css_pixel_point_sub(&sticky_top_left, scroll_ancestor_top_left),
        border_box_size = gfx.css_pixel_rect_size(&sticky_border_box_rect),
        scrollport_size = gfx.css_pixel_rect_size(&scroll_ancestor_rect),
        containing_block_region = containing_block_region,
        needs_parent_offset_adjustment = needs_parent_offset_adjustment,
        insets = paint_paintable_box_sticky_insets(paintable_box),
    ))

## Ported from Libraries/LibWeb/Painting/ViewportPaintable.cpp:88 Web::Painting::ViewportPaintable::assign_scroll_frames.
pub func paint_viewport_paintable_assign_scroll_frames(this: PaintViewportPaintable*):
    # for_each_in_inclusive_subtree_of_type<PaintableBox>
    for paintable in paint_paintable_inclusive_subtree(this.paint_paintable()):
        let paintable_box = as_if_paint_paintable_box(paintable) else continue
        var sticky_scroll_frame_index: u64 = 0
        if paint_paintable_is_sticky_position(paintable):
            let parent_index = paint_paintable_box_nearest_scroll_frame_index(paintable_box)
            sticky_scroll_frame_index = scroll_state_create_sticky_frame_for(&this.m_scroll_state, paintable_box, parent_index)
            paint_viewport_paintable_precompute_sticky_constraints(this, sticky_scroll_frame_index, paintable_box)
            paint_paintable_box_set_enclosing_scroll_frame_index(paintable_box, sticky_scroll_frame_index)
            paint_paintable_box_set_own_scroll_frame_index(paintable_box, sticky_scroll_frame_index)

        if paint_paintable_box_has_scrollable_overflow(paintable_box) or is_paint_viewport_paintable(paintable):
            var parent_index: u64 = 0
            if sticky_scroll_frame_index != 0:
                parent_index = sticky_scroll_frame_index
            else:
                parent_index = paint_paintable_box_nearest_scroll_frame_index(paintable_box)
            let scroll_frame_index = scroll_state_create_scroll_frame_for(&this.m_scroll_state, paintable_box, parent_index)
            paint_paintable_box_set_own_scroll_frame_index(paintable_box, scroll_frame_index)

    # for_each_in_subtree
    for paintable in paint_paintable_subtree(this.paint_paintable()):
        if paint_paintable_is_fixed_position(paintable) or paint_paintable_is_sticky_position(paintable):
            continue

        var found = false
        var block_or_none = paint_paintable_containing_block(paintable)
        while let block = block_or_none:
            let index = paint_paintable_box_own_scroll_frame_index(block)
            if index != 0:
                if let paintable_box = as_if_paint_paintable_box(paintable):
                    paint_paintable_box_set_enclosing_scroll_frame_index(paintable_box, index)
                found = true
                break
            if paint_paintable_is_fixed_position(block.paint_paintable()):
                found = true
                break
            block_or_none = paint_paintable_containing_block(block.paint_paintable())
        if not found:
            trap("VERIFY_NOT_REACHED")