Copy TastyInspector into scaladoc

Author: nicolasstucki

scaladoc/src/scala/tasty/inspector/Inspector.scala

@@ -0,0 +1,33 @@
+// Copy of tasty-inspector/src/scala/tasty/inspector/Inspector.scala
+// FIXME remove this copy of the file
+
+package scala.tasty.inspector
+
+import scala.quoted._
+import scala.quoted.runtime.impl.QuotesImpl
+
+import dotty.tools.dotc.Compiler
+import dotty.tools.dotc.Driver
+import dotty.tools.dotc.Run
+import dotty.tools.dotc.core.Contexts.Context
+import dotty.tools.dotc.core.Mode
+import dotty.tools.dotc.core.Phases.Phase
+import dotty.tools.dotc.fromtasty._
+import dotty.tools.dotc.util.ClasspathFromClassloader
+import dotty.tools.dotc.CompilationUnit
+import dotty.tools.unsupported
+import dotty.tools.dotc.report
+
+import java.io.File.pathSeparator
+
+trait Inspector:
+
+  /** Inspect all TASTy files using `Quotes` reflect API.
+   *
+   *  Note: Within this method `quotes.reflect.SourceFile.current` will not work, hence the explicit source paths.
+   *
+   *  @param tastys List of `Tasty` containing `.tasty`file path and AST
+   */
+  def inspect(using Quotes)(tastys: List[Tasty[quotes.type]]): Unit
+
+end Inspector

scaladoc/src/scala/tasty/inspector/Tasty.scala

@@ -0,0 +1,20 @@
+// Copy of tasty-inspector/src/scala/tasty/inspector/Tasty.scala
+// FIXME remove this copy of the file
+
+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

scaladoc/src/scala/tasty/inspector/TastyInspector.scala

@@ -0,0 +1,126 @@
+// Copy of tasty-inspector/src/scala/tasty/inspector/TastyInspector.scala
+// FIXME remove this copy of the file
+
+package scala.tasty.inspector
+
+import scala.quoted._
+import scala.quoted.runtime.impl.QuotesImpl
+
+import dotty.tools.dotc.Compiler
+import dotty.tools.dotc.Driver
+import dotty.tools.dotc.Run
+import dotty.tools.dotc.core.Contexts.Context
+import dotty.tools.dotc.core.Mode
+import dotty.tools.dotc.core.Phases.Phase
+import dotty.tools.dotc.fromtasty._
+import dotty.tools.dotc.quoted.QuotesCache
+import dotty.tools.dotc.util.ClasspathFromClassloader
+import dotty.tools.dotc.CompilationUnit
+import dotty.tools.unsupported
+import dotty.tools.dotc.report
+
+import java.io.File.pathSeparator
+
+object TastyInspector:
+
+  /** Load and process TASTy files using TASTy reflect
+   *
+   *  @param tastyFiles List of paths of `.tasty` files
+   *
+   *  @return boolean value indicating whether the process succeeded
+   */
+  def inspectTastyFiles(tastyFiles: List[String])(inspector: Inspector): Boolean =
+    inspectAllTastyFiles(tastyFiles, Nil, Nil)(inspector)
+
+  /** Load and process TASTy files in a `jar` file using TASTy reflect
+   *
+   *  @param jars Path of `.jar` file
+   *
+   *  @return boolean value indicating whether the process succeeded
+   */
+  def inspectTastyFilesInJar(jar: String)(inspector: Inspector): Boolean =
+    inspectAllTastyFiles(Nil, List(jar), Nil)(inspector)
+
+  /** Load and process TASTy files using TASTy reflect
+   *
+   *  @param tastyFiles List of paths of `.tasty` files
+   *  @param jars List of path of `.jar` files
+   *  @param dependenciesClasspath Classpath with extra dependencies needed to load class in the `.tasty` files
+   *
+   *  @return boolean value indicating whether the process succeeded
+   */
+  def inspectAllTastyFiles(tastyFiles: List[String], jars: List[String], dependenciesClasspath: List[String])(inspector: Inspector): Boolean =
+    def checkFile(fileName: String, ext: String): Unit =
+      val file = dotty.tools.io.Path(fileName)
+      if file.extension != ext then
+        throw new IllegalArgumentException(s"File extension is not `.$ext`: $file")
+      else if !file.exists then
+        throw new IllegalArgumentException(s"File not found: ${file.toAbsolute}")
+    tastyFiles.foreach(checkFile(_, "tasty"))
+    jars.foreach(checkFile(_, "jar"))
+    val files = tastyFiles ::: jars
+    inspectFiles(dependenciesClasspath, files)(inspector)
+
+  private def inspectorDriver(inspector: Inspector) =
+    class InspectorDriver extends Driver:
+      override protected def newCompiler(implicit ctx: Context): Compiler = new TastyFromClass
+
+    class TastyInspectorPhase extends Phase:
+      override def phaseName: String = "tastyInspector"
+
+      override def runOn(units: List[CompilationUnit])(using ctx0: Context): List[CompilationUnit] =
+        val ctx = QuotesCache.init(ctx0.fresh)
+        runOnImpl(units)(using ctx)
+
+      private def runOnImpl(units: List[CompilationUnit])(using Context): List[CompilationUnit] =
+        val quotesImpl = QuotesImpl()
+        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
+
+      override def run(implicit ctx: Context): Unit = unsupported("run")
+    end TastyInspectorPhase
+
+    class TastyFromClass extends TASTYCompiler:
+
+      override protected def frontendPhases: List[List[Phase]] =
+        List(new ReadTasty) :: // Load classes from tasty
+        Nil
+
+      override protected def picklerPhases: List[List[Phase]] = Nil
+
+      override protected def transformPhases: List[List[Phase]] = Nil
+
+      override protected def backendPhases: List[List[Phase]] =
+        List(new TastyInspectorPhase) ::  // Perform a callback for each compilation unit
+        Nil
+
+      override def newRun(implicit ctx: Context): Run =
+        reset()
+        val ctx2 = ctx.fresh
+            .addMode(Mode.ReadPositions)
+            .setSetting(ctx.settings.YreadComments, true)
+        new TASTYRun(this, ctx2)
+
+    new InspectorDriver
+
+  private def inspectorArgs(classpath: List[String], classes: List[String]): Array[String] =
+    val currentClasspath = ClasspathFromClassloader(getClass.getClassLoader)
+    val fullClasspath = (classpath :+ currentClasspath).mkString(pathSeparator)
+    ("-from-tasty" :: "-Yretain-trees" :: "-classpath" :: fullClasspath :: classes).toArray
+
+
+  private def inspectFiles(classpath: List[String], classes: List[String])(inspector: Inspector): Boolean =
+    classes match
+      case Nil => true
+      case _ =>
+        val reporter = inspectorDriver(inspector).process(inspectorArgs(classpath, classes))
+        !reporter.hasErrors
+
+  end inspectFiles
+
+
+end TastyInspector