test symbol.defTree

Author: liufengyun

compiler/src/dotty/tools/dotc/plugins/Plugin.scala

@@ -28,6 +28,8 @@ sealed trait Plugin {
    *
    *  Research plugin receives a phase plan and return a new phase plan, while
    *  non-research plugin returns a list of phases to be inserted.
+   *
+   *  @note Research plugins only compile with nightly build.
    */
   def isResearch: Boolean = isInstanceOf[ResearchPlugin]
 

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/app/Hello.scala

@@ -0,0 +1,37 @@
+package hello
+
+import lib._
+
+class M(val n: Int) {
+  val a = 30 * n
+  class B(x: Int) {
+    val b = x * a
+    def bar(i: Int) = i * x
+  }
+
+  def foo(i: Int) = i * n
+
+  def bar = {
+    class C(val s: String)
+    val c = new C("hello")
+    def qux = c.s
+    qux
+  }
+}
+
+
+object Hello {
+  def testLib: Unit = {
+    val a = new A(30)
+    val b = new a.B(24)
+    a.foo(3)
+    b.bar(9)
+  }
+
+  def testHello: Unit = {
+    val a = new M(30)
+    val b = new a.B(24)
+    a.foo(3)
+    b.bar(9)
+  }
+}

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/build.sbt

@@ -0,0 +1,27 @@
+lazy val dottyVersion = sys.props("plugin.scalaVersion")
+
+lazy val plugin = project
+  .in(file("plugin"))
+  .settings(
+    name := "init-checker",
+    version := "0.0.1",
+    organization := "ch.epfl.lamp",
+    scalaVersion := dottyVersion,
+
+    libraryDependencies ++= Seq(
+      "ch.epfl.lamp" %% "dotty-compiler" % scalaVersion.value % "provided"
+    )
+  )
+
+lazy val lib = project
+  .in(file("lib"))
+  .settings(
+    scalaVersion := dottyVersion
+  )
+
+lazy val app = project
+  .in(file("app"))
+  .settings(
+    scalaVersion := dottyVersion
+  )
+  .dependsOn(lib)

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/changes/plugin.sbt

@@ -0,0 +1,28 @@
+lazy val dottyVersion = sys.props("plugin.scalaVersion")
+
+lazy val plugin = project
+  .in(file("plugin"))
+  .settings(
+    name := "init-checker",
+    version := "0.0.1",
+    organization := "ch.epfl.lamp",
+    scalaVersion := dottyVersion,
+
+    libraryDependencies ++= Seq(
+      "ch.epfl.lamp" %% "dotty-compiler" % scalaVersion.value % "provided"
+    )
+  )
+
+lazy val lib = project
+  .in(file("lib"))
+  .settings(
+    scalaVersion := dottyVersion
+  )
+
+lazy val app = project
+  .in(file("app"))
+  .settings(
+    scalaVersion := dottyVersion,
+    addCompilerPlugin("ch.epfl.lamp" %% "init-checker" % "0.0.1")
+  )
+  .dependsOn(lib)

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/changes/retain.sbt

@@ -0,0 +1,29 @@
+lazy val dottyVersion = sys.props("plugin.scalaVersion")
+
+lazy val plugin = project
+  .in(file("plugin"))
+  .settings(
+    name := "init-checker",
+    version := "0.0.1",
+    organization := "ch.epfl.lamp",
+    scalaVersion := dottyVersion,
+
+    libraryDependencies ++= Seq(
+      "ch.epfl.lamp" %% "dotty-compiler" % scalaVersion.value % "provided"
+    )
+  )
+
+lazy val lib = project
+  .in(file("lib"))
+  .settings(
+    scalaVersion := dottyVersion
+  )
+
+lazy val app = project
+  .in(file("app"))
+  .settings(
+    scalaVersion := dottyVersion,
+    scalacOptions += "-Yretain-trees",
+    addCompilerPlugin("ch.epfl.lamp" %% "init-checker" % "0.0.1")
+  )
+  .dependsOn(lib)

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/lib/Lib.scala

@@ -0,0 +1,11 @@
+package lib
+
+class A(val n: Int) {
+  val a = 30 * n
+  class B(x: Int) {
+    val b = x * a
+    def bar(i: Int) = i * x
+  }
+
+  def foo(i: Int) = i * n
+}

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/plugin/Analyzer.scala

@@ -0,0 +1,63 @@
+package analyzer
+
+import scala.language.implicitConversions
+
+import dotty.tools.dotc._
+import core._
+import Contexts.Context
+import plugins._
+import Phases.Phase
+import ast.tpd
+import transform.MegaPhase.MiniPhase
+import Decorators._
+import Symbols.Symbol
+import Constants.Constant
+import transform.{Pickler, Staging}
+
+class InitChecker extends PluginPhase with StandardPlugin {
+  import tpd._
+
+  val name: String = "initChecker"
+  override val description: String = "checks that under -Yretain-trees we may get tree for all symbols"
+
+  val phaseName = name
+
+  override val runsAfter = Set(Staging.name)
+  override val runsBefore = Set(Pickler.name)
+
+  def init(options: List[String]): List[PluginPhase] = this :: Nil
+
+  private def checkDef(tree: Tree)(implicit ctx: Context): Tree = {
+    val span = tree.symbol.defTree.span
+    if (!(span.exists && span.end > span.start))
+      ctx.error("cannot get tree for " + tree.symbol.show, tree.sourcePos)
+    tree
+  }
+
+  private def checkRef(tree: Tree)(implicit ctx: Context): Tree = {
+    val helloPkgSym = ctx.requiredPackage("hello")
+    val libPkgSym = ctx.requiredPackage("lib")
+    val enclosingPkg = tree.symbol.enclosingPackageClass
+
+    if (enclosingPkg == helloPkgSym) {  // source code
+      checkDef(tree)
+    }
+    else if (enclosingPkg == libPkgSym) { // tasty from library
+      checkDef(tree)
+      // check that all sub-definitions have trees set properly
+      transformAllDeep(tree.symbol.defTree)
+    }
+
+    tree
+  }
+
+  override def transformValDef(tree: ValDef)(implicit ctx: Context): Tree = checkDef(tree)
+
+  override def transformDefDef(tree: DefDef)(implicit ctx: Context): Tree = checkDef(tree)
+
+  override def transformTypeDef(tree: TypeDef)(implicit ctx: Context): Tree = checkDef(tree)
+
+  override def transformSelect(tree: Select)(implicit ctx: Context): Tree = checkRef(tree)
+
+  override def transformIdent(tree: Ident)(implicit ctx: Context): Tree = checkRef(tree)
+}

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/plugin/src/main/resources/plugin.properties

@@ -0,0 +1 @@
+pluginClass=analyzer.InitChecker

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("ch.epfl.lamp" % "sbt-dotty" % sys.props("plugin.version"))

sbt-dotty/sbt-test/sbt-dotty/analyzer-plugin/test

@@ -0,0 +1,17 @@
+# Should compile OK without the plugin
+> app/compile
+
+# Publish plugin locally
+> plugin/publishLocal
+
+# Should NOT compile with just the plugin
+$ copy-file changes/plugin.sbt build.sbt
+> reload
+> clean
+-> app/compile
+
+# Should compile with the plugin and -Yretain-trees
+$ copy-file changes/retain.sbt build.sbt
+> reload
+> clean
+> app/compile