Backport "Fix TASTy source position printer" to LTS (#20782)

Backports #19105 to the LTS branch.

PR submitted by the release tooling.
[skip ci]

Author: WojciechMazur

compiler/src/dotty/tools/dotc/core/tasty/PositionUnpickler.scala

@@ -3,6 +3,8 @@ package dotc
 package core
 package tasty
 
+import scala.compiletime.uninitialized
+
 import dotty.tools.tasty.{TastyFormat, TastyBuffer, TastyReader}
 import TastyFormat.SOURCE
 import TastyBuffer.{Addr, NameRef}
@@ -14,9 +16,9 @@ import Names.TermName
 class PositionUnpickler(reader: TastyReader, nameAtRef: NameRef => TermName) {
   import reader.*
 
-  private var myLineSizes: Array[Int] = _
-  private var mySpans: util.HashMap[Addr, Span] = _
-  private var mySourcePaths: util.HashMap[Addr, String] = _
+  private var myLineSizes: Array[Int] = uninitialized
+  private var mySpans: util.HashMap[Addr, Span] = uninitialized
+  private var mySourceNameRefs: util.HashMap[Addr, NameRef] = uninitialized
   private var isDefined = false
 
   def ensureDefined(): Unit = {
@@ -29,15 +31,14 @@ class PositionUnpickler(reader: TastyReader, nameAtRef: NameRef => TermName) {
         i += 1
 
       mySpans = util.HashMap[Addr, Span]()
-      mySourcePaths = util.HashMap[Addr, String]()
+      mySourceNameRefs = util.HashMap[Addr, NameRef]()
       var curIndex = 0
       var curStart = 0
       var curEnd = 0
       while (!isAtEnd) {
         val header = readInt()
         if (header == SOURCE) {
-          val path = nameAtRef(readNameRef()).toString
-          mySourcePaths(Addr(curIndex)) = path
+          mySourceNameRefs(Addr(curIndex)) = readNameRef()
         }
         else {
           val addrDelta = header >> 3
@@ -62,9 +63,9 @@ class PositionUnpickler(reader: TastyReader, nameAtRef: NameRef => TermName) {
     mySpans
   }
 
-  private[tasty] def sourcePaths: util.ReadOnlyMap[Addr, String] = {
+  private[tasty] def sourceNameRefs: util.ReadOnlyMap[Addr, NameRef] = {
     ensureDefined()
-    mySourcePaths
+    mySourceNameRefs
   }
 
   private[tasty] def lineSizes: Array[Int] = {
@@ -73,5 +74,5 @@ class PositionUnpickler(reader: TastyReader, nameAtRef: NameRef => TermName) {
   }
 
   def spanAt(addr: Addr): Span = spans.getOrElse(addr, NoSpan)
-  def sourcePathAt(addr: Addr): String = sourcePaths.getOrElse(addr, "")
+  def sourcePathAt(addr: Addr): String = sourceNameRefs.get(addr).fold("")(nameAtRef(_).toString)
 }

compiler/src/dotty/tools/dotc/core/tasty/TastyPrinter.scala

@@ -12,6 +12,10 @@ import util.Spans.offsetToInt
 import dotty.tools.tasty.TastyFormat.{ASTsSection, PositionsSection, CommentsSection}
 import java.nio.file.{Files, Paths}
 import dotty.tools.io.{JarArchive, Path}
+import dotty.tools.tasty.TastyFormat.header
+
+import scala.compiletime.uninitialized
+import dotty.tools.tasty.TastyBuffer.Addr
 
 object TastyPrinter:
 
@@ -62,26 +66,43 @@ class TastyPrinter(bytes: Array[Byte]) {
 
   private val sb: StringBuilder = new StringBuilder
 
-  private val unpickler: TastyUnpickler = new TastyUnpickler(bytes)
+  class TastyPrinterUnpickler extends TastyUnpickler(bytes) {
+    var namesStart: Addr = uninitialized
+    var namesEnd: Addr = uninitialized
+    override def readNames() = {
+      namesStart = reader.currentAddr
+      super.readNames()
+      namesEnd = reader.currentAddr
+    }
+  }
+
+  private val unpickler: TastyPrinterUnpickler = new TastyPrinterUnpickler
   import unpickler.{nameAtRef, unpickle}
 
   private def nameToString(name: Name): String = name.debugString
 
   private def nameRefToString(ref: NameRef): String = nameToString(nameAtRef(ref))
 
+  private def printHeader(): Unit =
+    val header = unpickler.header
+    sb.append("Header:\n")
+    sb.append(s"  version: ${header.majorVersion}.${header.minorVersion}.${header.experimentalVersion}\n")
+    sb.append("  tooling: ").append(header.toolingVersion).append("\n")
+    sb.append("     UUID: ").append(header.uuid).append("\n")
+    sb.append("\n")
+
   private def printNames(): Unit =
+    sb.append(s"Names (${unpickler.namesEnd.index - unpickler.namesStart.index} bytes, starting from ${unpickler.namesStart.index}):\n")
     for ((name, idx) <- nameAtRef.contents.zipWithIndex) {
-      val index = nameStr("%4d".format(idx))
+      val index = nameStr("%6d".format(idx))
       sb.append(index).append(": ").append(nameToString(name)).append("\n")
     }
 
   def showContents(): String = {
-    sb.append("Names:\n")
+    printHeader()
     printNames()
-    sb.append("\n")
-    sb.append("Trees:\n")
     unpickle(new TreeSectionUnpickler) match {
-      case Some(s) => sb.append(s)
+      case Some(s) => sb.append("\n\n").append(s)
       case _ =>
     }
     sb.append("\n\n")
@@ -106,8 +127,8 @@ class TastyPrinter(bytes: Array[Byte]) {
       import reader.*
       var indent = 0
       def newLine() = {
-        val length = treeStr("%5d".format(index(currentAddr) - index(startAddr)))
-        sb.append(s"\n $length:" + " " * indent)
+        val length = treeStr("%6d".format(index(currentAddr) - index(startAddr)))
+        sb.append(s"\n$length:" + " " * indent)
       }
       def printNat() = sb.append(treeStr(" " + readNat()))
       def printName() = {
@@ -163,8 +184,7 @@ class TastyPrinter(bytes: Array[Byte]) {
           }
         indent -= 2
       }
-      sb.append(s"start = ${reader.startAddr}, base = $base, current = $currentAddr, end = $endAddr\n")
-      sb.append(s"${endAddr.index - startAddr.index} bytes of AST, base = $currentAddr\n")
+      sb.append(s"Trees (${endAddr.index - startAddr.index} bytes, starting from $base):")
       while (!isAtEnd) {
         printTree()
         newLine()
@@ -178,26 +198,30 @@ class TastyPrinter(bytes: Array[Byte]) {
     private val sb: StringBuilder = new StringBuilder
 
     def unpickle(reader: TastyReader, tastyName: NameTable): String = {
+      import reader.*
       val posUnpickler = new PositionUnpickler(reader, tastyName)
-      sb.append(s" ${reader.endAddr.index - reader.currentAddr.index}")
-      sb.append(" position bytes:\n")
+      sb.append(s"Positions (${reader.endAddr.index - reader.startAddr.index} bytes, starting from $base):\n")
       val lineSizes = posUnpickler.lineSizes
-      sb.append(s"   lines: ${lineSizes.length}\n")
-      sb.append(posUnpickler.lineSizes.mkString("   line sizes: ", ", ", "\n"))
-      sb.append("   positions:\n")
+      sb.append(s"  lines: ${lineSizes.length}\n")
+      sb.append(s"  line sizes:\n")
+      val windowSize = 20
+      for window <-posUnpickler.lineSizes.sliding(windowSize, windowSize) do
+        sb.append("     ").append(window.mkString(", ")).append("\n")
+      // sb.append(posUnpickler.lineSizes.mkString("  line sizes: ", ", ", "\n"))
+      sb.append("  positions:\n")
       val spans = posUnpickler.spans
       val sorted = spans.toSeq.sortBy(_._1.index)
       for ((addr, pos) <- sorted) {
-        sb.append(treeStr("%10d".format(addr.index)))
+        sb.append(treeStr("%6d".format(addr.index)))
         sb.append(s": ${offsetToInt(pos.start)} .. ${pos.end}\n")
       }
 
-      val sources = posUnpickler.sourcePaths
-      sb.append(s"\n source paths:\n")
+      val sources = posUnpickler.sourceNameRefs
+      sb.append(s"\n  source paths:\n")
       val sortedPath = sources.toSeq.sortBy(_._1.index)
-      for ((addr, path) <- sortedPath) {
-        sb.append(treeStr("%10d: ".format(addr.index)))
-        sb.append(path)
+      for ((addr, nameRef) <- sortedPath) {
+        sb.append(treeStr("%6d: ".format(addr.index)))
+        sb.append(nameStr(s"${nameRef.index} [${tastyName(nameRef)}]"))
         sb.append("\n")
       }
 
@@ -210,14 +234,15 @@ class TastyPrinter(bytes: Array[Byte]) {
     private val sb: StringBuilder = new StringBuilder
 
     def unpickle(reader: TastyReader, tastyName: NameTable): String = {
-      sb.append(s" ${reader.endAddr.index - reader.currentAddr.index}")
+      import reader.*
       val comments = new CommentUnpickler(reader).comments
-      sb.append(s" comment bytes:\n")
-      val sorted = comments.toSeq.sortBy(_._1.index)
-      for ((addr, cmt) <- sorted) {
-        sb.append(treeStr("%10d".format(addr.index)))
-        sb.append(s": ${cmt.raw} (expanded = ${cmt.isExpanded})\n")
-      }
+      if !comments.isEmpty then
+        sb.append(s"Comments (${reader.endAddr.index - reader.startAddr.index} bytes, starting from $base):\n")
+        val sorted = comments.toSeq.sortBy(_._1.index)
+        for ((addr, cmt) <- sorted) {
+          sb.append(treeStr("%6d".format(addr.index)))
+          sb.append(s": ${cmt.raw} (expanded = ${cmt.isExpanded})\n")
+        }
       sb.result
     }
   }

compiler/src/dotty/tools/dotc/core/tasty/TastyUnpickler.scala

@@ -11,6 +11,8 @@ import TastyBuffer.NameRef
 import scala.collection.mutable
 import Names.{TermName, termName, EmptyTermName}
 import NameKinds.*
+import dotty.tools.tasty.TastyHeader
+import dotty.tools.tasty.TastyBuffer.Addr
 
 object TastyUnpickler {
 
@@ -28,7 +30,7 @@ object TastyUnpickler {
 
 import TastyUnpickler.*
 
-class TastyUnpickler(reader: TastyReader) {
+class TastyUnpickler(protected val reader: TastyReader) {
   import reader.*
 
   def this(bytes: Array[Byte]) = this(new TastyReader(bytes))
@@ -88,17 +90,21 @@ class TastyUnpickler(reader: TastyReader) {
     result
   }
 
-  new TastyHeaderUnpickler(reader).readHeader()
+  val header: TastyHeader = new TastyHeaderUnpickler(reader).readFullHeader()
 
-  locally {
+  def readNames(): Unit =
     until(readEnd()) { nameAtRef.add(readNameContents()) }
+
+  def loadSections(): Unit = {
     while (!isAtEnd) {
       val secName = readString()
       val secEnd = readEnd()
       sectionReader(secName) = new TastyReader(bytes, currentAddr.index, secEnd.index, currentAddr.index)
       goto(secEnd)
     }
   }
+  readNames()
+  loadSections()
 
   def unpickle[R](sec: SectionUnpickler[R]): Option[R] =
     for (reader <- sectionReader.get(sec.name)) yield

project/scripts/cmdTests

@@ -27,7 +27,7 @@ echo "testing sbt scalac -print-tasty"
 clear_out "$OUT"
 "$SBT" ";scalac $SOURCE -d $OUT ;scalac -print-tasty -color:never $TASTY" > "$tmp"
 grep -qe "0: ASTs" "$tmp"
-grep -qe "0: tests/pos/HelloWorld.scala" "$tmp"
+grep -qe "0: 41 \[tests/pos/HelloWorld.scala\]" "$tmp"
 
 echo "testing that paths SourceFile annotations are relativized"
 clear_out "$OUT"