elide base index of sections

Author: bishabosha

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

@@ -97,10 +97,14 @@ class TastyPrinter(bytes: Array[Byte], val testPickler: Boolean) {
       sb.append("  tooling: ").append(header.toolingVersion).append("\n")
       sb.append("     UUID: ").append(header.uuid).append("\n")
     end if
-    sb.append("\n")
 
   private def printNames(sb: StringBuilder)(using refs: NameRefs): Unit =
-    sb.append(s"Names (${unpickler.namesEnd.index - unpickler.namesStart.index} bytes, starting from ${unpickler.namesStart.index}):\n")
+    sb.append(sectionHeader(
+      name = "Names",
+      count = (unpickler.namesEnd.index - unpickler.namesStart.index).toString,
+      base = showBase(unpickler.namesStart.index),
+      lineEnd = true
+    ))
     for ((name, idx) <- nameAtRef.contents.zipWithIndex) {
       val index = nameStr("%6d".format(idx))
       sb.append(index).append(": ").append(refs.nameRefToString(NameRef(idx))).append("\n")
@@ -187,19 +191,20 @@ class TastyPrinter(bytes: Array[Byte], val testPickler: Boolean) {
           }
         indent -= 2
       }
-      sb.append(s"\n\nTrees (${endAddr.index - startAddr.index} bytes, starting from $base):")
+      sb.append(sectionHeader("Trees", reader, lineEnd = false))
       while (!isAtEnd) {
         printTree()
         newLine()
       }
+      sb.append("\n")
     }
   }
 
   class PositionSectionUnpickler(sb: StringBuilder) extends PrinterSectionUnpickler[Unit](PositionsSection) {
     def unpickle0(reader: TastyReader)(using tastyName: NameRefs): Unit = {
       import reader.*
       val posUnpickler = new PositionUnpickler(reader, tastyName)
-      sb.append(s"\n\nPositions (${reader.endAddr.index - reader.startAddr.index} bytes, starting from $base):\n")
+      sb.append(sectionHeader("Positions", reader))
       val lineSizes = posUnpickler.lineSizes
       sb.append(s"  lines: ${lineSizes.length}\n")
       sb.append(s"  line sizes:\n")
@@ -232,7 +237,7 @@ class TastyPrinter(bytes: Array[Byte], val testPickler: Boolean) {
       import reader.*
       val comments = new CommentUnpickler(reader).comments
       if !comments.isEmpty then
-        sb.append(s"\n\nComments (${reader.endAddr.index - reader.startAddr.index} bytes, starting from $base):\n")
+        sb.append(sectionHeader("Comments", reader))
         val sorted = comments.toSeq.sortBy(_._1.index)
         for ((addr, cmt) <- sorted) {
           sb.append(treeStr("%6d".format(addr.index)))
@@ -245,7 +250,7 @@ class TastyPrinter(bytes: Array[Byte], val testPickler: Boolean) {
     import dotty.tools.tasty.TastyFormat.*
     def unpickle0(reader: TastyReader)(using nameAtRef: NameRefs): Unit = {
       import reader.*
-      sb.append(s"\n\nAttributes (${reader.endAddr.index - reader.startAddr.index} bytes, starting from $base):\n")
+      sb.append(sectionHeader("Attributes", reader))
       while !isAtEnd do
         // TODO: Should we elide attributes under testPickler? (i.e.
         //   if we add new attributes many check files will need to be updated)
@@ -290,6 +295,17 @@ class TastyPrinter(bytes: Array[Byte], val testPickler: Boolean) {
     }
   }
 
+  private final def showBase(index: Int): String =
+    if testPickler then "<elided base index>" else index.toString()
+
+  private final def sectionHeader(name: String, reader: TastyReader, lineEnd: Boolean = true): String =
+    val count = reader.endAddr.index - reader.startAddr.index
+    sectionHeader(name, count.toString, {showBase(reader.base)}, lineEnd)
+
+  private final def sectionHeader(name: String, count: String, base: String, lineEnd: Boolean): String =
+    val suffix = if lineEnd then "\n" else ""
+    s"\n$name ($count bytes, starting from $base):$suffix"
+
   abstract class PrinterSectionUnpickler[T](val name: String) {
     def unpickle0(reader: TastyReader)(using refs: NameRefs): T
   }

compiler/src/dotty/tools/dotc/transform/Pickler.scala

@@ -305,21 +305,21 @@ class Pickler extends Phase {
   end testSame
 
   private def testSamePrinted(printed: String, checkContents: String, cls: ClassSymbol, check: AbstractFile)(using Context): Unit = {
-    if hasDiff(printed, checkContents) then
+    for lines <- diff(printed, checkContents) do
       output("after-printing.txt", printed)
       report.error(em"""TASTy printer difference for $cls in ${cls.source}, did not match ${check},
-                    |  output dumped in after-printing.txt, check diff with `git diff --no-index -- after-printing.txt ${check}`
+                    |  output dumped in after-printing.txt, check diff with `git diff --no-index -- $check after-printing.txt`
                     |  actual output:
-                    |$printed""")
+                    |$lines%\n%""")
   }
 
   /** Reuse diff logic from compiler/test/dotty/tools/vulpix/FileDiff.scala */
-  private def hasDiff(actual: String, expect: String): Boolean =
+  private def diff(actual: String, expect: String): Option[Seq[String]] =
     import scala.util.Using
     import scala.io.Source
     val actualLines = Using(Source.fromString(actual))(_.getLines().toList).get
     val expectLines = Using(Source.fromString(expect))(_.getLines().toList).get
-    !matches(actualLines, expectLines)
+    Option.when(!matches(actualLines, expectLines))(actualLines)
 
   private def matches(actual: String, expect: String): Boolean = {
     import java.io.File

tests/pos/i19806/J.tastycheck

@@ -3,7 +3,7 @@ Header:
   tooling: <elided>
      UUID: <elided>
 
-Names (217 bytes, starting from 80):
+Names (217 bytes, starting from <elided base index>):
      0: ASTs
      1: p
      2: J
@@ -31,8 +31,7 @@ Names (217 bytes, starting from 80):
     24: Comments
     25: Attributes
 
-
-Trees (145 bytes, starting from 300):
+Trees (145 bytes, starting from <elided base index>):
      0: PACKAGE(142)
      3:   TERMREFpkg 1 [p]
      5:   VALDEF(11) 2 [J]
@@ -113,7 +112,7 @@ Trees (145 bytes, starting from 300):
    143:           SHAREDtype 38
    145:
 
-Positions (145 bytes, starting from 448):
+Positions (145 bytes, starting from <elided base index>):
   lines: 23
   line sizes:
      10, 0, 19, 0, 15, 0, 35, 29, 3, 0, 36, 29, 3, 0, 52, 41, 3, 0, 53, 41
@@ -154,8 +153,7 @@ Positions (145 bytes, starting from 448):
   source paths:
      0: 23 [<elided source file name>]
 
-
-Attributes (4 bytes, starting from 597):
+Attributes (4 bytes, starting from <elided base index>):
   JAVAattr
   OUTLINEattr
   SOURCEFILEattr 23 [<elided source file name>]