Add virtual text support #417

sudormrfbin · 2021-07-05T15:44:38Z

Closes #411, called text annotations in code.

TODO

End of line annotations
Overwrite with virtual text

Future Works

Inline annotations

POC using diagnostics (click to expand patch):

diff --git a/helix-term/src/application.rs b/helix-term/src/application.rs
index b04eef0..9018af7 100644
--- a/helix-term/src/application.rs
+++ b/helix-term/src/application.rs
@@ -422,8 +422,37 @@ impl Application {
                                         // source
                                     })
                                 })
-                                .collect();
-
+                                .collect::<Vec<_>>();
+
+                            doc.remove_text_annotations(|vt| vt.scope == "diagnostics");
+
+                            use helix_core::diagnostic::Severity;
+                            use helix_view::decorations::{TextAnnotation, TextAnnotationKind};
+                            use helix_view::graphics::{Color, Style};
+                            let style = Style::default().bg(Color::Gray);
+                            doc.extend_text_annotations(
+                                diagnostics
+                                    .iter()
+                                    .map(|d| TextAnnotation {
+                                        scope: "diagnostics".into(),
+                                        text: d.message.clone(),
+                                        style: d
+                                            .severity
+                                            .as_ref()
+                                            .map(|s| match s {
+                                                Severity::Error => style.clone().fg(Color::Red),
+                                                Severity::Warning => {
+                                                    style.clone().fg(Color::Yellow)
+                                                }
+                                                Severity::Info => style.clone().fg(Color::Blue),
+                                                Severity::Hint => style.clone().fg(Color::Green),
+                                            })
+                                            .unwrap_or(style.clone().fg(Color::Yellow)),
+                                        line: d.line,
+                                        kind: TextAnnotationKind::Eol,
+                                    })
+                                    .collect(),
+                            );
                             doc.set_diagnostics(diagnostics);
                         }
                     }

cessen · 2021-07-05T16:27:52Z

I think for an initial implementation, just end-of-line annotations are fine. As I mentioned in the linked issue, any rendering work you do here is likely to be redundant with planned future work. So keeping it to the simple case probably makes the most sense.

I'm also a little concerned that doing inline rendering right now will be a bit delicate, as the current rendering architecture isn't really set up to support it, nor is the cursor navigation system, etc. Inline annotations will need to touch a lot of systems to work properly.

sudormrfbin · 2021-07-05T16:46:35Z

In that case I'll drop the inline rendering plan and keep it as is. Cursor and selection rendering for inline annotations will definitely look hacky with the current architecture.

pickfire · 2021-07-06T01:37:25Z

I'm also a little concerned that doing inline rendering right now will be a bit delicate, as the current rendering architecture isn't really set up to support it, nor is the cursor navigation system, etc. Inline annotations will need to touch a lot of systems to work properly.

Yeah, kak-lsp did the same and it is quite broken in kakoune too.

sudormrfbin · 2021-11-11T18:48:44Z

As discussed on Matrix, this PR has been revived (yay !), and I have rebased the original changes on top of current master.

pickfire · 2021-11-12T23:55:02Z

Missing update in https://github.com/helix-editor/helix/blob/master/helix-core/src/position.rs I think, the visual_coords_at_pos should be updated.

helix-view/src/decorations.rs

korken89 · 2022-03-27T06:55:42Z

This is awesome, thanks for adding support!
Is anyone using this and have made a snippet for enabling rust-analyzer type hints?

sudormrfbin · 2022-03-27T09:01:22Z

This PR as of now doesn't implement inlayed virtual text, i.e. virtual text in between normal text, which is what we would need to properly add support for rust-analyzer's type hints. Also the type hint API isn't part of the LSP spec yet, so we would have to probably wait on that too.

korken89 · 2022-03-28T11:50:52Z

Ah, I see - that's unfortunate. The type hint API seems to work in vim and vs-code, what is it that they do differently?
Do you know?

sudormrfbin · 2022-03-28T11:59:03Z

They usually have dedicated plugins that do the setup for you, for example I use https://github.com/nvim-lua/lsp_extensions.nvim for Neovim which sets up inlay hints for rust. VSCode's rust extension also hooks into the decoration API provided by VSC and renders them.

archseer · 2022-03-30T01:41:16Z

Also the type hint API isn't part of the LSP spec yet, so we would have to probably wait on that too.

The new spec seems final, rust-analyzer recently switched over: https://rust-analyzer.github.io/thisweek/2022/03/14/changelog-120.html#new-features

korken89 · 2022-04-19T14:03:02Z

This seems to now be part of the LSP spec: microsoft/language-server-protocol#956

kellpossible · 2022-06-14T10:33:52Z

This PR as of now doesn't implement inlayed virtual text, i.e. virtual text in between normal text

@sudormrfbin I quite like the inlay hints from https://github.com/simrat39/rust-tools.nvim#inlay-hints

2brownc · 2022-07-28T07:56:43Z

Is it possible to make the hints show up below/above the line? If the hint is long it gets cut off when it is displayed beside the line.

EriKWDev · 2022-07-28T21:53:23Z

+1
Would love for this PR to land, even if behind an experimental config flag :)
(it hasn't already landed experimentally right...?)

dekuraan · 2022-07-29T13:03:13Z

Does this branch have working type hints?

Currently supports putting annotations at EOL and overlaying.

erasin · 2022-09-21T10:27:23Z

LSP 3.17 has support for inlay hints https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_inlayHint

lsp-type@0.93(0.93.1) has support InlayHint

language support:

poliorcetics · 2022-09-21T15:28:17Z

LSP 3.17 has support for inlay hints https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_inlayHint

That should be done in another PR I think

dead10ck

I don't have a very solid understanding of the rendering code, but this looks reasonable from what I can tell.

dead10ck · 2022-09-22T03:44:23Z

helix-term/src/ui/editor.rs

                                // we still want to render an empty cell with the style
                                surface.set_string(
                                    viewport.x + visual_x - offset.col as u16,
                                    viewport.y + line,
                                    &newline,
                                    style.patch(whitespace_style),
                                );
+                                visual_x += 1;


Why was this not necessary before, but is now?

I believe because it is due to the addition of virtual text.

But this += 1 does not seemed to support double width characters like CJK, otherwise I think it shouldn't always += 1 and sometimes it should += 2.

I think this works as intended in all cases.

visual_x point is placed after the last character (always incremented by the correct grapheme width in the else clause). The visual_x += 1 only moves the virtual text to the right by one cell so there is space between the annotation and the content of the line. It might be nice to configure the amount of space in the future but I think that can be done in a followup PR.

This was not required before this PR because visual_x is reset back to 0 right after this condition (as a new line starts) on master. However this PR still requires the visual_x (plus the space) to render the EOL annotations.

dead10ck · 2022-09-22T03:48:52Z

helix-view/src/document.rs

+        }
+    }
+
+    // pub fn slice<R>(&self, range: R) -> RopeSlice where R: RangeBounds {


Still needed?

pascalkuthe

Apart from two minor nits this looks good to me

pascalkuthe · 2022-10-01T18:20:56Z

helix-term/src/ui/editor.rs

+        // It's slightly more efficient to produce a full RopeSlice from the Rope, then slice that a bunch
+        // of times than it is to always call Rope::slice/get_slice (it will internally always hit RSEnum::Light).
+        let text = text.slice(..);


Suggested change

// It's slightly more efficient to produce a full RopeSlice from the Rope, then slice that a bunch

// of times than it is to always call Rope::slice/get_slice (it will internally always hit RSEnum::Light).

let text = text.slice(..);

this is a noop (text is already a RopeSlice

pascalkuthe · 2022-10-01T19:01:13Z

helix-view/src/document.rs

@@ -119,6 +121,7 @@ pub struct Document {
    pub(crate) modified_since_accessed: bool,

    diagnostics: Vec<Diagnostic>,
+    text_annotations: HashMap<TextAnnotationGroup, Vec<TextAnnotation>>,


Might be more performant to implement this as a BTreeMap in tne future with the lines as keys.
This would make iterating a small range of lines (during rendering) more efficient when there are a large amount of annotations.
Can probably be done in a followup PR tough

evanrichter

Just as a helix user, I'd really love to see this PR merged! Thanks for your time on this. I had time today to check out your branch and POC for LSP diagnostic virtual text, and it works as expected on my end.

The POC was a little outdated, but here's an updated one you can try (after merging the PR branch to master)

diff --git a/helix-term/src/application.rs b/helix- 
term/src/application.rs
index c7d98fce..4f24b4b9 100644
--- a/helix-term/src/application.rs
+++ b/helix-term/src/application.rs
@@ -633,7 +633,36 @@ pub async fn handle_language_server_message(
                                         source: diagnostic.source.clone()
                                     })
                                 })
-                                .collect();
+                                .collect::<Vec<_>>();
+
+                            doc.clear_text_annotations("diagnostics");
+
+                            use helix_core::diagnostic::Severity;
+                            use helix_view::decorations::{TextAnnotation, TextAnnotationKind};
+                            use helix_view::graphics::{Color, Style};
+                            let style = Style::default().bg(Color::Gray);
+                            doc.push_text_annotations(
+                                "diagnostics",
+                                diagnostics
+                                    .iter()
+                                    .map(|d| TextAnnotation {
+                                        text: d.message.clone().into(),
+                                        style: d
+                                            .severity
+                                            .as_ref()
+                                            .map(|s| match s {
+                                                Severity::Error => style.clone().fg(Color::Red),
+                                                Severity::Warning => {
+                                                    style.clone().fg(Color::Yellow)
+                                                }
+                                                Severity::Info => style.clone().fg(Color::Blue),
+                                                Severity::Hint => style.clone().fg(Color::Green),
+                                            })
+                                            .unwrap_or(style.clone().fg(Color::Yellow)),
+                                        line: d.line,
+                                        kind: TextAnnotationKind::Eol,
+                                    })
+                            );

                             doc.set_diagnostics(diagnostics);
                         }

evanrichter · 2022-10-07T20:34:46Z

helix-view/src/decorations.rs

+    }
+}
+
+/// Namespaces and identifes similar annotations


Suggested change

/// Namespaces and identifes similar annotations

/// Namespaces to identify similar annotations

evanrichter · 2022-10-08T02:00:57Z

helix-view/src/decorations.rs

+}
+
+/// Namespaces and identifes similar annotations
+pub type TextAnnotationGroup = &'static str;


I think this could be an enum instead of a string, since it will be known at compile time anyway.

pub enum TextAnnotationGroup { Diagnostic, JumpMode, }

Then hashing or b-tree look up & filtering will be fast, or possibly even faster would be to store annotations directly into a named field:

struct DocumentAnnotations { diagnostics: Vec<TextAnnotation>, jump_mode: Vec<TextAnnotation>, } pub struct Document { // -----8<----- text_annotations: DocumentAnnotations, }

ah, another review note: Document implements Debug manually, so consider adding the text_annotations field there as well

https://github.com/helix-editor/helix/pull/417/files#diff-36a64f6c432dc47d11c27851879a0b67459d908edfaa70262aefc21171dc62b9R129

I think making a TextAnnotationGroup enum would make it hard to use annotations from a plugin, once a plugin system is implemented.

that's a fair point! it's certainly not a blocking issue.

to reap benefits (which may be slight?) of the enum approach and allow plugins to add annotations, something like this would work:

/// first-party annotation groups (only used to differentiate access to the Vecs below) pub enum TextAnnotationGroup { Diagnostic, JumpMode, } /// plugin annotation groups /// (might have to reserve "diagnostic" and "jump_mode" strs? pub type TextAnnotationPluginGroup = &'static str; struct DocumentAnnotations { diagnostics: Vec<TextAnnotation>, jump_mode: Vec<TextAnnotation>, from_plugins: BTreeMap<&'static str, TextAnnotation>, } pub struct Document { // -----8<----- text_annotations: DocumentAnnotations, }

filipdutescu · 2022-10-13T11:21:39Z

This could also be extended to debugging, so it displays the values of variable and objects, which would be of tremendous help.

abseee · 2022-10-17T13:11:00Z

Update on this? Code folding and inlays are quite useful features currently blocked on this PR.

pascalkuthe · 2022-11-04T17:21:56Z

An update for everyone interested in this: After discussion in the matrix chat, I will be taking over work on virtual text.
However after discussion with @kirawi I plan to use a different approach than this PR that will build on his work in #3268 and #2184 so that the efforts on soft-wrapping and virtual text do not end up conflicting.
This will involve a generic update to the rendering system that @kirawi and I are planning to develop in cooperation.

sudormrfbin changed the title ~~Add initial virtual text support~~ Add virtual text support Jul 5, 2021

sudormrfbin force-pushed the virtual-text branch 2 times, most recently from 4fe1e11 to a091e11 Compare July 5, 2021 18:30

sudormrfbin force-pushed the virtual-text branch from a091e11 to 89385bf Compare November 11, 2021 18:46

pickfire reviewed Nov 12, 2021

View reviewed changes

helix-view/src/decorations.rs Show resolved Hide resolved

Omnikar mentioned this pull request Nov 24, 2021

Easymotion-like jump mode #1162

Closed

2 tasks

sudormrfbin mentioned this pull request Dec 13, 2021

Optionally show vertical indentation block lines #1257

Closed

glyh mentioned this pull request Dec 30, 2021

:h[elp] command and documentation #997

Open

sudormrfbin force-pushed the virtual-text branch from 89385bf to ae50561 Compare March 11, 2022 11:33

sudormrfbin requested a review from archseer March 11, 2022 12:31

sudormrfbin force-pushed the virtual-text branch from 26b211b to 2abb57f Compare March 11, 2022 20:09

sudormrfbin mentioned this pull request Mar 11, 2022

Add indent guides #1796

Merged

1 task

the-mikedavis mentioned this pull request Apr 9, 2022

Inline hints for rust analyzer #2049

Closed

sudormrfbin mentioned this pull request Jul 31, 2022

Error lens style LSP diagnostics #3272

Closed

Omnikar mentioned this pull request Sep 11, 2022

Jump mode #3791

Closed

3 tasks

kirawi added A-helix-term Area: Helix term improvements S-waiting-on-review Status: Awaiting review from a maintainer. labels Sep 13, 2022

sudormrfbin added 2 commits September 20, 2022 23:43

Add initial text annotations support

8b4254e

Currently supports putting annotations at EOL and overlaying.

Rework virtual text api

4d8be0a

sudormrfbin force-pushed the virtual-text branch from 2abb57f to 4d8be0a Compare September 20, 2022 18:18

dead10ck approved these changes Sep 22, 2022

View reviewed changes

pascalkuthe approved these changes Oct 1, 2022

View reviewed changes

David-Else mentioned this pull request Oct 6, 2022

CodeLens placement issues #4119

Closed

evanrichter reviewed Oct 8, 2022

View reviewed changes

rehtlaw mentioned this pull request Oct 11, 2022

LSP Type Hints #2070

Closed

SoraTenshi mentioned this pull request Oct 11, 2022

Add Code Folding #1840

Open

ngraham20 mentioned this pull request Oct 14, 2022

Intrusive Diagnostics #1462

Closed

David-Else mentioned this pull request Oct 26, 2022

Questions: Do Helix has support to show type inference in Rust like VScode does? #4474

Closed

kirawi mentioned this pull request Nov 14, 2022

Support soft wrap #136

Closed

sudormrfbin closed this Dec 19, 2022

semin-park mentioned this pull request Jan 16, 2023

Enhanced jump mode (based on #3791) #5340

Closed

	// It's slightly more efficient to produce a full RopeSlice from the Rope, then slice that a bunch
	// of times than it is to always call Rope::slice/get_slice (it will internally always hit RSEnum::Light).
	let text = text.slice(..);

	/// Namespaces and identifes similar annotations
	/// Namespaces to identify similar annotations

Add virtual text support #417

Add virtual text support #417

Conversation

sudormrfbin commented Jul 5, 2021 • edited Loading

TODO

Future Works

cessen commented Jul 5, 2021

sudormrfbin commented Jul 5, 2021

pickfire commented Jul 6, 2021

sudormrfbin commented Nov 11, 2021

pickfire commented Nov 12, 2021

korken89 commented Mar 27, 2022

sudormrfbin commented Mar 27, 2022 • edited Loading

korken89 commented Mar 28, 2022

sudormrfbin commented Mar 28, 2022

archseer commented Mar 30, 2022

korken89 commented Apr 19, 2022

kellpossible commented Jun 14, 2022 • edited Loading

2brownc commented Jul 28, 2022

EriKWDev commented Jul 28, 2022

dekuraan commented Jul 29, 2022

erasin commented Sep 21, 2022

poliorcetics commented Sep 21, 2022

dead10ck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pascalkuthe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evanrichter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as off-topic.

filipdutescu commented Oct 13, 2022

abseee commented Oct 17, 2022

pascalkuthe commented Nov 4, 2022

sudormrfbin commented Jul 5, 2021 •

edited

Loading

sudormrfbin commented Mar 27, 2022 •

edited

Loading

kellpossible commented Jun 14, 2022 •

edited

Loading