e8214fb · helix · git.iko.soy

git.iko.soy/helix

on master help sign in

Make gutters padding optional (#2996)

e8214fbIvan Tham4 years ago

book/src/configuration.md+1−1

compare with master

unifiedsplit

@@ -38,7 +38,7 @@ hidden = false

38| `shell` | Shell to use when running external commands. | Unix: `["sh", "-c"]`<br/>Windows: `["cmd", "/C"]` |

39| `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` |

40| `cursorline` | Highlight all lines with a cursor. | `false` |

41−| `gutters` | Gutters to display: Available are `diagnostics` and `line-numbers`, note that `diagnostics` also includes other features like breakpoints | `["diagnostics", "line-numbers"]` |

41+| `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"]` |

42| `auto-completion` | Enable automatic pop up of auto-completion. | `true` |

43| `auto-format` | Enable automatic formatting on save. | `true` |

44| `idle-timeout` | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | `400` |

helix-term/src/ui/editor.rs+1−1

@@ -615,7 +615,7 @@ impl EditorView {

615 // avoid lots of small allocations by reusing a text buffer for each line

616 let mut text = String::with_capacity(8);

617

618− for (constructor, width) in &view.gutters {

618+ for (constructor, width) in view.gutters() {

619 let gutter = constructor(editor, doc, view, theme, is_focused, *width);

620 text.reserve(*width); // ensure there's enough space for the gutter

621 for (i, line) in (view.offset.row..(last_line + 1)).enumerate() {

helix-view/src/editor.rs+7−1

@@ -314,6 +314,8 @@ pub enum GutterType {

314 Diagnostics,

315 /// Show line numbers

316 LineNumbers,

317+ /// Show one blank space

318+ Padding,

317}

319}

318

320

319impl std::str::FromStr for GutterType {

321impl std::str::FromStr for GutterType {

@@ -450,7 +452,11 @@ impl Default for Config {

450 },

452 },

451 line_number: LineNumber::Absolute,

453 line_number: LineNumber::Absolute,

452 cursorline: false,

454 cursorline: false,

455+ gutters: vec![

453− gutters: vec![GutterType::Diagnostics, GutterType::LineNumbers],

456+ GutterType::Diagnostics,

457+ GutterType::LineNumbers,

458+ GutterType::Padding,

459+ ],

454 middle_click_paste: true,

460 middle_click_paste: true,

455 auto_pairs: AutoPairConfig::default(),

461 auto_pairs: AutoPairConfig::default(),

456 auto_completion: true,

462 auto_completion: true,

helix-view/src/gutter.rs+11

@@ -102,6 +102,17 @@ pub fn line_numbers<'doc>(

102 })

103}

104

105+pub fn padding<'doc>(

106+ _editor: &'doc Editor,

107+ _doc: &'doc Document,

108+ _view: &View,

109+ _theme: &Theme,

110+ _is_focused: bool,

111+ _width: usize,

112+) -> GutterFn<'doc> {

113+ Box::new(|_line: usize, _selected: bool, _out: &mut String| None)

114+}

115+

105#[inline(always)]

116#[inline(always)]

106const fn abs_diff(a: usize, b: usize) -> usize {

117const fn abs_diff(a: usize, b: usize) -> usize {

107 if a > b {

118 if a > b {

helix-view/src/view.rs+46−17

@@ -75,7 +75,11 @@ pub struct View {

75 pub last_modified_docs: [Option<DocumentId>; 2],

76 /// used to store previous selections of tree-sitter objects

77 pub object_selections: Vec<Selection>,

78+ /// Gutter (constructor) and width of gutter, used to calculate

79+ /// `gutter_offset`

78− pub gutters: Vec<(Gutter, usize)>,

80+ gutters: Vec<(Gutter, usize)>,

81+ /// cached total width of gutter

82+ gutter_offset: u16,

79}

83}

81impl fmt::Debug for View {

85impl fmt::Debug for View {

@@ -91,12 +95,23 @@ impl fmt::Debug for View {

91impl View {

95impl View {

92 pub fn new(doc: DocumentId, gutter_types: Vec<crate::editor::GutterType>) -> Self {

96 pub fn new(doc: DocumentId, gutter_types: Vec<crate::editor::GutterType>) -> Self {

93 let mut gutters: Vec<(Gutter, usize)> = vec![];

97 let mut gutters: Vec<(Gutter, usize)> = vec![];

98+ let mut gutter_offset = 0;

94 use crate::editor::GutterType;

99 use crate::editor::GutterType;

95 for gutter_type in &gutter_types {

100 for gutter_type in &gutter_types {

96− match gutter_type {

101+ let width = match gutter_type {

102+ GutterType::Diagnostics => 1,

103+ GutterType::LineNumbers => 5,

104+ GutterType::Padding => 1,

105+ };

106+ gutter_offset += width;

107+ gutters.push((

108+ match gutter_type {

97− GutterType::Diagnostics => gutters.push((gutter::diagnostics_or_breakpoints, 1)),

109+ GutterType::Diagnostics => gutter::diagnostics_or_breakpoints,

98− GutterType::LineNumbers => gutters.push((gutter::line_numbers, 5)),

110+ GutterType::LineNumbers => gutter::line_numbers,

111+ GutterType::Padding => gutter::padding,

99− }

112+ },

113+ width as usize,

114+ ));

100 }

115 }

101 Self {

116 Self {

102 id: ViewId::default(),

117 id: ViewId::default(),

@@ -108,6 +123,7 @@ impl View {

108 last_modified_docs: [None, None],

123 last_modified_docs: [None, None],

109 object_selections: Vec::new(),

124 object_selections: Vec::new(),

110 gutters,

125 gutters,

126+ gutter_offset,

111 }

127 }

112 }

128 }

113

129

@@ -119,14 +135,12 @@ impl View {

119 }

135 }

120

136

121 pub fn inner_area(&self) -> Rect {

137 pub fn inner_area(&self) -> Rect {

122− // TODO: cache this

138+ // TODO add abilty to not use cached offset for runtime configurable gutter

123− let offset = self

124− .gutters

125− .iter()

126− .map(|(_, width)| *width as u16)

127− .sum::<u16>()

128− + 1; // +1 for some space between gutters and line

129− self.area.clip_left(offset).clip_bottom(1) // -1 for statusline

139+ self.area.clip_left(self.gutter_offset).clip_bottom(1) // -1 for statusline

140+ }

141+

142+ pub fn gutters(&self) -> &[(Gutter, usize)] {

143+ &self.gutters

130 }

144 }

131

145

132 //

146 //

@@ -327,7 +341,11 @@ mod tests {

327 fn test_text_pos_at_screen_coords() {

341 fn test_text_pos_at_screen_coords() {

328 let mut view = View::new(

342 let mut view = View::new(

329 DocumentId::default(),

343 DocumentId::default(),

344+ vec![

330− vec![GutterType::Diagnostics, GutterType::LineNumbers],

345+ GutterType::Diagnostics,

346+ GutterType::LineNumbers,

347+ GutterType::Padding,

348+ ],

331 );

349 );

332 view.area = Rect::new(40, 40, 40, 40);

350 view.area = Rect::new(40, 40, 40, 40);

333 let rope = Rope::from_str("abc\n\tdef");

351 let rope = Rope::from_str("abc\n\tdef");

@@ -374,7 +392,10 @@ mod tests {

374

392

375 #[test]

393 #[test]

376 fn test_text_pos_at_screen_coords_without_line_numbers_gutter() {

394 fn test_text_pos_at_screen_coords_without_line_numbers_gutter() {

395+ let mut view = View::new(

396+ DocumentId::default(),

377− let mut view = View::new(DocumentId::default(), vec![GutterType::Diagnostics]);

397+ vec![GutterType::Diagnostics, GutterType::Padding],

398+ );

378 view.area = Rect::new(40, 40, 40, 40);

399 view.area = Rect::new(40, 40, 40, 40);

379 let rope = Rope::from_str("abc\n\tdef");

400 let rope = Rope::from_str("abc\n\tdef");

380 let text = rope.slice(..);

401 let text = rope.slice(..);

@@ -400,7 +421,11 @@ mod tests {

400 fn test_text_pos_at_screen_coords_cjk() {

421 fn test_text_pos_at_screen_coords_cjk() {

401 let mut view = View::new(

422 let mut view = View::new(

402 DocumentId::default(),

423 DocumentId::default(),

424+ vec![

403− vec![GutterType::Diagnostics, GutterType::LineNumbers],

425+ GutterType::Diagnostics,

426+ GutterType::LineNumbers,

427+ GutterType::Padding,

428+ ],

404 );

429 );

405 view.area = Rect::new(40, 40, 40, 40);

430 view.area = Rect::new(40, 40, 40, 40);

406 let rope = Rope::from_str("Hi! こんにちは皆さん");

431 let rope = Rope::from_str("Hi! こんにちは皆さん");

@@ -440,7 +465,11 @@ mod tests {

440 fn test_text_pos_at_screen_coords_graphemes() {

465 fn test_text_pos_at_screen_coords_graphemes() {

441 let mut view = View::new(

466 let mut view = View::new(

442 DocumentId::default(),

467 DocumentId::default(),

468+ vec![

443− vec![GutterType::Diagnostics, GutterType::LineNumbers],

469+ GutterType::Diagnostics,

470+ GutterType::LineNumbers,

471+ GutterType::Padding,

472+ ],

444 );

473 );

445 view.area = Rect::new(40, 40, 40, 40);

474 view.area = Rect::new(40, 40, 40, 40);

446 let rope = Rope::from_str("Hèl̀l̀ò world!");

475 let rope = Rope::from_str("Hèl̀l̀ò world!");