tui/runtime/
terminal_runtime.rs1use 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 fn headless(writer: T, size: (u16, u16)) -> Self {
34 let config = TerminalConfig { bracketed_paste: false, mouse_capture: MouseCapture::Disabled };
35 Self { renderer: Renderer::new(writer, Theme::default(), size), session: None, event_task: None, config }
36 }
37
38 pub async fn next_event(&mut self) -> Option<CrosstermEvent> {
39 let task = self.event_task.as_mut()?;
40 task.rx().recv().await
41 }
42
43 pub fn render_frame(&mut self, f: impl FnOnce(&ViewContext) -> Frame) -> io::Result<()> {
44 self.renderer.render_frame(f)
45 }
46
47 pub fn clear_screen(&mut self) -> io::Result<()> {
48 self.renderer.clear_screen()
49 }
50
51 pub fn on_resize(&mut self, size: (u16, u16)) {
52 self.renderer.on_resize(size);
53 }
54
55 pub fn apply_commands(&mut self, commands: Vec<RendererCommand>) -> io::Result<()> {
56 self.renderer.apply_commands(commands)
57 }
58
59 pub async fn suspend(&mut self) -> io::Result<SuspendedTerminal<'_, T>> {
60 let was_headless = self.session.is_none();
61 if let Some(handle) = self.event_task.take() {
62 handle.stop().await;
63 }
64 drop(self.session.take());
65 Ok(SuspendedTerminal { runtime: self, resumed: false, was_headless })
66 }
67
68 pub async fn run_external(&mut self, mut command: Command) -> io::Result<ExitStatus> {
69 let mut suspended = self.suspend().await?;
70 let status = command.status()?;
71 suspended.resume()?;
72 Ok(status)
73 }
74}
75
76impl<T: Write> Drop for TerminalRuntime<T> {
77 fn drop(&mut self) {
78 if let Some(ref handle) = self.event_task {
79 handle.cancel();
80 }
81 let _ = self.renderer.cleanup();
82 }
83}
84
85pub struct SuspendedTerminal<'a, T: Write> {
86 runtime: &'a mut TerminalRuntime<T>,
87 resumed: bool,
88 was_headless: bool,
89}
90
91impl<T: Write> SuspendedTerminal<'_, T> {
92 pub fn resume(&mut self) -> io::Result<()> {
93 if self.resumed {
94 return Ok(());
95 }
96
97 if self.was_headless {
98 self.resumed = true;
99 return Ok(());
100 }
101
102 self.runtime.session =
103 Some(TerminalSession::new(self.runtime.config.bracketed_paste, self.runtime.config.mouse_capture)?);
104 self.runtime.event_task = Some(spawn_terminal_event_task());
105 self.runtime.renderer.clear_screen()?;
106 self.resumed = true;
107 Ok(())
108 }
109}
110
111impl<T: Write> Drop for SuspendedTerminal<'_, T> {
112 fn drop(&mut self) {
113 if self.resumed {
114 return;
115 }
116
117 if self.was_headless {
118 self.resumed = true;
119 return;
120 }
121
122 if self.runtime.session.is_none()
123 && let Ok(session) =
124 TerminalSession::new(self.runtime.config.bracketed_paste, self.runtime.config.mouse_capture)
125 {
126 self.runtime.session = Some(session);
127 }
128
129 if self.runtime.session.is_some() && self.runtime.event_task.is_none() {
130 self.runtime.event_task = Some(spawn_terminal_event_task());
131 }
132
133 let _ = self.runtime.renderer.clear_screen();
134 self.resumed = true;
135 }
136}