Somewhat working version of range hover action

scalameta · Aug 21, 2021 · dff09c0 · dff09c0
1 parent 9f8ccde
commit dff09c0
Show file tree

Hide file tree

Showing 13 changed files with 420 additions and 104 deletions.
diff --git a/metals/src/main/scala/scala/meta/internal/decorations/SyntheticsDecorationProvider.scala b/metals/src/main/scala/scala/meta/internal/decorations/SyntheticsDecorationProvider.scala
@@ -15,6 +15,7 @@ import scala.meta.internal.metals.ClientConfiguration
 import scala.meta.internal.metals.Diagnostics
 import scala.meta.internal.metals.MetalsEnrichments._
 import scala.meta.internal.metals.UserConfiguration
+import scala.meta.internal.metals.HoverExtParams
 import scala.meta.internal.metap.PrinterSymtab
 import scala.meta.internal.mtags.Md5Fingerprints
 import scala.meta.internal.mtags.Semanticdbs
@@ -31,7 +32,6 @@ import scala.meta.io.AbsolutePath
 import scala.meta.tokens.Token.RightParen
 import scala.meta.tokens.{Token => T}
 
-import org.eclipse.lsp4j.TextDocumentPositionParams
 import org.eclipse.{lsp4j => l}
 
 final class SyntheticsDecorationProvider(
@@ -98,12 +98,12 @@ final class SyntheticsDecorationProvider(
   }
 
   def addSyntheticsHover(
-      params: TextDocumentPositionParams,
+      params: HoverExtParams,
       pcHover: Option[l.Hover]
   ): Option[l.Hover] =
     if (isSyntheticsEnabled) {
-      val path = params.getTextDocument().getUri().toAbsolutePath
-      val line = params.getPosition().getLine()
+      val path = params.textDocument.getUri().toAbsolutePath
+      val line = params.getPosition.getLine()
       val newHover = currentDocument(path) match {
         case Some(textDocument) =>
           val edit = buffer.tokenEditDistance(path, textDocument.text, trees)
@@ -140,7 +140,7 @@ final class SyntheticsDecorationProvider(
                 path,
                 syntheticsAtLine,
                 pcHover,
-                params.getPosition()
+                params.getPosition
               )
             } else {
               createHoverAtLine(path, syntheticsAtLine, pcHover).orElse(

diff --git a/metals/src/main/scala/scala/meta/internal/metals/Compilers.scala b/metals/src/main/scala/scala/meta/internal/metals/Compilers.scala
@@ -312,14 +312,24 @@ class Compilers(
   }
 
   def hover(
-      params: TextDocumentPositionParams,
+      params: HoverExtParams,
       token: CancelToken
-  ): Future[Option[Hover]] =
-    withPCAndAdjustLsp(params) { (pc, pos, adjust) =>
-      pc.hover(CompilerOffsetParams.fromPos(pos, token))
-        .asScala
-        .map(_.asScala.map { hover => adjust.adjustHoverResp(hover) })
+  ): Future[Option[Hover]] = {
+    if (params.range != null) {
+      withPCAndAdjustLsp(params) { (pc, pos, adjust) =>
+        pc.hover(CompilerRangeParams.fromPos(pos, token))
+          .asScala
+          .map(_.asScala.map { hover => adjust.adjustHoverResp(hover) })
+      }
+    } else {
+      val param: TextDocumentPositionParams = new TextDocumentPositionParams(params.textDocument, params.position)
+      withPCAndAdjustLsp(param) { (pc, pos, adjust) =>
+        pc.hover(CompilerOffsetParams.fromPos(pos, token))
+          .asScala
+          .map(_.asScala.map { hover => adjust.adjustHoverResp(hover) })
+      }
     }
+  }
 
   def definition(
       params: TextDocumentPositionParams,
@@ -536,7 +546,21 @@ class Compilers(
       )
     val metaPos = pos.toMeta(input)
     fn(compiler, metaPos, adjust)
+  }
+
+  private def withPCAndAdjustLsp[T](
+      params: HoverExtParams
+  )(fn: (PresentationCompiler, Position, AdjustLspData) => T): T = {
+    val path = params.textDocument.getUri.toAbsolutePath
+    val compiler = loadCompiler(path).getOrElse(fallbackCompiler)
 
+    val (input, _, adjust) =
+      sourceAdjustments(
+        new TextDocumentPositionParams(params.textDocument, params.position),
+        compiler.scalaVersion()
+      )
+    val metaPos = params.range.toMeta(input)
+    fn(compiler, metaPos, adjust)
   }
 
   private def sourceAdjustments(

diff --git a/metals/src/main/scala/scala/meta/internal/metals/HoverExtension.scala b/metals/src/main/scala/scala/meta/internal/metals/HoverExtension.scala
@@ -0,0 +1,17 @@
+package scala.meta.internal.metals
+
+import javax.annotation.Nullable
+
+import org.eclipse.lsp4j.Position
+import org.eclipse.lsp4j.Range
+import org.eclipse.lsp4j.TextDocumentIdentifier
+
+case class HoverExtParams(
+  textDocument: TextDocumentIdentifier,
+  @Nullable position: Position = null,
+  @Nullable range: Range = null
+) {
+  def getPosition: Position =
+    if (position != null) position
+    else range.getStart() 
+}
diff --git a/metals/src/main/scala/scala/meta/internal/metals/MetalsLanguageServer.scala b/metals/src/main/scala/scala/meta/internal/metals/MetalsLanguageServer.scala
@@ -1319,7 +1319,7 @@ class MetalsLanguageServer(
     }
 
   @JsonRequest("textDocument/hover")
-  def hover(params: TextDocumentPositionParams): CompletableFuture[Hover] =
+  def hover(params: HoverExtParams): CompletableFuture[Hover] = {
     CancelTokens.future { token =>
       compilers
         .hover(params, token)
@@ -1328,14 +1328,15 @@ class MetalsLanguageServer(
         }
         .map(
           _.orElse {
-            val path = params.getTextDocument.getUri.toAbsolutePath
+            val path = params.textDocument.getUri.toAbsolutePath
             if (path.isWorksheet)
-              worksheetProvider.hover(path, params.getPosition())
+              worksheetProvider.hover(path, params.getPosition)
             else
               None
           }.orNull
         )
     }
+  }
 
   @JsonRequest("textDocument/documentHighlight")
   def documentHighlights(

diff --git a/mtags-interfaces/src/main/java/scala/meta/pc/RangeParams.java b/mtags-interfaces/src/main/java/scala/meta/pc/RangeParams.java
@@ -0,0 +1,13 @@
+package scala.meta.pc;
+
+/**
+ * Parameters for a presentation compiler request at a given offset in a single source file.
+ */
+public interface RangeParams extends OffsetParams {
+
+    /**
+     * The character offset of the request.
+     */
+    int endOffset();
+
+}
diff --git a/mtags/src/main/scala-2/scala/meta/internal/mtags/MtagsEnrichments.scala b/mtags/src/main/scala-2/scala/meta/internal/mtags/MtagsEnrichments.scala
@@ -111,6 +111,18 @@ trait MtagsEnrichments extends CommonMtagsEnrichments {
     }
   }
 
+  implicit class XtensionRangeLspInverse(range: l.Range) {
+    def toMeta(input: m.Input): m.Position = {
+      m.Position.Range(
+        input,
+        range.getStart.getLine,
+        range.getStart.getCharacter,
+        range.getEnd.getLine,
+        range.getEnd.getCharacter
+      )
+    }
+  }
+
   implicit class XtensionPositionLspInverse(pos: l.Position) {
     def toMeta(input: m.Input): m.Position = {
       m.Position.Range(