rdom-tui 0.5.0

//! # rdom-tui — terminal rendering for rdom-core
//!
//! Wraps `rdom_core::Dom<TuiExt>` with presentation data: flexbox layout,
//! TUI styles, scroll state, pseudo-elements (`::before`/`::after`), and
//! a CSS-faithful cascade. The pure DOM tree lives in `rdom-core`; this
//! crate adds the "how should it render to a terminal" layer.
//!
//! ## Quick start
//!
//! ```
//! use rdom_tui::prelude::*;
//!
//! let mut dom: TuiDom = TuiDom::new();
//! let root = dom.root();
//! let div = dom.create_element("div");
//! dom.node_mut(div).add_class("hero").unwrap();
//! dom.append_child(root, div).unwrap();
//!
//! let sheet = Stylesheet::new()
//!     .rule(".hero", TuiStyle::new().fg(Color::Rgb(255, 0, 0)).padding(Padding::all(1)))
//!     .unwrap();
//! dom.cascade(&sheet);
//!
//! let computed = dom.node(div).computed().unwrap();
//! assert_eq!(computed.fg, Color::Rgb(255, 0, 0));
//! assert_eq!(computed.padding, Padding::all(1));
//! ```
//!
//! ## What's here
//!
//! - **`TuiExt`** — per-element presentation data (inline style,
//!   computed style cache, dirty flags, geometry, scroll state).
//! - **`TuiStyle`** / **`ComputedStyle`** — author-input vs.
//!   post-cascade style; `TuiStyle` uses `Option<Value<T>>` to carry
//!   specified/inherit/initial; `ComputedStyle` is fully concrete.
//! - **`Stylesheet`** + **`CascadeExt`** — rule storage + cascade
//!   engine with 4-tuple specificity, `!important` ladder,
//!   pseudo-elements, `content`, and `var(--…)` resolution.
//! - **`DirtyTracker`** — `MutationObserver` impl that drives
//!   incremental re-cascade via `cascade_subtrees(&sheet, &roots)`.
//! - **`:hover`/`:focus`** pseudo-classes driven by `Dom::set_hovered`
//!   / `set_focused`.
//!
//! ## Type aliases
//!
//! - `TuiDom`       → `rdom_core::Dom<TuiExt>`
//! - `TuiNodeRef`   → `rdom_core::NodeRef<'_, TuiExt>`
//! - `TuiNodeMut`   → `rdom_core::NodeMut<'_, TuiExt>`
//! - `TuiEventCtx`  → `rdom_core::EventCtx<'_, TuiExt>`

use rdom_core as core;

pub mod accessors;
pub mod cssom;
pub mod editing;
pub mod ext;
pub mod layout;
pub mod node;
pub mod prelude;
pub mod render;
pub mod runtime;
pub mod style;
pub mod tui_event;

pub use accessors::{
    ScrollBehaviorOption, ScrollIntoViewOptions, ScrollLogicalPosition, ScrollToOptions,
    TuiAccessors, TuiAccessorsMut, TuiDocAccessors,
};
pub use cssom::{extend_from_style_tags, seed_inline_styles};
pub use tui_event::{TuiDispatchExt, TuiEvent};

pub use ext::{PseudoLayout, StaticPosition, TuiExt};
pub use layout::{
    Align, Border, Direction, Display, Flow, LayoutRect, Overflow, Padding, Size, UserSelect,
    WhiteSpace,
};
pub use node::{TuiNodeExt, TuiNodeMutExt};
/// Test-only VT emulator; see [`render::virtual_screen`].
#[cfg(any(test, feature = "test-util"))]
pub use render::VirtualScreen;
pub use render::{
    Backend, Buffer, Cell, CellDiff, CompletedFrame, CrosstermBackend, LayoutExt, PaintExt, Rect,
    Style, Terminal, TerminalGuard, TestBackend,
};
/// The canvas paint surface a `<canvas>` `set_paint` callback receives.
/// (Re-exported here as the canonical `RenderContext`; the old, unused
/// `render::RenderContext` was removed in `RENDERCTX-DEDUP-1`.)
pub use runtime::builtins::canvas::RenderContext;
pub use runtime::builtins::form::SubmitOutcome;
pub use runtime::builtins::validation::ValidityState;
pub use runtime::{
    App, AppContext, AppHandle, ControlFlow, HitTestExt, RouteOutcome, Router, StylesheetId,
};
pub use style::{
    CascadeExt, Color, ComputedStyle, Content, DirtyTracker, ImportantMask, Modifier,
    PseudoElementTarget, Rule, RuleOrigin, Specificity, StyleError, Stylesheet, TuiColor, TuiStyle,
    Value, VarMap, parse_color, resolve_tui_color,
};

/// `Dom<TuiExt>` — the full TUI document.
pub type TuiDom = core::Dom<TuiExt>;

/// Borrowed node accessor for `TuiDom`.
pub type TuiNodeRef<'a> = core::NodeRef<'a, TuiExt>;

/// Mutable node accessor for `TuiDom`.
pub type TuiNodeMut<'a> = core::NodeMut<'a, TuiExt>;

/// Event dispatch context for `TuiDom`.
pub type TuiEventCtx<'a> = core::EventCtx<'a, TuiExt>;

// Re-export the bits a caller typically needs so `use rdom_tui::*` is
// a reasonable start. The full rdom-core API is accessible via
// `rdom_tui::core_api::…` (re-exported below).
pub use rdom_core as core_api;
pub use rdom_core::{
    AdjacentPosition, ContentEditableState, DocumentPosition, DomError, Event, EventDetail,
    EventPhase, FormEnctype, FormMethod, InputDetail, InputType, InputTypeState, InteractionKind,
    KeyboardDetail, KeyboardModifiers, ListenerId, ListenerOptions, MouseButton, MouseDetail,
    Mutation, MutationObserver, NodeData, NodeId, NodeType, ObserverId, Position, Range, Result,
    Selection, SelectionSerial, SubmitDetail, ToggleDetail, ToggleState, TransitionDetail,
    ValidityHook,
};

#[cfg(test)]
mod tests {
    use super::*;

    /// `P7G-API-NAMES-1`: the rdom-core form / editing vocabulary a
    /// consumer names alongside `FormMethod` is re-exported here.
    #[test]
    fn form_and_editing_vocabulary_is_reexported() {
        let mut dom: TuiDom = TuiDom::new();
        let input = dom.create_element("input");
        assert_eq!(dom.input_type_state(input), Some(InputTypeState::Text));
        dom.set_attribute(input, "contenteditable", "").unwrap();
        assert_eq!(
            dom.content_editable_state(input),
            Some(ContentEditableState::True)
        );
        let hook: ValidityHook<TuiExt> = |_, _| true;
        dom.set_validity_hook(Some(hook));
        let serial: SelectionSerial = dom.selection_serial();
        assert_eq!(serial, dom.selection_serial());
    }

    #[test]
    fn tui_dom_aliases_compile() {
        let mut dom: TuiDom = TuiDom::new();
        let root = dom.root();
        let div = dom.create_element("div");
        dom.append_child(root, div).unwrap();

        // Accessor alias works.
        let node: TuiNodeRef<'_> = dom.node(div);
        assert_eq!(node.tag_name(), Some("div"));

        // Mutating alias works.
        let mut node_mut: TuiNodeMut<'_> = dom.node_mut(div);
        node_mut.set_id("hero").unwrap();
        assert_eq!(dom.node(div).get_attribute("id"), Some("hero"));
    }

    #[test]
    fn default_ext_is_default_tui_ext() {
        let ext: TuiExt = TuiExt::default();
        // Geometry lives in `inline_style` (empty by default) since
        // EXT-LAYOUT-SETTERS-1 removed the raw `ext` geometry fields.
        assert!(ext.inline_style.is_none());
    }

    #[test]
    fn event_dispatch_works_over_tui_ext() {
        use std::cell::Cell;
        use std::rc::Rc;

        let mut dom: TuiDom = TuiDom::new();
        let btn = dom.create_element("button");
        let fired = Rc::new(Cell::new(false));
        let f = fired.clone();
        dom.add_event_listener(
            btn,
            "click",
            ListenerOptions::default(),
            move |_ctx: &mut TuiEventCtx<'_>| {
                f.set(true);
            },
        )
        .unwrap();

        let mut e = Event::new("click");
        dom.dispatch_event(btn, &mut e).unwrap();
        assert!(fired.get());
    }

    #[test]
    fn query_selector_works_over_tui_ext() {
        let mut dom: TuiDom = TuiDom::new();
        let root = dom.root();
        let div = dom.create_element("div");
        dom.node_mut(div).set_id("target").unwrap();
        dom.append_child(root, div).unwrap();

        assert_eq!(dom.query_selector_in(root, "#target").unwrap(), Some(div));
    }

    #[test]
    fn presentation_builder_end_to_end() {
        let mut dom: TuiDom = TuiDom::new();
        let root = dom.root();
        let div = dom.create_element("div");
        // Geometry setters now write `inline_style`, and `set_inline_style`
        // replaces it wholesale — so seed the inline style first, then let
        // the geometry setters patch onto it.
        dom.node_mut(div)
            .set_inline_style(
                TuiStyle::new()
                    .fg(Color::Rgb(255, 255, 255))
                    .bg(Color::Rgb(0, 0, 0)),
            )
            .set_width(Size::Fixed(80))
            .set_height(Size::Flex(1))
            .set_padding(Padding::symmetric(2, 1))
            .set_border(Border::rounded())
            .set_gap(1)
            .set_direction(Direction::Row);

        dom.append_child(root, div).unwrap();

        let n = dom.node(div);
        assert_eq!(n.width(), Some(Size::Fixed(80)));
        assert_eq!(n.padding(), Some(Padding::symmetric(2, 1)));
        assert_eq!(n.border(), Some(Border::rounded()));
        assert_eq!(
            n.inline_style().unwrap().fg,
            Some(Value::Specified(TuiColor::Literal(Color::Rgb(
                255, 255, 255
            ))))
        );
    }
}