Implementation of scrollback

Cargo.toml

@@ -32,10 +32,12 @@ log = "0.3.8"
 clap = "2"
 fnv = "1"
 unicode-width = "0.1.4"
-arraydeque = "0.2.3"
+arraydeque = "0.2"
 glutin = "0.9.2"
 clippy = { version = "*", optional = true }
 env_logger = "0.4"
+owned_slice = { git = "https://github.com/neon64/owned-slice" }
+num = "0.1.37"
 
 [target.'cfg(any(target_os = "linux", target_os = "freebsd", target_os="dragonfly", target_os="openbsd"))'.dependencies]
 x11-dl = "2"

alacritty.yml

@@ -21,6 +21,11 @@ dimensions:
   columns: 80
   lines: 24
 
+# Scrollback buffer
+scrollback:
+  enabled: true
+  max_lines: 10000
+
 # Adds this many blank pixels of padding around the window
 # Units are physical pixels; this is not DPI aware.
 # (change requires restart)
@@ -261,20 +266,24 @@ live_config_reload: true
 key_bindings:
   - { key: V,        mods: Control|Shift,    action: Paste               }
   - { key: C,        mods: Control|Shift,    action: Copy                }
-  - { key: Q,        mods: Command, action: Quit                         }
-  - { key: W,        mods: Command, action: Quit                         }
-  - { key: Insert,   mods: Shift,   action: PasteSelection               }
-  - { key: Key0,     mods: Control, action: ResetFontSize                }
-  - { key: Equals,   mods: Control, action: IncreaseFontSize             }
-  - { key: Subtract, mods: Control, action: DecreaseFontSize             }
+  - { key: Q,        mods: Command,          action: Quit                }
+  - { key: W,        mods: Command,          action: Quit                }
+  - { key: Insert,   mods: Shift,            action: PasteSelection      }
+  - { key: Key0,     mods: Control,          action: ResetFontSize       }
+  - { key: Equals,   mods: Control,          action: IncreaseFontSize    }
+  - { key: Subtract, mods: Control,          action: DecreaseFontSize    }
+  - { key: Up,       mods: Control|Shift,    action: ScrollUp            }
+  - { key: Down,     mods: Control|Shift,    action: ScrollDown          }
+  - { key: PageUp,   mods: Shift,            action: PageUp              }
+  - { key: PageDown, mods: Shift,            action: PageDown            }
   - { key: Home,                    chars: "\x1bOH",   mode: AppCursor   }
   - { key: Home,                    chars: "\x1b[H",   mode: ~AppCursor  }
   - { key: End,                     chars: "\x1bOF",   mode: AppCursor   }
   - { key: End,                     chars: "\x1b[F",   mode: ~AppCursor  }
   - { key: PageUp,   mods: Shift,   chars: "\x1b[5;2~"                   }
-  - { key: PageUp,   mods: Control, chars: "\x1b[5;5~"                   }
+  #- { key: PageUp,   mods: Control, chars: "\x1b[5;5~"                   }
   - { key: PageUp,                  chars: "\x1b[5~"                     }
-  - { key: PageDown, mods: Shift,   chars: "\x1b[6;2~"                   }
+  #- { key: PageDown, mods: Shift,   chars: "\x1b[6;2~"                   }
   - { key: PageDown, mods: Control, chars: "\x1b[6;5~"                   }
   - { key: PageDown,                chars: "\x1b[6~"                     }
   - { key: Tab,      mods: Shift,   chars: "\x1b[Z"                      }

alacritty_macos.yml

@@ -19,6 +19,11 @@ dimensions:
   columns: 80
   lines: 24
 
+# Scrollback buffer
+scrollback:
+  enabled: true
+  max_lines: 10000
+
 # Adds this many blank pixels of padding around the window
 # Units are physical pixels; this is not DPI aware.
 # (change requires restart)

src/config.rs

@@ -24,7 +24,7 @@ use notify::{Watcher, watcher, DebouncedEvent, RecursiveMode};
 use glutin::ModifiersState;
 
 use input::{Action, Binding, MouseBinding, KeyBinding};
-use index::{Line, Column};
+use index::{AbsoluteLine, Line, Column};
 use ansi::CursorStyle;
 
 use util::fmt::Yellow;
@@ -220,6 +220,10 @@ pub struct Config {
     #[serde(default)]
     dimensions: Dimensions,
 
+    /// Maximum size of the scrollback buffer
+    #[serde(default)]
+    scrollback: Scrollback,
+
     /// Pixel padding
     #[serde(default="default_padding")]
     padding: Delta,
@@ -320,6 +324,7 @@ impl Default for Config {
         Config {
             draw_bold_text_with_bright_colors: true,
             dimensions: Default::default(),
+            scrollback: Default::default(),
             font: Default::default(),
             render_timer: Default::default(),
             custom_cursor_colors: false,
@@ -341,6 +346,25 @@ impl Default for Config {
     }
 }
 
+#[derive(Copy, Clone, Debug, Deserialize)]
+pub struct Scrollback {
+    pub enabled: bool,
+    #[serde(default="default_max_scrollback_lines")]
+    pub max_lines: AbsoluteLine
+}
+
+impl Default for Scrollback {
+    fn default() -> Scrollback {
+        Scrollback {
+            enabled: true,
+            max_lines: default_max_scrollback_lines()
+        }
+    }
+}
+fn default_max_scrollback_lines() -> AbsoluteLine {
+    AbsoluteLine(10000)
+}
+
 /// Newtype for implementing deserialize on glutin Mods
 ///
 /// Our deserialize impl wouldn't be covered by a derive(Deserialize); see the
@@ -406,7 +430,7 @@ impl<'a> de::Deserialize<'a> for ActionWrapper {
             type Value = ActionWrapper;
 
             fn expecting(&self, f: &mut fmt::Formatter) -> fmt::Result {
-                f.write_str("Paste, Copy, PasteSelection, IncreaseFontSize, DecreaseFontSize, ResetFontSize, or Quit")
+                f.write_str("Paste, Copy, PasteSelection, IncreaseFontSize, DecreaseFontSize, ResetFontSize, Quit, ScrollUp, ScrollDown, PageUp or PageDown")
             }
 
             fn visit_str<E>(self, value: &str) -> ::std::result::Result<ActionWrapper, E>
@@ -420,6 +444,10 @@ impl<'a> de::Deserialize<'a> for ActionWrapper {
                     "DecreaseFontSize" => Action::DecreaseFontSize,
                     "ResetFontSize" => Action::ResetFontSize,
                     "Quit" => Action::Quit,
+                    "ScrollUp" => Action::ScrollUp,
+                    "ScrollDown" => Action::ScrollDown,
+                    "PageUp" => Action::PageUp,
+                    "PageDown" => Action::PageDown,
                     _ => return Err(E::invalid_value(Unexpected::Str(value), &self)),
                 }))
             }
@@ -1105,6 +1133,14 @@ impl Config {
         self.background_opacity
     }
 
+    pub fn scrollback(&self) -> Scrollback {
+        self.scrollback
+    }
+
+    pub fn disable_scrollback(&mut self) {
+        self.scrollback.enabled = false;
+    }
+
     pub fn key_bindings(&self) -> &[KeyBinding] {
         &self.key_bindings[..]
     }

src/event.rs

@@ -13,7 +13,7 @@ use copypasta::{Clipboard, Load, Store};
 use config::{self, Config};
 use cli::Options;
 use display::OnResize;
-use index::{Line, Column, Side, Point};
+use index::{Line, AbsoluteLine, Column, Side, Point, AbsolutePoint};
 use input::{self, MouseBinding, KeyBinding};
 use selection::Selection;
 use sync::FairMutex;
@@ -76,7 +76,7 @@ impl<'a, N: Notify + 'a> input::ActionContext for ActionContext<'a, N> {
         self.selection_modified = true;
     }
 
-    fn update_selection(&mut self, point: Point, side: Side) {
+    fn update_selection(&mut self, point: AbsolutePoint, side: Side) {
         self.selection_modified = true;
         // Update selection if one exists
         if let &mut Some(ref mut selection) = self.selection {
@@ -88,17 +88,17 @@ impl<'a, N: Notify + 'a> input::ActionContext for ActionContext<'a, N> {
         self.simple_selection(point, side);
     }
 
-    fn simple_selection(&mut self, point: Point, side: Side) {
+    fn simple_selection(&mut self, point: AbsolutePoint, side: Side) {
         *self.selection = Some(Selection::simple(point, side));
         self.selection_modified = true;
     }
 
-    fn semantic_selection(&mut self, point: Point) {
+    fn semantic_selection(&mut self, point: AbsolutePoint) {
         *self.selection = Some(Selection::semantic(point, self.terminal as &Term));
         self.selection_modified = true;
     }
 
-    fn line_selection(&mut self, point: Point) {
+    fn line_selection(&mut self, point: AbsolutePoint) {
         *self.selection = Some(Selection::lines(point));
         self.selection_modified = true;
     }
@@ -115,6 +115,13 @@ impl<'a, N: Notify + 'a> input::ActionContext for ActionContext<'a, N> {
         self.terminal.reset_font_size();
     }
 
+    fn visible_to_absolute(&self, point: Point) -> AbsolutePoint {
+        AbsolutePoint {
+            line: self.terminal.grid().visible_to_absolute_line(point.line),
+            col: point.col
+        }
+    }
+
     #[inline]
     fn mouse_mut(&mut self) -> &mut Mouse {
         self.mouse
@@ -134,6 +141,20 @@ impl<'a, N: Notify + 'a> input::ActionContext for ActionContext<'a, N> {
     fn last_modifiers(&mut self) -> &mut ModifiersState {
         &mut self.last_modifiers
     }
+
+    fn move_visible_region_up(&mut self, lines: AbsoluteLine) {
+        self.terminal.move_visible_region_up(lines);
+    }
+
+    #[inline]
+    fn move_visible_region_down(&mut self, lines: AbsoluteLine) {
+        self.terminal.move_visible_region_down(lines);
+    }
+
+    #[inline]
+    fn jump_to_bottom(&mut self) {
+        self.terminal.move_visible_region_to_bottom();
+    }
 }
 
 pub enum ClickState {
@@ -151,6 +172,7 @@ pub struct Mouse {
     pub last_click_timestamp: Instant,
     pub click_state: ClickState,
     pub scroll_px: i32,
+    pub scroll_line: f32,
     pub line: Line,
     pub column: Column,
     pub cell_side: Side,
@@ -166,6 +188,7 @@ impl Default for Mouse {
             left_button_state: ElementState::Released,
             click_state: ClickState::None,
             scroll_px: 0,
+            scroll_line: 0.0,
             line: Line(0),
             column: Column(0),
             cell_side: Side::Left,