Skip to main content

tui/runtime/
terminal_runtime.rs

1use crossterm::event::Event as CrosstermEvent;
2use std::io::{self, Write};
3use std::process::{Command, ExitStatus};
4
5use crate::rendering::frame::Frame;
6use crate::rendering::render_context::ViewContext;
7use crate::rendering::renderer::{Renderer, RendererCommand};
8use crate::theme::Theme;
9
10use super::terminal::{MouseCapture, TerminalSession};
11use super::{EventTaskHandle, spawn_terminal_event_task};
12
13pub struct TerminalConfig {
14    pub bracketed_paste: bool,
15    pub mouse_capture: MouseCapture,
16}
17
18pub struct TerminalRuntime<T: Write> {
19    renderer: Renderer<T>,
20    session: Option<TerminalSession>,
21    event_task: Option<EventTaskHandle>,
22    config: TerminalConfig,
23}
24
25impl<T: Write> TerminalRuntime<T> {
26    pub fn new(writer: T, theme: Theme, size: (u16, u16), config: TerminalConfig) -> io::Result<Self> {
27        let renderer = Renderer::new(writer, theme, size);
28        let session = Some(TerminalSession::new(config.bracketed_paste, config.mouse_capture)?);
29        let event_task = Some(spawn_terminal_event_task());
30        Ok(Self { renderer, session, event_task, config })
31    }
32
33    pub async fn next_event(&mut self) -> Option<CrosstermEvent> {
34        let task = self.event_task.as_mut()?;
35        task.rx().recv().await
36    }
37
38    pub fn render_frame(&mut self, f: impl FnOnce(&ViewContext) -> Frame) -> io::Result<()> {
39        self.renderer.render_frame(f)
40    }
41
42    pub fn clear_screen(&mut self) -> io::Result<()> {
43        self.renderer.clear_screen()
44    }
45
46    pub fn on_resize(&mut self, size: (u16, u16)) {
47        self.renderer.on_resize(size);
48    }
49
50    pub fn apply_commands(&mut self, commands: Vec<RendererCommand>) -> io::Result<()> {
51        self.renderer.apply_commands(commands)
52    }
53
54    pub async fn suspend(&mut self) -> io::Result<SuspendedTerminal<'_, T>> {
55        if let Some(handle) = self.event_task.take() {
56            handle.stop().await;
57        }
58        drop(self.session.take());
59        Ok(SuspendedTerminal { runtime: self, resumed: false })
60    }
61
62    pub async fn run_external(&mut self, mut command: Command) -> io::Result<ExitStatus> {
63        let mut suspended = self.suspend().await?;
64        let status = command.status()?;
65        suspended.resume()?;
66        Ok(status)
67    }
68}
69
70impl<T: Write> Drop for TerminalRuntime<T> {
71    fn drop(&mut self) {
72        if let Some(ref handle) = self.event_task {
73            handle.cancel();
74        }
75        let _ = self.renderer.cleanup();
76    }
77}
78
79pub struct SuspendedTerminal<'a, T: Write> {
80    runtime: &'a mut TerminalRuntime<T>,
81    resumed: bool,
82}
83
84impl<T: Write> SuspendedTerminal<'_, T> {
85    pub fn resume(&mut self) -> io::Result<()> {
86        if self.resumed {
87            return Ok(());
88        }
89
90        self.runtime.session =
91            Some(TerminalSession::new(self.runtime.config.bracketed_paste, self.runtime.config.mouse_capture)?);
92        self.runtime.event_task = Some(spawn_terminal_event_task());
93        self.runtime.renderer.clear_screen()?;
94        self.resumed = true;
95        Ok(())
96    }
97}
98
99impl<T: Write> Drop for SuspendedTerminal<'_, T> {
100    fn drop(&mut self) {
101        if self.resumed {
102            return;
103        }
104
105        if self.runtime.session.is_none()
106            && let Ok(session) =
107                TerminalSession::new(self.runtime.config.bracketed_paste, self.runtime.config.mouse_capture)
108        {
109            self.runtime.session = Some(session);
110        }
111
112        if self.runtime.event_task.is_none() {
113            self.runtime.event_task = Some(spawn_terminal_event_task());
114        }
115
116        let _ = self.runtime.renderer.clear_screen();
117        self.resumed = true;
118    }
119}