feat: update code lens positions on change

Author: matoous

helix-term/src/handlers.rs

@@ -1,6 +1,7 @@
 use std::sync::Arc;
 
 use arc_swap::ArcSwap;
+use code_lenses::DocumentCodeLensesHandler;
 use diagnostics::PullAllDocumentsDiagnosticHandler;
 use helix_event::AsyncHook;
 
@@ -30,6 +31,7 @@ pub fn setup(config: Arc<ArcSwap<Config>>) -> Handlers {
     let signature_hints = SignatureHelpHandler::new().spawn();
     let auto_save = AutoSaveHandler::new().spawn();
     let document_colors = DocumentColorsHandler::default().spawn();
+    let code_lenses = DocumentCodeLensesHandler::default().spawn();
     let word_index = word_index::Handler::spawn();
     let pull_diagnostics = PullDiagnosticsHandler::default().spawn();
     let pull_all_documents_diagnostics = PullAllDocumentsDiagnosticHandler::default().spawn();
@@ -39,6 +41,7 @@ pub fn setup(config: Arc<ArcSwap<Config>>) -> Handlers {
         signature_hints,
         auto_save,
         document_colors,
+        code_lenses,
         word_index,
         pull_diagnostics,
         pull_all_documents_diagnostics,
@@ -52,6 +55,7 @@ pub fn setup(config: Arc<ArcSwap<Config>>) -> Handlers {
     snippet::register_hooks(&handlers);
     document_colors::register_hooks(&handlers);
     code_lenses::register_hooks(&handlers);
+    code_lenses::register_hooks(&handlers);
     prompt::register_hooks(&handlers);
     handlers
 }

helix-term/src/handlers/code_lenses.rs

@@ -87,7 +87,7 @@ pub fn request_document_code_lenses(editor: &mut Editor, doc_id: DocumentId) {
                 .collect(),
             Some(Ok(None)) => Vec::new(),
             Some(Err(err)) => {
-                log::error!("document color request failed: {err}");
+                log::error!("code lenses request failed: {err}");
                 return;
             }
             None => return,
@@ -109,15 +109,32 @@ pub fn request_document_code_lenses(editor: &mut Editor, doc_id: DocumentId) {
     });
 }
 
-pub(super) fn register_hooks(_handlers: &Handlers) {
+pub(super) fn register_hooks(handlers: &Handlers) {
     register_hook!(move |event: &mut DocumentDidOpen<'_>| {
         // when a document is initially opened, request code lenses for it
         request_document_code_lenses(event.editor, event.doc);
         Ok(())
     });
 
-    register_hook!(move |_event: &mut DocumentDidChange<'_>| {
-        // TODO(matoous): use to update code lenses positions on document changes
+    let tx = handlers.code_lenses.clone();
+    register_hook!(move |event: &mut DocumentDidChange<'_>| {
+        event.changes.update_positions(
+            event
+                .doc
+                .code_lenses
+                .iter_mut()
+                .map(|lens| (&mut lens.char_idx, helix_core::Assoc::After)),
+        );
+
+        // Avoid re-requesting code lenses if the change is a ghost transaction (completion)
+        // because the language server will not know about the updates to the document and will
+        // give out-of-date locations.
+        if !event.ghost_transaction {
+            // Cancel the ongoing request, if present.
+            event.doc.code_lenses_controller.cancel();
+            helix_event::send_blocking(&tx, CodeLensesEvent(event.doc.id()));
+        }
+
         Ok(())
     });
 

helix-view/src/document.rs

@@ -224,6 +224,7 @@ pub struct Document {
 
 #[derive(Debug, Clone)]
 pub struct CodeLens {
+    pub char_idx: usize,
     pub line: usize,
     pub lens: lsp::CodeLens,
 }
@@ -2184,11 +2185,26 @@ impl Document {
     }
 
     pub fn set_code_lenses(&mut self, lenses: Vec<lsp::CodeLens>) {
+        let text = self.text().clone();
+        let Some(language_server) = self
+            .language_servers_with_feature(LanguageServerFeature::CodeLens)
+            .next()
+        else {
+            return;
+        };
+        let offset_encoding = language_server.offset_encoding();
         self.code_lenses = lenses
             .into_iter()
-            .map(|l| CodeLens {
-                line: l.range.start.line as usize,
-                lens: l,
+            .filter_map(|l| {
+                if let Some(char_idx) = lsp_pos_to_pos(&text, l.range.start, offset_encoding) {
+                    Some(CodeLens {
+                        line: self.text.char_to_line(char_idx),
+                        char_idx,
+                        lens: l,
+                    })
+                } else {
+                    None
+                }
             })
             .collect();
     }

helix-view/src/gutter.rs

@@ -95,7 +95,6 @@ pub fn lens<'doc>(
 ) -> GutterFn<'doc> {
     let info = theme.get("info");
     let lenses = &doc.code_lenses;
-    log::error!("lenses: {:?}", lenses);
 
     Box::new(
         move |line: usize, _selected: bool, first_visual_line: bool, out: &mut String| {

helix-view/src/handlers.rs

@@ -23,6 +23,7 @@ pub struct Handlers {
     pub signature_hints: Sender<lsp::SignatureHelpEvent>,
     pub auto_save: Sender<AutoSaveEvent>,
     pub document_colors: Sender<lsp::DocumentColorsEvent>,
+    pub code_lenses: Sender<lsp::CodeLensesEvent>,
     pub word_index: word_index::Handler,
     pub pull_diagnostics: Sender<lsp::PullDiagnosticsEvent>,
     pub pull_all_documents_diagnostics: Sender<lsp::PullAllDocumentsDiagnosticsEvent>,