use std::collections::HashSet;
use super::*;
use crate::layout::assets::{DocumentPageIndex, PendingPositionedFragmentation};
use crate::layout::block::{DirectBlockLayoutConstraint, FloatReplayClearanceBoundary};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(in crate::layout) struct DocumentPrincipalFlow {
pub(in crate::layout) writing_mode: WritingMode,
pub(in crate::layout) direction: Direction,
pub(in crate::layout) text_orientation: TextOrientation,
pub(in crate::layout) source: PrincipalFlowSource,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(in crate::layout) enum PrincipalFlowSource {
Root,
Body(ElementId),
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub(in crate::layout) struct ActiveDocumentCanvas {
pub(in crate::layout) body: Option<ElementId>,
pub(in crate::layout) inline_end_inset: LayoutLength,
pub(in crate::layout) inline_origin: PageTopBlockPosition,
pub(in crate::layout) block_track_occupancy: LayoutLength,
pub(in crate::layout) trailing_child_block_margin: LayoutLength,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub(in crate::layout) struct CompletedDocumentCanvas {
pub(in crate::layout) body: Option<ElementId>,
pub(in crate::layout) source_page: DocumentPageIndex,
pub(in crate::layout) source_block_track: PageInlineSpan,
pub(in crate::layout) inline_origin: PageTopBlockPosition,
pub(in crate::layout) inline_end_inset: LayoutLength,
pub(in crate::layout) block_end_inset: LayoutLength,
pub(in crate::layout) block_track_occupancy: LayoutLength,
pub(in crate::layout) trailing_child_block_margin: LayoutLength,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub(in crate::layout) enum RootInlineCanvasPlacement {
RemainingTrack {
block_track: PageInlineSpan,
inline_origin: PageTopBlockPosition,
},
NextPage {
inline_origin: PageTopBlockPosition,
},
}
#[derive(Debug, Clone, Copy, Default, PartialEq)]
pub(in crate::layout) struct RootPrincipalFlowContext {
pub(in crate::layout) active_canvas: Option<ActiveDocumentCanvas>,
pub(in crate::layout) completed_canvas: Option<CompletedDocumentCanvas>,
pub(in crate::layout) active_root_inline_canvas: Option<CompletedDocumentCanvas>,
}
#[derive(Debug, Clone, Copy, PartialEq)]
pub(in crate::layout) struct RootPseudoBlockProjection {
pub(in crate::layout) element: ElementId,
pub(in crate::layout) block_start: PhysicalSide,
pub(in crate::layout) block_end_inset: LayoutLength,
}
impl DocumentPrincipalFlow {
pub(in crate::layout) fn from_style(style: &ComputedStyle) -> Self {
Self {
writing_mode: style.writing_mode,
direction: style.direction,
text_orientation: style.text_orientation,
source: PrincipalFlowSource::Root,
}
}
pub(in crate::layout) fn is_source_body(self, element: &Element) -> bool {
self.source == PrincipalFlowSource::Body(element.id)
}
pub(in crate::layout) fn has_propagated_body(self) -> bool {
matches!(self.source, PrincipalFlowSource::Body(_))
}
pub(in crate::layout) fn used_direction(self) -> Direction {
if self.writing_mode.has_vertical_lines()
&& self.text_orientation == TextOrientation::Upright
{
Direction::Ltr
} else {
self.direction
}
}
pub(in crate::layout) fn page_progression_direction(self) -> Direction {
match self.writing_mode {
WritingMode::HorizontalTb => self.used_direction(),
WritingMode::VerticalRl | WritingMode::SidewaysRl => Direction::Rtl,
WritingMode::VerticalLr | WritingMode::SidewaysLr => Direction::Ltr,
}
}
pub(in crate::layout) fn root_layout_style(self, root_style: &ComputedStyle) -> ComputedStyle {
let mut used = root_style.clone();
used.writing_mode = self.writing_mode;
used.direction = self.direction;
used.text_orientation = self.text_orientation;
used
}
}
impl CompletedDocumentCanvas {
pub(in crate::layout) fn root_inline_block_track_advance(
self,
axes: WritingModeAxes,
) -> LayoutLength {
match axes.writing_mode() {
WritingMode::SidewaysRl | WritingMode::SidewaysLr => {
self.block_track_occupancy + self.block_end_inset + self.trailing_child_block_margin
}
WritingMode::VerticalRl => {
self.block_track_occupancy + self.trailing_child_block_margin
}
WritingMode::VerticalLr => self.block_track_occupancy + self.block_end_inset,
WritingMode::HorizontalTb => layout_pt(0.0),
}
}
pub(in crate::layout) fn exhausts_root_block_track(
self,
axes: WritingModeAxes,
available_block_track: f32,
) -> bool {
self.root_inline_block_track_advance(axes).points() >= available_block_track - 0.01
}
pub(in crate::layout) fn resolve_root_inline_placement(
self,
axes: WritingModeAxes,
available_block_track: PageInlineSpan,
) -> RootInlineCanvasPlacement {
if self.exhausts_root_block_track(axes, available_block_track.width()) {
RootInlineCanvasPlacement::NextPage {
inline_origin: self.inline_origin,
}
} else {
let advance = self.root_inline_block_track_advance(axes).points();
let block_track = match axes.physical_side(LogicalSide::BlockStart) {
PhysicalSide::Left => PageInlineSpan::from_edges(
available_block_track.left_x() + advance,
available_block_track.right_x(),
),
PhysicalSide::Right => PageInlineSpan::from_edges(
available_block_track.left_x(),
available_block_track.right_x() - advance,
),
PhysicalSide::Top | PhysicalSide::Bottom => {
unreachable!("a vertical principal flow has a horizontal block track")
}
};
RootInlineCanvasPlacement::RemainingTrack {
block_track,
inline_origin: self.inline_origin,
}
}
}
}
#[derive(Debug, Clone, Copy)]
pub(in crate::layout) enum RootMetricState {
Bootstrapping,
Resolved(ResolvedRootFontMetrics),
}
impl RootMetricState {
pub(in crate::layout) const fn font_size_basis(self) -> Option<css::RootFontMetricLengthBasis> {
match self {
Self::Bootstrapping => None,
Self::Resolved(metrics) => Some(metrics.basis()),
}
}
pub(in crate::layout) fn resolved(self) -> ResolvedRootFontMetrics {
match self {
Self::Bootstrapping => {
unreachable!("the document root must establish font metrics before descendants")
}
Self::Resolved(metrics) => metrics,
}
}
pub(in crate::layout) fn establish(&mut self, metrics: ResolvedRootFontMetrics) {
debug_assert!(matches!(self, Self::Bootstrapping));
*self = Self::Resolved(metrics);
}
}
#[derive(Debug, Clone, Copy)]
pub(in crate::layout) struct ResolvedRootFontMetrics(css::RootFontMetricLengthBasis);
impl ResolvedRootFontMetrics {
pub(in crate::layout) const fn measured_for_document_root(
basis: css::RootFontMetricLengthBasis,
) -> Self {
Self(basis)
}
pub(in crate::layout) const fn basis(self) -> css::RootFontMetricLengthBasis {
self.0
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(in crate::layout) enum LayoutPassKind {
Normal,
PositionedAutoSizeMeasurement,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(in crate::layout) enum LayoutExecutionPurpose {
Committed,
Speculative,
}
pub(in crate::layout) struct LayoutBuilder<'a> {
pub(in crate::layout) options: &'a RenderOptions,
pub(in crate::layout) stylesheets: Stylesheets<'a>,
pub(in crate::layout) base_url: Option<&'a url::Url>,
pub(in crate::layout) root_url: Option<&'a url::Url>,
pub(in crate::layout) resource_cache: &'a ResourceCache,
pub(in crate::layout) iframe_documents: &'a HashMap<crate::dom::ElementId, Document>,
pub(in crate::layout) iframe_viewport: Option<IframeEmbeddingContext>,
pub(in crate::layout) pages: Vec<Page>,
pub(in crate::layout) page_names: Vec<Option<String>>,
pub(in crate::layout) page_blanks: Vec<bool>,
pub(in crate::layout) page_name_scope_suppression: usize,
pub(in crate::layout) page_name_element_scope_suppression: usize,
pub(in crate::layout) page_value_scope_stack: Vec<Option<String>>,
pub(in crate::layout) page_named_strings: Vec<HashMap<String, Vec<NamedStringAssignment>>>,
pub(in crate::layout) page_running_elements: Vec<HashMap<String, Vec<NamedStringAssignment>>>,
pub(in crate::layout) suppressed_named_strings_before:
HashMap<ElementId, Vec<box_tree::SuppressedNamedStringEvent>>,
pub(in crate::layout) suppressed_named_strings_after:
HashMap<ElementId, Vec<box_tree::SuppressedNamedStringEvent>>,
pub(in crate::layout) page_anchors: HashMap<String, usize>,
pub(in crate::layout) page_anchor_source_positions: HashMap<String, PaintPoint>,
pub(in crate::layout) page_anchor_text: HashMap<String, AnchorText>,
pub(in crate::layout) page_anchor_counters: HashMap<String, HashMap<String, Vec<i32>>>,
pub(in crate::layout) target_references: TargetReferenceSnapshot,
pub(in crate::layout) has_normal_flow_target_references: bool,
pub(in crate::layout) document_canvas_background: Option<DocumentCanvasBackground>,
pub(in crate::layout) document_canvas_scroll_translation: PaintTranslation,
pub(in crate::layout) document_canvas_root_positioning_area: Option<PaintBackgroundArea>,
pub(in crate::layout) document_canvas_overflow: DocumentCanvasResolution,
pub(in crate::layout) document_canvas_fragment_insets: Vec<FragmentOffsets>,
pub(in crate::layout) document_root_generates_box: bool,
pub(in crate::layout) current_page: Page,
pub(in crate::layout) current_page_has_flow_content: bool,
pub(in crate::layout) current_page_has_named_page_flow_content: bool,
pub(in crate::layout) current_page_selected_name: Option<String>,
pub(in crate::layout) last_block_layout_outcome: BlockLayoutOutcome,
pub(in crate::layout) last_principal_transform_box: Option<assets::TransformReferenceBox>,
pub(in crate::layout) preserve_3d_context_depth: usize,
pub(in crate::layout) current_page_name: Option<String>,
pub(in crate::layout) current_page_context: PageContext,
pub(in crate::layout) initial_viewport_context: PageContext,
pub(in crate::layout) page_descriptor_viewport_size: PageSize,
pub(in crate::layout) fragmentainer_override: Option<FragmentainerOverride>,
pub(in crate::layout) footnote_bodies: HashMap<ElementId, box_tree::FootnoteBox<'a>>,
pub(in crate::layout) ruby_formatting_descendants: HashMap<ElementId, bool>,
pub(in crate::layout) dom_page_boundary_summaries:
HashMap<(ElementId, Option<String>), (ResolvedPageBoundaryValues, PageBoundaryValues)>,
pub(in crate::layout) speculative_table_height_estimates:
HashMap<TableHeightEstimateCacheKey, f32>,
pub(in crate::layout) speculative_table_height_plans:
HashMap<TableHeightPlanCacheKey, table::TableHeightPlan>,
pub(in crate::layout) footnote_measurements: Vec<FootnoteMeasurement>,
pub(in crate::layout) rendered_footnote_measurements: Vec<FootnoteMeasurement>,
pub(in crate::layout) measured_footnotes: HashSet<ElementId>,
pub(in crate::layout) committed_inline_floats: HashMap<InlineFloatId, CommittedInlineFloat>,
pub(in crate::layout) footnote_reservations: HashMap<usize, f32>,
pub(in crate::layout) footnote_call_minimum_page_indices: HashMap<ElementId, usize>,
pub(in crate::layout) footnote_layout_mode: FootnoteLayoutMode,
pub(in crate::layout) footnote_measurement_depth: usize,
pub(in crate::layout) rendered_footnotes: HashSet<ElementId>,
pub(in crate::layout) pending_page_footnotes: Vec<ElementId>,
pub(in crate::layout) fragmentation_suppression_depth: usize,
pub(in crate::layout) multicol_spanner_fragmentation_depth: usize,
pub(in crate::layout) multicol_spanner_speculation_depth: usize,
pub(in crate::layout) multicol_balance_probe_depth: usize,
pub(in crate::layout) speculative_auto_float_margin_box_heights:
HashMap<AutoFloatMeasurementKey, MarginBoxLength>,
pub(in crate::layout) active_auto_float_measurements: Vec<ElementId>,
pub(in crate::layout) active_auto_float_measurement_fallbacks: Vec<ElementId>,
pub(in crate::layout) inherited_adjoining_start_margins: InheritedAdjoiningStartMarginScopes,
pub(in crate::layout) float_replay_clearance_scopes: Vec<Option<FloatReplayClearanceBoundary>>,
pub(in crate::layout) cursor_y: f32,
pub(in crate::layout) content_left: f32,
pub(in crate::layout) content_right: f32,
pub(in crate::layout) table_cell_content_coordinate_contexts:
Vec<table::TableCellContentCoordinateContext>,
pub(in crate::layout) principal_inline_end_inset: f32,
pub(in crate::layout) principal_body_block_end_inset: LayoutLength,
pub(in crate::layout) root_pseudo_block_projection: Option<RootPseudoBlockProjection>,
pub(in crate::layout) direct_block_layout_constraint: Option<DirectBlockLayoutConstraint>,
pub(in crate::layout) replayed_float_logical_inline_size: Option<LogicalInlineContentSize>,
pub(in crate::layout) inline_split_float_exclusion_query_offset: RelativeOffset,
pub(in crate::layout) content_logical_inline_size_stack: Vec<f32>,
pub(in crate::layout) container_unit_contexts: Vec<ContainerUnitContext>,
pub(in crate::layout) multicol_column_containing_blocks: Vec<MulticolColumnContainingBlock>,
pub(in crate::layout) intrinsic_inline_percentage_basis_stack:
Vec<IntrinsicInlinePercentageBasis>,
pub(in crate::layout) inline_static_position: Option<StaticPositionCapture>,
pub(in crate::layout) text_box_line_trim_stack: Vec<TextBoxLineTrim>,
pub(in crate::layout) clamp_line_slot_captures: Vec<ClampLineSlotCapture>,
pub(in crate::layout) positioned_inline_layout_suppression_depth: usize,
pub(in crate::layout) last_in_flow_line_baseline_y: Option<f32>,
pub(in crate::layout) pending_outside_marker_anchors: PendingOutsideMarkerAnchors,
pub(in crate::layout) block_static_position_y_offset: Option<f32>,
pub(in crate::layout) absolute_static_position: Option<AbsoluteStaticPosition>,
pub(in crate::layout) grid_positioning_scopes: Vec<grid::GridPositioningScope>,
pub(in crate::layout) pending_subgrid_contexts: Vec<Option<grid::ResolvedSubgridContext>>,
pub(in crate::layout) escaped_atom_positioning_depth: usize,
pub(in crate::layout) active_atomic_inline_coordinate_spaces:
Vec<AtomicInlineCoordinateSpaceId>,
pub(in crate::layout) next_atomic_inline_coordinate_space_id: u64,
pub(in crate::layout) escaped_atom_positioning_context: Option<EscapedAtomPositioningContext>,
pub(in crate::layout) containing_block_direction: Direction,
pub(in crate::layout) containing_block_writing_mode: WritingMode,
pub(in crate::layout) initial_containing_block_writing_mode: WritingMode,
pub(in crate::layout) principal_flow: DocumentPrincipalFlow,
pub(in crate::layout) root_principal_flow_context: RootPrincipalFlowContext,
pub(in crate::layout) fragmentainer_transition_recorders: Vec<FragmentainerTransitionRecorder>,
pub(in crate::layout) fragment_top_offsets: Vec<FragmentTopOffset>,
pub(in crate::layout) child_available_space_stack: Vec<ChildAvailableSpace>,
pub(in crate::layout) normal_flow_relative_containing_blocks:
Vec<NormalFlowRelativeContainingBlock>,
pub(in crate::layout) static_position_containing_blocks: Vec<StaticPositionContainingBlock>,
pub(in crate::layout) block_percentage_context_stack: BlockPercentageContextStack,
pub(in crate::layout) replayed_flex_item_percentage_height_bases:
Vec<Option<BlockSizePercentageBasis>>,
pub(in crate::layout) table_wrapper_block_size_overrides: Vec<Option<BorderBoxLength>>,
pub(in crate::layout) positioned_table_sizing: Vec<Option<PositionedTableSizing>>,
pub(in crate::layout) truncate_page_start_margins: bool,
pub(in crate::layout) avoid_inside_retry_depth: usize,
pub(in crate::layout) out_of_flow_prebreak_suppression_depth: usize,
pub(in crate::layout) layout_pass_kind: LayoutPassKind,
pub(in crate::layout) execution_purpose: LayoutExecutionPurpose,
pub(in crate::layout) element_side_effect_suppression_depth: usize,
pub(in crate::layout) positioned_generated_source: Option<InlineStaticPositionSourceId>,
pub(in crate::layout) containing_blocks: Vec<PositionedContainingBlockContext>,
pub(in crate::layout) fixed_containing_blocks: Vec<PositionedContainingBlockContext>,
pub(in crate::layout) multicol_text_box_trim_end_child_indices: Option<Vec<usize>>,
pub(in crate::layout) counter_set: CounterSet,
pub(in crate::layout) counter_plan: CounterPlan,
pub(in crate::layout) quote_depth: usize,
pub(in crate::layout) current_page_named_strings: HashMap<String, Vec<NamedStringAssignment>>,
pub(in crate::layout) current_page_running_elements:
HashMap<String, Vec<NamedStringAssignment>>,
pub(in crate::layout) next_assignment_id: usize,
pub(in crate::layout) assignment_capture_stack: Vec<Vec<AssignmentId>>,
pub(in crate::layout) ancestors: Vec<ElementSignature>,
pub(in crate::layout) page_counter_initial_values: HashMap<String, i32>,
pub(in crate::layout) page_rules: Vec<PageRule>,
pub(in crate::layout) page_progression_direction: Direction,
pub(in crate::layout) page_margin_inherited_style: ComputedStyle,
pub(in crate::layout) page_declarations: Declarations,
pub(in crate::layout) counter_styles: HashMap<String, CounterStyleRule>,
pub(in crate::layout) first_page_declarations: Declarations,
pub(in crate::layout) root_metric_state: RootMetricState,
pub(in crate::layout) root_metrics_require_selected_font: bool,
pub(in crate::layout) font_system: Box<FontSystem>,
pub(in crate::layout) autospace_items_scratch: Vec<InlineItem>,
pub(in crate::layout) bookmarks: Vec<Bookmark>,
pub(in crate::layout) positioned_layers: Vec<PositionedPaintLayer>,
pub(in crate::layout) committed_positioned_paint_identities:
HashSet<(DocumentPageIndex, PositionedPaintCommitKey)>,
pub(in crate::layout) positioned_paint_transaction_depth: usize,
pub(in crate::layout) positioned_scratch_page_limit: Option<usize>,
pub(in crate::layout) positioned_scratch_page_origin: Option<DocumentPageIndex>,
pub(in crate::layout) fixed_layers: Vec<FixedPaintLayer>,
pub(in crate::layout) deferred_multicol_positioned_children:
Vec<DeferredMulticolPositionedChild>,
pub(in crate::layout) multicol_positioned_containing_block_spans:
Vec<MulticolPositionedContainingBlockSpan>,
pub(in crate::layout) next_multicol_positioned_containing_block_span_id: u64,
pub(in crate::layout) active_multicol_positioned_containing_block_spans: Vec<u64>,
pub(in crate::layout) multicol_positioned_replay_capture_depth: usize,
pub(in crate::layout) absolute_positioned_page_span_target: Option<usize>,
pub(in crate::layout) pending_positioned_fragmentation: PendingPositionedFragmentation,
pub(in crate::layout) next_paint_source_order: usize,
pub(in crate::layout) overflow_clips: Vec<OverflowClip>,
pub(in crate::layout) active_scroll_snap_scopes: Vec<scroll_snap::ActiveScrollSnapScope>,
pub(in crate::layout) next_float_id: usize,
pub(in crate::layout) float_contexts: Vec<FloatContext>,
pub(in crate::layout) float_fragment_parent_inline_spans: Vec<PageInlineSpan>,
pub(in crate::layout) adjoining_float_origin_y: Option<f32>,
pub(in crate::layout) pending_paint_fragments: Vec<PendingPaintFragment>,
pub(in crate::layout) pending_page_side_effects: Vec<PendingPageSideEffects>,
pub(in crate::layout) float_paint_capture_depth: usize,
pub(in crate::layout) preserve_scoped_paint_public_order: bool,
pub(in crate::layout) defer_next_block_decoration_promotion: bool,
}
pub(in crate::layout) struct LayoutBuilderConfig<'a> {
pub(in crate::layout) options: &'a RenderOptions,
pub(in crate::layout) stylesheets: Stylesheets<'a>,
pub(in crate::layout) base_url: Option<&'a url::Url>,
pub(in crate::layout) root_url: Option<&'a url::Url>,
pub(in crate::layout) resource_cache: &'a ResourceCache,
pub(in crate::layout) iframe_documents: &'a HashMap<crate::dom::ElementId, Document>,
pub(in crate::layout) iframe_viewport: Option<IframeEmbeddingContext>,
pub(in crate::layout) page_progression_direction: Direction,
pub(in crate::layout) page_counter_initial_values: HashMap<String, i32>,
pub(in crate::layout) target_references: TargetReferenceSnapshot,
pub(in crate::layout) font_system: FontSystem,
}