From 38d8e2238d05cf3fa693ff3b8c63cd5c248c0a26 Mon Sep 17 00:00:00 2001
From: Aram Drevekenin <aram@poor.dev>
Date: Tue, 15 Dec 2020 12:58:58 +0100
Subject: [PATCH] fix(compatibility): handle tab characters properly (#99)

* fix(compatibility): handle tab characters properly

* style(formatting): make rustfmt happy
---
 src/terminal_pane/terminal_pane.rs            |   9 +++++
 src/tests/fixtures/tab_characters             | Bin 0 -> 633 bytes
 src/tests/integration/compatibility.rs        |  23 +++++++++++++
 ...ty__display_tab_characters_properly-2.snap |  32 ++++++++++++++++++
 ...lity__display_tab_characters_properly.snap |  32 ++++++++++++++++++
 5 files changed, 96 insertions(+)
 create mode 100644 src/tests/fixtures/tab_characters
 create mode 100644 src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly-2.snap
 create mode 100644 src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly.snap

diff --git a/src/terminal_pane/terminal_pane.rs b/src/terminal_pane/terminal_pane.rs
index 6754974c..0901b8c9 100644
--- a/src/terminal_pane/terminal_pane.rs
+++ b/src/terminal_pane/terminal_pane.rs
@@ -368,6 +368,15 @@ impl vte::Perform for TerminalPane {
                 // backspace
                 self.move_cursor_backwards(1);
             }
+            9 => {
+                // tab
+                let terminal_tab_character = TerminalCharacter {
+                    character: '\t',
+                    styles: self.pending_styles,
+                };
+                // TODO: handle better with line wrapping
+                self.scroll.add_character(terminal_tab_character);
+            }
             10 => {
                 // 0a, newline
                 self.add_newline();
diff --git a/src/tests/fixtures/tab_characters b/src/tests/fixtures/tab_characters
new file mode 100644
index 0000000000000000000000000000000000000000..cf40aac5d9c6757fe9f5546fae72df798c398299
GIT binary patch
literal 633
zcmcIiy>8nu5Y`sRfS!QMEdg905&vX4R)zva0XInE4237cgJ97X;hrdn64Ig1(7t1z
zB<ILZvUVs3l6UvreMf%BHsW^YLJhq3Xn9*URmnTs`oPhL(rqu8(E{1@3p2=!!oPoh
zj|Tjgl~8?1n7NOVNd(MDeEMF{DQ>mGS-ME2zAn3MEw3dkS8M*@n&Bsf@eE(Ly+iw!
zA_dfb=)x6b3Xs6P4I})u_%|Q=ru=|ExMp8@dg-y^E99#S2N*)Rx5elsrfOFJ?}mmC
z!FF5<A$aAt1w6I3D|_b~XnYT3pzC{EQAW&Tt>h9o%w)C%$n(o&5_7wAF{t??`C*Yi
z0;n7EpO{y+fA-zsoi-*da_UXb@cBopf&l6;JIa!wT&Ps$H>pT<G8r2kb&8nztc1ww
zi2a+^^2ju&EmLUjHYe4YSqL;r6k@(1cAeqdmr;Ov)f&gip{qieV(FSsN2J7GaGs<4
F=mpx!pW*-j

literal 0
HcmV?d00001

diff --git a/src/tests/integration/compatibility.rs b/src/tests/integration/compatibility.rs
index 1df46583..6fbf99e9 100644
--- a/src/tests/integration/compatibility.rs
+++ b/src/tests/integration/compatibility.rs
@@ -317,3 +317,26 @@ pub fn clear_scroll_region() {
         assert_snapshot!(snapshot);
     }
 }
+
+#[test]
+pub fn display_tab_characters_properly() {
+    let fake_win_size = PositionAndSize {
+        columns: 116,
+        rows: 28,
+        x: 0,
+        y: 0,
+    };
+    let fixture_name = "tab_characters";
+    let mut fake_input_output = get_fake_os_input(&fake_win_size, fixture_name);
+    fake_input_output.add_terminal_input(&[&COMMAND_TOGGLE, &COMMAND_TOGGLE, &QUIT]);
+    start(Box::new(fake_input_output.clone()), Opt::default());
+    let output_frames = fake_input_output
+        .stdout_writer
+        .output_frames
+        .lock()
+        .unwrap();
+    let snapshots = get_output_frame_snapshots(&output_frames, &fake_win_size);
+    for snapshot in snapshots {
+        assert_snapshot!(snapshot);
+    }
+}
diff --git a/src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly-2.snap b/src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly-2.snap
new file mode 100644
index 00000000..ce9f3423
--- /dev/null
+++ b/src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly-2.snap
@@ -0,0 +1,32 @@
+---
+source: src/tests/integration/compatibility.rs
+expression: snapshot
+---
+ OS: 5.9.13-arch1-1 GNU/Linux                                                                                       
+ Uptime: 10 hours, 42 minutes                                                                                       
+ Hostname: kingdom                                                                                                  
+ Disk usage:                                                                                                        
+                                                                                                                    
+df: /run/user/1000/doc: Operation not permitted                                                                     
+	/	321G / 514G  66%                                                                                                 
+	/efi	 27M /  96M  28%                                                                                              
+                                                                                                                    
+ Network:                                                                                                           
+                                                                                                                    
+	wlp2s0  192.168.0.3                                                                                                
+                                                                                                                    
+[I] [20:07] kingdom:mosaic (main) |                                                                                 
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+Bye from Mosaic!█                                                                                                   
diff --git a/src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly.snap b/src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly.snap
new file mode 100644
index 00000000..ec9cd4cd
--- /dev/null
+++ b/src/tests/integration/snapshots/mosaic__tests__integration__compatibility__display_tab_characters_properly.snap
@@ -0,0 +1,32 @@
+---
+source: src/tests/integration/compatibility.rs
+expression: snapshot
+---
+                                                                                                                    
+ OS: 5.9.13-arch1-1 GNU/Linux                                                                                       
+ Uptime: 10 hours, 42 minutes                                                                                       
+ Hostname: kingdom                                                                                                  
+ Disk usage:                                                                                                        
+                                                                                                                    
+df: /run/user/1000/doc: Operation not permitted                                                                     
+	/	321G / 514G  66%                                                                                                 
+	/efi	 27M /  96M  28%                                                                                              
+                                                                                                                    
+ Network:                                                                                                           
+                                                                                                                    
+	wlp2s0  192.168.0.3                                                                                                
+                                                                                                                    
+[I] [20:07] kingdom:mosaic (main) | █                                                                               
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+                                                                                                                    
+