Initial commit for fixing zellij-org#1353

docs/MANPAGE.md

@@ -151,6 +151,7 @@ ACTIONS
   next ID.
 * __MoveFocus: <Direction\>__ -  moves focus in the specified direction (Left,
   Right, Up, Down).
+* __DumpScreen: <File\>__ - dumps the screen in the specified file.
 * __ScrollUp__ - scrolls up 1 line in the focused pane.
 * __ScrollDown__ - scrolls down 1 line in the focused pane.
 * __PageScrollUp__ - scrolls up 1 page in the focused pane.

example/alt-centered-config.yaml

@@ -88,6 +88,8 @@ keybinds:
           key: [ Char: 'j', Down,]
         - action: [MoveFocus: Up,]
           key: [ Char: 'k', Up,]
+        - action: [DumpScreen,]
+          key: [Char: '/']
         - action: [SwitchFocus,]
           key: [Char: 'p']
         - action: [NewPane: ,]

example/default.yaml

@@ -113,6 +113,8 @@ keybinds:
           key: [Ctrl: 'b',]
         - action: [Quit,]
           key: [Ctrl: 'q',]
+        - action: [DumpScreen,]
+          key: [Char: '/']
         - action: [MoveFocus: Left,]
           key: [ Char: 'h', Left,]
         - action: [MoveFocus: Right,]

zellij-server/Cargo.toml

@@ -28,6 +28,7 @@ typetag = "0.1.7"
 chrono = "0.4.19"
 close_fds = "0.3.2"
 sysinfo = "0.22.5"
+tempfile = "3.2.0"
 
 [dev-dependencies]
 insta = "1.6.0"

zellij-server/src/os_input_output.rs

@@ -1,6 +1,8 @@
 use std::collections::HashMap;
+use std::{fs::File, io::Write};
 
 use crate::panes::PaneId;
+use tempfile::tempfile;
 
 use std::env;
 use std::os::unix::io::RawFd;
@@ -268,6 +270,8 @@ pub trait ServerOsApi: Send + Sync {
     fn load_palette(&self) -> Palette;
     /// Returns the current working directory for a given pid
     fn get_cwd(&self, pid: Pid) -> Option<PathBuf>;
+    /// Writes the given buffer to a string
+    fn write_to_file(&self, buf: String, file: Option<String>);
 }
 
 impl ServerOsApi for ServerOsInputOutput {
@@ -345,6 +349,16 @@ impl ServerOsApi for ServerOsInputOutput {
         }
         None
     }
+    fn write_to_file(&self, buf: String, name: Option<String>) {
+        let mut f: File;
+        match name {
+            Some(x) => f = File::create(x).unwrap(),
+            None => f = tempfile().unwrap(),
+        }
+        if let Err(e) = write!(f, "{}", buf) {
+            log::error!("could not write to file: {}", e);
+        }
+    }
 }
 
 impl Clone for Box<dyn ServerOsApi> {

zellij-server/src/panes/grid.rs

@@ -271,6 +271,23 @@ fn subtract_isize_from_usize(u: usize, i: isize) -> usize {
     }
 }
 
+macro_rules! dump_screen {
+    ($lines:expr) => {{
+        let mut is_first = true;
+        let mut buf = "".to_owned();
+
+        for line in &$lines {
+            if line.is_canonical && !is_first {
+                buf.push_str("\n");
+            }
+            let s: String = (&line.columns).into_iter().map(|x| x.character).collect();
+            buf.push_str(&(s.replace("[ ]*$", "")));
+            is_first = false;
+        }
+        buf
+    }};
+}
+
 #[derive(Clone)]
 pub struct Grid {
     lines_above: VecDeque<Row>,
@@ -796,6 +813,13 @@ impl Grid {
             Some((self.cursor.x, self.cursor.y))
         }
     }
+
+    pub fn dump_screen(&mut self) -> String {
+        let mut lines: String = dump_screen!(self.lines_above);
+        let viewport: String = dump_screen!(self.viewport);
+        lines.push_str(&viewport);
+        return lines;
+    }
     pub fn move_viewport_up(&mut self, count: usize) {
         for _ in 0..count {
             self.scroll_up_one_line();

zellij-server/src/panes/plugin_pane.rs

@@ -321,6 +321,9 @@ impl Pane for PluginPane {
         self.geom.y -= count;
         self.should_render = true;
     }
+    fn dump_screen(&mut self, _client_id: ClientId) -> String {
+        return "".to_owned();
+    }
     fn scroll_up(&mut self, count: usize, client_id: ClientId) {
         self.send_plugin_instructions
             .send(PluginInstruction::Update(

zellij-server/src/panes/terminal_pane.rs

@@ -386,6 +386,9 @@ impl Pane for TerminalPane {
         self.geom.y -= count;
         self.reflow_lines();
     }
+    fn dump_screen(&mut self, _client_id: ClientId) -> String {
+        return self.grid.dump_screen();
+    }
     fn scroll_up(&mut self, count: usize, _client_id: ClientId) {
         self.grid.move_viewport_up(count);
         self.set_should_render(true);

zellij-server/src/route.rs

@@ -146,6 +146,12 @@ fn route_action(
             };
             session.senders.send_to_screen(screen_instr).unwrap();
         }
+        Action::DumpScreen(val) => {
+            session
+                .senders
+                .send_to_screen(ScreenInstruction::DumpScreen(val, client_id))
+                .unwrap();
+        }
         Action::ScrollUp => {
             session
                 .senders

zellij-server/src/screen.rs

@@ -62,6 +62,7 @@ pub enum ScreenInstruction {
     MovePaneRight(ClientId),
     MovePaneLeft(ClientId),
     Exit,
+    DumpScreen(String, ClientId),
     ScrollUp(ClientId),
     ScrollUpAt(Position, ClientId),
     ScrollDown(ClientId),
@@ -140,6 +141,7 @@ impl From<&ScreenInstruction> for ScreenContext {
             ScreenInstruction::MovePaneRight(..) => ScreenContext::MovePaneRight,
             ScreenInstruction::MovePaneLeft(..) => ScreenContext::MovePaneLeft,
             ScreenInstruction::Exit => ScreenContext::Exit,
+            ScreenInstruction::DumpScreen(..) => ScreenContext::DumpScreen,
             ScreenInstruction::ScrollUp(..) => ScreenContext::ScrollUp,
             ScreenInstruction::ScrollDown(..) => ScreenContext::ScrollDown,
             ScreenInstruction::ScrollToBottom(..) => ScreenContext::ScrollToBottom,
@@ -1037,6 +1039,15 @@ pub(crate) fn screen_thread_main(
 
                 screen.render();
             }
+            ScreenInstruction::DumpScreen(file, client_id) => {
+                if let Some(active_tab) = screen.get_active_tab_mut(client_id) {
+                    active_tab.dump_active_terminal(Some(file.to_string()), 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);

zellij-server/src/tab/mod.rs

@@ -152,6 +152,7 @@ pub trait Pane {
     fn push_right(&mut self, count: usize);
     fn pull_left(&mut self, count: usize);
     fn pull_up(&mut self, count: usize);
+    fn dump_screen(&mut self, client_id: ClientId) -> String;
     fn scroll_up(&mut self, count: usize, client_id: ClientId);
     fn scroll_down(&mut self, count: usize, client_id: ClientId);
     fn clear_scroll(&mut self);
@@ -1370,6 +1371,12 @@ impl Tab {
                 .unwrap();
         }
     }
+    pub fn dump_active_terminal(&mut self, file: Option<String>, client_id: ClientId) {
+        if let Some(active_pane) = self.get_active_pane_or_floating_pane_mut(client_id) {
+            let dump = active_pane.dump_screen(client_id);
+            self.os_api.write_to_file(dump, file);
+        }
+    }
     pub fn scroll_active_terminal_up(&mut self, client_id: ClientId) {
         if let Some(active_pane) = self.get_active_pane_or_floating_pane_mut(client_id) {
             active_pane.scroll_up(1, client_id);

zellij-server/src/tab/unit/tab_integration_tests.rs

@@ -83,6 +83,9 @@ impl ServerOsApi for FakeInputOutput {
     fn get_cwd(&self, _pid: Pid) -> Option<PathBuf> {
         unimplemented!()
     }
+    fn write_to_file(&self, buf: String, name: Option<String>) {
+        unimplemented!()
+    }
 }
 
 // TODO: move to shared thingy with other test file

zellij-server/src/tab/unit/tab_tests.rs

@@ -81,6 +81,10 @@ impl ServerOsApi for FakeInputOutput {
     fn get_cwd(&self, _pid: Pid) -> Option<PathBuf> {
         unimplemented!()
     }
+
+    fn write_to_file(&self, buf: String, name: Option<String>) {
+        unimplemented!()
+    }
 }
 
 fn create_new_tab(size: Size) -> Tab {

zellij-server/src/unit/screen_tests.rs

@@ -77,6 +77,9 @@ impl ServerOsApi for FakeInputOutput {
     fn get_cwd(&self, _pid: Pid) -> Option<PathBuf> {
         unimplemented!()
     }
+    fn write_to_file(&self, _: std::string::String, _: std::option::Option<std::string::String>) {
+        unimplemented!()
+    }
 }
 
 fn create_new_screen(size: Size) -> Screen {

zellij-utils/src/errors.rs

@@ -240,6 +240,7 @@ pub enum ScreenContext {
     MovePaneRight,
     MovePaneLeft,
     Exit,
+    DumpScreen,
     ScrollUp,
     ScrollUpAt,
     ScrollDown,

zellij-utils/src/input/actions.rs

@@ -54,6 +54,8 @@ pub enum Action {
     /// If there is no pane in the direction, move to previous/next Tab.
     MoveFocusOrTab(Direction),
     MovePane(Option<Direction>),
+    /// Dumps the screen to a file
+    DumpScreen(String),
     /// Scroll up in focus pane.
     ScrollUp,
     /// Scroll up at point