dioxus/packages/tui/src/lib.rs

// notes:
// mouse events binary search was broken for absolutely positioned elements

use anyhow::Result;
use crossterm::{
    event::{DisableMouseCapture, EnableMouseCapture, Event as TermEvent, KeyCode, KeyModifiers},
    execute,
    terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
};
use dioxus_core::exports::futures_channel::mpsc::unbounded;
use dioxus_core::*;
use dioxus_html::on::{KeyboardData, MouseData, PointerData, TouchData, WheelData};
use dioxus_native_core::{layout::StretchLayout, Tree};
use futures::{channel::mpsc::UnboundedSender, pin_mut, StreamExt};
use std::collections::HashSet;
use std::{io, time::Duration};
use stretch2::{prelude::Size, Stretch};
use style_attributes::StyleModifier;
use tokio::time::Instant;
use tui::{backend::CrosstermBackend, Terminal};

mod config;
mod hooks;
mod render;
mod style;
mod style_attributes;
mod widget;

pub use config::*;
pub use hooks::*;
pub use render::*;

pub fn launch(app: Component<()>) {
    launch_cfg(app, Config::default())
}

pub fn launch_cfg(app: Component<()>, cfg: Config) {
    let mut dom = VirtualDom::new(app);
    let (tx, rx) = unbounded();

    let cx = dom.base_scope();

    let (handler, state) = RinkInputHandler::new(rx, cx);

    cx.provide_root_context(state);

    let mut tree: Tree<StretchLayout, StyleModifier> = Tree::new();
    let mutations = dom.rebuild();
    let to_update = tree.apply_mutations(vec![mutations]);
    let mut stretch = Stretch::new();
    let _to_rerender = tree
        .update_state(&dom, to_update, &mut stretch, &mut ())
        .unwrap();

    render_vdom(&mut dom, tx, handler, cfg, tree, stretch).unwrap();
}

pub fn render_vdom(
    vdom: &mut VirtualDom,
    ctx: UnboundedSender<TermEvent>,
    handler: RinkInputHandler,
    cfg: Config,
    mut tree: Tree<StretchLayout, StyleModifier>,
    mut stretch: Stretch,
) -> Result<()> {
    // Setup input handling
    let (tx, mut rx) = unbounded();
    std::thread::spawn(move || {
        let tick_rate = Duration::from_millis(100);
        let mut last_tick = Instant::now();
        loop {
            // poll for tick rate duration, if no events, sent tick event.
            let timeout = tick_rate
                .checked_sub(last_tick.elapsed())
                .unwrap_or_else(|| Duration::from_secs(0));

            if crossterm::event::poll(timeout).unwrap() {
                let evt = crossterm::event::read().unwrap();
                tx.unbounded_send(InputEvent::UserInput(evt)).unwrap();
            }

            if last_tick.elapsed() >= tick_rate {
                tx.unbounded_send(InputEvent::Tick).unwrap();
                last_tick = Instant::now();
            }
        }
    });

    tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .build()?
        .block_on(async {
            /*
            Get the terminal to calcualte the layout from
            */
            enable_raw_mode().unwrap();
            let mut stdout = std::io::stdout();
            execute!(stdout, EnterAlternateScreen, EnableMouseCapture).unwrap();
            let backend = CrosstermBackend::new(io::stdout());
            let mut terminal = Terminal::new(backend).unwrap();

            terminal.clear().unwrap();
            let mut to_rerender: HashSet<usize> = tree
                .nodes
                .iter()
                .filter_map(|n| n.as_ref())
                .map(|n| n.id.0)
                .collect();

            loop {
                /*
                -> collect all the nodes
                -> resolve events
                -> render the nodes in the right place with tui/crossterm
                -> rendering
                -> lazily update the layout and style based on nodes changed

                use simd to compare lines for diffing?

                todo: lazy re-rendering
                */

                if !to_rerender.is_empty() {
                    terminal.draw(|frame| {
                        // size is guaranteed to not change when rendering
                        let dims = frame.size();
                        // println!("{dims:?}");
                        let width = dims.width;
                        let height = dims.height;
                        let root_id = tree.root;
                        let root_node = tree.get(root_id).up_state.node.unwrap();
                        stretch
                            .compute_layout(
                                root_node,
                                Size {
                                    width: stretch2::prelude::Number::Defined((width - 1) as f32),
                                    height: stretch2::prelude::Number::Defined((height - 1) as f32),
                                },
                            )
                            .unwrap();
                        let root = tree.get(tree.root);
                        render::render_vnode(frame, &stretch, &tree, &root, cfg);
                    })?;
                }

                // resolve events before rendering
                // todo: events do not trigger update?
                for e in handler.get_events(&stretch, &mut tree) {
                    // let tname = if e.data.is::<PointerData>() {
                    //     "PointerData"
                    // } else if e.data.is::<WheelData>() {
                    //     "WheelData"
                    // } else if e.data.is::<MouseData>() {
                    //     "MouseData"
                    // } else if e.data.is::<KeyboardData>() {
                    //     "KeyboardData"
                    // } else if e.data.is::<TouchData>() {
                    //     "TouchData"
                    // } else if e.data.is::<(u16, u16)>() {
                    //     "(u16, u16)"
                    // } else {
                    //     panic!()
                    // };
                    // println!("{tname}: {e:?}");
                    vdom.handle_message(SchedulerMsg::Event(e));
                }

                use futures::future::{select, Either};
                {
                    let wait = vdom.wait_for_work();
                    pin_mut!(wait);

                    match select(wait, rx.next()).await {
                        Either::Left((_a, _b)) => {
                            //
                        }
                        Either::Right((evt, _o)) => {
                            match evt.as_ref().unwrap() {
                                InputEvent::UserInput(event) => match event {
                                    TermEvent::Key(key) => {
                                        if matches!(key.code, KeyCode::Char('C' | 'c'))
                                            && key.modifiers.contains(KeyModifiers::CONTROL)
                                        {
                                            break;
                                        }
                                    }
                                    TermEvent::Resize(_, _) | TermEvent::Mouse(_) => {}
                                },
                                InputEvent::Tick => {} // tick
                                InputEvent::Close => break,
                            };

                            if let InputEvent::UserInput(evt) = evt.unwrap() {
                                ctx.unbounded_send(evt).unwrap();
                            }
                        }
                    }
                }

                let mutations = vdom.work_with_deadline(|| false);
                // updates the tree's nodes
                let to_update = tree.apply_mutations(mutations);
                // update the style and layout
                to_rerender = tree
                    .update_state(&vdom, to_update, &mut stretch, &mut ())
                    .unwrap();
            }

            disable_raw_mode()?;
            execute!(
                terminal.backend_mut(),
                LeaveAlternateScreen,
                DisableMouseCapture
            )?;
            terminal.show_cursor()?;

            Ok(())
        })
}

enum InputEvent {
    UserInput(TermEvent),
    Tick,
    #[allow(dead_code)]
    Close,
}