Struct tui_term::widget::PseudoTerminal
source · pub struct PseudoTerminal<'a> { /* private fields */ }Expand description
A widget representing a pseudo-terminal screen.
The PseudoTerminal widget displays the contents of a pseudo-terminal screen,
which is typically populated with text and control sequences from a terminal emulator.
It provides a visual representation of the terminal output within a TUI application.
The contents of the pseudo-terminal screen are represented by a vt100::Screen object.
The vt100 library provides functionality for parsing and processing terminal control sequences
and handling terminal state, allowing the PseudoTerminal widget to accurately render the
terminal output.
Examples
use ratatui::{
style::{Color, Modifier, Style},
widgets::{Block, Borders},
};
use tui_term::widget::PseudoTerminal;
use vt100::Parser;
let mut parser = vt100::Parser::new(24, 80, 0);
let pseudo_term = PseudoTerminal::new(&parser.screen())
.block(Block::default().title("Terminal").borders(Borders::ALL))
.style(
Style::default()
.fg(Color::White)
.bg(Color::Black)
.add_modifier(Modifier::BOLD),
);Implementations§
source§impl<'a> PseudoTerminal<'a>
impl<'a> PseudoTerminal<'a>
sourcepub fn new(screen: &'a Screen) -> Self
pub fn new(screen: &'a Screen) -> Self
Creates a new instance of PseudoTerminal.
Arguments
screen: The reference to theScreen.
Example
use tui_term::widget::PseudoTerminal;
use vt100::Parser;
let mut parser = vt100::Parser::new(24, 80, 0);
let pseudo_term = PseudoTerminal::new(&parser.screen());Examples found in repository?
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(100),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let block = Block::default()
.borders(Borders::ALL)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[0]);
let explanation = "Press q to exit".to_string();
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[1]);
}More examples
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(100),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let block = Block::default()
.borders(Borders::ALL)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[0]);
let explanation = "Press q to exit".to_string();
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[1]);
}122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(0),
ratatui::layout::Constraint::Percentage(100),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let title = Line::from("[ Running: top ]");
let block = Block::default()
.borders(Borders::ALL)
.title(title)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[1]);
let block = Block::default().borders(Borders::ALL);
f.render_widget(block, f.size());
let explanation = "Press q to exit".to_string();
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[2]);
}87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let title = Line::from("[ Running: ls ]");
let block = Block::default()
.borders(Borders::ALL)
.title(title)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block.clone());
f.render_widget(pseudo_term, chunks[0]);
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[1]);
let block = Block::default().borders(Borders::ALL);
f.render_widget(block, f.size());
let explanation = "Press q to exit";
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[2]);
}95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let title = Line::from("[ Running: ls ]");
let block = Block::default()
.borders(Borders::ALL)
.title(title)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block.clone());
f.render_widget(pseudo_term, chunks[0]);
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[1]);
let block = Block::default().borders(Borders::ALL);
f.render_widget(block, f.size());
let explanation = "Press q to exit";
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[2]);
}38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
async fn main() -> io::Result<()> {
init_panic_hook();
let (mut terminal, mut size) = setup_terminal().unwrap();
let cwd = std::env::current_dir().unwrap();
let mut cmd = CommandBuilder::new_default_prog();
cmd.cwd(cwd);
let mut panes: Vec<PtyPane> = Vec::new();
let mut active_pane: Option<usize> = None;
// Add a default pane
let mut pane_size = size.clone();
pane_size.rows -= 2;
open_new_pane(&mut panes, &mut active_pane, &cmd, pane_size)?;
loop {
terminal.draw(|f| {
let chunks = Layout::default()
.direction(Direction::Vertical)
.margin(1)
.constraints([Constraint::Percentage(100), Constraint::Min(1)].as_ref())
.split(f.size());
let pane_height = if panes.is_empty() {
chunks[0].height
} else {
(chunks[0].height.saturating_sub(1)) / panes.len() as u16
};
for (index, pane) in panes.iter().enumerate() {
let block = Block::default()
.borders(Borders::ALL)
.style(Style::default().add_modifier(Modifier::BOLD));
let block = if Some(index) == active_pane {
block.style(
Style::default()
.add_modifier(Modifier::BOLD)
.fg(Color::LightMagenta),
)
} else {
block
};
let parser = pane.parser.read().unwrap();
let screen = parser.screen();
let pseudo_term = PseudoTerminal::new(screen).block(block);
let pane_chunk = Rect {
x: chunks[0].x,
y: chunks[0].y + (index as u16 * pane_height), /* Adjust the y coordinate for
* each pane */
width: chunks[0].width,
height: pane_height, // Use the calculated pane height directly
};
f.render_widget(pseudo_term, pane_chunk);
}
let explanation =
"Ctrl+n to open a new pane | Ctrl+x to close the active pane | Ctrl+q to quit";
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[1]);
})?;
if event::poll(Duration::from_millis(10))? {
tracing::info!("Terminal Size: {:?}", terminal.size());
match event::read()? {
Event::Key(key) => match key.code {
KeyCode::Char('q') if key.modifiers.contains(KeyModifiers::CONTROL) => {
cleanup_terminal(&mut terminal).unwrap();
return Ok(());
}
KeyCode::Char('n') if key.modifiers.contains(KeyModifiers::CONTROL) => {
let amount = panes.len() + 1;
let mut pane_size = size.clone();
pane_size.rows /= amount as u16;
tracing::info!("Opened new pane with size: {size:?}");
open_new_pane(&mut panes, &mut active_pane, &cmd, pane_size)?;
}
KeyCode::Char('x') if key.modifiers.contains(KeyModifiers::CONTROL) => {
close_active_pane(&mut panes, &mut active_pane).await?;
}
KeyCode::Char('k') if key.modifiers.contains(KeyModifiers::CONTROL) => {
if let Some(pane) = active_pane {
active_pane = Some(pane.saturating_sub(1));
}
}
KeyCode::Char('j') if key.modifiers.contains(KeyModifiers::CONTROL) => {
if let Some(pane) = active_pane {
if pane < panes.len() - 1 {
active_pane = Some(pane.saturating_add(1));
}
}
}
_ => {
if let Some(index) = active_pane {
if handle_pane_key_event(&mut panes[index], &key).await {
continue;
}
}
}
},
Event::Resize(rows, cols) => {
tracing::info!("Resized to: rows: {} cols: {}", rows, cols);
for pane in panes.iter_mut() {
pane.parser.write().unwrap().set_size(rows, cols);
}
size.rows = rows;
size.cols = cols;
}
_ => {}
}
}
}
}sourcepub fn block(self, block: Block<'a>) -> Self
pub fn block(self, block: Block<'a>) -> Self
Sets the block for the PseudoTerminal.
Arguments
block: TheBlockto set.
Example
use ratatui::widgets::Block;
use tui_term::widget::PseudoTerminal;
use vt100::Parser;
let mut parser = vt100::Parser::new(24, 80, 0);
let block = Block::default();
let pseudo_term = PseudoTerminal::new(&parser.screen()).block(block);Examples found in repository?
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(100),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let block = Block::default()
.borders(Borders::ALL)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[0]);
let explanation = "Press q to exit".to_string();
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[1]);
}More examples
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(100),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let block = Block::default()
.borders(Borders::ALL)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[0]);
let explanation = "Press q to exit".to_string();
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[1]);
}122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(0),
ratatui::layout::Constraint::Percentage(100),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let title = Line::from("[ Running: top ]");
let block = Block::default()
.borders(Borders::ALL)
.title(title)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[1]);
let block = Block::default().borders(Borders::ALL);
f.render_widget(block, f.size());
let explanation = "Press q to exit".to_string();
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[2]);
}87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let title = Line::from("[ Running: ls ]");
let block = Block::default()
.borders(Borders::ALL)
.title(title)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block.clone());
f.render_widget(pseudo_term, chunks[0]);
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[1]);
let block = Block::default().borders(Borders::ALL);
f.render_widget(block, f.size());
let explanation = "Press q to exit";
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[2]);
}95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
fn ui(f: &mut Frame, screen: &Screen) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Vertical)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Min(1),
]
.as_ref(),
)
.split(f.size());
let title = Line::from("[ Running: ls ]");
let block = Block::default()
.borders(Borders::ALL)
.title(title)
.style(Style::default().add_modifier(Modifier::BOLD));
let pseudo_term = PseudoTerminal::new(screen).block(block.clone());
f.render_widget(pseudo_term, chunks[0]);
let pseudo_term = PseudoTerminal::new(screen).block(block);
f.render_widget(pseudo_term, chunks[1]);
let block = Block::default().borders(Borders::ALL);
f.render_widget(block, f.size());
let explanation = "Press q to exit";
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[2]);
}38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
async fn main() -> io::Result<()> {
init_panic_hook();
let (mut terminal, mut size) = setup_terminal().unwrap();
let cwd = std::env::current_dir().unwrap();
let mut cmd = CommandBuilder::new_default_prog();
cmd.cwd(cwd);
let mut panes: Vec<PtyPane> = Vec::new();
let mut active_pane: Option<usize> = None;
// Add a default pane
let mut pane_size = size.clone();
pane_size.rows -= 2;
open_new_pane(&mut panes, &mut active_pane, &cmd, pane_size)?;
loop {
terminal.draw(|f| {
let chunks = Layout::default()
.direction(Direction::Vertical)
.margin(1)
.constraints([Constraint::Percentage(100), Constraint::Min(1)].as_ref())
.split(f.size());
let pane_height = if panes.is_empty() {
chunks[0].height
} else {
(chunks[0].height.saturating_sub(1)) / panes.len() as u16
};
for (index, pane) in panes.iter().enumerate() {
let block = Block::default()
.borders(Borders::ALL)
.style(Style::default().add_modifier(Modifier::BOLD));
let block = if Some(index) == active_pane {
block.style(
Style::default()
.add_modifier(Modifier::BOLD)
.fg(Color::LightMagenta),
)
} else {
block
};
let parser = pane.parser.read().unwrap();
let screen = parser.screen();
let pseudo_term = PseudoTerminal::new(screen).block(block);
let pane_chunk = Rect {
x: chunks[0].x,
y: chunks[0].y + (index as u16 * pane_height), /* Adjust the y coordinate for
* each pane */
width: chunks[0].width,
height: pane_height, // Use the calculated pane height directly
};
f.render_widget(pseudo_term, pane_chunk);
}
let explanation =
"Ctrl+n to open a new pane | Ctrl+x to close the active pane | Ctrl+q to quit";
let explanation = Paragraph::new(explanation)
.style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
.alignment(Alignment::Center);
f.render_widget(explanation, chunks[1]);
})?;
if event::poll(Duration::from_millis(10))? {
tracing::info!("Terminal Size: {:?}", terminal.size());
match event::read()? {
Event::Key(key) => match key.code {
KeyCode::Char('q') if key.modifiers.contains(KeyModifiers::CONTROL) => {
cleanup_terminal(&mut terminal).unwrap();
return Ok(());
}
KeyCode::Char('n') if key.modifiers.contains(KeyModifiers::CONTROL) => {
let amount = panes.len() + 1;
let mut pane_size = size.clone();
pane_size.rows /= amount as u16;
tracing::info!("Opened new pane with size: {size:?}");
open_new_pane(&mut panes, &mut active_pane, &cmd, pane_size)?;
}
KeyCode::Char('x') if key.modifiers.contains(KeyModifiers::CONTROL) => {
close_active_pane(&mut panes, &mut active_pane).await?;
}
KeyCode::Char('k') if key.modifiers.contains(KeyModifiers::CONTROL) => {
if let Some(pane) = active_pane {
active_pane = Some(pane.saturating_sub(1));
}
}
KeyCode::Char('j') if key.modifiers.contains(KeyModifiers::CONTROL) => {
if let Some(pane) = active_pane {
if pane < panes.len() - 1 {
active_pane = Some(pane.saturating_add(1));
}
}
}
_ => {
if let Some(index) = active_pane {
if handle_pane_key_event(&mut panes[index], &key).await {
continue;
}
}
}
},
Event::Resize(rows, cols) => {
tracing::info!("Resized to: rows: {} cols: {}", rows, cols);
for pane in panes.iter_mut() {
pane.parser.write().unwrap().set_size(rows, cols);
}
size.rows = rows;
size.cols = cols;
}
_ => {}
}
}
}
}sourcepub fn cursor(self, cursor: Cursor) -> Self
pub fn cursor(self, cursor: Cursor) -> Self
Sets the cursor configuration for the PseudoTerminal.
The cursor method allows configuring the appearance of the cursor within the
PseudoTerminal widget.
Arguments
cursor: TheCursorconfiguration to set.
Example
use ratatui::style::Style;
use tui_term::widget::{Cursor, PseudoTerminal};
let mut parser = vt100::Parser::new(24, 80, 0);
let cursor = Cursor::default().symbol("|").style(Style::default());
let pseudo_term = PseudoTerminal::new(&parser.screen()).cursor(cursor);