Merge pull request scala#10807 from som-snytt/scaladoc/phases

Restore plugins to Scaladoc

Author: lrytz

src/compiler/scala/tools/nsc/Global.scala

@@ -735,7 +735,7 @@ class Global(var currentSettings: Settings, reporter0: Reporter)
 
   protected def computePlatformPhases() = platform.platformPhases.foreach(p => addToPhasesSet(p, otherPhaseDescriptions(p.phaseName)))
 
-  // sequences the phase assembly
+  // compute the order in which phases will run; subclasses may override the template methods used here.
   protected def computePhaseDescriptors: List[SubComponent] = {
     /* Allow phases to opt out of the phase assembly. */
     def cullPhases(phases: List[SubComponent]) = {

src/scaladoc/scala/tools/nsc/ScalaDoc.scala

@@ -41,11 +41,11 @@ class ScalaDoc {
     else if (docSettings.showPlugins.value)
       reporter.warning(null, "Plugins are not available when using Scaladoc")
     else if (docSettings.showPhases.value)
-      reporter.warning(null, "Phases are restricted when using Scaladoc")
+      reporter.warning(null, s"Phases are restricted when using Scaladoc.\n${new DocFactory(reporter, docSettings).compiler.phaseDescriptions}")
     else if (docSettings.help.value || !hasFiles)
       reporter.echo(command.usageMsg)
     else
-      try { new DocFactory(reporter, docSettings) document command.files }
+      try new DocFactory(reporter, docSettings).document(command.files)
       catch {
         case ex @ FatalError(msg) =>
           if (docSettings.isDebug) ex.printStackTrace()

src/scaladoc/scala/tools/nsc/doc/DocParser.scala

@@ -15,6 +15,7 @@ package nsc
 package doc
 
 import scala.reflect.internal.util._
+import scala.tools.nsc.backend.JavaPlatform
 import scala.tools.nsc.doc.DocParser.Parsed
 import scala.tools.nsc.reporters.{ConsoleReporter, Reporter}
 
@@ -23,18 +24,24 @@ import scala.tools.nsc.reporters.{ConsoleReporter, Reporter}
  *  otherwise cause the compiler to go haywire.
  */
 class DocParser(settings: nsc.Settings, reporter: Reporter) extends Global(settings, reporter) with ScaladocGlobalTrait {
+  self =>
   def this(settings: Settings) = this(settings, new ConsoleReporter(settings))
   def this() = this(new Settings(Console println _))
 
   // the usual global initialization
   locally { new Run() }
 
-  override protected def computePhaseDescriptors: List[SubComponent] = {
-    assert(phasesSet.isEmpty, "Scaladoc limits available phases")
+  override protected def computeInternalPhases(): Unit = {
     phasesSet += syntaxAnalyzer
     phasesSet += terminal
-    computePhaseAssembly()
   }
+  override protected def computePluginPhases(): Unit = ()
+
+  override lazy val platform: ThisPlatform =
+    new JavaPlatform {
+      lazy val global: self.type = self
+      override def platformPhases = Nil // used by computePlatformPhases
+    }
 
   /** Returns a list of `DocParser.Parseds`, which hold the DocDefs found
    *  in the given code along with the surrounding trees.

src/scaladoc/scala/tools/nsc/doc/ScaladocGlobal.scala

@@ -13,6 +13,7 @@
 package scala.tools.nsc
 package doc
 
+import scala.tools.nsc.backend.JavaPlatform
 import scala.tools.nsc.reporters.Reporter
 import scala.tools.nsc.typechecker.MacroAnnotationNamers
 
@@ -47,15 +48,44 @@ trait ScaladocGlobalTrait extends Global {
 
 // takes a `Reporter`, not `FilteringReporter` for sbt compatibility
 class ScaladocGlobal(settings: doc.Settings, reporter: Reporter) extends Global(settings, reporter) with ScaladocGlobalTrait {
-  override protected def computePhaseDescriptors: List[SubComponent] = {
-    assert(phasesSet.isEmpty, "Scaladoc limits available phases")
+  self =>
+  override protected def computeInternalPhases(): Unit = {
     phasesSet += syntaxAnalyzer
     phasesSet += analyzer.namerFactory
     phasesSet += analyzer.packageObjects
     phasesSet += analyzer.typerFactory
+    phasesSet += patmatSentinel
+    phasesSet += erasureSentinel
     phasesSet += terminal
-    computePhaseAssembly()
   }
+
+  override lazy val platform: ThisPlatform =
+    new JavaPlatform {
+      lazy val global: self.type = self
+      override def platformPhases = Nil // used by computePlatformPhases
+    }
+
+  // Placeholders for plugins who wish to declare runsBefore patmat or erasure.
+  // A bit deceptive for plugins that run after them, as scaladoc ought to -Ystop-before:patmat
+  lazy val patmatSentinel: SubComponent = new { val global = self } with SubComponent {
+    val phaseName = "patmat"
+    val runsAfter = "typer" :: Nil
+    val runsRightAfter = None
+    def newPhase(prev: Phase): Phase = new Phase(prev) {
+      val name = phaseName
+      def run() = ()
+    }
+  }
+  lazy val erasureSentinel: SubComponent = new { val global = self } with SubComponent {
+    val phaseName = "erasure"
+    val runsAfter = "patmat" :: Nil
+    val runsRightAfter = None
+    def newPhase(prev: Phase): Phase = new Phase(prev) {
+      val name = phaseName
+      def run() = ()
+    }
+  }
+
   override def createJavadoc = if (settings.docNoJavaComments.value) false else true
 
   override lazy val analyzer =