term_wm_pty_engine/
pane.rs

1use std::io;
2use std::sync::{Arc, Mutex};
3use std::thread::JoinHandle;
4
5use portable_pty::{Child, ExitStatus, PtySize};
6
7use crate::{PtyResult, PtyStatus};
8
9pub trait Pane {
10    fn resize(&mut self, size: PtySize) -> PtyResult<()>;
11    fn has_exited(&mut self) -> bool;
12    fn alternate_screen(&mut self) -> bool;
13    fn scrollback(&mut self) -> usize;
14    fn set_scrollback(&mut self, rows: usize);
15    fn write_bytes(&mut self, input: &[u8]) -> io::Result<()>;
16    fn max_scrollback(&mut self) -> usize;
17    fn scrollback_len(&self) -> usize;
18    fn take_exit_status(&mut self) -> Option<ExitStatus>;
19    fn exit_status(&self) -> Option<ExitStatus>;
20    fn bytes_received(&self) -> usize;
21    fn last_bytes_text(&self) -> String;
22    fn kill_child(&mut self) -> PtyResult<()>;
23    /// Set a status callback invoked on PTY data or exit.
24    fn set_status_callback(&mut self, _cb: Option<Box<dyn Fn(PtyStatus) + Send + Sync>>) {}
25    fn take_pending_title(&mut self) -> Option<String> {
26        None
27    }
28    /// Extract the child process and reader thread handle so they can be
29    /// moved into the `Reaper` for async teardown.
30    /// Returns `None` by default (for mock panes). The real `Pty` impl
31    /// returns `(child, reader_handle)`.
32    fn take_parts(&mut self) -> Option<(Box<dyn Child + Send + Sync>, JoinHandle<()>)> {
33        None
34    }
35    /// Access the shared parser for zero-copy rendering.
36    fn shared_parser(&mut self) -> Arc<Mutex<vt100::Parser>> {
37        Arc::new(Mutex::new(vt100::Parser::new(24, 80, 0)))
38    }
39    /// Reset the dirty flag. Returns true if dirty was set.
40    fn take_dirty(&self) -> bool {
41        false
42    }
43    /// Clear the dirty flag and notify the reader thread via Condvar.
44    /// This is the primary mechanism for I/O burst budget backpressure.
45    fn clear_dirty_and_notify(&self) {}
46    /// Sync dirty state and handle DSR/foreground polling.
47    /// Call before locking the parser for cell access.
48    fn sync_screen(&mut self) {}
49}
50
51impl Pane for crate::Pty {
52    fn resize(&mut self, size: PtySize) -> PtyResult<()> {
53        self.resize(size)
54    }
55
56    fn has_exited(&mut self) -> bool {
57        self.has_exited()
58    }
59
60    fn alternate_screen(&mut self) -> bool {
61        self.alternate_screen()
62    }
63
64    fn scrollback(&mut self) -> usize {
65        self.scrollback()
66    }
67
68    fn set_scrollback(&mut self, rows: usize) {
69        self.set_scrollback(rows);
70    }
71
72    fn write_bytes(&mut self, input: &[u8]) -> io::Result<()> {
73        self.write_bytes(input)
74    }
75
76    fn sync_screen(&mut self) {
77        crate::Pty::screen(self);
78    }
79
80    fn max_scrollback(&mut self) -> usize {
81        self.max_scrollback()
82    }
83
84    fn scrollback_len(&self) -> usize {
85        self.scrollback_len()
86    }
87
88    fn take_exit_status(&mut self) -> Option<ExitStatus> {
89        self.take_exit_status()
90    }
91
92    fn exit_status(&self) -> Option<ExitStatus> {
93        self.exit_status()
94    }
95
96    fn bytes_received(&self) -> usize {
97        self.bytes_received()
98    }
99
100    fn last_bytes_text(&self) -> String {
101        self.last_bytes_text()
102    }
103
104    fn kill_child(&mut self) -> PtyResult<()> {
105        self.kill_child()
106    }
107
108    fn take_pending_title(&mut self) -> Option<String> {
109        crate::Pty::take_pending_title(self)
110    }
111
112    fn take_parts(&mut self) -> Option<(Box<dyn Child + Send + Sync>, JoinHandle<()>)> {
113        let parts = self.into_parts();
114        match (parts.child, parts.reader_handle) {
115            (Some(child), Some(handle)) => Some((child, handle)),
116            _ => None,
117        }
118    }
119
120    fn set_status_callback(&mut self, cb: Option<Box<dyn Fn(PtyStatus) + Send + Sync>>) {
121        crate::Pty::set_status_callback(self, cb)
122    }
123
124    fn shared_parser(&mut self) -> Arc<Mutex<vt100::Parser>> {
125        self.shared_parser.clone()
126    }
127
128    fn take_dirty(&self) -> bool {
129        self.dirty.swap(false, std::sync::atomic::Ordering::AcqRel)
130    }
131
132    fn clear_dirty_and_notify(&self) {
133        let (lock, cvar) = &*self.dirty_cond;
134        let _guard = lock.lock().unwrap();
135        self.dirty
136            .store(false, std::sync::atomic::Ordering::Release);
137        cvar.notify_one();
138    }
139}
term_wm_pty_engine/pane.rs

term_wm_pty_engine/
pane.rs
