cranpose_app_shell/

lib.rs

use std::sync::PoisonError;
mod focus_reveal;
mod fps_monitor;
mod hit_path_tracker;
pub mod inspector;
mod modal_focus;
mod shell_debug;
mod shell_frame;
mod shell_input;
mod surface;
mod wheel;
use std::{
    cell::RefCell,
    fmt::{Debug, Write},
    rc::Rc,
    sync::{
        Mutex, MutexGuard,
        atomic::{AtomicBool, Ordering},
    },
};

use cranpose_core::{
    Applier, Composition, Key, MemoryApplier, NodeError, NodeId, collections::map::HashSet,
    enter_event_handler_scope, location_key, run_in_mutable_snapshot,
};
pub use cranpose_foundation::{
    DEFAULT_ROTARY_SCROLL_FACTOR_DP, Modifiers, PointerSource, RotaryScrollEvent,
    rotary_scroll_pixels_from_detents,
};
use cranpose_foundation::{PointerButton, PointerButtons, PointerEvent, PointerEventKind};
use cranpose_render_common::{HitTestTarget, RenderScene, Renderer};
use cranpose_runtime_std::StdRuntime;
use cranpose_ui::{
    HeadlessRenderer, LayoutBox, LayoutNode, LayoutTree, MeasureLayoutOptions, SemanticsTree,
    SubcomposeLayoutNode, WindowRootEntry, clear_transient_scroll_motion_contexts,
    format_layout_tree, format_render_scene, format_screen_summary,
    has_pending_focus_invalidations, has_pending_pointer_repasses,
    has_pending_semantics_invalidations, peek_focus_invalidation, peek_layout_invalidation,
    peek_pointer_invalidation, peek_render_invalidation, process_focus_invalidations,
    process_pointer_repasses, process_semantics_invalidations, request_render_invalidation,
    take_draw_repass_nodes, take_focus_invalidation, take_layout_invalidation,
    take_pointer_invalidation, take_render_invalidation,
};
pub use cranpose_ui::{KeyCode, KeyEvent, KeyEventType};
use cranpose_ui_graphics::{Point, PointerIcon, Rect, Size};
pub use fps_monitor::FpsStats;
use hit_path_tracker::PointerId;
#[cfg(test)]
use shell_frame::build_draw_refresh_scope;
pub use surface::{RootId, RootSurface, SurfaceMut};
use surface::{TextInputRouter, TextInputRoutes, partition_nodes_by_surface};
use web_time::Instant;
pub use wheel::WheelScroll;

#[cfg(all(
    feature = "clipboard-native",
    not(target_arch = "wasm32"),
    not(target_os = "android"),
    not(target_os = "ios")
))]
struct ShellClipboard {
    inner: std::rc::Rc<std::cell::RefCell<Option<arboard::Clipboard>>>,
}

#[cfg(all(
    feature = "clipboard-native",
    not(target_arch = "wasm32"),
    not(target_os = "android"),
    not(target_os = "ios")
))]
impl cranpose_ui::clipboard_session::PlatformClipboard for ShellClipboard {
    fn write_text(&self, text: &str) {
        if let Some(clipboard) = self.inner.borrow_mut().as_mut() {
            let _ = clipboard.set_text(text);
        }
    }

    fn read_text(&self) -> Option<String> {
        self.inner
            .borrow_mut()
            .as_mut()
            .and_then(|clipboard| clipboard.get_text().ok())
    }
}
#[cfg(any(test, feature = "test-support"))]
use cranpose_core::{
    CompositionPassDebugStats, SlotId,
    runtime::{RuntimeDebugStats, StateArenaDebugStats},
    snapshot_pinning::{SnapshotPinningDebugStats, debug_snapshot_pinning_stats},
    snapshot_state_observer::SnapshotStateObserverDebugStats,
    snapshot_v2::{SnapshotV2DebugStats, debug_snapshot_v2_stats},
};
#[cfg(any(test, feature = "test-support"))]
use cranpose_core::{
    MemoryApplierDebugStats, RecomposeScopeRegistryDebugStats, SlotTableDebugStats,
    debug_recompose_scope_registry_stats,
};
pub use cranpose_ui::{ImeEditorState, PlatformTextInputHandler};
#[cfg(any(test, feature = "test-support"))]
pub mod accessibility_audit;
#[cfg(any(test, feature = "test-support"))]
pub mod placed_semantics;

/// How the platform should vote the display's frame rate on behalf of the app.
///
/// Compose apps get 120 Hz gameplay on a 120 Hz panel not by presenting faster
/// but because HWUI votes a rate on the window while animations and gestures
/// run, and clears it when they stop. A window that never votes is pinned by
/// SurfaceFlinger's cadence inference instead — which also throttles the app's
/// choreographer, so the inference reinforces itself. `Auto` reproduces the
/// HWUI behaviour; the platform backends read it every frame and vote through
/// the native window when the desired rate changes.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub enum FrameRatePreference {
    /// Ask for the panel's fastest rate while frames are being produced, no
    /// preference when the scene is still. This is the default, matching what
    /// Compose/HWUI do for every app without the app's involvement.
    #[default]
    Auto,
    /// Never vote; the OS infers a rate from presentation cadence.
    NoPreference,
    /// Always vote exactly this rate in Hz. Values `<= 0` behave like
    /// [`FrameRatePreference::NoPreference`].
    Exact(f32),
}

impl FrameRatePreference {
    /// The baseline `Auto` votes while animating without interaction — the
    /// same rate HWUI's NORMAL frame-rate category resolves to on phone
    /// panels. The quiet vote cannot simply be "no vote": SurfaceFlinger
    /// infers a non-voting window's rate from whatever cadence it last
    /// observed and pins it, so an app that ever ran the panel's fast rate
    /// would stay there forever (measured on a Pixel 9 Pro, both directions).
    pub const AUTO_QUIET_RATE_HZ: f32 = 60.0;

    /// The rate the platform should vote right now, in Hz, where `0.0` means
    /// "clear the vote". `producing_frames` is whether the frame loop has a
    /// frame scheduled, `interacting` whether input arrived within the
    /// platform's boost hold-off, and `panel_max_hz` the display's fastest
    /// supported rate when the platform knows it.
    ///
    /// While interacting, `Auto` holds the boost even through moments with no
    /// frame scheduled: a gesture sequence crosses still screens (a tap lands,
    /// the old scene stops animating, the new one hasn't started), and letting
    /// each of those instantly clear the vote flapped the display between the
    /// boost rate and no-vote several times per second on device. This mirrors
    /// SurfaceFlinger's own touch boost, which also outlives the touch by
    /// seconds regardless of what the app presents in between.
    pub fn desired_rate_hz(
        self,
        producing_frames: bool,
        interacting: bool,
        panel_max_hz: Option<f32>,
    ) -> f32 {
        match self {
            FrameRatePreference::Auto => {
                if interacting {
                    panel_max_hz
                        .filter(|rate| *rate > 0.0)
                        .unwrap_or(Self::AUTO_QUIET_RATE_HZ)
                } else if producing_frames {
                    Self::AUTO_QUIET_RATE_HZ
                } else {
                    0.0
                }
            }
            FrameRatePreference::NoPreference => 0.0,
            FrameRatePreference::Exact(rate) if rate > 0.0 => rate,
            FrameRatePreference::Exact(_) => 0.0,
        }
    }
}

pub(crate) struct ShellApp {
    pub(crate) app_context: Rc<cranpose_ui::AppContext>,
    pub(crate) runtime: StdRuntime,
    pub(crate) composition: Composition<MemoryApplier>,
    pub(crate) content: Box<dyn FnMut()>,
    pub(crate) start_time: Instant,
    pub(crate) last_frame_time_nanos: u64,
    pub(crate) semantics_enabled: bool,
    pub(crate) semantics_snapshot_revision: u64,
    pub(crate) revealed_focus: Option<NodeId>,
    pub(crate) layout_requested: bool,
    pub(crate) force_layout_pass: bool,
    pub(crate) modifiers: Option<Modifiers>,
    pub(crate) rotary_scroll_factor: f32,
    #[cfg(all(feature = "clipboard-native", target_os = "linux"))]
    pub(crate) clipboard: Option<arboard::Clipboard>,
    pub(crate) dev_options: DevOptions,
    pub(crate) inspector_projector: Option<inspector::InspectorProjector>,
    pub(crate) fps_monitor: fps_monitor::FpsMonitor,
    pub(crate) text_input_routes: Rc<RefCell<TextInputRoutes>>,
    pub(crate) text_input_router_installed: bool,
    pub(crate) window_roots_seen: Option<u64>,
}

/// The application: one runtime, one composition, and a surface per window
/// it shows.
///
/// Methods that name no root act on the primary surface, so a platform with
/// one window uses the shell as it always has. A platform showing more
/// windows reaches the others through [`AppShell::surface`], after giving
/// each window root a renderer with [`AppShell::add_window_surface`].
pub struct AppShell<R>
where
    R: Renderer,
{
    pub(crate) app: ShellApp,
    pub(crate) surfaces: Vec<RootSurface<R>>,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
/// Platform and animation-clock timestamps for one pointer sample.
pub struct PointerEventTime {
    /// Timestamp supplied by the platform, in its millisecond clock domain.
    pub platform_time_ms: Option<i64>,
    /// Timestamp in the animation frame-clock domain.
    pub animation_time_nanos: u64,
}

fn update_stage_telemetry_threshold_ms() -> Option<f64> {
    static THRESHOLD_MS: std::sync::OnceLock<Option<f64>> = std::sync::OnceLock::new();
    *THRESHOLD_MS.get_or_init(|| {
        std::env::var("CRANPOSE_UPDATE_STAGE_TELEMETRY_MS")
            .ok()
            .and_then(|value| value.parse::<f64>().ok())
            .filter(|value| value.is_finite() && *value >= 0.0)
    })
}

#[derive(Clone, Copy, Debug)]
struct UpdateStageTelemetry {
    started_at: Instant,
    after_frame_callbacks: Instant,
    after_ui_drain: Instant,
    after_reconcile: Instant,
    after_process_frame: Instant,
    should_render: bool,
    reconcile_attempted: bool,
    reconcile_changed: bool,
}

fn log_update_stage_telemetry(telemetry: UpdateStageTelemetry) {
    let Some(threshold_ms) = update_stage_telemetry_threshold_ms() else {
        return;
    };
    let total_ms = telemetry
        .after_process_frame
        .duration_since(telemetry.started_at)
        .as_secs_f64()
        * 1000.0;
    if total_ms < threshold_ms {
        return;
    }

    let frame_callbacks_ms = telemetry
        .after_frame_callbacks
        .duration_since(telemetry.started_at)
        .as_secs_f64()
        * 1000.0;
    let ui_drain_ms = telemetry
        .after_ui_drain
        .duration_since(telemetry.after_frame_callbacks)
        .as_secs_f64()
        * 1000.0;
    let reconcile_ms = telemetry
        .after_reconcile
        .duration_since(telemetry.after_ui_drain)
        .as_secs_f64()
        * 1000.0;
    let process_frame_ms = telemetry
        .after_process_frame
        .duration_since(telemetry.after_reconcile)
        .as_secs_f64()
        * 1000.0;
    eprintln!(
        "[update-stage-telemetry] total_ms={total_ms:.2} frame_callbacks_ms={frame_callbacks_ms:.2} ui_drain_ms={ui_drain_ms:.2} reconcile_ms={reconcile_ms:.2} process_frame_ms={process_frame_ms:.2} should_render={} reconcile_attempted={} reconcile_changed={}",
        telemetry.should_render, telemetry.reconcile_attempted, telemetry.reconcile_changed
    );
}

#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub enum FramePacingMode {
    /// Pace frames to the display refresh interval. The production default:
    /// animations advance once per vsync instead of re-rendering uncapped.
    #[default]
    Vsync,
    Hard60,
    Hard120,
    /// Render as fast as possible. For perf harnesses and robot drivers that
    /// measure work throughput; saturates the GPU if used in a real app.
    NoVsync,
}

impl FramePacingMode {
    pub const ALL: [Self; 4] = [Self::Vsync, Self::Hard60, Self::Hard120, Self::NoVsync];

    pub fn label(self) -> &'static str {
        match self {
            Self::Vsync => "VSync",
            Self::Hard60 => "60fps",
            Self::Hard120 => "120fps",
            Self::NoVsync => "NoVSync",
        }
    }

    pub fn target_fps(self) -> Option<u32> {
        match self {
            Self::Hard60 => Some(60),
            Self::Hard120 => Some(120),
            Self::Vsync | Self::NoVsync => None,
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub struct FrameSchedule {
    pub needs_update: bool,
    pub needs_frame: bool,
    pub next_deadline: Option<web_time::Instant>,
}

#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct FrameUpdateResult {
    pub visual_changed: bool,
    pub structure_changed: bool,
}

pub trait PlatformFrameDriver {
    fn request_frame(&self);
    fn request_wake_at(&self, deadline: web_time::Instant);
    fn clear_wake(&self);
}

#[derive(Debug)]
pub struct FrameScheduler {
    update_pending: AtomicBool,
    frame_pending: AtomicBool,
    next_deadline: Mutex<Option<web_time::Instant>>,
}

impl Default for FrameScheduler {
    fn default() -> Self {
        Self {
            update_pending: AtomicBool::new(false),
            frame_pending: AtomicBool::new(false),
            next_deadline: Mutex::new(None),
        }
    }
}

impl FrameScheduler {
    fn lock_deadline(&self) -> MutexGuard<'_, Option<web_time::Instant>> {
        self.next_deadline
            .lock()
            .unwrap_or_else(PoisonError::into_inner)
    }

    pub fn record(&self, schedule: FrameSchedule) {
        self.update_pending
            .store(schedule.needs_update, Ordering::SeqCst);
        self.frame_pending
            .store(schedule.needs_frame, Ordering::SeqCst);
        let mut next_deadline = self.lock_deadline();
        *next_deadline = if schedule.needs_update {
            None
        } else {
            schedule.next_deadline
        };
    }

    pub fn schedule<D>(&self, schedule: FrameSchedule, driver: &D)
    where
        D: PlatformFrameDriver + ?Sized,
    {
        self.record(schedule);
        schedule.apply_to(driver);
    }

    pub fn snapshot(&self) -> FrameSchedule {
        FrameSchedule {
            needs_update: self.update_pending.load(Ordering::SeqCst),
            needs_frame: self.frame_pending.load(Ordering::SeqCst),
            next_deadline: *self.lock_deadline(),
        }
    }
}

impl FrameSchedule {
    pub fn apply_to<D>(self, driver: &D)
    where
        D: PlatformFrameDriver + ?Sized,
    {
        if self.needs_frame {
            driver.clear_wake();
            driver.request_frame();
        } else if self.needs_update {
            driver.request_wake_at(web_time::Instant::now());
        } else if let Some(deadline) = self.next_deadline {
            driver.request_wake_at(deadline);
        } else {
            driver.clear_wake();
        }
    }
}

#[derive(Clone, Copy, Debug)]
pub(crate) struct DevOverlayControl {
    bounds: Rect,
    mode: FramePacingMode,
}

/// Development options for debugging and performance monitoring.
///
/// These are rendered directly by the renderer (not via composition)
/// to avoid affecting performance measurements.
#[derive(Clone, Debug, Default)]
pub struct DevOptions {
    /// Show FPS counter overlay
    pub fps_counter: bool,
    /// Show recomposition count
    pub recomposition_counter: bool,
    /// Show layout timing breakdown
    pub layout_timing: bool,
    pub frame_pacing_controls: bool,
    pub frame_pacing_mode: FramePacingMode,
}

#[cfg(any(test, feature = "test-support"))]
#[doc(hidden)]
#[derive(Clone, Copy, Debug)]
pub struct RuntimeLeakDebugStats {
    pub applier_stats: MemoryApplierDebugStats,
    pub live_node_heap_bytes: usize,
    pub recycled_node_heap_bytes: usize,
    pub slot_table_heap_bytes: usize,
    pub pass_stats: CompositionPassDebugStats,
    pub slot_stats: SlotTableDebugStats,
    pub observer_stats: SnapshotStateObserverDebugStats,
    pub runtime_stats: RuntimeDebugStats,
    pub state_arena_stats: StateArenaDebugStats,
    pub recompose_scope_stats: RecomposeScopeRegistryDebugStats,
    pub snapshot_v2_stats: SnapshotV2DebugStats,
    pub snapshot_pinning_stats: SnapshotPinningDebugStats,
}

impl ShellApp {
    pub(crate) fn request_layout_pass(&mut self) {
        self.layout_requested = true;
    }

    pub(crate) fn request_forced_layout_pass(&mut self) {
        self.layout_requested = true;
        self.force_layout_pass = true;
    }

    pub(crate) fn composition_tree_needs_layout(&mut self) -> bool {
        let Some(root) = self.composition.root() else {
            return true;
        };
        let mut applier = self.composition.applier_mut();
        cranpose_ui::tree_needs_layout(&mut *applier, root).unwrap_or_else(|err| {
            log::warn!("Cannot check layout dirty status for root #{root}: {err}");
            true
        })
    }

    pub(crate) fn has_stale_work_in_context(&self) -> bool {
        self.layout_requested
            || peek_render_invalidation()
            || peek_pointer_invalidation()
            || peek_focus_invalidation()
            || peek_layout_invalidation()
            || cranpose_ui::has_pending_layout_repasses()
            || cranpose_ui::has_pending_measure_repasses()
            || cranpose_ui::has_pending_draw_repasses()
            || has_pending_pointer_repasses()
            || has_pending_focus_invalidations()
    }

    pub(crate) fn wants_frame_in_context(&self) -> bool {
        self.layout_requested
            || peek_render_invalidation()
            || peek_pointer_invalidation()
            || peek_focus_invalidation()
            || peek_layout_invalidation()
            || cranpose_ui::has_pending_layout_repasses()
            || cranpose_ui::has_pending_measure_repasses()
            || self.composition.should_render()
    }

    pub(crate) fn needs_ui_update_in_context(&self, surfaces_dirty: bool) -> bool {
        surfaces_dirty
            || self.has_stale_work_in_context()
            || self.composition.runtime_handle().has_pending_ui()
            || has_pending_semantics_invalidations()
            || self.composition.should_render()
    }

    pub(crate) fn next_event_time(&self) -> Option<web_time::Instant> {
        let app_context = Rc::clone(&self.app_context);
        app_context.enter(cranpose_ui::next_cursor_blink_time)
    }

    pub(crate) fn frame_time_nanos_at(&self, now: Instant) -> u64 {
        now.checked_duration_since(self.start_time)
            .unwrap_or_default()
            .as_nanos()
            .min(u128::from(u64::MAX)) as u64
    }

    pub(crate) fn realtime_pointer_event_time(
        &self,
        platform_time_ms: Option<i64>,
    ) -> PointerEventTime {
        PointerEventTime {
            platform_time_ms,
            animation_time_nanos: self
                .frame_time_nanos_at(Instant::now())
                .max(self.last_frame_time_nanos),
        }
    }

    pub(crate) fn install_text_input_router(&mut self) {
        if self.text_input_router_installed {
            return;
        }
        let router = Rc::new(TextInputRouter {
            routes: Rc::clone(&self.text_input_routes),
        });
        let app_context = Rc::clone(&self.app_context);
        app_context
            .enter(|| cranpose_ui::text_input_session::set_platform_text_input_handler(router));
        self.text_input_router_installed = true;
    }
}

impl<R> AppShell<R>
where
    R: Renderer,
    R::Error: Debug,
{
    pub fn new(renderer: R, root_key: Key, content: impl FnMut() + 'static) -> Self {
        Self::new_with_size(renderer, root_key, content, (800, 600), (800.0, 600.0))
    }

    pub fn new_with_size(
        renderer: R,
        root_key: Key,
        content: impl FnMut() + 'static,
        buffer_size: (u32, u32),
        viewport: (f32, f32),
    ) -> Self {
        Self::new_with_size_and_density(renderer, root_key, content, buffer_size, viewport, 1.0)
    }

    pub fn new_with_size_and_density(
        mut renderer: R,
        root_key: Key,
        content: impl FnMut() + 'static,
        buffer_size: (u32, u32),
        viewport: (f32, f32),
        density: f32,
    ) -> Self {
        let app_context = cranpose_ui::AppContext::new_with_density(density);
        let runtime = StdRuntime::new();
        let mut composition = Composition::with_runtime(MemoryApplier::new(), runtime.runtime());
        let app_content = Rc::new(std::cell::RefCell::new(content));
        let mut build: Box<dyn FnMut()> = Box::new(move || {
            let app_content = Rc::clone(&app_content);
            cranpose_ui::density::ProvideDensity(cranpose_ui::Density::from_host(), move || {
                cranpose_ui::widgets::PopupHost(move || {
                    (app_content.borrow_mut())();
                });
            });
        });
        renderer.attach_app_context_services(&app_context);
        app_context.enter(|| {
            #[cfg(all(
                feature = "clipboard-native",
                not(target_arch = "wasm32"),
                not(target_os = "android"),
                not(target_os = "ios")
            ))]
            {
                let clipboard =
                    std::rc::Rc::new(std::cell::RefCell::new(arboard::Clipboard::new().ok()));
                cranpose_ui::clipboard_session::set_platform_clipboard(std::rc::Rc::new(
                    ShellClipboard { inner: clipboard },
                ));
            }
            if let Err(err) = composition.render_stable(root_key, &mut *build) {
                log::error!("initial render failed: {err}");
            }
        });
        renderer.scene_mut().clear();
        let app = ShellApp {
            app_context,
            runtime,
            composition,
            content: build,
            start_time: Instant::now(),
            last_frame_time_nanos: 0,
            semantics_enabled: false,
            semantics_snapshot_revision: 0,
            revealed_focus: None,
            layout_requested: true,
            force_layout_pass: true,
            modifiers: None,
            rotary_scroll_factor: DEFAULT_ROTARY_SCROLL_FACTOR_DP,
            #[cfg(all(feature = "clipboard-native", target_os = "linux"))]
            clipboard: arboard::Clipboard::new().ok(),
            dev_options: DevOptions::default(),
            inspector_projector: None,
            fps_monitor: fps_monitor::FpsMonitor::new(),
            text_input_routes: Rc::new(RefCell::new(TextInputRoutes::default())),
            text_input_router_installed: false,
            window_roots_seen: None,
        };
        let mut shell = Self {
            app,
            surfaces: vec![RootSurface::new(
                RootId::Primary,
                renderer,
                buffer_size,
                viewport,
            )],
        };
        shell.process_frame();
        shell
    }

    /// The shell's [`AppContext`](cranpose_ui::AppContext). Platform backends
    /// use it to register per-context services (such as the OS clipboard) that
    /// need UIKit/JNI access the shell itself does not have: enter the context
    /// and call the relevant `set_platform_*` installer.
    pub fn app_context(&self) -> &Rc<cranpose_ui::AppContext> {
        &self.app.app_context
    }

    /// The surface drawing `root`, or `None` when no surface was added for
    /// it. The primary surface always exists.
    pub fn surface(&mut self, root: RootId) -> Option<SurfaceMut<'_, R>> {
        let index = self.surface_index(root)?;
        Some(SurfaceMut::new(self, index))
    }

    /// The surface drawing the composition root.
    pub fn primary(&mut self) -> SurfaceMut<'_, R> {
        SurfaceMut::new(self, 0)
    }

    /// The root whose surface now draws the node that took the primary
    /// press, or `None` while no press is being held.
    ///
    /// A press is taken by a node, not by a rectangle. When the application
    /// moves that node into a window of its own — a tab pulled out of a
    /// strip, a pane pulled off a stack — the press belongs to that window
    /// from then on, and a platform can hand it over on the strength of this
    /// rather than on where the pointer happens to be.
    pub fn root_holding_the_press(&mut self) -> Option<RootId> {
        let pressed = self
            .surfaces
            .iter()
            .find_map(|surface| surface.hit_path_tracker.dispatch_order(PointerId::PRIMARY))?;
        let primary_root = self.app.composition.root()?;
        let mut applier = self.app.composition.applier_mut();
        let holder = pressed.into_iter().find_map(|node| {
            let node = applier.scene_node_attached_to(node, primary_root)?;
            Some(cranpose_ui::nearest_window_root(&mut applier, node))
        })?;
        drop(applier);
        self.surfaces
            .iter()
            .find(|surface| surface.owns_nodes_under(holder))
            .map(|surface| surface.id)
    }

    fn surface_index(&self, root: RootId) -> Option<usize> {
        self.surfaces.iter().position(|surface| surface.id == root)
    }

    /// Gives the window root registered under `window` a surface of its
    /// own, drawn by `renderer` into a framebuffer of `buffer_size` physical
    /// pixels and `viewport` logical pixels. The surface follows the window
    /// root node while it stays in the tree, and draws nothing while it is
    /// out. Returns the renderer of the surface this one replaces, if the
    /// window already had one.
    ///
    /// The renderer joins an app whose services the primary renderer
    /// already installed; nothing is attached to the app context again.
    pub fn add_window_surface(
        &mut self,
        window: u64,
        renderer: R,
        buffer_size: (u32, u32),
        viewport: (f32, f32),
    ) -> Option<R> {
        let previous = self.remove_window_surface(window);
        self.surfaces.push(RootSurface::new(
            RootId::Window(window),
            renderer,
            buffer_size,
            viewport,
        ));
        self.app.window_roots_seen = None;
        self.sync_window_roots();
        previous
    }

    /// Takes the surface of `window` away, handing back its renderer.
    pub fn remove_window_surface(&mut self, window: u64) -> Option<R> {
        let root = RootId::Window(window);
        let index = self.surface_index(root)?;
        self.app.text_input_routes.borrow_mut().remove(root);
        Some(self.surfaces.remove(index).renderer)
    }

    /// Every surface's root, the primary first.
    pub fn surface_ids(&self) -> Vec<RootId> {
        self.surfaces.iter().map(|surface| surface.id).collect()
    }

    /// The window roots attached in the composition right now. A platform
    /// reads this after an update to open a window for each new entry and
    /// close the windows whose entries left.
    pub fn window_roots(&self) -> Vec<WindowRootEntry> {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(cranpose_ui::window_roots)
    }

    /// Changes whenever a window root attaches, detaches or is updated; a
    /// platform that stored the last value it acted on skips
    /// [`Self::window_roots`] while it reads the same.
    pub fn window_roots_revision(&self) -> u64 {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(cranpose_ui::window_roots_revision)
    }

    /// Whether the primary root lays out anything of its own: a node with
    /// area outside every window root. A platform hides the primary window
    /// while this is false, because every visible node is then in a window
    /// of its own.
    pub fn primary_has_content(&mut self) -> bool {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| {
            self.surfaces[0]
                .layout_tree_in_context(&mut self.app)
                .is_some_and(|tree| tree.root().children.iter().any(layout_has_area))
        })
    }

    /// The extent of what the primary root lays out: the far right and
    /// bottom edges of its nodes with area, measured from the root's origin
    /// and leaving out every window root's subtree. `None` while it lays
    /// out nothing. A platform whose primary window wraps its content sizes
    /// the window to this after every update.
    pub fn primary_content_size(&mut self) -> Option<Size> {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| {
            self.surfaces[0]
                .layout_tree_in_context(&mut self.app)
                .and_then(|tree| {
                    tree.root()
                        .children
                        .iter()
                        .filter_map(layout_extent)
                        .reduce(farther_extent)
                })
        })
    }

    /// The `drag_and_drop_target` under `point` and where the point falls in
    /// that target's surface. A point on the screen is looked up in every
    /// surface whose window position the platform told, later windows
    /// first and the primary last; a point without one only in `source`,
    /// the surface holding the press.
    pub(crate) fn drag_and_drop_target_at(
        &mut self,
        point: cranpose_ui::DragAndDropPoint,
        source: usize,
    ) -> Option<(NodeId, cranpose_ui::Point)> {
        let app_context = Rc::clone(&self.app.app_context);
        let candidates: Vec<(usize, cranpose_ui::Point)> = match point.screen {
            Some(screen) => (0..self.surfaces.len())
                .rev()
                .filter_map(|index| {
                    let local = self.surfaces[index].screen_point_inside(screen)?;
                    Some((index, local))
                })
                .collect(),
            None => vec![(source, point.local)],
        };
        candidates.into_iter().find_map(|(index, local)| {
            self.surfaces[index]
                .renderer
                .scene()
                .hit_test_nodes(local.x, local.y)
                .into_iter()
                .find(|node| app_context.drag_and_drop().is_target(*node))
                .map(|node| (node, local))
        })
    }

    /// Names the surface the platform considers focused, which is where the
    /// soft keyboard belongs. Pointer presses activate their surface on
    /// their own; a platform calls this for focus it grants otherwise.
    pub fn set_active_root(&mut self, root: RootId) {
        self.app.text_input_routes.borrow_mut().set_active(root);
    }

    /// The surface the platform considers focused.
    pub fn active_root(&self) -> RootId {
        self.app.text_input_routes.borrow().active()
    }

    fn sync_window_roots(&mut self) {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| self.sync_window_roots_in_context());
    }

    pub(crate) fn sync_window_roots_in_context(&mut self) {
        let revision = cranpose_ui::window_roots_revision();
        if self.app.window_roots_seen == Some(revision) {
            return;
        }
        self.app.window_roots_seen = Some(revision);
        let entries = cranpose_ui::window_roots();
        for surface in &mut self.surfaces {
            let RootId::Window(id) = surface.id else {
                continue;
            };
            let root = entries
                .iter()
                .find(|entry| entry.node as u64 == id)
                .map(|entry| entry.node);
            surface.set_root(root);
        }
    }

    pub(crate) fn any_surface_dirty(&self) -> bool {
        self.surfaces
            .iter()
            .any(|surface| surface.is_dirty || surface.scene_dirty)
    }

    pub(crate) fn mark_all_dirty(&mut self) {
        for surface in &mut self.surfaces {
            surface.is_dirty = true;
        }
    }

    fn clear_surface_dirt(&mut self) {
        for surface in &mut self.surfaces {
            surface.is_dirty = false;
        }
    }

    fn invalidate_dev_overlay_text(&mut self) {
        for surface in &mut self.surfaces {
            surface.invalidate_dev_overlay_text();
        }
    }

    /// Set development options for debugging and performance monitoring.
    ///
    /// The FPS counter and other overlays are rendered directly by the renderer
    /// (not via composition) to avoid affecting performance measurements.
    pub fn set_dev_options(&mut self, options: DevOptions) {
        self.app.dev_options = options;
        self.invalidate_dev_overlay_text();
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(request_render_invalidation);
        self.mark_all_dirty();
    }

    /// Get a reference to the current dev options.
    pub fn dev_options(&self) -> &DevOptions {
        &self.app.dev_options
    }

    pub fn frame_pacing_mode(&self) -> FramePacingMode {
        self.app.dev_options.frame_pacing_mode
    }

    pub fn current_fps(&self) -> f32 {
        self.app.fps_monitor.current_fps()
    }

    pub fn fps_stats(&self) -> FpsStats {
        self.app.fps_monitor.stats()
    }

    pub fn reset_fps_stats(&mut self) {
        self.app.fps_monitor.reset_stats();
        self.invalidate_dev_overlay_text();
    }

    pub fn record_presented_frame(
        &mut self,
        frame_started_at: Instant,
        frame_finished_at: Instant,
    ) {
        self.app
            .fps_monitor
            .record_frame_work(frame_started_at, frame_finished_at);
    }

    #[cfg(any(test, feature = "test-support"))]
    #[doc(hidden)]
    pub fn record_presented_frame_for_test(
        &mut self,
        frame_started_nanos: u64,
        frame_finished_nanos: u64,
    ) {
        let started = self.app.start_time + std::time::Duration::from_nanos(frame_started_nanos);
        let finished = self.app.start_time + std::time::Duration::from_nanos(frame_finished_nanos);
        self.record_presented_frame(started, finished);
    }

    pub fn set_frame_pacing_mode(&mut self, mode: FramePacingMode) {
        if self.app.dev_options.frame_pacing_mode == mode {
            return;
        }
        self.app.dev_options.frame_pacing_mode = mode;
        self.invalidate_dev_overlay_text();
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(request_render_invalidation);
        self.mark_all_dirty();
    }

    /// Where the dev overlay draws the control for `mode`, in logical pixels.
    ///
    /// The overlay is drawn by the renderer rather than composed, so it has no
    /// semantics for a test to search. Without this a test that wants to press
    /// a pacing control has to hard-code a coordinate and silently starts
    /// passing against empty space the moment the overlay's text changes.
    pub fn dev_overlay_control_center(&self, mode: FramePacingMode) -> Option<(f32, f32)> {
        self.surfaces[0].dev_overlay_control_center(mode)
    }

    /// Sets the primary surface's viewport and lays out and renders at once.
    pub fn set_viewport(&mut self, width: f32, height: f32) {
        self.primary().set_viewport(width, height);
        self.process_frame();
    }

    pub fn viewport_size(&self) -> (f32, f32) {
        self.surfaces[0].viewport
    }

    /// Tells the shell where the primary window sits on the screen. See
    /// [`SurfaceMut::set_screen_origin`].
    pub fn set_screen_origin(&mut self, origin: Option<cranpose_ui_graphics::Point>) {
        self.surfaces[0].screen_origin = origin;
    }

    pub fn set_buffer_size(&mut self, width: u32, height: u32) {
        self.surfaces[0].buffer_size = (width, height);
    }

    pub fn buffer_size(&self) -> (u32, u32) {
        self.surfaces[0].buffer_size
    }

    pub fn scene(&self) -> &R::Scene {
        self.surfaces[0].renderer.scene()
    }

    pub fn renderer(&mut self) -> &mut R {
        &mut self.surfaces[0].renderer
    }

    #[cfg(not(target_arch = "wasm32"))]
    pub fn set_frame_waker(&mut self, waker: impl Fn() + Send + Sync + 'static) {
        self.app.runtime.set_frame_waker(waker);
    }

    #[cfg(target_arch = "wasm32")]
    pub fn set_frame_waker(&mut self, waker: impl Fn() + 'static) {
        self.app.runtime.set_frame_waker(waker);
    }

    pub fn clear_frame_waker(&mut self) {
        self.app.runtime.clear_frame_waker();
    }

    pub fn should_render(&self) -> bool {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| {
            self.app.wants_frame_in_context()
                || self.surfaces.iter().any(|surface| surface.scene_dirty)
        })
    }

    pub fn needs_update(&self) -> bool {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| {
            self.app
                .needs_ui_update_in_context(self.any_surface_dirty())
        })
    }

    /// Returns true when the runtime holds work for the UI thread: posted tasks,
    /// continuations from worker threads, or async tasks ready to poll.
    ///
    /// This is the part of [`needs_update`](Self::needs_update) that another
    /// thread is waiting on, told apart from the part that only wants the screen
    /// redrawn. A platform backend running with no surface uses it to compose
    /// for work and stay asleep for animation.
    pub fn has_pending_ui(&self) -> bool {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| self.app.composition.runtime_handle().has_pending_ui())
    }

    /// Returns true if the primary surface owes the display a frame: stale
    /// pixels, or a renderer that has not warmed its swapchain yet.
    ///
    /// An app that merely holds an open `next_frame()` await - a game loop, a
    /// polling effect - keeps [`Self::needs_update`] true forever without
    /// changing a single pixel. Such an app must still be *ticked* every frame,
    /// but the frame it produces is byte-identical to the last one, and
    /// presenting it costs a full swapchain rotation and pins the panel at its
    /// maximum refresh rate. Callers pair this with
    /// [`FrameUpdateResult::visual_changed`] from the update they just ran,
    /// which reports the work that update actually did.
    /// Note: Cursor blink is now timer-based and uses WaitUntil scheduling, not continuous redraw.
    pub fn needs_redraw(&self) -> bool {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| self.surfaces[0].needs_redraw_in_context(&self.app))
    }

    /// Marks the primary surface as dirty, indicating a redraw is needed.
    pub fn mark_dirty(&mut self) {
        self.surfaces[0].is_dirty = true;
    }

    pub fn request_root_render(&mut self) {
        self.app.composition.request_root_render();
        self.app.request_forced_layout_pass();
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(request_render_invalidation);
        self.mark_all_dirty();
    }

    pub fn set_density(&mut self, density: f32) {
        let app_context = Rc::clone(&self.app.app_context);
        let changed = app_context.enter(|| {
            let previous = cranpose_ui::current_density().to_bits();
            cranpose_ui::set_density(density);
            previous != cranpose_ui::current_density().to_bits()
        });
        if changed {
            self.request_root_render();
        }
    }

    /// Reports the system font scale the platform is showing text at.
    ///
    /// Hosts call this at startup and on every configuration change. Sizes in
    /// `Sp` follow it, sizes in `Dp` do not, which is what lets an app grow its
    /// text with the user's setting while its layout stays where it was.
    ///
    /// This takes the setting as a plain multiplier. A host whose platform
    /// converts `Sp` through a table of its own — Android 14 and up does — calls
    /// [`AppShell::set_font_scale_curve`] with what the platform answered
    /// instead, because the multiplication is not what that platform does.
    pub fn set_font_scale(&mut self, font_scale: f32) {
        self.set_font_scale_curve(cranpose_ui::FontScaleCurve::linear(font_scale));
    }

    /// Reports the system font scale together with the conversion behind it.
    ///
    /// See [`cranpose_ui::font_scale`]: above a threshold setting Android
    /// resolves a size in `Sp` through a piecewise-linear table rather than by
    /// multiplying, so a host that can read that table hands it over here and
    /// every `Sp` in the app resolves the way the platform's own text does.
    pub fn set_font_scale_curve(&mut self, curve: cranpose_ui::FontScaleCurve) {
        let app_context = Rc::clone(&self.app.app_context);
        let changed = app_context.enter(|| {
            let previous = cranpose_ui::current_font_scale_curve();
            cranpose_ui::set_font_scale_curve(curve);
            previous != cranpose_ui::current_font_scale_curve()
        });
        if changed {
            self.request_root_render();
        }
    }

    #[cfg(any(test, feature = "test-support"))]
    #[doc(hidden)]
    pub fn debug_current_density(&self) -> f32 {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(cranpose_ui::current_density)
    }

    #[cfg(any(test, feature = "test-support"))]
    #[doc(hidden)]
    pub fn debug_current_font_scale(&self) -> f32 {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(cranpose_ui::current_font_scale)
    }

    #[cfg(any(test, feature = "test-support"))]
    #[doc(hidden)]
    pub fn debug_current_font_scale_curve(&self) -> cranpose_ui::FontScaleCurve {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(cranpose_ui::current_font_scale_curve)
    }

    #[cfg(any(test, feature = "test-support"))]
    #[doc(hidden)]
    pub fn debug_enter_app_context<T>(&self, block: impl FnOnce() -> T) -> T {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(block)
    }

    /// Returns true if there are active animations or pending recompositions.
    pub fn has_active_animations(&self) -> bool {
        self.app.composition.should_render()
    }

    pub fn has_transient_frame_callbacks(&self) -> bool {
        self.app
            .composition
            .runtime_handle()
            .has_transient_frame_callbacks()
    }

    pub fn has_active_pointer_gesture(&self) -> bool {
        self.surfaces[0].has_active_pointer_gesture()
    }

    /// Primary-surface form of [`SurfaceMut::frame_owed`].
    pub fn frame_owed(&self) -> bool {
        self.surfaces[0].frame_owed
    }

    /// Primary-surface form of [`SurfaceMut::take_frame_owed`].
    pub fn take_frame_owed(&mut self) -> bool {
        std::mem::take(&mut self.surfaces[0].frame_owed)
    }

    /// Returns the next scheduled event time for cursor blink.
    /// Use this for `ControlFlow::WaitUntil` scheduling.
    pub fn next_event_time(&self) -> Option<web_time::Instant> {
        self.app.next_event_time()
    }

    fn compute_frame_schedule(&self) -> FrameSchedule {
        self.surfaces[0].compute_frame_schedule(&self.app, self.any_surface_dirty())
    }

    pub fn frame_schedule(&self) -> FrameSchedule {
        let schedule = self.compute_frame_schedule();
        self.surfaces[0].frame_scheduler.record(schedule);
        schedule
    }

    pub fn schedule_platform_frame<D>(&self, driver: &D) -> FrameSchedule
    where
        D: PlatformFrameDriver + ?Sized,
    {
        let schedule = self.compute_frame_schedule();
        self.surfaces[0].frame_scheduler.schedule(schedule, driver);
        schedule
    }

    pub fn frame_scheduler_snapshot(&self) -> FrameSchedule {
        self.surfaces[0].frame_scheduler.snapshot()
    }

    /// Timestamp a live input sample against the current animation clock.
    pub fn realtime_pointer_event_time(&self, platform_time_ms: Option<i64>) -> PointerEventTime {
        self.app.realtime_pointer_event_time(platform_time_ms)
    }

    /// Timestamp deterministic input at the most recently processed frame.
    pub fn exact_pointer_event_time(&self, platform_time_ms: Option<i64>) -> PointerEventTime {
        PointerEventTime {
            platform_time_ms,
            animation_time_nanos: self.app.last_frame_time_nanos,
        }
    }

    pub fn update_after_frame_interval(
        &mut self,
        frame_interval: std::time::Duration,
    ) -> FrameUpdateResult {
        let wall_frame_time = self.app.frame_time_nanos_at(Instant::now());
        let base_frame_time = self.app.last_frame_time_nanos.max(wall_frame_time);
        let frame_time = base_frame_time
            .saturating_add(frame_interval.as_nanos().min(u128::from(u64::MAX)) as u64);
        self.update_at_frame_time_nanos(frame_time)
    }

    /// Advance the frame clock by EXACTLY `frame_interval` past the last
    /// frame — no wall anchoring — and run one update there. Robot keyframe
    /// captures ride this to sample animations deterministically: while the
    /// advanced clock is ahead of wall time, interleaved wall-clocked
    /// updates clamp to it (dt 0) instead of fast-forwarding animations.
    pub fn update_after_exact_interval(
        &mut self,
        frame_interval: std::time::Duration,
    ) -> FrameUpdateResult {
        let frame_time = self
            .app
            .last_frame_time_nanos
            .saturating_add(frame_interval.as_nanos().min(u128::from(u64::MAX)) as u64);
        self.update_at_frame_time_nanos(frame_time)
    }

    pub fn update_at_frame_time_nanos(&mut self, frame_time: u64) -> FrameUpdateResult {
        let app_context = Rc::clone(&self.app.app_context);
        app_context.enter(|| {
            let update_started_at = Instant::now();
            let frame_time = frame_time.max(self.app.last_frame_time_nanos);
            self.app.last_frame_time_nanos = frame_time;
            let runtime_handle = self.app.runtime.runtime_handle();
            runtime_handle.with_deferred_state_releases(|| {
                self.app.runtime.drain_frame_callbacks(frame_time);
                let after_frame_callbacks = Instant::now();
                runtime_handle.drain_ui();
                let after_ui_drain = Instant::now();
                let should_render = self.app.composition.should_recompose();
                let mut reconcile_attempted = false;
                let mut reconcile_changed = false;
                if should_render {
                    log::trace!(
                        target: "cranpose::input",
                        "update begin: should_render=true layout_requested={} scene_dirty={} is_dirty={}",
                        self.app.layout_requested,
                        self.surfaces[0].scene_dirty,
                        self.surfaces[0].is_dirty
                    );
                    (reconcile_attempted, reconcile_changed) = self.reconcile_in_context();
                }
                let after_reconcile = Instant::now();
                let result = self.process_frame_in_context(reconcile_changed);
                let after_process_frame = Instant::now();
                log_update_stage_telemetry(UpdateStageTelemetry {
                    started_at: update_started_at,
                    after_frame_callbacks,
                    after_ui_drain,
                    after_reconcile,
                    after_process_frame,
                    should_render,
                    reconcile_attempted,
                    reconcile_changed,
                });
                self.clear_surface_dirt();
                result
            })
        })
    }

    fn reconcile_in_context(&mut self) -> (bool, bool) {
        let Some(root_key) = self.app.composition.root_key() else {
            return (false, false);
        };
        match self
            .app
            .composition
            .reconcile(root_key, &mut *self.app.content)
        {
            Ok(changed) => {
                log::trace!(
                    target: "cranpose::input",
                    "reconcile changed={changed}"
                );
                if changed {
                    self.app.fps_monitor.record_recomposition();
                    if self.app.composition_tree_needs_layout() {
                        self.app.request_layout_pass();
                    }
                    request_render_invalidation();
                }
                (true, changed)
            }
            Err(NodeError::Missing { id }) => {
                log::debug!("Recomposition skipped: node {id} no longer exists");
                self.app.request_layout_pass();
                request_render_invalidation();
                (true, false)
            }
            Err(err) => {
                log::error!("recomposition failed: {err}");
                self.app.request_layout_pass();
                request_render_invalidation();
                (true, false)
            }
        }
    }

    pub fn update(&mut self) -> FrameUpdateResult {
        let frame_time = self.app.frame_time_nanos_at(Instant::now());
        self.update_at_frame_time_nanos(frame_time)
    }
}

impl<R> Drop for AppShell<R>
where
    R: Renderer,
{
    fn drop(&mut self) {
        self.app.runtime.clear_frame_waker();
    }
}

fn layout_has_area(layout: &cranpose_ui::LayoutBox) -> bool {
    (layout.rect.width > 0.0 && layout.rect.height > 0.0)
        || layout.children.iter().any(layout_has_area)
}

fn layout_extent(layout: &cranpose_ui::LayoutBox) -> Option<Size> {
    let own = (layout.rect.width > 0.0 && layout.rect.height > 0.0).then(|| {
        Size::new(
            layout.rect.x + layout.rect.width,
            layout.rect.y + layout.rect.height,
        )
    });
    layout
        .children
        .iter()
        .filter_map(layout_extent)
        .chain(own)
        .reduce(farther_extent)
}

fn farther_extent(a: Size, b: Size) -> Size {
    Size::new(a.width.max(b.width), a.height.max(b.height))
}

pub fn default_root_key() -> Key {
    location_key(file!(), line!(), column!())
}

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

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

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