ltrait_ui_tui/

lib.rs

use ltrait::{
    color_eyre::eyre::{OptionExt, Result, WrapErr, bail},
    launcher::batcher::Batcher,
    tokio_stream::StreamExt as _,
    ui::{Buffer, Position, UI},
};

use crossterm::{
    event::{Event as CEvent, KeyCode, KeyEvent, KeyEventKind, KeyModifiers},
    execute,
    terminal::{disable_raw_mode, enable_raw_mode},
};
use ratatui::{
    Frame, Terminal, TerminalOptions,
    layout::{Constraint, Direction, Layout},
    prelude::{Backend, CrosstermBackend},
    style::Style,
    widgets::{Block, Borders, Clear, List, Paragraph, Widget},
};
use tracing::{debug, info};
use tui_input::{Input, backend::crossterm::EventHandler};

pub use ratatui::{Viewport, style};

use futures::{FutureExt as _, select};
use tokio::sync::mpsc;

use std::{io::Write, sync::RwLock};

pub struct Tui<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    config: TuiConfig<F>,
}

impl<Cushion, F> UI<Cushion> for Tui<F>
where
    F: Fn(&KeyEvent) -> Action + Send + Sync + Clone,
    Cushion: Sync + Send + 'static,
{
    type Context = TuiEntry;

    async fn run(&self, mut batcher: Batcher<Cushion, Self::Context>) -> Result<Option<Cushion>> {
        let writer: Box<dyn Write + Send> = if self.config.use_tty {
            let tty = std::fs::OpenOptions::new()
                .read(true)
                .write(true)
                .open("/dev/tty")?;
            Box::new(tty)
        } else {
            Box::new(std::io::stdout())
        };

        let backend = CrosstermBackend::new(writer);

        let mut terminal = Terminal::with_options(
            backend,
            TerminalOptions {
                viewport: self.config.viewport.clone(),
            },
        )?;

        self.enter(&mut terminal)?;

        let i = App::new(self.config.clone())
            .run(&mut terminal, &mut batcher)
            .await;

        self.exit(&mut terminal)?;

        Ok(if let Some(id) = i? {
            Some(batcher.compute_cushion(id)?)
        } else {
            None
        })
    }
}

impl<F> Tui<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    pub fn new(config: TuiConfig<F>) -> Self {
        Self { config }
    }

    fn enter<B: Backend + Write>(&self, terminal: &mut Terminal<B>) -> Result<()> {
        use ratatui::Viewport;

        match &self.config.viewport {
            Viewport::Fullscreen => {
                execute!(
                    terminal.backend_mut(),
                    crossterm::terminal::EnterAlternateScreen,
                    crossterm::event::EnableMouseCapture
                )?;
                enable_raw_mode()?;
                terminal.clear()?;
            }
            Viewport::Inline(_) | Viewport::Fixed(_) => {
                enable_raw_mode()?;
            }
        }

        Ok(())
    }

    fn exit<B: Backend + Write>(&self, terminal: &mut Terminal<B>) -> Result<()> {
        match &self.config.viewport {
            Viewport::Fullscreen => {
                execute!(
                    terminal.backend_mut(),
                    crossterm::terminal::LeaveAlternateScreen,
                    crossterm::event::DisableMouseCapture
                )?;
                disable_raw_mode()?;
                ratatui::restore();
            }
            Viewport::Inline(_) | Viewport::Fixed(_) => {
                disable_raw_mode()?;
            }
        }

        Ok(())
    }
}

#[derive(Clone)]
pub struct TuiConfig<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    viewport: Viewport,
    use_tty: bool,
    selecting: char,
    no_selecting: char,
    keybinder: F,
}

impl<F> TuiConfig<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    pub fn new(
        viewport: Viewport,
        use_tty: bool,
        selecting: char,
        no_selecting: char,
        keybinder: F,
    ) -> Self {
        Self {
            viewport,
            use_tty,
            selecting,
            no_selecting,
            keybinder,
        }
    }
}

type StyledText = (String, Style);

/// `<SelectingStatus> <icon> <title> <sub_string>`
/// SelectingStatus in above is a char
pub struct TuiEntry {
    pub text: StyledText,
}

// なんのArc, Mutex, RwLockを使うか検討する必要がある。renderの中で使えないと意味ないし
struct App<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    config: TuiConfig<F>,

    exit: bool,
    // 上が0
    selecting_i: usize,
    input: Input,
    cursor_pos: RwLock<Option<(u16, u16)>>,
    buffer: Buffer<(TuiEntry, usize)>,
    has_more: bool,
    tx: Option<mpsc::Sender<Event>>,
    selected: bool,
}

impl<F> App<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    fn new(config: TuiConfig<F>) -> Self {
        Self {
            has_more: true,
            config,
            exit: false,
            selecting_i: 0,
            input: Input::default(),
            buffer: Buffer::default(),
            tx: None,
            cursor_pos: None.into(),
            selected: false,
        }
    }
}

#[derive(Debug)]
enum Event {
    Key(KeyEvent),
    Refresh,
    Input,
}

#[derive(Debug, Clone)]
pub enum Action {
    Select,
    ExitWithoutSelect,
    Up,
    Down,
    Input,
}

impl Event {
    async fn terminal_event_listener(tx: mpsc::Sender<Event>) {
        let mut reader = crossterm::event::EventStream::new();

        loop {
            let crossterm_event = reader.next().fuse();
            std::thread::sleep(std::time::Duration::from_millis(10));

            if let Some(Ok(CEvent::Key(key))) = crossterm_event.await
                && key.kind == KeyEventKind::Press
            {
                tx.send(Event::Key(key)).await.unwrap();
            }
        }
    }
}

impl<F> App<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    async fn run<Cusion: Send, B: Backend>(
        &mut self,
        terminal: &mut Terminal<B>,
        batcher: &mut Batcher<Cusion, TuiEntry>,
    ) -> Result<Option<usize>> {
        let (tx, mut rx) = mpsc::channel(100);

        tokio::spawn(Event::terminal_event_listener(tx.clone()));
        self.tx = Some(tx.clone());

        while !self.exit {
            let prepare = async {
                if self.has_more {
                    batcher.prepare().await
                } else {
                    // HACK: もうeventだけ気にしていればいいから
                    info!("No more items. Sleeping");
                    tokio::time::sleep(std::time::Duration::from_secs(100)).await;
                    batcher.prepare().await
                }
            };

            select! {
                // TODO: 毎回futureを生成し直していると
                // dropした場合にバグるかも。あと必ず、rx.recvが早い場合何も表示されなくなっちゃうかも
                from = prepare.fuse( ) => {
                    info!("Merging");
                    let has_more  =
                        batcher.merge(&mut self.buffer, from);

                        let _ = tx.send(Event::Refresh).await;

                    self.has_more = has_more?;
                    info!("Merged");
                }
                event_like = rx.recv().fuse() => {
                    info!("Caught event-like");
                    debug!("{event_like:?}");

                    match event_like {
                        Some(event) => {
                            self.handle_events(event, batcher)
                                .await
                                .wrap_err("handle events failed")?;

                            terminal.draw(|frame| self.draw(frame))?;
                        }
                    _ => bail!("the communication channel for event was unexpectedly closed.")
                    }
                }
            }
        }

        Ok(if self.selected {
            let mut pos = Position(self.buffer.len() - 1 - self.selecting_i);
            Some(self.buffer.next(&mut pos).unwrap().1)
        } else {
            None
        })
    }

    fn draw(&self, frame: &mut Frame) {
        frame.render_widget(self, frame.area());
        frame.set_cursor_position(ratatui::layout::Position::from(
            self.cursor_pos.read().unwrap().unwrap(),
        ))
    }

    async fn handle_events<Cusion: Send>(
        &mut self,
        event: Event,
        batcher: &mut Batcher<Cusion, TuiEntry>,
    ) -> Result<()> {
        match event {
            // it's important to check that the event is a key press event as
            // crossterm also emits key release and repeat events on Windows.
            Event::Key(key_event) if key_event.kind == KeyEventKind::Press => {
                info!("Handling KeyInput");
                self.handle_key_event(key_event).await?
            }
            Event::Input => {
                info!("Handling Input");
                batcher.input(&mut self.buffer, self.input.value());
                // 一回一番上に戻す
                self.selecting_i = 0;
                self.has_more = true;
            }
            _ => {}
        };
        Ok(())
    }

    async fn handle_key_event(&mut self, key_event: KeyEvent) -> Result<()> {
        match (self.config.keybinder)(&key_event) {
            Action::Select => {
                self.selected = true;
                self.exit();
            }
            Action::ExitWithoutSelect => self.exit(),
            Action::Up => {
                self.selecting_i = (self.selecting_i + 1).min(self.buffer.len().saturating_sub(1));
            }
            Action::Down => {
                self.selecting_i = self.selecting_i.saturating_sub(1);
            }
            _ => {
                if !(self.input.cursor() == 0
                    && (key_event.code == KeyCode::Backspace || key_event.code == KeyCode::Left)
                    || self.input.cursor() == self.input.value().len()
                        && (key_event.code == KeyCode::Delete || key_event.code == KeyCode::Right))
                {
                    self.input
                        .handle_event(&crossterm::event::Event::Key(key_event))
                        .ok_or_eyre("Failed to handle input")?;

                    self.tx
                        .as_mut()
                        .unwrap()
                        .send(Event::Input)
                        .await
                        .wrap_err("Failed to send Refresh")?;
                }
            }
        }
        Ok(())
    }

    fn exit(&mut self) {
        self.exit = true;
    }
}

pub fn sample_keyconfig(key: &KeyEvent) -> Action {
    match (key.code, key.modifiers) {
        (KeyCode::Enter, _) => Action::Select,
        (KeyCode::Char('c'), KeyModifiers::CONTROL)
        | (KeyCode::Char('d'), KeyModifiers::CONTROL)
        | (KeyCode::Esc, _) => Action::ExitWithoutSelect,
        (KeyCode::Up, _) | (KeyCode::Char('k'), KeyModifiers::CONTROL) => Action::Up,
        (KeyCode::Down, _) | (KeyCode::Char('j'), KeyModifiers::CONTROL) => Action::Down,
        _ => Action::Input,
    }
}

impl<F> Widget for &App<F>
where
    F: Fn(&KeyEvent) -> Action + Clone,
{
    fn render(self, area: ratatui::prelude::Rect, buffer: &mut ratatui::prelude::Buffer) {
        let chunks = Layout::default()
            .direction(Direction::Vertical)
            .constraints([Constraint::Min(0), Constraint::Length(2)].as_ref())
            .split(area);

        // エントリーの部分
        if !self.buffer.is_empty() {
            let list_area = chunks[0];

            let items_count = self.buffer.len();
            let mut items = Vec::with_capacity(items_count);

            let mut pos = Position::default();

            while let Some((entry, _)) = self.buffer.next(&mut pos) {
                let is_selected = pos.0 - 1 == items_count - self.selecting_i - 1;

                let selecting_status = if is_selected {
                    self.config.selecting
                } else {
                    self.config.no_selecting
                };

                let entry_text = format!("{} {}", selecting_status, entry.text.0);
                let style = entry.text.1;

                // リストアイテムを追加
                items.push(ratatui::widgets::ListItem::new(entry_text).style(style));
            }

            let visible_height = list_area.height as usize;
            let reversed_selecting_index = items_count - 1 - self.selecting_i;

            // 選択されたアイテムが常に表示されるようにスクロール位置を計算
            let margin_below = 2;
            let scroll_offset =
                reversed_selecting_index.saturating_sub(visible_height - margin_below - 1);

            let start_index = scroll_offset;
            let end_index = (scroll_offset + visible_height).min(items_count);

            let items: Vec<_> = items
                .into_iter()
                .skip(start_index)
                .take(end_index - start_index)
                .collect();

            List::new(items)
                .block(Block::default())
                .render(list_area, buffer);
        } else {
            let list_area = chunks[0];

            Clear.render(list_area, buffer);
        }
        // テキスト入力部分
        {
            let input_area = chunks[1];
            let input_text = self.input.to_string();

            Paragraph::new(input_text)
                .block(Block::default().borders(Borders::TOP))
                .render(input_area, buffer);

            *self.cursor_pos.write().unwrap() = Some((
                input_area.x + self.input.visual_cursor() as u16,
                input_area.y + 1,
            ));
        }
    }
}