Add an interface for Tasty loaded in the inspector

Author: nicolasstucki

docs/docs/reference/metaprogramming/tasty-inspect.md

@@ -10,7 +10,7 @@ libraryDependencies += "org.scala-lang" %% "scala3-tasty-inspector" % scalaVersi
 TASTy files contain the full typed tree of a class including source positions
 and documentation. This is ideal for tools that analyze or extract semantic
 information from the code. To avoid the hassle of working directly with the TASTy
-file we provide the `TastyInspector` which loads the contents and exposes it
+file we provide the `Inspector` which loads the contents and exposes it
 through the TASTy reflect API.
 
 ## Inspecting TASTy files
@@ -21,18 +21,22 @@ To inspect the trees of a TASTy file a consumer can be defined in the following
 import scala.quoted._
 import scala.tasty.inspector._
 
-class MyInspector extends TastyInspector with
-   protected def processCompilationUnit(using Quotes)(tree: quotes.reflect.Tree): Unit =
+class MyInspector extends Inspector with
+    def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit =
       import quotes.reflect._
-      // Do something with the tree
+      for tasty <- tastys do
+        val tree = tasty.ast
+        // Do something with the tree
 ```
 
 Then the consumer can be instantiated with the following code to get the tree of the `foo/Bar.tasty` file.
 
 ```scala
 object Test with
    def main(args: Array[String]): Unit =
-      new MyInspector().inspectTastyFiles("foo/Bar.tasty")
+      val tastyFiles = List("foo/Bar.tasty")
+      TastyInspector.inspectTastyFiles(tastyFiles)(new MyInspector)
+
 ```
 
 Note that if we need to run the main (in the example below defined in an object called `Test`) after compilation we need to make the compiler available to the runtime:

sbt-dotty/sbt-test/sbt-dotty/tasty-inspector-example-project/app/Main.scala

@@ -10,9 +10,9 @@ import java.nio.file.{Path, Files, Paths, FileSystems}
 object Main extends App {
 
   val inspector = new Inspector {
-    def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit = {
-      for (_, tree) <- tastys do
-        val tastyStr = tree.show
+    def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit = {
+      for tasty <- tastys do
+        val tastyStr = tasty.ast.show
         println(tastyStr)
 
     }

stdlib-bootstrapped-tasty-tests/test/BootstrappedStdLibTASYyTest.scala

@@ -103,9 +103,9 @@ object BootstrappedStdLibTASYyTest with
 
   def loadWithTastyInspector(blacklisted: Set[String]): Unit =
     val inspector = new scala.tasty.inspector.Inspector {
-      def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit =
-        for (_, tree) <- tastys do
-          tree.show(using quotes.reflect.Printer.TreeStructure) // Check that we can traverse the full tree
+      def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit =
+        for tasty <- tastys do
+          tasty.ast.show(using quotes.reflect.Printer.TreeStructure) // Check that we can traverse the full tree
         ()
     }
     val tastyFiles = scalaLibTastyPaths.filterNot(blacklisted)

tasty-inspector/src/scala/tasty/inspector/Inspector.scala

@@ -23,8 +23,8 @@ trait Inspector:
    *
    *  Note: Within this method `quotes.reflect.SourceFile.current` will not work, hence the explicit source paths.
    *
-   *  @param tastys List of tuples containing the path of the `.tasty` and the AST within the file.
+   *  @param tastys List of `Tasty` containing `.tasty`file path and AST
    */
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit
 
 end Inspector

tasty-inspector/src/scala/tasty/inspector/Tasty.scala

@@ -0,0 +1,17 @@
+package scala.tasty.inspector
+
+import scala.quoted._
+
+/** `.tasty` file representation containing file path and the AST */
+trait Tasty[Q <: Quotes & Singleton]:
+
+  /** Instance of `Quotes` used to load the AST */
+  val quotes: Q
+
+  /** Path to the `.tasty` file */
+  def path: String
+
+  /** Abstract Syntax Tree contained in the `.tasty` file */
+  def ast: quotes.reflect.Tree
+
+end Tasty

tasty-inspector/src/scala/tasty/inspector/TastyInspector.scala

@@ -60,7 +60,10 @@ object TastyInspector:
 
       override def runOn(units: List[CompilationUnit])(using Context): List[CompilationUnit] =
         val quotesImpl = QuotesImpl()
-        val tastys = units.map(unit => (unit.source.path , unit.tpdTree.asInstanceOf[quotesImpl.reflect.Tree]))
+        class TastyImpl(val path: String, val ast: quotesImpl.reflect.Tree) extends Tasty[quotesImpl.type] {
+          val quotes = quotesImpl
+        }
+        val tastys = units.map(unit => new TastyImpl(unit.source.path , unit.tpdTree.asInstanceOf[quotesImpl.reflect.Tree]))
         inspector.inspect(using quotesImpl)(tastys)
         units
 

tests/run-custom-args/tasty-inspector/i10359.scala

@@ -35,13 +35,13 @@ object Test {
 
 class TestInspector() extends Inspector with
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit =
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit =
     import quotes.reflect._
 
-    for (_, root) <- tastys do
-      val code = root.show
+    for tasty <- tastys do
+      val code = tasty.ast.show
       assert(code.contains("import Foo.this.g.{given}"), code)
       assert(code.contains("import Foo.this.g.{given scala.Int}"), code)
 
-      val extractors = root.show(using Printer.TreeStructure)
+      val extractors = tasty.ast.show(using Printer.TreeStructure)
       assert(extractors.contains("GivenSelector"), extractors)

tests/run-custom-args/tasty-inspector/i8163.scala

@@ -22,9 +22,9 @@ object Test {
 
 class TestInspector() extends Inspector with
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit =
-    for (_, tree) <- tastys do
-      inspectClass(tree)
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit =
+    for tasty <- tastys do
+      inspectClass(tasty.ast)
 
   private def inspectClass(using Quotes)(tree: quotes.reflect.Tree): Unit =
     import quotes.reflect._

tests/run-custom-args/tasty-inspector/i8364.scala

@@ -3,9 +3,9 @@ import scala.tasty.inspector._
 
 @main def Test = {
   val inspector = new Inspector {
-    def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit = {
-      for (_, tree) <- tastys do
-        tree.show(using quotes.reflect.Printer.TreeStructure) // Make sure that tree is loaded and can be traveresed
+    def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit = {
+      for tasty <- tastys do
+        tasty.ast.show(using quotes.reflect.Printer.TreeStructure) // Make sure that tree is loaded and can be traveresed
     }
   }
 

tests/run-custom-args/tasty-inspector/i8389.scala

@@ -10,9 +10,9 @@ import scala.tasty.inspector._
 
   // in dotty-example-project
   val inspector = new Inspector {
-    def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit = {
-      for (_, tree) <- tastys do
-        println(tree.show)
+    def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit = {
+      for tasty <- tastys do
+        println(tasty.ast.show)
     }
   }
   TastyInspector.inspectTastyFiles(tastyFiles)(inspector)

tests/run-custom-args/tasty-inspector/i8460.scala

@@ -37,9 +37,9 @@ class TestInspector_Children() extends Inspector with
 
   var kids: List[String] = Nil
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit = {
-    for (_, tree) <- tastys do
-      inspectClass(tree)
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit = {
+    for tasty <- tastys do
+      inspectClass(tasty.ast)
   }
 
   private def inspectClass(using Quotes)(tree: quotes.reflect.Tree): Unit =

tests/run-custom-args/tasty-inspector/i9970.scala

@@ -48,7 +48,7 @@ object Test {
 
 class TestInspector() extends Inspector with
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit =
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit =
     var foundIOApp: Boolean = false
     var foundSimple: Boolean = false
 
@@ -80,10 +80,10 @@ class TestInspector() extends Inspector with
 
         case _ =>
 
-    for (_, tree) <- tastys do
+    for tasty <- tastys do
       foundIOApp = false
       foundSimple = false
-      inspectClass(tree)
+      inspectClass(tasty.ast)
       // Sanity check to make sure that our pattern matches are not simply glossing over the things we want to test
       assert(foundIOApp, "the inspector did not encounter IOApp")
       assert(foundSimple, "the inspect did not encounter IOApp.Simple")

tests/run-custom-args/tasty-inspector/tasty-documentation-inspector/Test.scala

@@ -15,7 +15,7 @@ object Test {
 
 class DocumentationInspector extends Inspector {
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit = {
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit = {
 
     import quotes.reflect._
     object Traverser extends TreeTraverser {
@@ -32,8 +32,8 @@ class DocumentationInspector extends Inspector {
       }
 
     }
-    for (_, tree) <- tastys do
-      Traverser.traverseTree(tree)
+    for tasty <- tastys do
+      Traverser.traverseTree(tasty.ast)
   }
 
 }

tests/run-custom-args/tasty-inspector/tasty-inspector/Test.scala

@@ -15,7 +15,7 @@ object Test {
 
 class DBInspector extends Inspector {
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit = {
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit = {
     import quotes.reflect._
     object Traverser extends TreeTraverser {
 
@@ -28,8 +28,8 @@ class DBInspector extends Inspector {
       }
 
     }
-    for (_, tree) <- tastys do
-      Traverser.traverseTree(tree)
+    for tasty <- tastys do
+      Traverser.traverseTree(tasty.ast)
   }
 
 }

tests/run-custom-args/tasty-inspector/tastyPaths.scala

@@ -22,8 +22,8 @@ object Test {
 
 class TestInspector() extends Inspector:
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit =
-    println(tastys.map(_._1.split("/tasty-inspector/").last))
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit =
+    println(tastys.map(_.path.split("/tasty-inspector/").last))
     try
       quotes.reflect.SourceFile.current
       assert(false)

tests/run-custom-args/tasty-interpreter/interpreter/TastyInterpreter.scala

@@ -1,11 +1,11 @@
 package scala.tasty.interpreter
 
 import scala.quoted._
-import scala.tasty.inspector.Inspector
+import scala.tasty.inspector._
 
 class TastyInterpreter extends Inspector {
 
-  def inspect(using Quotes)(tastys: List[(String, quotes.reflect.Tree)]): Unit = {
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit = {
     import quotes.reflect._
 
     object Traverser extends TreeTraverser {
@@ -21,8 +21,8 @@ class TastyInterpreter extends Inspector {
       }
     }
 
-    for (_, tree) <- tastys do
-      Traverser.traverseTree(tree)(Symbol.spliceOwner)
+    for tasty <- tastys do
+      Traverser.traverseTree(tasty.ast)(Symbol.spliceOwner)
   }
 
 }