split Plugin to ResearchPlugin & StandardPlugin

Author: liufengyun

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

@@ -16,7 +16,7 @@ trait PluginPhase extends MiniPhase {
   def runsBefore: Set[Class[_ <: Phase]] = Set.empty
 }
 
-trait Plugin {
+sealed trait Plugin {
   /** The name of this plugin */
   def name: String
 
@@ -28,36 +28,34 @@ 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.
    */
-  def research: Boolean = false
+  def research: Boolean = isInstanceOf[ResearchPlugin]
 
+  /** A description of this plugin's options, suitable as a response
+   *  to the -help command-line option.  Conventionally, the options
+   *  should be listed with the `-P:plugname:` part included.
+   */
+  val optionsHelp: Option[String] = None
+}
 
+trait StandardPlugin extends Plugin {
   /** Non-research plugins should override this method to return the phases
    *
    *  @param options: commandline options to the plugin, `-P:plugname:opt1,opt2` becomes List(opt1, opt2)
    *  @return a list of phases to be added to the phase plan
    */
-  def init(options: List[String]): List[PluginPhase] = ???
+  def init(options: List[String]): List[PluginPhase]
+}
 
+trait ResearchPlugin extends Plugin {
   /** Research plugins should override this method to return the new phase plan
    *
    *  @param options: commandline options to the plugin, `-P:plugname:opt1,opt2` becomes List(opt1, opt2)
    *  @param plan: the given phase plan
    *  @return the new phase plan
    */
-  def init(options: List[String], plan: List[List[Phase]])(implicit ctx: Context): List[List[Phase]] = ???
-
-  /** A description of this plugin's options, suitable as a response
-   *  to the -help command-line option.  Conventionally, the options
-   *  should be listed with the `-P:plugname:` part included.
-   */
-  val optionsHelp: Option[String] = None
+  def init(options: List[String], plan: List[List[Phase]])(implicit ctx: Context): List[List[Phase]]
 }
 
-/** ...
- *
- *  @author Lex Spoon
- *  @version 1.0, 2007-5-21
- */
 object Plugin {
 
   private val PluginXML = "scalac-plugin.xml"
@@ -72,21 +70,6 @@ object Plugin {
     new java.net.URLClassLoader(urls.toArray, compilerLoader)
   }
 
-  /** Try to load a plugin description from the specified location.
-   */
-  private def loadDescriptionFromJar(jarp: Path): Try[PluginDescription] = {
-    // XXX Return to this once we have more ARM support
-    def read(is: InputStream) =
-      if (is == null) throw new PluginLoadException(jarp.path, s"Missing $PluginXML in $jarp")
-      else PluginDescription.fromXML(is)
-
-    val xmlEntry = new java.util.jar.JarEntry(PluginXML)
-    Try(read(new Jar(jarp.jpath.toFile).getEntryStream(xmlEntry)))
-  }
-
-  private def loadDescriptionFromFile(f: Path): Try[PluginDescription] =
-    Try(PluginDescription.fromXML(new java.io.FileInputStream(f.jpath.toFile)))
-
   type AnyClass = Class[_]
 
   /** Use a class loader to load the plugin class.
@@ -115,6 +98,20 @@ object Plugin {
     dirs: List[Path],
     ignoring: List[String]): List[Try[AnyClass]] =
   {
+
+    def loadDescriptionFromDir(f: Path): Try[PluginDescription] =
+      Try(PluginDescription.fromXML(new java.io.FileInputStream((f / PluginXML).jpath.toFile)))
+
+    def loadDescriptionFromJar(jarp: Path): Try[PluginDescription] = {
+      // XXX Return to this once we have more ARM support
+      def read(is: InputStream) =
+        if (is == null) throw new PluginLoadException(jarp.path, s"Missing $PluginXML in $jarp")
+        else PluginDescription.fromXML(is)
+
+      val xmlEntry = new java.util.jar.JarEntry(PluginXML)
+      Try(read(new Jar(jarp.jpath.toFile).getEntryStream(xmlEntry)))
+    }
+
     // List[(jar, Try(descriptor))] in dir
     def scan(d: Directory) =
       d.files.toList sortBy (_.name) filter (Jar isJarOrZip _) map (j => (j, loadDescriptionFromJar(j)))
@@ -134,7 +131,7 @@ object Plugin {
       def loop(qs: List[Path]): Try[PluginDescription] = qs match {
         case Nil       => Failure(new MissingPluginException(ps))
         case p :: rest =>
-          if (p.isDirectory) loadDescriptionFromFile(p.toDirectory / PluginXML) orElse loop(rest)
+          if (p.isDirectory) loadDescriptionFromDir(p.toDirectory) orElse loop(rest)
           else if (p.isFile) loadDescriptionFromJar(p.toFile) orElse loop(rest)
           else loop(rest)
       }

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

@@ -128,11 +128,11 @@ trait Plugins {
     }
 
     // schedule plugins according to ordering constraints
-    val pluginPhases = plugins.filter(!_.research).flatMap(plug => plug.init(options(plug)))
+    val pluginPhases = plugins.collect { case p: StandardPlugin => p }.flatMap { plug => plug.init(options(plug)) }
     val updatedPlan = Plugins.schedule(plan, pluginPhases)
 
     // add research plugins
-    plugins.filter(_.research).foldRight(updatedPlan) { (plug, plan) => plug.init(options(plug), plan) }
+    plugins.collect { case p: ResearchPlugin => p }.foldRight(updatedPlan) { (plug, plan) => plug.init(options(plug), plan) }
   }
 }
 

sbt-dotty/sbt-test/sbt-dotty/compiler-plugin/plugin/DivideZero.scala

@@ -3,7 +3,7 @@ package dividezero
 import dotty.tools.dotc._
 import core._
 import Contexts.Context
-import plugins.{Plugin, PluginPhase}
+import plugins._
 import Phases.Phase
 import ast.tpd
 import transform.MegaPhase.MiniPhase
@@ -12,7 +12,7 @@ import Symbols.Symbol
 import Constants.Constant
 import transform.{LinkAll, Pickler}
 
-class DivideZero extends PluginPhase with Plugin {
+class DivideZero extends PluginPhase with StandardPlugin {
   val name: String = "divideZero"
   override val description: String = "divide zero check"
 

sbt-dotty/sbt-test/sbt-dotty/compiler-plugin/project/build.properties

@@ -1 +1 @@
-sbt.version=0.13.15
+sbt.version=0.13.17

tests/plugins/neg/divideZero-research/plugin_1.scala

@@ -1,7 +1,7 @@
 import dotty.tools.dotc._
 import core._
 import Contexts.Context
-import plugins.Plugin
+import plugins._
 import Phases.Phase
 import ast.tpd
 import transform.MegaPhase.MiniPhase
@@ -10,12 +10,10 @@ import Symbols.Symbol
 import Constants.Constant
 import StdNames._
 
-class DivideZero extends MiniPhase with Plugin {
+class DivideZero extends MiniPhase with ResearchPlugin {
   val name: String = "divideZero"
   override val description: String = "divide zero check"
 
-  override val research = true
-
   val phaseName = name
 
   override def init(options: List[String], phases: List[List[Phase]])(implicit ctx: Context): List[List[Phase]] = {

tests/plugins/neg/divideZero/plugin_1.scala

@@ -1,7 +1,7 @@
 import dotty.tools.dotc._
 import core._
 import Contexts.Context
-import plugins.{Plugin, PluginPhase}
+import plugins._
 import Phases.Phase
 import ast.tpd
 import transform.MegaPhase.MiniPhase
@@ -11,7 +11,7 @@ import Constants.Constant
 import transform.{LinkAll, Pickler}
 import StdNames._
 
-class DivideZero extends PluginPhase with Plugin {
+class DivideZero extends PluginPhase with StandardPlugin {
   val name: String = "divideZero"
   override val description: String = "divide zero check"