zellij/zellij-server/src/screen.rs
Aram Drevekenin bf4f90d694
fix(screen): handle various edge cases rather than crashing (#1269)
* fix(screen): handle various edge cases rather than crashing

* style(fmt): rustfmt

* fix(logging): add error logs when unable to find tab

* style(fmt): rustfmt
2022-03-25 10:35:45 +01:00

1386 lines
56 KiB
Rust

//! Things related to [`Screen`]s.
use std::cell::RefCell;
use std::collections::{BTreeMap, HashSet};
use std::os::unix::io::RawFd;
use std::rc::Rc;
use std::str;
use zellij_tile::prelude::Style;
use zellij_utils::input::options::Clipboard;
use zellij_utils::pane_size::Size;
use zellij_utils::{
input::command::TerminalAction, input::layout::Layout, position::Position, zellij_tile,
};
use crate::{
output::Output,
panes::PaneId,
pty::{ClientOrTabIndex, PtyInstruction, VteBytes},
tab::Tab,
thread_bus::Bus,
ui::overlay::{Overlay, OverlayWindow, Overlayable},
wasm_vm::PluginInstruction,
ClientId, ServerInstruction,
};
use zellij_tile::data::{Event, InputMode, ModeInfo, PluginCapabilities, TabInfo};
use zellij_utils::{
errors::{ContextType, ScreenContext},
input::{get_mode_info, options::Options},
ipc::ClientAttributes,
};
/// Instructions that can be sent to the [`Screen`].
#[derive(Debug, Clone)]
pub enum ScreenInstruction {
PtyBytes(RawFd, VteBytes),
Render,
NewPane(PaneId, ClientOrTabIndex),
TogglePaneEmbedOrFloating(ClientId),
ToggleFloatingPanes(ClientId, Option<TerminalAction>),
HorizontalSplit(PaneId, ClientId),
VerticalSplit(PaneId, ClientId),
WriteCharacter(Vec<u8>, ClientId),
ResizeLeft(ClientId),
ResizeRight(ClientId),
ResizeDown(ClientId),
ResizeUp(ClientId),
ResizeIncrease(ClientId),
ResizeDecrease(ClientId),
SwitchFocus(ClientId),
FocusNextPane(ClientId),
FocusPreviousPane(ClientId),
MoveFocusLeft(ClientId),
MoveFocusLeftOrPreviousTab(ClientId),
MoveFocusDown(ClientId),
MoveFocusUp(ClientId),
MoveFocusRight(ClientId),
MoveFocusRightOrNextTab(ClientId),
MovePane(ClientId),
MovePaneUp(ClientId),
MovePaneDown(ClientId),
MovePaneRight(ClientId),
MovePaneLeft(ClientId),
Exit,
ScrollUp(ClientId),
ScrollUpAt(Position, ClientId),
ScrollDown(ClientId),
ScrollDownAt(Position, ClientId),
ScrollToBottom(ClientId),
PageScrollUp(ClientId),
PageScrollDown(ClientId),
HalfPageScrollUp(ClientId),
HalfPageScrollDown(ClientId),
ClearScroll(ClientId),
CloseFocusedPane(ClientId),
ToggleActiveTerminalFullscreen(ClientId),
TogglePaneFrames,
SetSelectable(PaneId, bool, usize),
ClosePane(PaneId, Option<ClientId>),
UpdatePaneName(Vec<u8>, ClientId),
NewTab(Layout, Vec<RawFd>, ClientId),
SwitchTabNext(ClientId),
SwitchTabPrev(ClientId),
ToggleActiveSyncTab(ClientId),
CloseTab(ClientId),
GoToTab(u32, Option<ClientId>), // this Option is a hacky workaround, please do not copy thie behaviour
ToggleTab(ClientId),
UpdateTabName(Vec<u8>, ClientId),
TerminalResize(Size),
ChangeMode(ModeInfo, ClientId),
LeftClick(Position, ClientId),
RightClick(Position, ClientId),
MouseRelease(Position, ClientId),
MouseHold(Position, ClientId),
Copy(ClientId),
AddClient(ClientId),
RemoveClient(ClientId),
AddOverlay(Overlay, ClientId),
RemoveOverlay(ClientId),
ConfirmPrompt(ClientId),
DenyPrompt(ClientId),
}
impl From<&ScreenInstruction> for ScreenContext {
fn from(screen_instruction: &ScreenInstruction) -> Self {
match *screen_instruction {
ScreenInstruction::PtyBytes(..) => ScreenContext::HandlePtyBytes,
ScreenInstruction::Render => ScreenContext::Render,
ScreenInstruction::NewPane(..) => ScreenContext::NewPane,
ScreenInstruction::TogglePaneEmbedOrFloating(..) => {
ScreenContext::TogglePaneEmbedOrFloating
}
ScreenInstruction::ToggleFloatingPanes(..) => ScreenContext::ToggleFloatingPanes,
ScreenInstruction::HorizontalSplit(..) => ScreenContext::HorizontalSplit,
ScreenInstruction::VerticalSplit(..) => ScreenContext::VerticalSplit,
ScreenInstruction::WriteCharacter(..) => ScreenContext::WriteCharacter,
ScreenInstruction::ResizeLeft(..) => ScreenContext::ResizeLeft,
ScreenInstruction::ResizeRight(..) => ScreenContext::ResizeRight,
ScreenInstruction::ResizeDown(..) => ScreenContext::ResizeDown,
ScreenInstruction::ResizeUp(..) => ScreenContext::ResizeUp,
ScreenInstruction::ResizeIncrease(..) => ScreenContext::ResizeIncrease,
ScreenInstruction::ResizeDecrease(..) => ScreenContext::ResizeDecrease,
ScreenInstruction::SwitchFocus(..) => ScreenContext::SwitchFocus,
ScreenInstruction::FocusNextPane(..) => ScreenContext::FocusNextPane,
ScreenInstruction::FocusPreviousPane(..) => ScreenContext::FocusPreviousPane,
ScreenInstruction::MoveFocusLeft(..) => ScreenContext::MoveFocusLeft,
ScreenInstruction::MoveFocusLeftOrPreviousTab(..) => {
ScreenContext::MoveFocusLeftOrPreviousTab
}
ScreenInstruction::MoveFocusDown(..) => ScreenContext::MoveFocusDown,
ScreenInstruction::MoveFocusUp(..) => ScreenContext::MoveFocusUp,
ScreenInstruction::MoveFocusRight(..) => ScreenContext::MoveFocusRight,
ScreenInstruction::MoveFocusRightOrNextTab(..) => {
ScreenContext::MoveFocusRightOrNextTab
}
ScreenInstruction::MovePane(..) => ScreenContext::MovePane,
ScreenInstruction::MovePaneDown(..) => ScreenContext::MovePaneDown,
ScreenInstruction::MovePaneUp(..) => ScreenContext::MovePaneUp,
ScreenInstruction::MovePaneRight(..) => ScreenContext::MovePaneRight,
ScreenInstruction::MovePaneLeft(..) => ScreenContext::MovePaneLeft,
ScreenInstruction::Exit => ScreenContext::Exit,
ScreenInstruction::ScrollUp(..) => ScreenContext::ScrollUp,
ScreenInstruction::ScrollDown(..) => ScreenContext::ScrollDown,
ScreenInstruction::ScrollToBottom(..) => ScreenContext::ScrollToBottom,
ScreenInstruction::PageScrollUp(..) => ScreenContext::PageScrollUp,
ScreenInstruction::PageScrollDown(..) => ScreenContext::PageScrollDown,
ScreenInstruction::HalfPageScrollUp(..) => ScreenContext::HalfPageScrollUp,
ScreenInstruction::HalfPageScrollDown(..) => ScreenContext::HalfPageScrollDown,
ScreenInstruction::ClearScroll(..) => ScreenContext::ClearScroll,
ScreenInstruction::CloseFocusedPane(..) => ScreenContext::CloseFocusedPane,
ScreenInstruction::ToggleActiveTerminalFullscreen(..) => {
ScreenContext::ToggleActiveTerminalFullscreen
}
ScreenInstruction::TogglePaneFrames => ScreenContext::TogglePaneFrames,
ScreenInstruction::SetSelectable(..) => ScreenContext::SetSelectable,
ScreenInstruction::ClosePane(..) => ScreenContext::ClosePane,
ScreenInstruction::UpdatePaneName(..) => ScreenContext::UpdatePaneName,
ScreenInstruction::NewTab(..) => ScreenContext::NewTab,
ScreenInstruction::SwitchTabNext(..) => ScreenContext::SwitchTabNext,
ScreenInstruction::SwitchTabPrev(..) => ScreenContext::SwitchTabPrev,
ScreenInstruction::CloseTab(..) => ScreenContext::CloseTab,
ScreenInstruction::GoToTab(..) => ScreenContext::GoToTab,
ScreenInstruction::UpdateTabName(..) => ScreenContext::UpdateTabName,
ScreenInstruction::TerminalResize(..) => ScreenContext::TerminalResize,
ScreenInstruction::ChangeMode(..) => ScreenContext::ChangeMode,
ScreenInstruction::ToggleActiveSyncTab(..) => ScreenContext::ToggleActiveSyncTab,
ScreenInstruction::ScrollUpAt(..) => ScreenContext::ScrollUpAt,
ScreenInstruction::ScrollDownAt(..) => ScreenContext::ScrollDownAt,
ScreenInstruction::LeftClick(..) => ScreenContext::LeftClick,
ScreenInstruction::RightClick(..) => ScreenContext::RightClick,
ScreenInstruction::MouseRelease(..) => ScreenContext::MouseRelease,
ScreenInstruction::MouseHold(..) => ScreenContext::MouseHold,
ScreenInstruction::Copy(..) => ScreenContext::Copy,
ScreenInstruction::ToggleTab(..) => ScreenContext::ToggleTab,
ScreenInstruction::AddClient(..) => ScreenContext::AddClient,
ScreenInstruction::RemoveClient(..) => ScreenContext::RemoveClient,
ScreenInstruction::AddOverlay(..) => ScreenContext::AddOverlay,
ScreenInstruction::RemoveOverlay(..) => ScreenContext::RemoveOverlay,
ScreenInstruction::ConfirmPrompt(..) => ScreenContext::ConfirmPrompt,
ScreenInstruction::DenyPrompt(..) => ScreenContext::DenyPrompt,
}
}
}
/// A [`Screen`] holds multiple [`Tab`]s, each one holding multiple [`panes`](crate::client::panes).
/// It only directly controls which tab is active, delegating the rest to the individual `Tab`.
pub(crate) struct Screen {
/// A Bus for sending and receiving messages with the other threads.
pub bus: Bus<ScreenInstruction>,
/// An optional maximal amount of panes allowed per [`Tab`] in this [`Screen`] instance.
max_panes: Option<usize>,
/// A map between this [`Screen`]'s tabs and their ID/key.
tabs: BTreeMap<usize, Tab>,
/// The full size of this [`Screen`].
size: Size,
/// The overlay that is drawn on top of [`Pane`]'s', [`Tab`]'s and the [`Screen`]
overlay: OverlayWindow,
connected_clients: Rc<RefCell<HashSet<ClientId>>>,
/// The indices of this [`Screen`]'s active [`Tab`]s.
active_tab_indices: BTreeMap<ClientId, usize>,
tab_history: BTreeMap<ClientId, Vec<usize>>,
mode_info: BTreeMap<ClientId, ModeInfo>,
default_mode_info: ModeInfo, // TODO: restructure ModeInfo to prevent this duplication
style: Style,
draw_pane_frames: bool,
session_is_mirrored: bool,
copy_command: Option<String>,
copy_clipboard: Clipboard,
}
impl Screen {
/// Creates and returns a new [`Screen`].
#[allow(clippy::too_many_arguments)]
pub fn new(
bus: Bus<ScreenInstruction>,
client_attributes: &ClientAttributes,
max_panes: Option<usize>,
mode_info: ModeInfo,
draw_pane_frames: bool,
session_is_mirrored: bool,
copy_command: Option<String>,
copy_clipboard: Clipboard,
) -> Self {
Screen {
bus,
max_panes,
size: client_attributes.size,
style: client_attributes.style,
connected_clients: Rc::new(RefCell::new(HashSet::new())),
active_tab_indices: BTreeMap::new(),
tabs: BTreeMap::new(),
overlay: OverlayWindow::default(),
tab_history: BTreeMap::new(),
mode_info: BTreeMap::new(),
default_mode_info: mode_info,
draw_pane_frames,
session_is_mirrored,
copy_command,
copy_clipboard,
}
}
/// Returns the index where a new [`Tab`] should be created in this [`Screen`].
/// Currently, this is right after the last currently existing tab, or `0` if
/// no tabs exist in this screen yet.
fn get_new_tab_index(&self) -> usize {
if let Some(index) = self.tabs.keys().last() {
*index + 1
} else {
0
}
}
fn move_clients_from_closed_tab(
&mut self,
client_ids_and_mode_infos: Vec<(ClientId, ModeInfo)>,
) {
// this will panic if there are no more tabs (ie. if self.tabs.is_empty() == true)
for (client_id, client_mode_info) in client_ids_and_mode_infos {
let client_tab_history = self.tab_history.entry(client_id).or_insert_with(Vec::new);
match client_tab_history.pop() {
Some(client_previous_tab) => {
self.active_tab_indices
.insert(client_id, client_previous_tab);
self.tabs
.get_mut(&client_previous_tab)
.unwrap()
.add_client(client_id, Some(client_mode_info));
}
None => {
let next_tab_index = *self.tabs.keys().next().unwrap();
self.active_tab_indices.insert(client_id, next_tab_index);
self.tabs
.get_mut(&next_tab_index)
.unwrap()
.add_client(client_id, Some(client_mode_info));
}
}
}
}
fn move_clients_between_tabs(
&mut self,
source_tab_index: usize,
destination_tab_index: usize,
clients_to_move: Option<Vec<ClientId>>,
) {
// None ==> move all clients
let drained_clients = self
.get_indexed_tab_mut(source_tab_index)
.map(|t| t.drain_connected_clients(clients_to_move));
if let Some(client_mode_info_in_source_tab) = drained_clients {
let destination_tab = self.get_indexed_tab_mut(destination_tab_index).unwrap();
destination_tab.add_multiple_clients(client_mode_info_in_source_tab);
destination_tab.update_input_modes();
destination_tab.set_force_render();
destination_tab.visible(true);
}
}
fn update_client_tab_focus(&mut self, client_id: ClientId, new_tab_index: usize) {
match self.active_tab_indices.remove(&client_id) {
Some(old_active_index) => {
self.active_tab_indices.insert(client_id, new_tab_index);
let client_tab_history = self.tab_history.entry(client_id).or_insert_with(Vec::new);
client_tab_history.retain(|&e| e != new_tab_index);
client_tab_history.push(old_active_index);
}
None => {
self.active_tab_indices.insert(client_id, new_tab_index);
}
}
}
/// A helper function to switch to a new tab at specified position.
fn switch_active_tab(&mut self, new_tab_pos: usize, client_id: ClientId) {
if let Some(new_tab) = self.tabs.values().find(|t| t.position == new_tab_pos) {
if let Some(current_tab) = self.get_active_tab(client_id) {
// If new active tab is same as the current one, do nothing.
if current_tab.position == new_tab_pos {
return;
}
let current_tab_index = current_tab.index;
let new_tab_index = new_tab.index;
if self.session_is_mirrored {
self.move_clients_between_tabs(current_tab_index, new_tab_index, None);
let all_connected_clients: Vec<ClientId> =
self.connected_clients.borrow().iter().copied().collect();
for client_id in all_connected_clients {
self.update_client_tab_focus(client_id, new_tab_index);
}
} else {
self.move_clients_between_tabs(
current_tab_index,
new_tab_index,
Some(vec![client_id]),
);
self.update_client_tab_focus(client_id, new_tab_index);
}
if let Some(current_tab) = self.get_indexed_tab_mut(current_tab_index) {
if current_tab.has_no_connected_clients() {
current_tab.visible(false);
}
} else {
log::error!("Tab index: {:?} not found", current_tab_index);
}
self.update_tabs();
self.render();
} else {
log::error!("Active tab not found for client_id: {:?}", client_id);
}
}
}
/// Sets this [`Screen`]'s active [`Tab`] to the next tab.
pub fn switch_tab_next(&mut self, client_id: ClientId) {
if let Some(active_tab) = self.get_active_tab(client_id) {
let active_tab_pos = active_tab.position;
let new_tab_pos = (active_tab_pos + 1) % self.tabs.len();
self.switch_active_tab(new_tab_pos, client_id);
} else {
log::error!("Active tab not found for client_id: {:?}", client_id);
}
}
/// Sets this [`Screen`]'s active [`Tab`] to the previous tab.
pub fn switch_tab_prev(&mut self, client_id: ClientId) {
if let Some(active_tab) = self.get_active_tab(client_id) {
let active_tab_pos = active_tab.position;
let new_tab_pos = if active_tab_pos == 0 {
self.tabs.len() - 1
} else {
active_tab_pos - 1
};
self.switch_active_tab(new_tab_pos, client_id);
} else {
log::error!("Active tab not found for client_id: {:?}", client_id);
}
}
pub fn go_to_tab(&mut self, tab_index: usize, client_id: ClientId) {
self.switch_active_tab(tab_index - 1, client_id);
}
fn close_tab_at_index(&mut self, tab_index: usize) {
let mut tab_to_close = self.tabs.remove(&tab_index).unwrap();
let pane_ids = tab_to_close.get_all_pane_ids();
// below we don't check the result of sending the CloseTab instruction to the pty thread
// because this might be happening when the app is closing, at which point the pty thread
// has already closed and this would result in an error
self.bus
.senders
.send_to_pty(PtyInstruction::CloseTab(pane_ids))
.unwrap();
if self.tabs.is_empty() {
self.active_tab_indices.clear();
self.bus
.senders
.send_to_server(ServerInstruction::Render(None))
.unwrap();
} else {
let client_mode_infos_in_closed_tab = tab_to_close.drain_connected_clients(None);
self.move_clients_from_closed_tab(client_mode_infos_in_closed_tab);
let visible_tab_indices: HashSet<usize> =
self.active_tab_indices.values().copied().collect();
for t in self.tabs.values_mut() {
if visible_tab_indices.contains(&t.index) {
t.set_force_render();
t.visible(true);
}
if t.position > tab_to_close.position {
t.position -= 1;
}
}
self.update_tabs();
self.render();
}
}
// Closes the client_id's focused tab
pub fn close_tab(&mut self, client_id: ClientId) {
let active_tab_index = *self.active_tab_indices.get(&client_id).unwrap();
self.close_tab_at_index(active_tab_index);
}
pub fn resize_to_screen(&mut self, new_screen_size: Size) {
self.size = new_screen_size;
for tab in self.tabs.values_mut() {
tab.resize_whole_tab(new_screen_size);
tab.set_force_render();
}
self.render();
}
/// Renders this [`Screen`], which amounts to rendering its active [`Tab`].
pub fn render(&mut self) {
let mut output = Output::default();
let mut tabs_to_close = vec![];
let size = self.size;
let overlay = self.overlay.clone();
for (tab_index, tab) in &mut self.tabs {
if tab.has_selectable_tiled_panes() {
let vte_overlay = overlay.generate_overlay(size);
tab.render(&mut output, Some(vte_overlay));
} else {
tabs_to_close.push(*tab_index);
}
}
for tab_index in tabs_to_close {
self.close_tab_at_index(tab_index);
}
let serialized_output = output.serialize();
self.bus
.senders
.send_to_server(ServerInstruction::Render(Some(serialized_output)))
.unwrap();
}
/// Returns a mutable reference to this [`Screen`]'s tabs.
pub fn get_tabs_mut(&mut self) -> &mut BTreeMap<usize, Tab> {
&mut self.tabs
}
/// Returns an immutable reference to this [`Screen`]'s active [`Tab`].
pub fn get_active_tab(&self, client_id: ClientId) -> Option<&Tab> {
match self.active_tab_indices.get(&client_id) {
Some(tab) => self.tabs.get(tab),
None => None,
}
}
/// Returns an immutable reference to this [`Screen`]'s previous active [`Tab`].
/// Consumes the last entry in tab history.
pub fn get_previous_tab(&mut self, client_id: ClientId) -> Option<&Tab> {
match self.tab_history.get_mut(&client_id).unwrap().pop() {
Some(tab) => self.tabs.get(&tab),
None => None,
}
}
/// Returns a mutable reference to this [`Screen`]'s active [`Tab`].
pub fn get_active_tab_mut(&mut self, client_id: ClientId) -> Option<&mut Tab> {
match self.active_tab_indices.get(&client_id) {
Some(tab) => self.tabs.get_mut(tab),
None => None,
}
}
/// Returns a mutable reference to this [`Screen`]'s active [`Overlays`].
pub fn get_active_overlays_mut(&mut self) -> &mut Vec<Overlay> {
&mut self.overlay.overlay_stack
}
/// Returns a mutable reference to this [`Screen`]'s indexed [`Tab`].
pub fn get_indexed_tab_mut(&mut self, tab_index: usize) -> Option<&mut Tab> {
self.get_tabs_mut().get_mut(&tab_index)
}
/// Creates a new [`Tab`] in this [`Screen`], applying the specified [`Layout`]
/// and switching to it.
pub fn new_tab(&mut self, layout: Layout, new_pids: Vec<RawFd>, client_id: ClientId) {
let tab_index = self.get_new_tab_index();
let position = self.tabs.len();
let client_mode_info = self
.mode_info
.get(&client_id)
.unwrap_or(&self.default_mode_info)
.clone();
let mut tab = Tab::new(
tab_index,
position,
String::new(),
self.size,
self.bus.os_input.as_ref().unwrap().clone(),
self.bus.senders.clone(),
self.max_panes,
self.style,
client_mode_info,
self.draw_pane_frames,
self.connected_clients.clone(),
self.session_is_mirrored,
client_id,
self.copy_command.clone(),
self.copy_clipboard.clone(),
);
tab.apply_layout(layout, new_pids, tab_index, client_id);
if self.session_is_mirrored {
if let Some(active_tab) = self.get_active_tab_mut(client_id) {
let client_mode_infos_in_source_tab = active_tab.drain_connected_clients(None);
tab.add_multiple_clients(client_mode_infos_in_source_tab);
if active_tab.has_no_connected_clients() {
active_tab.visible(false);
}
}
let all_connected_clients: Vec<ClientId> =
self.connected_clients.borrow().iter().copied().collect();
for client_id in all_connected_clients {
self.update_client_tab_focus(client_id, tab_index);
}
} else if let Some(active_tab) = self.get_active_tab_mut(client_id) {
let client_mode_info_in_source_tab =
active_tab.drain_connected_clients(Some(vec![client_id]));
tab.add_multiple_clients(client_mode_info_in_source_tab);
if active_tab.has_no_connected_clients() {
active_tab.visible(false);
}
self.update_client_tab_focus(client_id, tab_index);
}
tab.update_input_modes();
tab.visible(true);
self.tabs.insert(tab_index, tab);
if !self.active_tab_indices.contains_key(&client_id) {
// this means this is a new client and we need to add it to our state properly
self.add_client(client_id);
}
self.update_tabs();
self.render();
}
pub fn add_client(&mut self, client_id: ClientId) {
let mut tab_index = 0;
let mut tab_history = vec![];
if let Some((_first_client, first_active_tab_index)) = self.active_tab_indices.iter().next()
{
tab_index = *first_active_tab_index;
}
if let Some((_first_client, first_tab_history)) = self.tab_history.iter().next() {
tab_history = first_tab_history.clone();
}
self.active_tab_indices.insert(client_id, tab_index);
self.connected_clients.borrow_mut().insert(client_id);
self.tab_history.insert(client_id, tab_history);
self.tabs
.get_mut(&tab_index)
.unwrap()
.add_client(client_id, None);
}
pub fn remove_client(&mut self, client_id: ClientId) {
self.tabs.iter_mut().for_each(|(_, tab)| {
tab.remove_client(client_id);
if tab.has_no_connected_clients() {
tab.visible(false);
}
});
if self.active_tab_indices.contains_key(&client_id) {
self.active_tab_indices.remove(&client_id);
}
if self.tab_history.contains_key(&client_id) {
self.tab_history.remove(&client_id);
}
self.connected_clients.borrow_mut().remove(&client_id);
self.update_tabs();
}
pub fn update_tabs(&self) {
for (client_id, active_tab_index) in self.active_tab_indices.iter() {
let mut tab_data = vec![];
for tab in self.tabs.values() {
let other_focused_clients: Vec<ClientId> = if self.session_is_mirrored {
vec![]
} else {
self.active_tab_indices
.iter()
.filter(|(c_id, tab_position)| {
**tab_position == tab.index && *c_id != client_id
})
.map(|(c_id, _)| c_id)
.copied()
.collect()
};
tab_data.push(TabInfo {
position: tab.position,
name: tab.name.clone(),
active: *active_tab_index == tab.index,
panes_to_hide: tab.panes_to_hide_count(),
is_fullscreen_active: tab.is_fullscreen_active(),
is_sync_panes_active: tab.is_sync_panes_active(),
are_floating_panes_visible: tab.are_floating_panes_visible(),
other_focused_clients,
});
}
self.bus
.senders
.send_to_plugin(PluginInstruction::Update(
None,
Some(*client_id),
Event::TabUpdate(tab_data),
))
.unwrap();
}
}
pub fn update_active_tab_name(&mut self, buf: Vec<u8>, client_id: ClientId) {
let s = str::from_utf8(&buf).unwrap();
if let Some(active_tab) = self.get_active_tab_mut(client_id) {
match s {
"\0" => {
active_tab.name = String::new();
}
"\u{007F}" | "\u{0008}" => {
// delete and backspace keys
active_tab.name.pop();
}
c => {
// It only allows printable unicode
if buf.iter().all(|u| matches!(u, 0x20..=0x7E)) {
active_tab.name.push_str(c);
}
}
}
self.update_tabs();
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
}
pub fn change_mode(&mut self, mode_info: ModeInfo, client_id: ClientId) {
let previous_mode = self
.mode_info
.get(&client_id)
.unwrap_or(&self.default_mode_info)
.mode;
if previous_mode == InputMode::Scroll
&& (mode_info.mode == InputMode::Normal || mode_info.mode == InputMode::Locked)
{
if let Some(active_tab) = self.get_active_tab_mut(client_id) {
active_tab.clear_active_terminal_scroll(client_id);
}
}
self.style = mode_info.style;
self.mode_info.insert(client_id, mode_info.clone());
for tab in self.tabs.values_mut() {
tab.change_mode_info(mode_info.clone(), client_id);
tab.mark_active_pane_for_rerender(client_id);
}
}
pub fn move_focus_left_or_previous_tab(&mut self, client_id: ClientId) {
if let Some(active_tab) = self.get_active_tab_mut(client_id) {
if !active_tab.move_focus_left(client_id) {
println!("can has true");
self.switch_tab_prev(client_id);
}
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
}
pub fn move_focus_right_or_next_tab(&mut self, client_id: ClientId) {
if let Some(active_tab) = self.get_active_tab_mut(client_id) {
if !active_tab.move_focus_right(client_id) {
self.switch_tab_next(client_id);
}
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
}
pub fn toggle_tab(&mut self, client_id: ClientId) {
let tab = self.get_previous_tab(client_id);
if let Some(t) = tab {
let position = t.position;
self.go_to_tab(position + 1, client_id);
};
self.update_tabs();
self.render();
}
}
// The box is here in order to make the
// NewClient enum smaller
#[allow(clippy::boxed_local)]
pub(crate) fn screen_thread_main(
bus: Bus<ScreenInstruction>,
max_panes: Option<usize>,
client_attributes: ClientAttributes,
config_options: Box<Options>,
) {
let capabilities = config_options.simplified_ui;
let draw_pane_frames = config_options.pane_frames.unwrap_or(true);
let session_is_mirrored = config_options.mirror_session.unwrap_or(false);
let mut screen = Screen::new(
bus,
&client_attributes,
max_panes,
get_mode_info(
config_options.default_mode.unwrap_or_default(),
client_attributes.style,
PluginCapabilities {
arrow_fonts: capabilities.unwrap_or_default(),
},
),
draw_pane_frames,
session_is_mirrored,
config_options.copy_command,
config_options.copy_clipboard.unwrap_or_default(),
);
loop {
let (event, mut err_ctx) = screen
.bus
.recv()
.expect("failed to receive event on channel");
err_ctx.add_call(ContextType::Screen((&event).into()));
match event {
ScreenInstruction::PtyBytes(pid, vte_bytes) => {
let all_tabs = screen.get_tabs_mut();
for tab in all_tabs.values_mut() {
if tab.has_terminal_pid(pid) {
tab.handle_pty_bytes(pid, vte_bytes);
break;
}
}
}
ScreenInstruction::Render => {
screen.render();
}
ScreenInstruction::NewPane(pid, client_or_tab_index) => {
match client_or_tab_index {
ClientOrTabIndex::ClientId(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.new_pane(pid, Some(client_id));
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
}
ClientOrTabIndex::TabIndex(tab_index) => {
if let Some(active_tab) = screen.tabs.get_mut(&tab_index) {
active_tab.new_pane(pid, None);
} else {
log::error!("Tab index not found: {:?}", tab_index);
}
}
};
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.update_tabs();
screen.render();
}
ScreenInstruction::TogglePaneEmbedOrFloating(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.toggle_pane_embed_or_floating(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.update_tabs(); // update tabs so that the ui indication will be send to the plugins
screen.render();
}
ScreenInstruction::ToggleFloatingPanes(client_id, default_shell) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.toggle_floating_panes(client_id, default_shell);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.update_tabs(); // update tabs so that the ui indication will be send to the plugins
screen.render();
}
ScreenInstruction::HorizontalSplit(pid, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.horizontal_split(pid, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.update_tabs();
screen.render();
}
ScreenInstruction::VerticalSplit(pid, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.vertical_split(pid, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.update_tabs();
screen.render();
}
ScreenInstruction::WriteCharacter(bytes, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
match active_tab.is_sync_panes_active() {
true => active_tab.write_to_terminals_on_current_tab(bytes),
false => active_tab.write_to_active_terminal(bytes, client_id),
}
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
}
ScreenInstruction::ResizeLeft(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.resize_left(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ResizeRight(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.resize_right(client_id);
}
screen.render();
}
ScreenInstruction::ResizeDown(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.resize_down(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ResizeUp(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.resize_up(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ResizeIncrease(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.resize_increase(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ResizeDecrease(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.resize_decrease(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::SwitchFocus(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.focus_next_pane(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::FocusNextPane(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.focus_next_pane(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::FocusPreviousPane(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.focus_previous_pane(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MoveFocusLeft(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_focus_left(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MoveFocusLeftOrPreviousTab(client_id) => {
screen.move_focus_left_or_previous_tab(client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
ScreenInstruction::MoveFocusDown(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_focus_down(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MoveFocusRight(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_focus_right(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MoveFocusRightOrNextTab(client_id) => {
screen.move_focus_right_or_next_tab(client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
ScreenInstruction::MoveFocusUp(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_focus_up(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ScrollUp(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_active_terminal_up(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MovePane(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_active_pane(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MovePaneDown(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_active_pane_down(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MovePaneUp(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_active_pane_up(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MovePaneRight(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_active_pane_right(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MovePaneLeft(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.move_active_pane_left(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ScrollUpAt(point, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_terminal_up(&point, 3, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ScrollDown(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_active_terminal_down(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ScrollDownAt(point, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_terminal_down(&point, 3, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ScrollToBottom(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_active_terminal_to_bottom(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::PageScrollUp(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_active_terminal_up_page(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::PageScrollDown(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_active_terminal_down_page(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::HalfPageScrollUp(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_active_terminal_up_half_page(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::HalfPageScrollDown(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.scroll_active_terminal_down_half_page(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ClearScroll(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.clear_active_terminal_scroll(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::CloseFocusedPane(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.close_focused_pane(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.update_tabs(); // update_tabs eventually calls render through the plugin thread
}
ScreenInstruction::SetSelectable(id, selectable, tab_index) => {
screen.get_indexed_tab_mut(tab_index).map_or_else(
|| {
log::warn!(
"Tab index #{} not found, could not set selectable for plugin #{:?}.",
tab_index,
id
)
},
|tab| tab.set_pane_selectable(id, selectable),
);
screen.render();
}
ScreenInstruction::ClosePane(id, client_id) => {
match client_id {
Some(client_id) => {
screen
.get_active_tab_mut(client_id)
.and_then(|active_tab| active_tab.close_pane(id))
.or_else(|| {
log::error!("Active tab not found for client id: {:?}", client_id);
None
});
}
None => {
for tab in screen.tabs.values_mut() {
if tab.get_all_pane_ids().contains(&id) {
tab.close_pane(id);
break;
}
}
}
}
screen.update_tabs();
}
ScreenInstruction::UpdatePaneName(c, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.update_active_pane_name(c, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::ToggleActiveTerminalFullscreen(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.toggle_active_pane_fullscreen(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.update_tabs();
screen.render();
}
ScreenInstruction::TogglePaneFrames => {
screen.draw_pane_frames = !screen.draw_pane_frames;
for tab in screen.tabs.values_mut() {
tab.set_pane_frames(screen.draw_pane_frames);
}
screen.render();
}
ScreenInstruction::SwitchTabNext(client_id) => {
screen.switch_tab_next(client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
ScreenInstruction::SwitchTabPrev(client_id) => {
screen.switch_tab_prev(client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
ScreenInstruction::CloseTab(client_id) => {
screen.close_tab(client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
ScreenInstruction::NewTab(layout, new_pane_pids, client_id) => {
screen.new_tab(layout, new_pane_pids, client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
ScreenInstruction::GoToTab(tab_index, client_id) => {
if let Some(client_id) =
client_id.or_else(|| screen.active_tab_indices.keys().next().copied())
{
screen.go_to_tab(tab_index as usize, client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
}
ScreenInstruction::UpdateTabName(c, client_id) => {
screen.update_active_tab_name(c, client_id);
screen.render();
}
ScreenInstruction::TerminalResize(new_size) => {
screen.resize_to_screen(new_size);
screen.render();
}
ScreenInstruction::ChangeMode(mode_info, client_id) => {
screen.change_mode(mode_info, client_id);
screen.render();
}
ScreenInstruction::ToggleActiveSyncTab(client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.toggle_sync_panes_is_active();
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.update_tabs();
screen.render();
}
ScreenInstruction::LeftClick(point, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.handle_left_click(&point, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.update_tabs();
screen.render();
}
ScreenInstruction::RightClick(point, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.handle_right_click(&point, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.update_tabs();
screen.render();
}
ScreenInstruction::MouseRelease(point, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.handle_mouse_release(&point, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::MouseHold(point, client_id) => {
if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
active_tab.handle_mouse_hold(&point, client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::Copy(client_id) => {
if let Some(active_tab) = screen.get_active_tab(client_id) {
active_tab.copy_selection(client_id);
} else {
log::error!("Active tab not found for client id: {:?}", client_id);
}
screen.render();
}
ScreenInstruction::Exit => {
break;
}
ScreenInstruction::ToggleTab(client_id) => {
screen.toggle_tab(client_id);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
screen.render();
}
ScreenInstruction::AddClient(client_id) => {
screen.add_client(client_id);
screen.update_tabs();
screen.render();
}
ScreenInstruction::RemoveClient(client_id) => {
screen.remove_client(client_id);
screen.render();
}
ScreenInstruction::AddOverlay(overlay, _client_id) => {
screen.get_active_overlays_mut().pop();
screen.get_active_overlays_mut().push(overlay);
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
}
ScreenInstruction::RemoveOverlay(_client_id) => {
screen.get_active_overlays_mut().pop();
screen.render();
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
}
ScreenInstruction::ConfirmPrompt(_client_id) => {
let overlay = screen.get_active_overlays_mut().pop();
let instruction = overlay.and_then(|o| o.prompt_confirm());
if let Some(instruction) = instruction {
screen.bus.senders.send_to_server(*instruction).unwrap();
}
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
}
ScreenInstruction::DenyPrompt(_client_id) => {
screen.get_active_overlays_mut().pop();
screen.render();
screen
.bus
.senders
.send_to_server(ServerInstruction::UnblockInputThread)
.unwrap();
}
}
}
}
#[cfg(test)]
#[path = "./unit/screen_tests.rs"]
mod screen_tests;