cranpose_app_shell/

shell_frame.rs

use super::*;

const DEV_OVERLAY_PADDING: f32 = 8.0;
const DEV_OVERLAY_FONT_SIZE: f32 = 14.0;
const DEV_OVERLAY_CHAR_WIDTH: f32 = 7.0;
const DEV_OVERLAY_SEPARATOR: &str = " | ";
const DEV_OVERLAY_REFRESH_INTERVAL: std::time::Duration = std::time::Duration::from_millis(250);
const DEFAULT_FRAME_STAGE_TELEMETRY_THRESHOLD_MS: f64 = 4.0;

#[derive(Copy, Clone)]
enum DispatchInvalidationKind {
    Pointer,
    Focus,
}

fn frame_stage_telemetry_threshold_ms() -> Option<f64> {
    static THRESHOLD_MS: std::sync::OnceLock<Option<f64>> = std::sync::OnceLock::new();
    *THRESHOLD_MS.get_or_init(|| {
        let explicit = std::env::var("CRANPOSE_FRAME_STAGE_TELEMETRY_MS")
            .ok()
            .and_then(|value| value.parse::<f64>().ok())
            .filter(|value| value.is_finite() && *value >= 0.0);
        explicit.or_else(|| {
            std::env::var_os("CRANPOSE_FRAME_STAGE_TELEMETRY")
                .is_some()
                .then_some(DEFAULT_FRAME_STAGE_TELEMETRY_THRESHOLD_MS)
        })
    })
}

/// The stages of a frame that its telemetry times: start, initial layout,
/// post-layout recomposition, dispatch and render.
type FrameStages = cranpose_core::StageTimes<5>;

fn log_frame_stage_telemetry(stages: &FrameStages) {
    let Some(threshold_ms) = frame_stage_telemetry_threshold_ms() else {
        return;
    };
    let Some(
        [
            frame_start,
            after_initial_layout,
            after_layout,
            after_dispatch,
            after_render,
        ],
    ) = stages.times()
    else {
        return;
    };
    let ms = cranpose_core::stage_ms;
    let total_ms = ms(frame_start, after_render);
    if total_ms < threshold_ms {
        return;
    }
    log::warn!(
        "[frame-stage-telemetry] total_ms={total_ms:.2} layout_ms={:.2} initial_layout_ms={:.2} post_layout_ms={:.2} dispatch_ms={:.2} scene_ms={:.2}",
        ms(frame_start, after_layout),
        ms(frame_start, after_initial_layout),
        ms(after_initial_layout, after_layout),
        ms(after_layout, after_dispatch),
        ms(after_dispatch, after_render),
    );
}

fn render_phase_dirty_diagnostics_enabled() -> bool {
    cranpose_core::env_flag!("CRANPOSE_RENDER_PHASE_DIRTY_DIAG")
}

struct RenderPhaseDirtyDiagnostics<'a> {
    render_dirty: bool,
    pointer_dirty: bool,
    scene_dirty: bool,
    draw_repass_pending: bool,
    draw_dirty_nodes: usize,
    layer_property_nodes: usize,
    layout_dirty_nodes: usize,
    moved_nodes: usize,
    structural_dirty_nodes: usize,
    partial_dirty_nodes: usize,
    dirty_node_ids: Option<String>,
    render_only_dirty: bool,
    recomposed_this_frame: bool,
    path: &'a str,
}

fn log_render_phase_dirty_diagnostics(diagnostics: RenderPhaseDirtyDiagnostics<'_>) {
    if !render_phase_dirty_diagnostics_enabled() {
        return;
    }

    let RenderPhaseDirtyDiagnostics {
        render_dirty,
        pointer_dirty,
        scene_dirty,
        draw_repass_pending,
        draw_dirty_nodes,
        layer_property_nodes,
        layout_dirty_nodes,
        moved_nodes,
        structural_dirty_nodes,
        partial_dirty_nodes,
        dirty_node_ids,
        render_only_dirty,
        recomposed_this_frame,
        path,
    } = diagnostics;
    if let Some(dirty_node_ids) = dirty_node_ids {
        log::warn!(
            "[render-phase-dirty] path={path} render_dirty={render_dirty} pointer_dirty={pointer_dirty} scene_dirty={scene_dirty} draw_repass_pending={draw_repass_pending} draw_dirty_nodes={draw_dirty_nodes} layer_property_nodes={layer_property_nodes} layout_dirty_nodes={layout_dirty_nodes} moved_nodes={moved_nodes} structural_dirty_nodes={structural_dirty_nodes} partial_dirty_nodes={partial_dirty_nodes} render_only_dirty={render_only_dirty} recomposed_this_frame={recomposed_this_frame} ids={dirty_node_ids}",
        );
    } else {
        log::warn!(
            "[render-phase-dirty] path={path} render_dirty={render_dirty} pointer_dirty={pointer_dirty} scene_dirty={scene_dirty} draw_repass_pending={draw_repass_pending} draw_dirty_nodes={draw_dirty_nodes} layer_property_nodes={layer_property_nodes} layout_dirty_nodes={layout_dirty_nodes} moved_nodes={moved_nodes} structural_dirty_nodes={structural_dirty_nodes} partial_dirty_nodes={partial_dirty_nodes} render_only_dirty={render_only_dirty} recomposed_this_frame={recomposed_this_frame}",
        );
    }
}

#[derive(Clone, Copy)]
struct FrameDirt {
    render_dirty: bool,
    pointer_dirty: bool,
    attributed: bool,
    layer_properties_pending: bool,
    recomposed_this_frame: bool,
}

struct SurfaceDirt {
    draw_dirty_nodes: Vec<NodeId>,
    layer_property_nodes: Vec<NodeId>,
    layout_dirty_nodes: Vec<NodeId>,
    moved_nodes: Vec<NodeId>,
    structural_parents: Vec<NodeId>,
    partial_dirty_nodes: Vec<NodeId>,
    draw_repass_pending: bool,
    render_only_dirty: bool,
    visual_only_partial_dirty: bool,
    full_scene_dirty: bool,
    needs_scene_rebuild: bool,
}

struct ScopedVisualNodes {
    draw: Vec<NodeId>,
    layers: Vec<NodeId>,
}

impl SurfaceDirt {
    fn classify(
        frame: &FrameDirt,
        scene_dirty: bool,
        draw_repass_pending: bool,
        visual_nodes: ScopedVisualNodes,
        layout: cranpose_ui::GeometrySceneNodes,
        structural_parents: Vec<NodeId>,
        mut partial_dirty_nodes: Vec<NodeId>,
    ) -> Self {
        let ScopedVisualNodes {
            draw: draw_dirty_nodes,
            layers: layer_property_nodes,
        } = visual_nodes;
        let cranpose_ui::GeometrySceneNodes {
            reshaped: layout_dirty_nodes,
            moved: moved_nodes,
        } = layout;
        let structural_dirty = !structural_parents.is_empty();
        partial_dirty_nodes.clear();
        partial_dirty_nodes.extend(draw_dirty_nodes.iter().copied());
        partial_dirty_nodes.extend(layout_dirty_nodes.iter().copied());
        partial_dirty_nodes.extend(structural_parents.iter().copied());
        partial_dirty_nodes.sort_unstable();
        partial_dirty_nodes.dedup();

        // Moved nodes are not part of the partial list: the scene moves them.
        let layout_changed = !layout_dirty_nodes.is_empty() || !moved_nodes.is_empty();
        let partial_scene_dirty = !partial_dirty_nodes.is_empty() || !moved_nodes.is_empty();
        let render_only_dirty = frame.render_dirty
            && !frame.attributed
            && !partial_scene_dirty
            && layer_property_nodes.is_empty()
            && !draw_repass_pending
            && !structural_dirty;
        let visual_only_partial_dirty = (!draw_dirty_nodes.is_empty()
            || !layer_property_nodes.is_empty())
            && !layout_changed
            && !frame.pointer_dirty
            && !frame.recomposed_this_frame
            && !structural_dirty;
        let scoped_scene_dirty = scene_dirty && layout_changed;
        let full_scene_dirty = scene_dirty && !scoped_scene_dirty && !visual_only_partial_dirty;
        // A scoped scene change always has nodes, so `partial_scene_dirty`
        // covers it.
        let needs_scene_rebuild = full_scene_dirty
            || partial_scene_dirty
            || !layer_property_nodes.is_empty()
            || draw_repass_pending
            || structural_dirty;
        Self {
            draw_dirty_nodes,
            layer_property_nodes,
            layout_dirty_nodes,
            moved_nodes,
            structural_parents,
            partial_dirty_nodes,
            draw_repass_pending,
            render_only_dirty,
            visual_only_partial_dirty,
            full_scene_dirty,
            needs_scene_rebuild,
        }
    }

    fn use_partial_update(&self) -> bool {
        (!self.partial_dirty_nodes.is_empty()
            || !self.layer_property_nodes.is_empty()
            || !self.moved_nodes.is_empty())
            && !self.render_only_dirty
            && !self.full_scene_dirty
    }

    fn use_visual_update(&self) -> bool {
        self.use_partial_update() && self.visual_only_partial_dirty
    }

    fn rebuild_path(&self) -> &'static str {
        if self.use_visual_update() {
            "visual-update"
        } else if self.use_partial_update() {
            "update"
        } else {
            "rebuild"
        }
    }

    fn log(&self, frame: &FrameDirt, scene_dirty: bool, path: &str) {
        log_render_phase_dirty_diagnostics(RenderPhaseDirtyDiagnostics {
            render_dirty: frame.render_dirty,
            pointer_dirty: frame.pointer_dirty,
            scene_dirty,
            draw_repass_pending: self.draw_repass_pending,
            draw_dirty_nodes: self.draw_dirty_nodes.len(),
            layer_property_nodes: self.layer_property_nodes.len(),
            layout_dirty_nodes: self.layout_dirty_nodes.len(),
            moved_nodes: self.moved_nodes.len(),
            structural_dirty_nodes: self.structural_parents.len(),
            partial_dirty_nodes: self.partial_dirty_nodes.len(),
            dirty_node_ids: render_phase_dirty_diagnostics_enabled().then(|| {
                format!(
                    "draw={:?} layers={:?} layout={:?} moved={:?} structural={:?} partial={:?}",
                    self.draw_dirty_nodes,
                    self.layer_property_nodes,
                    self.layout_dirty_nodes,
                    self.moved_nodes,
                    self.structural_parents,
                    self.partial_dirty_nodes,
                )
            }),
            render_only_dirty: self.render_only_dirty,
            recomposed_this_frame: frame.recomposed_this_frame,
            path,
        });
    }
}

struct SurfaceFrame {
    result: FrameUpdateResult,
    rebuilt: bool,
}

fn pending_repass_nodes() -> Vec<NodeId> {
    let mut nodes = if cranpose_ui::has_pending_layout_repasses() {
        cranpose_ui::pending_layout_repass_nodes_snapshot()
    } else {
        Vec::new()
    };
    if cranpose_ui::has_pending_measure_repasses() {
        for node in cranpose_ui::pending_measure_repass_nodes_snapshot() {
            if !nodes.contains(&node) {
                nodes.push(node);
            }
        }
    }
    nodes
}

fn mark_root_for_layout(applier: &mut MemoryApplier, root: NodeId) {
    match applier.with_node::<LayoutNode, _>(root, |node| {
        node.mark_needs_measure();
        node.mark_needs_layout();
    }) {
        Ok(()) | Err(NodeError::Missing { .. }) => {}
        Err(NodeError::TypeMismatch { .. }) => {
            let _ = applier.with_node::<SubcomposeLayoutNode, _>(root, |node| {
                node.mark_needs_measure();
                node.mark_needs_layout_flag();
            });
        }
        Err(_) => {}
    }
}

pub(crate) const IDLE_PREFETCH_MAX_PASSES: usize = 4;

impl<R> AppShell<R>
where
    R: Renderer,
    R::Error: Debug,
{
    /// Turns semantics tracking on or off. Turning it on forces a layout pass and marks every
    /// surface dirty. Turning it off drops the cached semantics trees.
    pub fn set_semantics_enabled(&mut self, enabled: bool) {
        if self.app.semantics_enabled == enabled {
            return;
        }
        self.app.semantics_enabled = enabled;
        self.app.semantics_snapshot_revision = self.app.semantics_snapshot_revision.wrapping_add(1);
        if enabled {
            self.app.request_forced_layout_pass();
            self.mark_all_dirty();
        } else {
            for surface in &mut self.surfaces {
                surface.semantics_tree = None;
            }
        }
    }

    /// Sets how the platform should vote the display's frame rate for this
    /// app. The default, [`FrameRatePreference::Auto`], mirrors Compose: the
    /// panel's fastest rate while frames are being produced, no preference
    /// when the scene is still.
    pub fn set_frame_rate_preference(&mut self, preference: crate::FrameRatePreference) {
        self.surfaces[0].frame_rate_preference = preference;
    }

    /// The app's current display frame-rate preference. Read by platform
    /// backends each frame; the vote itself is applied by the backend that
    /// owns the native window.
    pub fn frame_rate_preference(&self) -> crate::FrameRatePreference {
        self.surfaces[0].frame_rate_preference
    }

    pub(crate) fn process_frame(&mut self) -> FrameUpdateResult {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| self.process_frame_in_context(false))
    }

    pub(crate) fn process_frame_in_context(
        &mut self,
        recomposed_before_frame: bool,
    ) -> FrameUpdateResult {
        let mut stages = FrameStages::start(frame_stage_telemetry_threshold_ms().is_some());

        #[cfg(feature = "installed-fonts")]
        self.apply_installed_fonts();
        self.sync_window_roots_in_context();
        self.run_layout_phase_in_context();
        stages.reached();

        let recomposed_this_frame = recomposed_before_frame || self.run_post_layout_recomposition();

        stages.reached();

        self.run_dispatch_queues();
        self.update_modal_focus();
        self.reveal_new_focus();

        stages.reached();

        clear_transient_scroll_motion_contexts();

        let result = self.run_render_phase_in_context(recomposed_this_frame);
        stages.reached();
        log_frame_stage_telemetry(&stages);
        result
    }

    /// Whether a lazy list waits for [`Self::run_idle_prefetch`].
    pub fn has_idle_prefetch_work(&self) -> bool {
        self.app
            .app_context
            .enter(cranpose_ui::has_lazy_prefetch_requests)
    }

    /// Composes lazy list items that frames left beyond their viewports for
    /// later, in layout passes, at most four of them. A pass runs while
    /// `deadline`, if any, still leaves room for the recent cost of one full pass
    /// and `frame_can_start`, asked before each pass, says the next frame
    /// cannot start yet.
    /// Call it while waiting for the next frame. Returns whether a pass ran.
    pub fn run_idle_prefetch(
        &mut self,
        deadline: Option<Instant>,
        mut frame_can_start: impl FnMut(&mut R) -> bool,
    ) -> bool {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| {
            let mut passes = 0;
            while passes < IDLE_PREFETCH_MAX_PASSES
                && cranpose_ui::has_lazy_prefetch_requests()
                && deadline.is_none_or(|deadline| {
                    Instant::now() + cranpose_ui::lazy_prefetch_pass_cost() <= deadline
                })
                && !frame_can_start(self.renderer())
            {
                cranpose_ui::with_lazy_prefetch_pass(|| {
                    cranpose_ui::drain_lazy_prefetch_requests(cranpose_ui::schedule_measure_repass);
                    self.run_layout_phase_in_context();
                    cranpose_ui::warm_prefetched_slices(&mut self.app.composition.applier_mut());
                });
                passes += 1;
            }
            passes > 0
        })
    }

    /// Gives every renderer the fonts installed since the last frame, before
    /// this frame lays text out.
    #[cfg(feature = "installed-fonts")]
    fn apply_installed_fonts(&mut self) {
        let generation = cranpose_render_common::installed_fonts::installed_font_generation();
        if generation == self.app.installed_fonts {
            return;
        }
        self.app.installed_fonts = generation;
        for surface in &mut self.surfaces {
            surface
                .renderer
                .apply_installed_fonts(&self.app.app_context);
        }
    }

    #[cfg(test)]
    pub(crate) fn run_layout_phase(&mut self) {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| self.run_layout_phase_in_context());
    }

    pub(crate) fn run_layout_phase_in_context(&mut self) {
        let has_scoped_repasses = cranpose_ui::has_pending_layout_repasses()
            || cranpose_ui::has_pending_measure_repasses();
        let scoped_layout_nodes = pending_repass_nodes();

        let global_layout_invalidation = take_layout_invalidation();
        let force_layout_pass = self.app.force_layout_pass;

        if global_layout_invalidation {
            cranpose_ui::layout::invalidate_all_layout_caches();
            if let Some(root) = self.app.composition.root() {
                mark_root_for_layout(&mut self.app.composition.applier_mut(), root);
            }
            self.app.request_forced_layout_pass();
        } else if has_scoped_repasses {
            self.app.request_layout_pass();
        }

        if !self.app.layout_requested {
            return;
        }

        let Some(root) = self.app.composition.root() else {
            self.reset_layout_snapshots();
            return;
        };
        let viewport_size = self.surfaces[0].viewport_size();
        let handle = self.app.composition.runtime_handle();
        let mut applier = self.app.composition.applier_mut();
        applier.set_runtime_handle(handle);

        let tree_needs_layout_check = cranpose_ui::tree_needs_layout(&mut *applier, root)
            .unwrap_or_else(|err| {
                log::warn!("Cannot check layout dirty status for root #{root}: {err}");
                true
            });
        let needs_layout =
            self.app.force_layout_pass || has_scoped_repasses || tree_needs_layout_check;
        self.app.layout_requested = false;
        self.app.force_layout_pass = false;

        if !needs_layout {
            log::trace!("Skipping layout: tree is clean");
            applier.clear_runtime_handle();
            return;
        }

        let measured = cranpose_ui::measure_layout_with_options(
            &mut applier,
            root,
            viewport_size,
            MeasureLayoutOptions {
                collect_semantics: false,
                build_layout_tree: false,
            },
        );
        applier.clear_runtime_handle();
        drop(applier);
        match measured {
            Ok(_measurements) => {
                self.forget_frame_snapshots();
                self.record_layout_scene_nodes(
                    global_layout_invalidation || force_layout_pass,
                    has_scoped_repasses,
                    scoped_layout_nodes,
                );
            }
            Err(err) => {
                log::error!("failed to compute layout: {err}");
                self.reset_layout_snapshots();
            }
        }
    }

    fn forget_frame_snapshots(&mut self) {
        self.app.semantics_snapshot_revision = self.app.semantics_snapshot_revision.wrapping_add(1);
        for surface in &mut self.surfaces {
            surface.forget_snapshots();
        }
    }

    fn reset_layout_snapshots(&mut self) {
        self.forget_frame_snapshots();
        for surface in &mut self.surfaces {
            surface.invalidate_scene_root(surface.root_node(&self.app));
        }
        let _ = cranpose_ui::take_geometry_scene_nodes();
        self.app.layout_requested = false;
        self.app.force_layout_pass = false;
    }

    fn record_layout_scene_nodes(
        &mut self,
        global: bool,
        has_scoped_repasses: bool,
        scoped_layout_nodes: Vec<NodeId>,
    ) {
        cranpose_ui::take_geometry_scene_nodes_into(&mut self.geometry_scene_nodes);
        self.app.content_moved |= !self.geometry_scene_nodes.is_empty();
        if global {
            for surface in &mut self.surfaces {
                surface.invalidate_scene_root(surface.root_node(&self.app));
            }
        }
        // The scene updates the root of a global pass in place and keeps the
        // layers below it, so the nodes the pass reshaped or moved go to the
        // scene too: a padding that grew moves its node's children although
        // no child moved in its parent.
        let scoped = (has_scoped_repasses && !global)
            .then_some(scoped_layout_nodes)
            .into_iter()
            .flatten();
        route_nodes_by_surface(
            &mut self.app,
            &mut self.surfaces,
            scoped.chain(self.geometry_scene_nodes.reshaped.iter().copied()),
            SurfaceDirtyLane::Layout,
            &mut self.routing_scratch,
        );
        route_nodes_by_surface(
            &mut self.app,
            &mut self.surfaces,
            self.geometry_scene_nodes.moved.iter().copied(),
            SurfaceDirtyLane::Moved,
            &mut self.routing_scratch,
        );
    }

    fn run_post_layout_recomposition(&mut self) -> bool {
        if !self.app.composition.should_recompose() {
            return false;
        }

        let Some(root_key) = self.app.composition.root_key() else {
            return false;
        };

        match self
            .app
            .composition
            .reconcile(root_key, &mut *self.app.content)
        {
            Ok(changed) => {
                if !changed {
                    return false;
                }
                self.app.fps_monitor.record_recomposition();
                self.sync_window_roots_in_context();
                if self.app.composition_tree_needs_layout() {
                    self.app.request_layout_pass();
                    self.run_layout_phase_in_context();
                }
                request_render_invalidation();
                true
            }
            Err(NodeError::Missing { id }) => {
                log::debug!("Post-layout recomposition skipped: node {id} no longer exists");
                self.app.request_layout_pass();
                request_render_invalidation();
                true
            }
            Err(err) => {
                log::error!("post-layout recomposition failed: {err}");
                self.app.request_layout_pass();
                request_render_invalidation();
                true
            }
        }
    }

    fn run_dispatch_queues(&mut self) {
        if has_pending_pointer_repasses() {
            let mut applier = self.app.composition.applier_mut();
            process_pointer_repasses(|node_id| {
                match clear_dispatch_invalidation(
                    &mut applier,
                    node_id,
                    DispatchInvalidationKind::Pointer,
                ) {
                    Ok(true) => {
                        log::trace!("Cleared pointer repass flag for node #{node_id}");
                    }
                    Ok(false) => {}
                    Err(err) => {
                        log::debug!("Could not process pointer repass for node #{node_id}: {err}");
                    }
                }
            });
        }

        if has_pending_focus_invalidations() {
            let mut applier = self.app.composition.applier_mut();
            process_focus_invalidations(|node_id| {
                match clear_dispatch_invalidation(
                    &mut applier,
                    node_id,
                    DispatchInvalidationKind::Focus,
                ) {
                    Ok(true) => {
                        log::trace!("Cleared focus sync flag for node #{node_id}");
                    }
                    Ok(false) => {}
                    Err(err) => {
                        log::debug!(
                            "Could not process focus invalidation for node #{node_id}: {err}"
                        );
                    }
                }
            });
        }

        self.app.flush_semantics_invalidations();
    }

    fn take_structural_change_parents(&mut self) {
        self.pending_dirty_nodes.clear();
        if cranpose_core::env_flag!("CRANPOSE_DISABLE_STRUCTURAL_DIRT") {
            return;
        }
        if self.app.composition.root().is_none() {
            return;
        }
        self.app
            .composition
            .applier_mut()
            .take_structural_change_parents_into(&mut self.pending_dirty_nodes);
        // A child's z index orders it among its siblings, in its parent's
        // layer: the parent changed as a child list does.
        let reordered = self.pending_dirty_nodes.len();
        cranpose_ui::append_z_order_changes(&mut self.pending_dirty_nodes);
        if self.pending_dirty_nodes.len() == reordered {
            return;
        }
        let mut applier = self.app.composition.applier_mut();
        for node in &mut self.pending_dirty_nodes[reordered..] {
            if let Some(parent) = applier.get_mut(*node).ok().and_then(|child| child.parent()) {
                *node = parent;
            }
        }
    }

    #[cfg(test)]
    pub(crate) fn run_render_phase(&mut self) -> FrameUpdateResult {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| self.run_render_phase_in_context(false))
    }

    fn run_render_phase_in_context(&mut self, recomposed_this_frame: bool) -> FrameUpdateResult {
        let inspector_revision = if self.app.inspector_projector.is_some()
            && self
                .surfaces
                .iter()
                .any(|surface| surface.inspector.state.open)
        {
            self.semantics_snapshot_revision()
        } else {
            0
        };
        cranpose_ui::tick_cursor_blink();
        let render_dirty = take_render_invalidation();
        let pointer_dirty = take_pointer_invalidation();
        take_focus_invalidation();
        for surface in &mut self.surfaces {
            surface.scoped_draw_nodes.clear();
            surface.scoped_layer_property_nodes.clear();
            surface.structural_scene_nodes.clear();
        }
        cranpose_ui::take_draw_repass_nodes_into(&mut self.pending_dirty_nodes);
        route_nodes_by_surface(
            &mut self.app,
            &mut self.surfaces,
            self.pending_dirty_nodes.iter().copied(),
            SurfaceDirtyLane::Draw,
            &mut self.routing_scratch,
        );
        cranpose_ui::take_layer_property_repass_nodes_into(&mut self.pending_layer_property_nodes);
        route_nodes_by_surface(
            &mut self.app,
            &mut self.surfaces,
            self.pending_layer_property_nodes.iter().copied(),
            SurfaceDirtyLane::LayerProperties,
            &mut self.routing_scratch,
        );
        self.take_structural_change_parents();
        route_nodes_by_surface(
            &mut self.app,
            &mut self.surfaces,
            self.pending_dirty_nodes.iter().copied(),
            SurfaceDirtyLane::Structural,
            &mut self.routing_scratch,
        );
        self.pending_dirty_nodes.clear();
        self.pending_layer_property_nodes.clear();
        let _ = cranpose_ui::has_focused_field();
        let attributed = self.surfaces.iter().any(|surface| {
            !surface.scoped_draw_nodes.is_empty()
                || !surface.scoped_layer_property_nodes.is_empty()
                || !surface.structural_scene_nodes.is_empty()
        }) || self.surfaces.iter().any(|surface| {
            !surface.scoped_layout_scene_nodes.is_empty()
                || !surface.scoped_moved_scene_nodes.is_empty()
        });
        let layer_properties_pending = self
            .surfaces
            .iter()
            .any(|surface| !surface.scoped_layer_property_nodes.is_empty());
        let frame = FrameDirt {
            render_dirty,
            pointer_dirty,
            attributed,
            layer_properties_pending,
            recomposed_this_frame,
        };

        let mut result = FrameUpdateResult::default();
        for surface in &mut self.surfaces {
            let mut frame = render_surface(&mut self.app, surface, &frame);
            frame.result.visual_changed |=
                crate::inspector::refresh(&mut self.app, surface, inspector_revision);
            surface.last_update = frame.result;
            surface.frame_owed |= frame.result.visual_changed;
            result.visual_changed |= frame.result.visual_changed;
            result.structure_changed |= frame.result.structure_changed;
            result.content_redrawn |= frame.rebuilt;
        }
        if result.content_redrawn {
            self.prune_stale_draw_observations();
        }
        result.content_moved = std::mem::take(&mut self.app.content_moved);
        result
    }

    /// Drops the draw observations of nodes no surface's render graph holds
    /// any more, once every [`OBSERVATION_PRUNE_INTERVAL`] rebuilt frames:
    /// finding them walks every node of every graph, and an observation
    /// left behind in between costs no more than a redraw request for a
    /// node nothing draws.
    fn prune_stale_draw_observations(&mut self) {
        self.app.rebuilt_frames_since_observation_prune += 1;
        if self.app.rebuilt_frames_since_observation_prune < OBSERVATION_PRUNE_INTERVAL {
            return;
        }
        self.app.rebuilt_frames_since_observation_prune = 0;
        let mut retained_visual_nodes = HashSet::default();
        let mut any_graph = false;
        for surface in &mut self.surfaces {
            any_graph |= surface
                .renderer
                .scene()
                .collect_retained_visual_observation_nodes(&mut surface.retained_visual_nodes);
            retained_visual_nodes.extend(surface.retained_visual_nodes.iter().copied());
        }
        if any_graph {
            cranpose_ui::prune_draw_observations_to_nodes(&retained_visual_nodes);
        }
    }
}

/// Rebuilt frames between prunes of stale draw observations: once a second
/// at 60 Hz.
pub(crate) const OBSERVATION_PRUNE_INTERVAL: u32 = 60;

fn render_surface<R>(
    app: &mut ShellApp,
    surface: &mut RootSurface<R>,
    frame: &FrameDirt,
) -> SurfaceFrame
where
    R: Renderer,
    R::Error: Debug,
{
    let draw_dirty_nodes = std::mem::take(&mut surface.scoped_draw_nodes);
    let layer_property_nodes = std::mem::take(&mut surface.scoped_layer_property_nodes);
    let structural_parents = std::mem::take(&mut surface.structural_scene_nodes);
    let draw_repass_pending = !draw_dirty_nodes.is_empty();
    let mut draw_dirty_nodes = refresh_draw_nodes(app, surface, draw_dirty_nodes);
    if frame.render_dirty && !frame.layer_properties_pending && !draw_repass_pending {
        draw_dirty_nodes = refresh_retained_redraw_nodes(app, surface, draw_dirty_nodes);
    }
    let layout = cranpose_ui::GeometrySceneNodes {
        reshaped: std::mem::take(&mut surface.scoped_layout_scene_nodes),
        moved: std::mem::take(&mut surface.scoped_moved_scene_nodes),
    };
    let partial_dirty_nodes = std::mem::take(&mut surface.partial_scene_nodes);
    let scene_dirty = surface.scene_dirty;
    let mut dirt = SurfaceDirt::classify(
        frame,
        scene_dirty,
        draw_repass_pending,
        ScopedVisualNodes {
            draw: draw_dirty_nodes,
            layers: layer_property_nodes,
        },
        layout,
        structural_parents,
        partial_dirty_nodes,
    );

    if !dirt.needs_scene_rebuild {
        dirt.log(
            frame,
            scene_dirty,
            if dirt.render_only_dirty {
                "present-retained"
            } else {
                "skip"
            },
        );
        surface.scoped_layout_scene_nodes = dirt.layout_dirty_nodes;
        surface.scoped_moved_scene_nodes = dirt.moved_nodes;
        surface.scoped_draw_nodes = dirt.draw_dirty_nodes;
        surface.scoped_layer_property_nodes = dirt.layer_property_nodes;
        surface.structural_scene_nodes = dirt.structural_parents;
        surface.partial_scene_nodes = dirt.partial_dirty_nodes;
        if dirt.render_only_dirty && app.dev_options.fps_counter {
            draw_dev_overlay(app, surface);
        }
        return SurfaceFrame {
            result: FrameUpdateResult {
                visual_changed: dirt.render_only_dirty,
                ..FrameUpdateResult::default()
            },
            rebuilt: false,
        };
    }

    surface.scene_dirty = false;
    let structure_changed = !dirt.render_only_dirty && !dirt.use_visual_update();
    rebuild_surface_scene(app, surface, frame, scene_dirty, &dirt);
    if dev_overlay_belongs_on(surface.id, app.dev_options.fps_counter) {
        draw_dev_overlay(app, surface);
    }
    dirt.layout_dirty_nodes.clear();
    dirt.moved_nodes.clear();
    surface.scoped_moved_scene_nodes = dirt.moved_nodes;
    surface.scoped_draw_nodes = dirt.draw_dirty_nodes;
    surface.scoped_layer_property_nodes = dirt.layer_property_nodes;
    surface.structural_scene_nodes = dirt.structural_parents;
    surface.partial_scene_nodes = dirt.partial_dirty_nodes;
    surface.scoped_layout_scene_nodes = dirt.layout_dirty_nodes;
    SurfaceFrame {
        result: FrameUpdateResult {
            visual_changed: true,
            structure_changed,
            ..FrameUpdateResult::default()
        },
        rebuilt: true,
    }
}

fn rebuild_surface_scene<R>(
    app: &mut ShellApp,
    surface: &mut RootSurface<R>,
    frame: &FrameDirt,
    scene_dirty: bool,
    dirt: &SurfaceDirt,
) where
    R: Renderer,
    R::Error: Debug,
{
    let viewport_size = surface.viewport_size();
    let Some(root) = surface.root_node(app) else {
        surface.renderer.scene_mut().clear();
        return;
    };
    let mut applier = app.composition.applier_mut();
    dirt.log(frame, scene_dirty, dirt.rebuild_path());
    let rebuild_result = if dirt.use_visual_update() {
        surface.renderer.update_visual_scene_from_applier(
            &mut applier,
            root,
            viewport_size,
            SceneUpdates {
                content: &dirt.partial_dirty_nodes,
                layers: &dirt.layer_property_nodes,
                moved: &dirt.moved_nodes,
            },
        )
    } else if dirt.use_partial_update() {
        surface.renderer.update_scene_from_applier(
            &mut applier,
            root,
            viewport_size,
            SceneUpdates {
                content: &dirt.partial_dirty_nodes,
                layers: &dirt.layer_property_nodes,
                moved: &dirt.moved_nodes,
            },
        )
    } else {
        surface
            .renderer
            .rebuild_scene_from_applier(&mut applier, root, viewport_size)
    };
    if let Err(err) = rebuild_result {
        log::error!("renderer rebuild failed: {err:?}");
        surface.renderer.scene_mut().clear();
    }
}

fn dev_overlay_belongs_on(id: RootId, fps_counter: bool) -> bool {
    fps_counter && matches!(id, RootId::Primary)
}

fn draw_dev_overlay<R: Renderer>(app: &ShellApp, surface: &mut RootSurface<R>) {
    let viewport_size = surface.viewport_size();
    surface.refresh_dev_overlay_text_for_frame_at(app, viewport_size, Instant::now());
    surface
        .renderer
        .draw_dev_overlay(surface.dev_overlay_text.as_str(), viewport_size);
}

fn refresh_draw_nodes<R: Renderer>(
    app: &mut ShellApp,
    surface: &mut RootSurface<R>,
    mut dirty_nodes: Vec<NodeId>,
) -> Vec<NodeId> {
    if dirty_nodes.is_empty() {
        return dirty_nodes;
    }
    let Some(layout_tree) = surface.layout_tree.as_mut() else {
        return dirty_nodes;
    };

    dirty_nodes.sort_unstable();
    dirty_nodes.dedup();
    let dirty_set: HashSet<NodeId> = dirty_nodes.iter().copied().collect();
    let mut applier = app.composition.applier_mut();
    let refresh_scope = build_draw_refresh_scope(&mut applier, &dirty_set);
    refresh_layout_box_data(
        &mut applier,
        layout_tree.root_mut(),
        &refresh_scope,
        &dirty_set,
    );
    dirty_nodes
}

fn refresh_retained_redraw_nodes<R: Renderer>(
    app: &mut ShellApp,
    surface: &mut RootSurface<R>,
    mut dirty_nodes: Vec<NodeId>,
) -> Vec<NodeId> {
    dirty_nodes.clear();
    let Some(root) = surface.root_node(app) else {
        return dirty_nodes;
    };
    {
        let mut applier = app.composition.applier_mut();
        collect_retained_redraw_nodes(
            &mut applier,
            root,
            &mut dirty_nodes,
            &mut surface.redraw_walk,
        );
    }
    refresh_draw_nodes(app, surface, dirty_nodes)
}

impl<R: Renderer> RootSurface<R> {
    fn refresh_dev_overlay_text_for_frame_at(
        &mut self,
        app: &ShellApp,
        viewport_size: Size,
        now: Instant,
    ) {
        if !self.dev_overlay_text_needs_refresh(viewport_size, now) {
            return;
        }
        self.dev_overlay_text = self.build_dev_overlay_text(app, viewport_size);
        self.dev_overlay_last_refresh = Some(now);
        self.dev_overlay_viewport = Some(viewport_size);
    }

    fn dev_overlay_text_needs_refresh(&self, viewport_size: Size, now: Instant) -> bool {
        if self.dev_overlay_text.is_empty() || self.dev_overlay_viewport != Some(viewport_size) {
            return true;
        }

        self.dev_overlay_last_refresh.is_none_or(|last| {
            now.checked_duration_since(last).unwrap_or_default() >= DEV_OVERLAY_REFRESH_INTERVAL
        })
    }

    fn build_dev_overlay_text(&mut self, app: &ShellApp, viewport_size: Size) -> String {
        self.dev_overlay_controls.clear();

        let stats = app.fps_monitor.stats();
        // Each field with its rank: a viewport too narrow for the whole line,
        // such as a phone browser's, drops the highest ranks first.
        let fields = [
            (0, format!("{:.0} FPS", stats.fps)),
            (3, format!("avg {:.1}ms", stats.avg_ms)),
            (2, format!("p95 {:.1}ms", stats.p95_ms)),
            (4, format!("max {:.1}ms", stats.max_ms)),
            (1, format!("work {:.1}ms", stats.work_avg_ms)),
            (5, format!("{} recomp/s", stats.recomps_per_second)),
        ];
        let line_len = |max_rank: u8| {
            let (count, chars) = fields
                .iter()
                .filter(|(rank, _)| *rank <= max_rank)
                .fold((0_usize, 0_usize), |(count, chars), (_, field)| {
                    (count + 1, chars + field.len())
                });
            chars + count.saturating_sub(1) * DEV_OVERLAY_SEPARATOR.len()
        };
        let fitting_chars = ((viewport_size.width - DEV_OVERLAY_PADDING * 2.0)
            / DEV_OVERLAY_CHAR_WIDTH)
            .max(0.0) as usize;
        let controls_chars = if app.dev_options.frame_pacing_controls {
            DEV_OVERLAY_SEPARATOR.len() + frame_pacing_controls_len()
        } else {
            0
        };
        let mut max_rank = 5;
        while max_rank > 0 && line_len(max_rank) + controls_chars > fitting_chars {
            max_rank -= 1;
        }
        let mut text = String::with_capacity(line_len(max_rank) + controls_chars);
        for (_, field) in fields.iter().filter(|(rank, _)| *rank <= max_rank) {
            if !text.is_empty() {
                text.push_str(DEV_OVERLAY_SEPARATOR);
            }
            text.push_str(field);
        }

        if !app.dev_options.frame_pacing_controls {
            return text;
        }

        text.push_str(DEV_OVERLAY_SEPARATOR);
        let mut controls = Vec::with_capacity(FramePacingMode::ALL.len());
        for (index, mode) in FramePacingMode::ALL.into_iter().enumerate() {
            if index > 0 {
                text.push(' ');
            }
            let start = text.len();
            if mode == app.dev_options.frame_pacing_mode {
                text.push('[');
                text.push_str(mode.label());
                text.push(']');
            } else {
                text.push_str(mode.label());
            }
            controls.push((start, text.len(), mode));
        }

        let overlay_width = text.len() as f32 * DEV_OVERLAY_CHAR_WIDTH;
        let overlay_x = (viewport_size.width - overlay_width - DEV_OVERLAY_PADDING * 2.0)
            .max(DEV_OVERLAY_PADDING);
        let overlay_y = DEV_OVERLAY_PADDING;
        let text_x = overlay_x + DEV_OVERLAY_PADDING / 2.0;
        let text_y = overlay_y + DEV_OVERLAY_PADDING / 4.0;
        let text_height = DEV_OVERLAY_FONT_SIZE * 1.4;

        self.dev_overlay_controls = controls
            .into_iter()
            .map(|(start, end, mode)| DevOverlayControl {
                bounds: Rect {
                    x: text_x + start as f32 * DEV_OVERLAY_CHAR_WIDTH - 3.0,
                    y: text_y - 3.0,
                    width: (end - start) as f32 * DEV_OVERLAY_CHAR_WIDTH + 6.0,
                    height: text_height + 6.0,
                },
                mode,
            })
            .collect();

        text
    }
}

/// The length of the frame pacing controls: every mode's label, a space
/// between labels and brackets around the selected one.
fn frame_pacing_controls_len() -> usize {
    let labels: usize = FramePacingMode::ALL
        .iter()
        .map(|mode| mode.label().len())
        .sum();
    labels + FramePacingMode::ALL.len() - 1 + 2
}

fn clear_dispatch_invalidation(
    applier: &mut MemoryApplier,
    node_id: NodeId,
    invalidation: DispatchInvalidationKind,
) -> Result<bool, NodeError> {
    match invalidation {
        DispatchInvalidationKind::Pointer => {
            match applier.with_node::<LayoutNode, _>(node_id, |node| {
                let needs_pointer_pass = node.needs_pointer_pass();
                if needs_pointer_pass {
                    node.clear_needs_pointer_pass();
                }
                needs_pointer_pass
            }) {
                Ok(cleared) => Ok(cleared),
                Err(NodeError::TypeMismatch { .. }) => applier
                    .with_node::<SubcomposeLayoutNode, _>(node_id, |node| {
                        let needs_pointer_pass = node.needs_pointer_pass();
                        if needs_pointer_pass {
                            node.clear_needs_pointer_pass();
                        }
                        needs_pointer_pass
                    }),
                Err(err) => Err(err),
            }
        }
        DispatchInvalidationKind::Focus => {
            match applier.with_node::<LayoutNode, _>(node_id, |node| {
                let needs_focus_sync = node.needs_focus_sync();
                if needs_focus_sync {
                    node.clear_needs_focus_sync();
                }
                needs_focus_sync
            }) {
                Ok(cleared) => Ok(cleared),
                Err(NodeError::TypeMismatch { .. }) => applier
                    .with_node::<SubcomposeLayoutNode, _>(node_id, |node| {
                        let needs_focus_sync = node.needs_focus_sync();
                        if needs_focus_sync {
                            node.clear_needs_focus_sync();
                        }
                        needs_focus_sync
                    }),
                Err(err) => Err(err),
            }
        }
    }
}

pub(crate) fn build_draw_refresh_scope(
    applier: &mut MemoryApplier,
    dirty_nodes: &HashSet<NodeId>,
) -> HashSet<NodeId> {
    let mut refresh_scope =
        HashSet::with_capacity_and_hasher(dirty_nodes.len(), Default::default());
    for &dirty_node in dirty_nodes {
        let mut current = Some(dirty_node);
        while let Some(node_id) = current {
            if !refresh_scope.insert(node_id) {
                break;
            }
            current = applier.get_mut(node_id).ok().and_then(|node| node.parent());
        }
    }
    refresh_scope
}

/// Collects into `dirty_nodes` the nodes under `root` whose redraw flag no
/// draw repass took, clearing the flags. A window root below `root` draws on
/// a surface of its own. Each node takes one lookup; `pending` holds the
/// nodes still to visit and keeps its storage for the next frame.
fn collect_retained_redraw_nodes(
    applier: &mut MemoryApplier,
    root: NodeId,
    dirty_nodes: &mut Vec<NodeId>,
    pending: &mut Vec<NodeId>,
) {
    pending.clear();
    pending.push(root);
    while let Some(id) = pending.pop() {
        let Ok(node) = applier.get_mut(id) else {
            continue;
        };
        if let Some(layout) = node.as_any_mut().downcast_mut::<LayoutNode>() {
            if id != root && layout.is_window_root() {
                continue;
            }
            if layout.needs_redraw() {
                layout.clear_needs_redraw();
                dirty_nodes.push(id);
            }
            // Reversed, so the first child comes off next and the nodes
            // come in tree order.
            pending.extend(layout.children.iter().rev());
            continue;
        }
        let mut children = Default::default();
        node.collect_children_into(&mut children);
        pending.extend(children.iter().rev());
        if let Some(subcompose) = node.as_any_mut().downcast_mut::<SubcomposeLayoutNode>()
            && subcompose.needs_redraw()
        {
            subcompose.clear_needs_redraw();
            dirty_nodes.push(id);
        }
    }
}

fn refresh_layout_box_data(
    applier: &mut MemoryApplier,
    layout: &mut cranpose_ui::layout::LayoutBox,
    refresh_scope: &HashSet<NodeId>,
    dirty_nodes: &HashSet<NodeId>,
) {
    if !refresh_scope.contains(&layout.node_id) {
        return;
    }

    if dirty_nodes.contains(&layout.node_id) {
        let refreshed = applier
            .with_node::<LayoutNode, _>(layout.node_id, |node| {
                node.clear_needs_redraw();
                (
                    node.modifier.clone(),
                    node.resolved_modifiers(),
                    node.modifier_slices_snapshot(),
                    node.semantics_configuration(),
                )
            })
            .or_else(|_| {
                applier.with_node::<SubcomposeLayoutNode, _>(layout.node_id, |node| {
                    node.clear_needs_redraw();
                    (
                        node.modifier(),
                        node.resolved_modifiers(),
                        node.modifier_slices_snapshot(),
                        node.semantics_configuration(),
                    )
                })
            });
        if let Ok((modifier, resolved_modifiers, slices, semantics)) = refreshed {
            layout.node_data.modifier = modifier;
            layout.node_data.resolved_modifiers = resolved_modifiers;
            layout.node_data.modifier_slices = slices;
            layout.node_data.semantics = semantics.map(std::rc::Rc::new);
        }
    }

    for child in &mut layout.children {
        refresh_layout_box_data(applier, child, refresh_scope, dirty_nodes);
    }
}

#[cfg(test)]
#[path = "tests/shell_frame_tests.rs"]
mod tests;