on master help sign in
Make gutters configurable (#1967)

* config option line numbers none * view tests * added tests * doc * comment * Make gutters configurable * docu * docu * rm none docu * order * order * precedence * simpler * rm todo * fixed clippy * order * double quotes * only allow diagnostics and line-numbers * tests * docu * format * rm short variant and more docu * performance improvements * typo * rename

commitb04c425c63d03f8320eb47ab6e38e4bb79763248 authorDr. David A. Kunz <david.kunz@sap.com> dateSat 16 Apr 2022, 03:41 (5 years ago) parent450f348
6 files changed+110−25
book/src/configuration.md+1 helix-term/src/ui/editor.rs+1−1 helix-view/src/editor.rs+26−2 helix-view/src/gutter.rs+1−1 helix-view/src/tree.rs+17−4 helix-view/src/view.rs+64−17
book/src/configuration.md+1
@@ -37,6 +37,7 @@ hidden = false
3737| `scroll-lines` | Number of lines to scroll per scroll wheel step. | `3` |
3838| `shell` | Shell to use when running external commands. | Unix: `["sh", "-c"]`<br/>Windows: `["cmd", "/C"]` |
3939| `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+| `gutters` | Gutters to display: Available are `diagnostics` and `line-numbers`, note that `diagnostics` also includes other features like breakpoints | `["diagnostics", "line-numbers"]` |
4041| `auto-completion` | Enable automatic pop up of auto-completion. | `true` |
4142| `idle-timeout` | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | `400` |
4243| `completion-trigger-len` | The min-length of word under cursor to trigger autocompletion | `2` |
helix-term/src/ui/editor.rs+1−1
@@ -466,7 +466,7 @@ impl EditorView {
466466 // avoid lots of small allocations by reusing a text buffer for each line
467467 let mut text = String::with_capacity(8);
468468
469− for (constructor, width) in view.gutters() {
469+ for (constructor, width) in &view.gutters {
470470 let gutter = constructor(editor, doc, view, theme, is_focused, *width);
471471 text.reserve(*width); // ensure there's enough space for the gutter
472472 for (i, line) in (view.offset.row..(last_line + 1)).enumerate() {
helix-view/src/editor.rs+26−2
@@ -117,6 +117,8 @@ pub struct Config {
117117 pub shell: Vec<String>,
118118 /// Line number mode.
119119 pub line_number: LineNumber,
120+ /// Gutters. Default ["diagnostics", "line-numbers"]
121+ pub gutters: Vec<GutterType>,
120122 /// Middle click paste support. Defaults to true.
121123 pub middle_click_paste: bool,
122124 /// Automatic insertion of pairs to parentheses, brackets,
@@ -238,6 +240,27 @@ impl std::str::FromStr for LineNumber {
238240 }
239241}
240242
243+#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize)]
244+#[serde(rename_all = "kebab-case")]
245+pub enum GutterType {
246+ /// Show diagnostics and other features like breakpoints
247+ Diagnostics,
248+ /// Show line numbers
249+ LineNumbers,
250+}
251+
252+impl std::str::FromStr for GutterType {
253+ type Err = anyhow::Error;
254+
255+ fn from_str(s: &str) -> Result<Self, Self::Err> {
256+ match s.to_lowercase().as_str() {
257+ "diagnostics" => Ok(Self::Diagnostics),
258+ "line-numbers" => Ok(Self::LineNumbers),
259+ _ => anyhow::bail!("Gutter type can only be `diagnostics` or `line-numbers`."),
260+ }
261+ }
262+}
263+
241264impl Default for Config {
242265 fn default() -> Self {
243266 Self {
@@ -250,6 +273,7 @@ impl Default for Config {
250273 vec!["sh".to_owned(), "-c".to_owned()]
251274 },
252275 line_number: LineNumber::Absolute,
276+ gutters: vec![GutterType::Diagnostics, GutterType::LineNumbers],
253277 middle_click_paste: true,
254278 auto_pairs: AutoPairConfig::default(),
255279 auto_completion: true,
@@ -579,7 +603,7 @@ impl Editor {
579603 return;
580604 }
581605 Action::HorizontalSplit | Action::VerticalSplit => {
582− let view = View::new(id);
606+ let view = View::new(id, self.config().gutters.clone());
583607 let view_id = self.tree.split(
584608 view,
585609 match action {
@@ -701,7 +725,7 @@ impl Editor {
701725 .map(|(&doc_id, _)| doc_id)
702726 .next()
703727 .unwrap_or_else(|| self.new_document(Document::default()));
704− let view = View::new(doc_id);
728+ let view = View::new(doc_id, self.config().gutters.clone());
705729 let view_id = self.tree.insert(view);
706730 let doc = self.documents.get_mut(&doc_id).unwrap();
707731 doc.selections.insert(view_id, Selection::point(0));
helix-view/src/gutter.rs+1−1
@@ -39,7 +39,7 @@ pub fn diagnostic<'doc>(
3939 })
4040}
4141
42−pub fn line_number<'doc>(
42+pub fn line_numbers<'doc>(
4343 editor: &'doc Editor,
4444 doc: &'doc Document,
4545 view: &View,
helix-view/src/tree.rs+17−4
@@ -568,6 +568,7 @@ impl<'a> Iterator for Traverse<'a> {
568568#[cfg(test)]
569569mod test {
570570 use super::*;
571+ use crate::editor::GutterType;
571572 use crate::DocumentId;
572573
573574 #[test]
@@ -578,22 +579,34 @@ mod test {
578579 width: 180,
579580 height: 80,
580581 });
581− let mut view = View::new(DocumentId::default());
582+ let mut view = View::new(
583+ DocumentId::default(),
584+ vec![GutterType::Diagnostics, GutterType::LineNumbers],
585+ );
582586 view.area = Rect::new(0, 0, 180, 80);
583587 tree.insert(view);
584588
585589 let l0 = tree.focus;
586− let view = View::new(DocumentId::default());
590+ let view = View::new(
591+ DocumentId::default(),
592+ vec![GutterType::Diagnostics, GutterType::LineNumbers],
593+ );
587594 tree.split(view, Layout::Vertical);
588595 let r0 = tree.focus;
589596
590597 tree.focus = l0;
591− let view = View::new(DocumentId::default());
598+ let view = View::new(
599+ DocumentId::default(),
600+ vec![GutterType::Diagnostics, GutterType::LineNumbers],
601+ );
592602 tree.split(view, Layout::Horizontal);
593603 let l1 = tree.focus;
594604
595605 tree.focus = l0;
596− let view = View::new(DocumentId::default());
606+ let view = View::new(
607+ DocumentId::default(),
608+ vec![GutterType::Diagnostics, GutterType::LineNumbers],
609+ );
597610 tree.split(view, Layout::Vertical);
598611 let l2 = tree.focus;
599612
helix-view/src/view.rs+64−17
@@ -11,6 +11,8 @@ use helix_core::{
1111 visual_coords_at_pos, Position, RopeSlice, Selection,
1212};
1313
14+use std::fmt;
15+
1416type Jump = (DocumentId, Selection);
1517
1618#[derive(Debug, Clone)]
@@ -64,17 +66,11 @@ impl JumpList {
6466 }
6567}
6668
67−const GUTTERS: &[(Gutter, usize)] = &[
68− (gutter::diagnostics_or_breakpoints, 1),
69− (gutter::line_number, 5),
70−];
71−
72−#[derive(Debug)]
7369pub struct View {
7470 pub id: ViewId,
75− pub doc: DocumentId,
7671 pub offset: Position,
7772 pub area: Rect,
73+ pub doc: DocumentId,
7874 pub jumps: JumpList,
7975 /// the last accessed file before the current one
8076 pub last_accessed_doc: Option<DocumentId>,
@@ -85,10 +81,29 @@ pub struct View {
8581 pub last_modified_docs: [Option<DocumentId>; 2],
8682 /// used to store previous selections of tree-sitter objecs
8783 pub object_selections: Vec<Selection>,
84+ pub gutters: Vec<(Gutter, usize)>,
85+}
86+
87+impl fmt::Debug for View {
88+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
89+ f.debug_struct("View")
90+ .field("id", &self.id)
91+ .field("area", &self.area)
92+ .field("doc", &self.doc)
93+ .finish()
94+ }
8895}
8996
9097impl View {
91− pub fn new(doc: DocumentId) -> Self {
98+ pub fn new(doc: DocumentId, gutter_types: Vec<crate::editor::GutterType>) -> Self {
99+ let mut gutters: Vec<(Gutter, usize)> = vec![];
100+ use crate::editor::GutterType;
101+ for gutter_type in &gutter_types {
102+ match gutter_type {
103+ GutterType::Diagnostics => gutters.push((gutter::diagnostics_or_breakpoints, 1)),
104+ GutterType::LineNumbers => gutters.push((gutter::line_numbers, 5)),
105+ }
106+ }
92107 Self {
93108 id: ViewId::default(),
94109 doc,
@@ -98,17 +113,14 @@ impl View {
98113 last_accessed_doc: None,
99114 last_modified_docs: [None, None],
100115 object_selections: Vec::new(),
116+ gutters,
101117 }
102118 }
103119
104− pub fn gutters(&self) -> &[(Gutter, usize)] {
105− GUTTERS
106− }
107−
108120 pub fn inner_area(&self) -> Rect {
109121 // TODO: cache this
110122 let offset = self
111− .gutters()
123+ .gutters
112124 .iter()
113125 .map(|(_, width)| *width as u16)
114126 .sum::<u16>()
@@ -324,11 +336,16 @@ mod tests {
324336 use super::*;
325337 use helix_core::Rope;
326338 const OFFSET: u16 = 7; // 1 diagnostic + 5 linenr + 1 gutter
327− // const OFFSET: u16 = GUTTERS.iter().map(|(_, width)| *width as u16).sum();
339+ const OFFSET_WITHOUT_LINE_NUMBERS: u16 = 2; // 1 diagnostic + 1 gutter
340+ // const OFFSET: u16 = GUTTERS.iter().map(|(_, width)| *width as u16).sum();
341+ use crate::editor::GutterType;
328342
329343 #[test]
330344 fn test_text_pos_at_screen_coords() {
331− let mut view = View::new(DocumentId::default());
345+ let mut view = View::new(
346+ DocumentId::default(),
347+ vec![GutterType::Diagnostics, GutterType::LineNumbers],
348+ );
332349 view.area = Rect::new(40, 40, 40, 40);
333350 let rope = Rope::from_str("abc\n\tdef");
334351 let text = rope.slice(..);
@@ -372,9 +389,36 @@ mod tests {
372389 assert_eq!(view.text_pos_at_screen_coords(&text, 41, 80, 4), Some(8));
373390 }
374391
392+ #[test]
393+ fn test_text_pos_at_screen_coords_without_line_numbers_gutter() {
394+ let mut view = View::new(DocumentId::default(), vec![GutterType::Diagnostics]);
395+ view.area = Rect::new(40, 40, 40, 40);
396+ let rope = Rope::from_str("abc\n\tdef");
397+ let text = rope.slice(..);
398+ assert_eq!(
399+ view.text_pos_at_screen_coords(&text, 41, 40 + OFFSET_WITHOUT_LINE_NUMBERS + 1, 4),
400+ Some(4)
401+ );
402+ }
403+
404+ #[test]
405+ fn test_text_pos_at_screen_coords_without_any_gutters() {
406+ let mut view = View::new(DocumentId::default(), vec![]);
407+ view.area = Rect::new(40, 40, 40, 40);
408+ let rope = Rope::from_str("abc\n\tdef");
409+ let text = rope.slice(..);
410+ assert_eq!(
411+ view.text_pos_at_screen_coords(&text, 41, 40 + 1, 4),
412+ Some(4)
413+ );
414+ }
415+
375416 #[test]
376417 fn test_text_pos_at_screen_coords_cjk() {
377− let mut view = View::new(DocumentId::default());
418+ let mut view = View::new(
419+ DocumentId::default(),
420+ vec![GutterType::Diagnostics, GutterType::LineNumbers],
421+ );
378422 view.area = Rect::new(40, 40, 40, 40);
379423 let rope = Rope::from_str("Hi! こんにちは皆さん");
380424 let text = rope.slice(..);
@@ -411,7 +455,10 @@ mod tests {
411455
412456 #[test]
413457 fn test_text_pos_at_screen_coords_graphemes() {
414− let mut view = View::new(DocumentId::default());
458+ let mut view = View::new(
459+ DocumentId::default(),
460+ vec![GutterType::Diagnostics, GutterType::LineNumbers],
461+ );
415462 view.area = Rect::new(40, 40, 40, 40);
416463 let rope = Rope::from_str("Hèl̀l̀ò world!");
417464 let text = rope.slice(..);