feat(ui): add the ability to synchronize input sent to panes

assets/config/default.yaml

@@ -97,6 +97,8 @@ keybinds:
           key: [Char: 'r',]
         - action: [CloseFocus,]
           key: [Char: 'x',]
+        - action: [ToggleActiveSyncPanes]
+          key: [Char: 's']
         - action: [ToggleFocusFullscreen,]
           key: [Char: 'f',]
         - action: [FocusPreviousPane,]

default-plugins/tab-bar/src/main.rs

@@ -65,7 +65,7 @@ impl ZellijPlugin for State {
             } else if t.active {
                 active_tab_index = t.position;
             }
-            let tab = tab_style(tabname, t.active, t.position);
+            let tab = tab_style(tabname, t.active, t.position, t.is_sync_panes_active);
             all_tabs.push(tab);
         }
         let tab_line = tab_line(all_tabs, active_tab_index, cols);

default-plugins/tab-bar/src/tab.rs

@@ -40,9 +40,18 @@ pub fn non_active_tab(text: String) -> LinePart {
     }
 }
 
-pub fn tab_style(text: String, is_active_tab: bool, position: usize) -> LinePart {
+pub fn tab_style(
+    text: String,
+    is_active_tab: bool,
+    position: usize,
+    is_sync_panes_active: bool,
+) -> LinePart {
+    let sync_text = match is_sync_panes_active {
+        true => " (Sync)".to_string(),
+        false => "".to_string(),
+    };
     let tab_text = if text.is_empty() {
-        format!("Tab #{}", position + 1)
+        format!("Tab #{}{}", position + 1, sync_text)
     } else {
         text
     };

src/client/tab.rs

@@ -68,6 +68,7 @@ pub struct Tab {
     max_panes: Option<usize>,
     full_screen_ws: PositionAndSize,
     fullscreen_is_active: bool,
+    synchronize_is_active: bool,
     os_api: Box<dyn OsApi>,
     pub send_pty_instructions: SenderWithContext<PtyInstruction>,
     pub send_plugin_instructions: SenderWithContext<PluginInstruction>,
@@ -249,6 +250,7 @@ impl Tab {
             active_terminal: pane_id,
             full_screen_ws: *full_screen_ws,
             fullscreen_is_active: false,
+            synchronize_is_active: false,
             os_api,
             send_app_instructions,
             send_pty_instructions,
@@ -592,6 +594,21 @@ impl Tab {
             terminal_output.handle_pty_bytes(bytes);
         }
     }
+    pub fn write_to_terminals_on_current_tab(&mut self, input_bytes: Vec<u8>) {
+        let pane_ids = self.get_pane_ids();
+        pane_ids.iter().for_each(|pane_id| match pane_id {
+            PaneId::Terminal(pid) => {
+                self.write_to_pane_id(input_bytes.clone(), *pid);
+            }
+            PaneId::Plugin(_) => {}
+        });
+    }
+    pub fn write_to_pane_id(&mut self, mut input_bytes: Vec<u8>, pid: RawFd) {
+        self.os_api
+            .write_to_tty_stdin(pid, &mut input_bytes)
+            .expect("failed to write to terminal");
+        self.os_api.tcdrain(pid).expect("failed to drain terminal");
+    }
     pub fn write_to_active_terminal(&mut self, input_bytes: Vec<u8>) {
         match self.get_active_pane_id() {
             Some(PaneId::Terminal(active_terminal_id)) => {
@@ -677,6 +694,12 @@ impl Tab {
     pub fn toggle_fullscreen_is_active(&mut self) {
         self.fullscreen_is_active = !self.fullscreen_is_active;
     }
+    pub fn is_sync_panes_active(&self) -> bool {
+        self.synchronize_is_active
+    }
+    pub fn toggle_sync_panes_is_active(&mut self) {
+        self.synchronize_is_active = !self.synchronize_is_active;
+    }
     pub fn render(&mut self) {
         if self.active_terminal.is_none() {
             // we might not have an active terminal if we closed the last pane

src/common/errors.rs

@@ -200,6 +200,7 @@ pub enum ScreenContext {
     PageScrollDown,
     ClearScroll,
     CloseFocusedPane,
+    ToggleActiveSyncPanes,
     ToggleActiveTerminalFullscreen,
     SetSelectable,
     SetInvisibleBorders,
@@ -260,6 +261,7 @@ impl From<&ScreenInstruction> for ScreenContext {
             ScreenInstruction::UpdateTabName(_) => ScreenContext::UpdateTabName,
             ScreenInstruction::TerminalResize => ScreenContext::TerminalResize,
             ScreenInstruction::ChangeMode(_) => ScreenContext::ChangeMode,
+            ScreenInstruction::ToggleActiveSyncPanes => ScreenContext::ToggleActiveSyncPanes,
         }
     }
 }

src/common/input/actions.rs

@@ -39,6 +39,8 @@ pub enum Action {
     PageScrollDown,
     /// Toggle between fullscreen focus pane and normal layout.
     ToggleFocusFullscreen,
+    /// Toggle between sending text commands to all panes and normal mode.
+    ToggleActiveSyncPanes,
     /// Open a new pane in the specified direction (relative to focus).
     /// If no direction is specified, will try to use the biggest available space.
     NewPane(Option<Direction>),

src/common/input/handler.rs

@@ -244,6 +244,11 @@ impl InputHandler {
                     .send(ScreenInstruction::SwitchTabPrev)
                     .unwrap();
             }
+            Action::ToggleActiveSyncPanes => {
+                self.send_screen_instructions
+                    .send(ScreenInstruction::ToggleActiveSyncPanes)
+                    .unwrap();
+            }
             Action::CloseTab => {
                 self.command_is_executing.closing_pane();
                 self.send_screen_instructions
@@ -293,6 +298,7 @@ pub fn get_mode_info(mode: InputMode) -> ModeInfo {
             keybinds.push(("d".to_string(), "Down split".to_string()));
             keybinds.push(("r".to_string(), "Right split".to_string()));
             keybinds.push(("x".to_string(), "Close".to_string()));
+            keybinds.push(("s".to_string(), "Sync".to_string()));
             keybinds.push(("f".to_string(), "Fullscreen".to_string()));
         }
         InputMode::Tab => {

src/common/mod.rs

@@ -320,10 +320,11 @@ pub fn start(mut os_input: Box<dyn OsApi>, opts: CliArgs) {
                             command_is_executing.done_opening_new_pane();
                         }
                         ScreenInstruction::WriteCharacter(bytes) => {
-                            screen
+                            let active_tab = screen.get_active_tab_mut().unwrap();
-                                .get_active_tab_mut()
+                            match active_tab.is_sync_panes_active() {
-                                .unwrap()
+                                true => active_tab.write_to_terminals_on_current_tab(bytes),
-                                .write_to_active_terminal(bytes);
+                                false => active_tab.write_to_active_terminal(bytes),
+                            }
                         }
                         ScreenInstruction::ResizeLeft => {
                             screen.get_active_tab_mut().unwrap().resize_left();
@@ -444,6 +445,13 @@ pub fn start(mut os_input: Box<dyn OsApi>, opts: CliArgs) {
                         ScreenInstruction::ChangeMode(mode_info) => {
                             screen.change_mode(mode_info);
                         }
+                        ScreenInstruction::ToggleActiveSyncPanes => {
+                            screen
+                                .get_active_tab_mut()
+                                .unwrap()
+                                .toggle_sync_panes_is_active();
+                            screen.update_tabs();
+                        }
                         ScreenInstruction::Quit => {
                             break;
                         }

src/common/screen.rs

@@ -51,6 +51,7 @@ pub enum ScreenInstruction {
     NewTab(RawFd),
     SwitchTabNext,
     SwitchTabPrev,
+    ToggleActiveSyncPanes,
     CloseTab,
     GoToTab(u32),
     UpdateTabName(Vec<u8>),
@@ -285,7 +286,7 @@ impl Screen {
         self.update_tabs();
     }
 
-    fn update_tabs(&self) {
+    pub fn update_tabs(&self) {
         let mut tab_data = vec![];
         let active_tab_index = self.active_tab_index.unwrap();
         for tab in self.tabs.values() {
@@ -293,6 +294,7 @@ impl Screen {
                 position: tab.position,
                 name: tab.name.clone(),
                 active: active_tab_index == tab.index,
+                is_sync_panes_active: tab.is_sync_panes_active(),
             });
         }
         self.send_plugin_instructions

zellij-tile/src/data.rs

@@ -83,6 +83,7 @@ pub struct TabInfo {
     pub position: usize,
     pub name: String,
     pub active: bool,
+    pub is_sync_panes_active: bool,
 }
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]