Make gutters padding automatic

Remove padding gutter type, and automatically add 1 padding if gutters is non-empty. Fix #3111
helix-editor · Jul 23, 2022 · c155990 · c155990
1 parent 1b3a10d
commit c155990
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 40 deletions.
diff --git a/book/src/configuration.md b/book/src/configuration.md
@@ -38,7 +38,7 @@ hidden = false
 | `shell` | Shell to use when running external commands. | Unix: `["sh", "-c"]`<br/>Windows: `["cmd", "/C"]` |
 | `line-number` | Line number display: `absolute` simply shows each line's number, while `relative` shows the distance from the current line. When unfocused or in insert mode, `relative` will still show absolute line numbers. | `absolute` |
 | `cursorline` | Highlight all lines with a cursor. | `false` |
-| `gutters` | Gutters to display: Available are `diagnostics` and `line-numbers` and `padding`, note that `diagnostics` also includes other features like breakpoints | `["diagnostics", "line-numbers", "padding"]` |
+| `gutters` | Gutters to display: Available are `diagnostics` and `line-numbers`, note that `diagnostics` also includes other features like breakpoints | `["diagnostics", "line-numbers"]` |
 | `auto-completion` | Enable automatic pop up of auto-completion. | `true` |
 | `auto-format` | Enable automatic formatting on save. | `true` |
 | `idle-timeout` | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | `400` |

diff --git a/helix-view/src/editor.rs b/helix-view/src/editor.rs
@@ -332,8 +332,6 @@ pub enum GutterType {
     Diagnostics,
     /// Show line numbers
     LineNumbers,
-    /// Show one blank space
-    Padding,
 }
 
 impl std::str::FromStr for GutterType {
@@ -470,11 +468,7 @@ impl Default for Config {
             },
             line_number: LineNumber::Absolute,
             cursorline: false,
-            gutters: vec![
-                GutterType::Diagnostics,
-                GutterType::LineNumbers,
-                GutterType::Padding,
-            ],
+            gutters: vec![GutterType::Diagnostics, GutterType::LineNumbers],
             middle_click_paste: true,
             auto_pairs: AutoPairConfig::default(),
             auto_completion: true,

diff --git a/helix-view/src/gutter.rs b/helix-view/src/gutter.rs
@@ -102,17 +102,6 @@ pub fn line_numbers<'doc>(
     })
 }
 
-pub fn padding<'doc>(
-    _editor: &'doc Editor,
-    _doc: &'doc Document,
-    _view: &View,
-    _theme: &Theme,
-    _is_focused: bool,
-    _width: usize,
-) -> GutterFn<'doc> {
-    Box::new(|_line: usize, _selected: bool, _out: &mut String| None)
-}
-
 #[inline(always)]
 const fn abs_diff(a: usize, b: usize) -> usize {
     if a > b {

diff --git a/helix-view/src/view.rs b/helix-view/src/view.rs
@@ -106,18 +106,19 @@ impl View {
             let width = match gutter_type {
                 GutterType::Diagnostics => 1,
                 GutterType::LineNumbers => 5,
-                GutterType::Padding => 1,
             };
             gutter_offset += width;
             gutters.push((
                 match gutter_type {
                     GutterType::Diagnostics => gutter::diagnostics_or_breakpoints,
                     GutterType::LineNumbers => gutter::line_numbers,
-                    GutterType::Padding => gutter::padding,
                 },
                 width as usize,
             ));
         }
+        if !gutter_types.is_empty() {
+            gutter_offset += 1;
+        }
         Self {
             id: ViewId::default(),
             doc,
@@ -346,11 +347,7 @@ mod tests {
     fn test_text_pos_at_screen_coords() {
         let mut view = View::new(
             DocumentId::default(),
-            vec![
-                GutterType::Diagnostics,
-                GutterType::LineNumbers,
-                GutterType::Padding,
-            ],
+            vec![GutterType::Diagnostics, GutterType::LineNumbers],
         );
         view.area = Rect::new(40, 40, 40, 40);
         let rope = Rope::from_str("abc\n\tdef");
@@ -397,10 +394,7 @@ mod tests {
 
     #[test]
     fn test_text_pos_at_screen_coords_without_line_numbers_gutter() {
-        let mut view = View::new(
-            DocumentId::default(),
-            vec![GutterType::Diagnostics, GutterType::Padding],
-        );
+        let mut view = View::new(DocumentId::default(), vec![GutterType::Diagnostics]);
         view.area = Rect::new(40, 40, 40, 40);
         let rope = Rope::from_str("abc\n\tdef");
         let text = rope.slice(..);
@@ -426,11 +420,7 @@ mod tests {
     fn test_text_pos_at_screen_coords_cjk() {
         let mut view = View::new(
             DocumentId::default(),
-            vec![
-                GutterType::Diagnostics,
-                GutterType::LineNumbers,
-                GutterType::Padding,
-            ],
+            vec![GutterType::Diagnostics, GutterType::LineNumbers],
         );
         view.area = Rect::new(40, 40, 40, 40);
         let rope = Rope::from_str("Hi! こんにちは皆さん");
@@ -470,11 +460,7 @@ mod tests {
     fn test_text_pos_at_screen_coords_graphemes() {
         let mut view = View::new(
             DocumentId::default(),
-            vec![
-                GutterType::Diagnostics,
-                GutterType::LineNumbers,
-                GutterType::Padding,
-            ],
+            vec![GutterType::Diagnostics, GutterType::LineNumbers],
         );
         view.area = Rect::new(40, 40, 40, 40);
         let rope = Rope::from_str("Hèl̀l̀ò world!");