Merge pull request #131 from sourcegraph/nsc/lsif-semanticdb-sigformat

Author: Strum355

lsif-java/src/main/scala/com/sourcegraph/lsif_java/SemanticdbPrinters.scala

@@ -2,7 +2,10 @@ package com.sourcegraph.lsif_java
 
 import scala.jdk.CollectionConverters._
 
+import com.sourcegraph.lsif_semanticdb.SignatureFormatter
+import com.sourcegraph.lsif_semanticdb.Symtab
 import com.sourcegraph.semanticdb_javac.Semanticdb.SymbolOccurrence
+import com.sourcegraph.semanticdb_javac.Semanticdb.SymbolOccurrence.Role
 import com.sourcegraph.semanticdb_javac.Semanticdb.TextDocument
 
 object SemanticdbPrinters {
@@ -12,13 +15,14 @@ object SemanticdbPrinters {
       .asScala
       .groupBy(_.getRange.getStartLine)
     val out = new StringBuilder()
+    val symtab = new Symtab(doc)
     doc
       .getText
       .linesWithSeparators
       .zipWithIndex
       .foreach { case (line, i) =>
         out.append(line.replace("\t", "→"))
-        val occurences = occurrencesByLine
+        val occurrences = occurrencesByLine
           .getOrElse(i, Nil)
           .sortBy(o =>
             (
@@ -27,8 +31,8 @@ object SemanticdbPrinters {
               o.getRange.getEndCharacter
             )
           )
-        occurences.foreach { occ =>
-          formatOccurrence(out, occ, line)
+        occurrences.foreach { occ =>
+          formatOccurrence(out, occ, line, symtab)
         }
       }
     out.toString()
@@ -37,7 +41,8 @@ object SemanticdbPrinters {
   private def formatOccurrence(
       out: StringBuilder,
       occ: SymbolOccurrence,
-      line: String
+      line: String,
+      symtab: Symtab
   ): Unit = {
     val r = occ.getRange
     val isMultiline = r.getStartLine != r.getEndLine
@@ -76,6 +81,19 @@ object SemanticdbPrinters {
         else
           ""
       )
+      .append(
+        symtab.symbols.asScala.get(occ.getSymbol) match {
+          case Some(info) if occ.getRole == Role.DEFINITION =>
+            val sig = new SignatureFormatter(info, symtab).formatSymbol()
+            if (sig.isEmpty)
+              " " + info.getDisplayName
+            else
+              " " + sig
+          case _ =>
+            ""
+        }
+      )
       .append("\n")
   }
+
 }

lsif-java/src/main/scala/com/sourcegraph/lsif_java/commands/SnapshotLsifCommand.scala

@@ -28,6 +28,7 @@ import com.sourcegraph.lsif_protocol.LsifObject
 import com.sourcegraph.lsif_protocol.LsifPosition
 import com.sourcegraph.semanticdb_javac.Semanticdb
 import com.sourcegraph.semanticdb_javac.Semanticdb.Language
+import com.sourcegraph.semanticdb_javac.Semanticdb.SymbolInformation
 import com.sourcegraph.semanticdb_javac.Semanticdb.SymbolOccurrence
 import com.sourcegraph.semanticdb_javac.Semanticdb.SymbolOccurrence.Role
 import com.sourcegraph.semanticdb_javac.Semanticdb.TextDocument
@@ -119,6 +120,27 @@ object SnapshotLsifCommand {
           .setSymbol(symbol)
           .build()
         doc.addOccurrences(occ)
+
+        if (isDefinition) {
+          val hover =
+            (
+              for {
+                resultSetId <- lsif.next.get(o.getId).toList
+                hoverId <- lsif.hoverEdges.get(resultSetId).toList
+                hover <- lsif.hoverVertexes.get(hoverId).toList
+                contents <- hover.getContentsList.asScala
+                if contents.getLanguage !=
+                  Language.UNKNOWN_LANGUAGE.toString.toLowerCase
+              } yield contents.getValue
+            ).mkString("\n")
+          val symInfo = SymbolInformation
+            .newBuilder()
+            // we cheese it a bit here, as this is less work than trying to reconstruct
+            // a Signature from the pretty-printed Signature, with accompanying logic
+            // to fallback to display_name in SemanticdbPrinters.scala
+            .setDisplayName(hover).setSymbol(symbol).build()
+          doc.addSymbols(symInfo)
+        }
       }
     lsif.documents.values.map(_.build()).toList
   }

lsif-semanticdb/src/main/java/com/sourcegraph/lsif_semanticdb/LsifSemanticdb.java

@@ -76,6 +76,8 @@ private Stream<Integer> processPath(Path path, Set<String> isExportedSymbol) {
   }
 
   private Integer processDocument(LsifTextDocument doc, Set<String> isExportedSymbol) {
+    Symtab symtab = new Symtab(doc.semanticdb);
+
     int documentId = writer.emitDocument(doc);
     Set<String> localDefinitions =
         doc.semanticdb.getOccurrencesList().stream()
@@ -112,9 +114,21 @@ private Integer processDocument(LsifTextDocument doc, Set<String> isExportedSymb
         }
 
         // Hover
+        ArrayList<MarkedString> markedStrings = new ArrayList<>();
         String documentation = symbolInformation.getDocumentation().getMessage();
         if (!documentation.isEmpty()) {
-          int hoverId = writer.emitHoverResult(doc.semanticdb.getLanguage(), documentation);
+          markedStrings.add(new MarkedString(Semanticdb.Language.UNKNOWN_LANGUAGE, documentation));
+        }
+
+        if (symbolInformation.hasSignature()) {
+          markedStrings.add(
+              new MarkedString(
+                  doc.semanticdb.getLanguage(),
+                  new SignatureFormatter(symbolInformation, symtab).formatSymbol()));
+        }
+
+        if (!markedStrings.isEmpty()) {
+          int hoverId = writer.emitHoverResult(markedStrings.toArray(new MarkedString[0]));
           writer.emitHoverEdge(ids.resultSet, hoverId);
         }
       }

lsif-semanticdb/src/main/java/com/sourcegraph/lsif_semanticdb/LsifWriter.java

@@ -10,9 +10,12 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Locale;
 import java.util.concurrent.atomic.AtomicInteger;
+import java.util.stream.Collectors;
 
 /** High-level utility methods to write LSIF vertex/edge objects into the LSIF output stream. */
 public class LsifWriter implements AutoCloseable {
@@ -90,15 +93,21 @@ public int emitDefinitionResult(int resultSet) {
     return definitionResult;
   }
 
-  public int emitHoverResult(Semanticdb.Language language, String value) {
+  public int emitHoverResult(MarkedString[] markedStrings) {
     return emitObject(
         lsifVertex("hoverResult")
             .setResult(
                 LsifHover.newBuilder()
-                    .addContents(
-                        Content.newBuilder()
-                            .setLanguage(language.toString().toLowerCase(Locale.ROOT))
-                            .setValue(value))));
+                    .addAllContents(
+                        Arrays.stream(markedStrings)
+                            .map(
+                                (ms) ->
+                                    Content.newBuilder()
+                                        .setLanguage(
+                                            ms.language.toString().toLowerCase(Locale.ROOT))
+                                        .setValue(ms.value)
+                                        .build())
+                            .collect(Collectors.toList()))));
   }
 
   public void emitHoverEdge(int outV, int inV) {

lsif-semanticdb/src/main/java/com/sourcegraph/lsif_semanticdb/MarkedString.java

@@ -0,0 +1,13 @@
+package com.sourcegraph.lsif_semanticdb;
+
+import com.sourcegraph.semanticdb_javac.Semanticdb;
+
+public class MarkedString {
+  public final String value;
+  public final Semanticdb.Language language;
+
+  public MarkedString(Semanticdb.Language language, String value) {
+    this.value = value;
+    this.language = language;
+  }
+}