Add config option "soft-wrap.indicator-on-gutter"

Author: goll72

helix-core/src/doc_formatter.rs

@@ -149,7 +149,9 @@ pub struct TextFormat {
     pub max_wrap: u16,
     pub max_indent_retain: u16,
     pub wrap_indicator: Box<str>,
+    pub wrap_indicator_width: u16,
     pub wrap_indicator_highlight: Option<Highlight>,
+    pub wrap_indicator_on_gutter: bool,
     pub viewport_width: u16,
     pub soft_wrap_at_text_width: bool,
 }
@@ -163,6 +165,8 @@ impl Default for TextFormat {
             max_wrap: 3,
             max_indent_retain: 4,
             wrap_indicator: Box::from(" "),
+            wrap_indicator_width: 1,
+            wrap_indicator_on_gutter: false,
             viewport_width: 17,
             wrap_indicator_highlight: None,
             soft_wrap_at_text_width: false,
@@ -313,21 +317,24 @@ impl<'t> DocumentFormatter<'t> {
         self.visual_pos.row += 1 + virtual_lines;
         let mut i = 0;
         let mut word_width = 0;
-        let wrap_indicator = UnicodeSegmentation::graphemes(&*self.text_fmt.wrap_indicator, true)
-            .map(|g| {
-                i += 1;
-                let grapheme = GraphemeWithSource::new(
-                    g.into(),
-                    self.visual_pos.col + word_width,
-                    self.text_fmt.tab_width,
-                    GraphemeSource::VirtualText {
-                        highlight: self.text_fmt.wrap_indicator_highlight,
-                    },
-                );
-                word_width += grapheme.width();
-                grapheme
-            });
-        self.word_buf.splice(0..0, wrap_indicator);
+
+        if !self.text_fmt.wrap_indicator_on_gutter {
+            let wrap_indicator =
+                UnicodeSegmentation::graphemes(&*self.text_fmt.wrap_indicator, true).map(|g| {
+                    i += 1;
+                    let grapheme = GraphemeWithSource::new(
+                        g.into(),
+                        self.visual_pos.col + word_width,
+                        self.text_fmt.tab_width,
+                        GraphemeSource::VirtualText {
+                            highlight: self.text_fmt.wrap_indicator_highlight,
+                        },
+                    );
+                    word_width += grapheme.width();
+                    grapheme
+                });
+            self.word_buf.splice(0..0, wrap_indicator);
+        }
 
         for grapheme in &mut self.word_buf[i..] {
             let visual_x = self.visual_pos.col + word_width;

helix-core/src/doc_formatter/test.rs

@@ -9,6 +9,8 @@ impl TextFormat {
             max_wrap: 3,
             max_indent_retain: 4,
             wrap_indicator: ".".into(),
+            wrap_indicator_width: 1,
+            wrap_indicator_on_gutter: false,
             wrap_indicator_highlight: None,
             // use a prime number to allow lining up too often with repeat
             viewport_width: 17,

helix-core/src/syntax/config.rs

@@ -576,6 +576,8 @@ pub struct SoftWrap {
     ///
     /// Defaults to ↪
     pub wrap_indicator: Option<String>,
+    /// Show the indicator on the `line-numbers` gutter instead of as part of the document
+    pub indicator_on_gutter: Option<bool>,
     /// Softwrap at `text_width` instead of viewport width if it is shorter
     pub wrap_at_text_width: Option<bool>,
 }

helix-term/src/ui/editor.rs

@@ -647,9 +647,9 @@ impl EditorView {
     pub fn render_gutter<'d>(
         editor: &'d Editor,
         doc: &'d Document,
-        view: &View,
+        view: &'d View,
         viewport: Rect,
-        theme: &Theme,
+        theme: &'d Theme,
         is_focused: bool,
         decoration_manager: &mut DecorationManager<'d>,
     ) {
@@ -674,7 +674,6 @@ impl EditorView {
             let mut text = String::with_capacity(width);
             let cursors = cursors.clone();
             let gutter_decoration = move |renderer: &mut TextRenderer, pos: LinePos| {
-                // TODO handle softwrap in gutters
                 let selected = cursors.contains(&pos.doc_line);
                 let x = viewport.x + offset;
                 let y = pos.visual_line;

helix-view/src/annotations/diagnostics.rs

@@ -99,6 +99,8 @@ impl InlineDiagnosticsConfig {
             max_wrap: self.max_wrap.min(width / 4),
             max_indent_retain: 0,
             wrap_indicator: "".into(),
+            wrap_indicator_width: 0,
+            wrap_indicator_on_gutter: false,
             wrap_indicator_highlight: None,
             viewport_width: width,
             soft_wrap_at_text_width: true,

helix-view/src/document.rs

@@ -12,6 +12,7 @@ use helix_core::encoding::Encoding;
 use helix_core::snippets::{ActiveSnippet, SnippetRenderCtx};
 use helix_core::syntax::config::LanguageServerFeature;
 use helix_core::text_annotations::{InlineAnnotation, Overlay};
+use helix_core::unicode::segmentation::UnicodeSegmentation;
 use helix_event::TaskController;
 use helix_lsp::util::lsp_pos_to_pos;
 use helix_stdx::faccess::{copy_metadata, readonly};
@@ -2258,11 +2259,25 @@ impl Document {
             .and_then(|soft_wrap| soft_wrap.max_indent_retain)
             .or(editor_soft_wrap.max_indent_retain)
             .unwrap_or(40);
+        let wrap_indicator_on_gutter = language_soft_wrap
+            .and_then(|soft_wrap| soft_wrap.indicator_on_gutter)
+            .or(config.soft_wrap.indicator_on_gutter)
+            .unwrap_or(false);
         let wrap_indicator = language_soft_wrap
-            .and_then(|soft_wrap| soft_wrap.wrap_indicator.clone())
-            .or_else(|| config.soft_wrap.wrap_indicator.clone())
-            .unwrap_or_else(|| "↪ ".into());
+            .and_then(|soft_wrap| soft_wrap.wrap_indicator.as_deref())
+            .or_else(|| config.soft_wrap.wrap_indicator.as_deref())
+            .unwrap_or_else(|| "↪ ");
+
         let tab_width = self.tab_width() as u16;
+
+        let wrap_indicator = if wrap_indicator_on_gutter {
+            wrap_indicator.trim_end_matches(" ")
+        } else {
+            &wrap_indicator
+        };
+        let wrap_indicator_width =
+            UnicodeSegmentation::graphemes(wrap_indicator, true).count() as u16;
+
         TextFormat {
             soft_wrap: enable_soft_wrap && viewport_width > 10,
             tab_width,
@@ -2271,7 +2286,9 @@ impl Document {
             // avoid spinning forever when the window manager
             // sets the size to something tiny
             viewport_width,
-            wrap_indicator: wrap_indicator.into_boxed_str(),
+            wrap_indicator: wrap_indicator.into(),
+            wrap_indicator_width,
+            wrap_indicator_on_gutter,
             wrap_indicator_highlight: theme
                 .and_then(|theme| theme.find_highlight("ui.virtual.wrap")),
             soft_wrap_at_text_width,

helix-view/src/gutter.rs

@@ -21,8 +21,8 @@ impl GutterType {
         self,
         editor: &'doc Editor,
         doc: &'doc Document,
-        view: &View,
-        theme: &Theme,
+        view: &'doc View,
+        theme: &'doc Theme,
         is_focused: bool,
     ) -> GutterFn<'doc> {
         match self {
@@ -142,8 +142,8 @@ pub fn diff<'doc>(
 pub fn line_numbers<'doc>(
     editor: &'doc Editor,
     doc: &'doc Document,
-    view: &View,
-    theme: &Theme,
+    view: &'doc View,
+    theme: &'doc Theme,
     is_focused: bool,
 ) -> GutterFn<'doc> {
     let text = doc.text().slice(..);
@@ -190,13 +190,25 @@ pub fn line_numbers<'doc>(
                     linenr
                 };
 
+                let text_fmt = doc.text_format(view.inner_width(doc), Some(theme));
+
+                // TODO: the output would look weird if wrap indicator on gutter is enabled,
+                // a long wrap indicator is used and there are no lines being wrapped
+                let width = if text_fmt.wrap_indicator_on_gutter {
+                    width.max(text_fmt.wrap_indicator_width.into())
+                } else {
+                    width
+                };
+
                 if first_visual_line {
                     write!(out, "{:>1$}", display_num, width).unwrap();
+                } else if text_fmt.wrap_indicator_on_gutter {
+                    write!(out, "{:>1$}", text_fmt.wrap_indicator, width).unwrap();
                 } else {
                     write!(out, "{:>1$}", " ", width).unwrap();
                 }
 
-                first_visual_line.then_some(style)
+                Some(style)
             }
         },
     )
@@ -205,8 +217,11 @@ pub fn line_numbers<'doc>(
 /// The width of a "line-numbers" gutter
 ///
 /// The width of the gutter depends on the number of lines in the document,
-/// whether there is content on the last line (the `~` line), and the
-/// `editor.gutters.line-numbers.min-width` settings.
+/// whether there is content on the last line (the `~` line), the
+/// `editor.gutters.line-numbers.min-width` settings and the width of
+/// the wrap indicator (if `soft-wrap` is enabled and the indicator is
+/// set to be displayed on the gutter). The wrap indicator isn't taken
+/// into account here, as that would lead to infinite recursion.
 fn line_numbers_width(view: &View, doc: &Document) -> usize {
     let text = doc.text();
     let last_line = text.len_lines().saturating_sub(1);