virtual_console_lib/
terminal.rs

1// Copyright 2021 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::colors::ColorScheme;
6use anyhow::Error;
7use carnelian::color::Color;
8use carnelian::Size;
9use pty::ServerPty;
10use std::cell::RefCell;
11use std::fs::File;
12use std::io::Write;
13use std::rc::Rc;
14use term_model::clipboard::Clipboard;
15use term_model::config::Config;
16use term_model::event::EventListener;
17use term_model::grid::Scroll;
18use term_model::term::color::Rgb;
19use term_model::term::{SizeInfo, TermMode};
20use term_model::Term;
21
22/// Empty type for term model config.
23#[derive(Default)]
24pub struct TermConfig;
25pub type TerminalConfig = Config<TermConfig>;
26
27fn make_term_color(color: &Color) -> Rgb {
28    Rgb { r: color.r, g: color.g, b: color.b }
29}
30
31impl From<ColorScheme> for TerminalConfig {
32    fn from(color_scheme: ColorScheme) -> Self {
33        let mut config = Self::default();
34        config.colors.primary.background = make_term_color(&color_scheme.back);
35        config.colors.primary.foreground = make_term_color(&color_scheme.front);
36        config
37    }
38}
39
40/// Wrapper around a term model instance and its associated PTY fd.
41pub struct Terminal<T> {
42    term: Rc<RefCell<Term<T>>>,
43    title: String,
44    pty: Option<ServerPty>,
45    /// Lazily initialized if `pty` is set.
46    pty_fd: Option<File>,
47}
48
49impl<T> Terminal<T> {
50    pub fn new(
51        event_listener: T,
52        title: String,
53        color_scheme: ColorScheme,
54        scrollback_rows: u32,
55        pty: Option<ServerPty>,
56    ) -> Self {
57        // Initial size info used before we know what the real size is.
58        let cell_size = Size::new(8.0, 16.0);
59        let size_info = SizeInfo {
60            width: cell_size.width * 80.0,
61            height: cell_size.height * 24.0,
62            cell_width: cell_size.width,
63            cell_height: cell_size.height,
64            padding_x: 0.0,
65            padding_y: 0.0,
66            dpr: 1.0,
67        };
68        let mut config: TerminalConfig = color_scheme.into();
69        config.scrolling.set_history(scrollback_rows);
70        let term =
71            Rc::new(RefCell::new(Term::new(&config, &size_info, Clipboard::new(), event_listener)));
72
73        Self { term: Rc::clone(&term), title, pty, pty_fd: None }
74    }
75
76    #[cfg(test)]
77    fn new_for_test(event_listener: T, pty: ServerPty) -> Self {
78        Self::new(event_listener, String::new(), ColorScheme::default(), 1024, Some(pty))
79    }
80
81    pub fn clone_term(&self) -> Rc<RefCell<Term<T>>> {
82        Rc::clone(&self.term)
83    }
84
85    pub fn try_clone(&self) -> Result<Self, Error> {
86        let term = self.clone_term();
87        let title = self.title.clone();
88        let pty = self.pty.clone();
89        let pty_fd = None;
90        Ok(Self { term, title, pty, pty_fd })
91    }
92
93    pub fn resize(&mut self, size_info: &SizeInfo) {
94        let mut term = self.term.borrow_mut();
95        term.resize(size_info);
96    }
97
98    pub fn title(&self) -> &str {
99        self.title.as_str()
100    }
101
102    pub fn pty(&self) -> Option<&ServerPty> {
103        self.pty.as_ref()
104    }
105
106    pub fn scroll(&mut self, scroll: Scroll)
107    where
108        T: EventListener,
109    {
110        let mut term = self.term.borrow_mut();
111        term.scroll_display(scroll);
112    }
113
114    pub fn history_size(&self) -> usize {
115        let term = self.term.borrow();
116        term.grid().history_size()
117    }
118
119    pub fn display_offset(&self) -> usize {
120        let term = self.term.borrow();
121        term.grid().display_offset()
122    }
123
124    pub fn mode(&self) -> TermMode {
125        let term = self.term.borrow();
126        *term.mode()
127    }
128
129    fn file(&mut self) -> Result<Option<&mut File>, std::io::Error> {
130        if self.pty_fd.is_none() {
131            if let Some(pty) = &self.pty {
132                let pty_fd = pty.try_clone_fd().map_err(|e| {
133                    std::io::Error::new(std::io::ErrorKind::BrokenPipe, format!("{:?}", e))
134                })?;
135                self.pty_fd = Some(pty_fd);
136            }
137        }
138        Ok(self.pty_fd.as_mut())
139    }
140}
141
142impl<T> Write for Terminal<T> {
143    fn write(&mut self, buf: &[u8]) -> Result<usize, std::io::Error> {
144        let fd = self.file()?;
145        if let Some(fd) = fd {
146            fd.write(buf)
147        } else {
148            Ok(buf.len())
149        }
150    }
151
152    fn flush(&mut self) -> Result<(), std::io::Error> {
153        let fd = self.file()?;
154        if let Some(fd) = fd {
155            fd.flush()
156        } else {
157            Ok(())
158        }
159    }
160}
161
162#[cfg(test)]
163mod tests {
164    use super::*;
165    use fuchsia_async as fasync;
166    use term_model::event::Event;
167
168    #[derive(Default)]
169    struct TestListener;
170
171    impl EventListener for TestListener {
172        fn send_event(&self, _event: Event) {}
173    }
174
175    #[fasync::run_singlethreaded(test)]
176    async fn can_create_terminal() -> Result<(), Error> {
177        let pty = ServerPty::new()?;
178        let _ = Terminal::new_for_test(TestListener::default(), pty);
179        Ok(())
180    }
181}
virtual_console_lib/terminal.rs

virtual_console_lib/
terminal.rs
