Merge pull request #12372 from dotty-staging/fix-12352

Fix #12352: replace Mode.ReadComments with -Yread-comments

Author: liufengyun

compiler/src/dotty/tools/dotc/Driver.scala

@@ -82,7 +82,7 @@ class Driver {
     Positioned.init(using ictx)
 
     inContext(ictx) {
-      if !ctx.settings.YdropComments.value || ctx.mode.is(Mode.ReadComments) then
+      if !ctx.settings.YdropComments.value || ctx.settings.YreadComments.value then
         ictx.setProperty(ContextDoc, new ContextDocstrings)
       val fileNamesOrNone = command.checkUsage(summary, sourcesRequired)(using ctx.settings)(using ctx.settingsState)
       fileNamesOrNone.map { fileNames =>

compiler/src/dotty/tools/dotc/config/ScalaSettings.scala

@@ -179,6 +179,7 @@ trait AllScalaSettings extends CommonScalaSettings { self: Settings.SettingGroup
   val YcheckReentrant: Setting[Boolean] = BooleanSetting("-Ycheck-reentrant", "Check that compiled program does not contain vars that can be accessed from a global root.")
   val YdropComments: Setting[Boolean] = BooleanSetting("-Ydrop-docs", "Drop documentation when scanning source files.", aliases = List("-Ydrop-comments"))
   val YcookComments: Setting[Boolean] = BooleanSetting("-Ycook-docs", "Cook the documentation (type check `@usecase`, etc.)", aliases = List("-Ycook-comments"))
+  val YreadComments: Setting[Boolean] = BooleanSetting("-Yread-docs", "Read documentation from tasty.")
   val YforceSbtPhases: Setting[Boolean] = BooleanSetting("-Yforce-sbt-phases", "Run the phases used by sbt for incremental compilation (ExtractDependencies and ExtractAPI) even if the compiler is ran outside of sbt, for debugging.")
   val YdumpSbtInc: Setting[Boolean] = BooleanSetting("-Ydump-sbt-inc", "For every compiled foo.scala, output the API representation and dependencies used for sbt incremental compilation in foo.inc, implies -Yforce-sbt-phases.")
   val YcheckAllPatmat: Setting[Boolean] = BooleanSetting("-Ycheck-all-patmat", "Check exhaustivity and redundancy of all pattern matching (used for testing the algorithm).")

compiler/src/dotty/tools/dotc/core/Mode.scala

@@ -102,9 +102,6 @@ object Mode {
   /** We are typing the body of an inline method */
   val InlineableBody: Mode = newMode(21, "InlineableBody")
 
-  /** Read comments from definitions when unpickling from TASTY */
-  val ReadComments: Mode = newMode(22, "ReadComments")
-
   /** We are synthesizing the receiver of an extension method */
   val SynthesizeExtMethodReceiver: Mode = newMode(23, "SynthesizeExtMethodReceiver")
 

compiler/src/dotty/tools/dotc/core/tasty/TreeUnpickler.scala

@@ -884,8 +884,8 @@ class TreeUnpickler(reader: TastyReader,
       if (!sym.isType) // Only terms might have leaky aliases, see the documentation of `checkNoPrivateLeaks`
         sym.info = ta.avoidPrivateLeaks(sym)
 
-      if (ctx.mode.is(Mode.ReadComments)) {
-        assert(ctx.docCtx.isDefined, "Mode is `ReadComments`, but no `docCtx` is set.")
+      if (ctx.settings.YreadComments.value) {
+        assert(ctx.docCtx.isDefined, "`-Yread-docs` enabled, but no `docCtx` is set.")
         commentUnpicklerOpt.foreach { commentUnpickler =>
           val comment = commentUnpickler.commentAt(start)
           ctx.docCtx.get.addDocstring(tree.symbol, comment)

compiler/src/dotty/tools/dotc/decompiler/IDEDecompilerDriver.scala

@@ -16,7 +16,8 @@ import scala.quoted.runtime.impl.QuotesImpl
 class IDEDecompilerDriver(val settings: List[String]) extends dotc.Driver {
 
   private val myInitCtx: Context = {
-    val rootCtx = initCtx.fresh.addMode(Mode.Interactive | Mode.ReadPositions | Mode.ReadComments)
+    val rootCtx = initCtx.fresh.addMode(Mode.Interactive | Mode.ReadPositions)
+    rootCtx.setSetting(rootCtx.settings.YreadComments, true)
     rootCtx.setSetting(rootCtx.settings.YretainTrees, true)
     rootCtx.setSetting(rootCtx.settings.fromTasty, true)
     val ctx = setup(settings.toArray :+ "dummy.scala", rootCtx).get._2

compiler/src/dotty/tools/dotc/interactive/InteractiveDriver.scala

@@ -29,9 +29,10 @@ class InteractiveDriver(val settings: List[String]) extends Driver {
   override def sourcesRequired: Boolean = false
 
   private val myInitCtx: Context = {
-    val rootCtx = initCtx.fresh.addMode(Mode.ReadPositions).addMode(Mode.Interactive).addMode(Mode.ReadComments)
+    val rootCtx = initCtx.fresh.addMode(Mode.ReadPositions).addMode(Mode.Interactive)
     rootCtx.setSetting(rootCtx.settings.YretainTrees, true)
     rootCtx.setSetting(rootCtx.settings.YcookComments, true)
+    rootCtx.setSetting(rootCtx.settings.YreadComments, true)
     val ctx = setup(settings.toArray, rootCtx) match
       case Some((_, ctx)) => ctx
       case None => rootCtx

compiler/src/dotty/tools/dotc/transform/Pickler.scala

@@ -110,12 +110,12 @@ class Pickler extends Phase {
   override def runOn(units: List[CompilationUnit])(using Context): List[CompilationUnit] = {
     val result = super.runOn(units)
     if ctx.settings.YtestPickler.value then
+      val ctx2 = ctx.fresh.setSetting(ctx.settings.YreadComments, true)
       testUnpickler(
-        using ctx.fresh
+        using ctx2
             .setPeriod(Period(ctx.runId + 1, FirstPhaseId))
             .setReporter(new ThrowingReporter(ctx.reporter))
             .addMode(Mode.ReadPositions)
-            .addMode(Mode.ReadComments)
             .addMode(Mode.PrintShowExceptions))
     result
   }

compiler/src/dotty/tools/repl/ReplDriver.scala

@@ -66,8 +66,9 @@ class ReplDriver(settings: Array[String],
 
   /** Create a fresh and initialized context with IDE mode enabled */
   private def initialCtx = {
-    val rootCtx = initCtx.fresh.addMode(Mode.ReadPositions | Mode.Interactive | Mode.ReadComments)
+    val rootCtx = initCtx.fresh.addMode(Mode.ReadPositions | Mode.Interactive)
     rootCtx.setSetting(rootCtx.settings.YcookComments, true)
+    rootCtx.setSetting(rootCtx.settings.YreadComments, true)
     setup(settings, rootCtx) match
       case Some((files, ictx)) =>
         shouldStart = true

compiler/test/dotty/tools/dotc/BootstrappedOnlyCompilationTests.scala

@@ -118,6 +118,7 @@ class BootstrappedOnlyCompilationTests {
     aggregateTests(
       compileFilesInDir("tests/run-macros", defaultOptions.and("-Xcheck-macros")),
       compileFilesInDir("tests/run-custom-args/Yretain-trees", defaultOptions and "-Yretain-trees"),
+      compileFilesInDir("tests/run-custom-args/Yread-comments", defaultOptions and "-Yread-docs"),
       compileFilesInDir("tests/run-custom-args/run-macros-erased", defaultOptions.and("-language:experimental.erasedDefinitions").and("-Xcheck-macros")),
     )
   }.checkRuns()

compiler/test/dotty/tools/dotc/core/tasty/CommentPicklingTest.scala

@@ -105,7 +105,11 @@ class CommentPicklingTest {
   }
 
   private class UnpicklingDriver extends Driver {
-    override def initCtx = super.initCtx.addMode(Mode.ReadComments)
+    override def initCtx =
+      val ctx = super.initCtx.fresh
+      ctx.setSetting(ctx.settings.YreadComments, true)
+      ctx
+
     def unpickle[T](args: Array[String], files: List[File])(fn: (List[tpd.Tree], Context) => T): T = {
       implicit val ctx: Context = setup(args, initCtx).map(_._2).getOrElse(initCtx)
       ctx.initialize()

scaladoc/src/scala/tasty/inspector/OldTastyInspector.scala

@@ -110,7 +110,10 @@ trait OldTastyInspector:
 
       override def newRun(implicit ctx: Context): Run =
         reset()
-        new TASTYRun(this, ctx.fresh.addMode(Mode.ReadPositions).addMode(Mode.ReadComments))
+        val ctx2 = ctx.fresh
+            .addMode(Mode.ReadPositions)
+            .setSetting(ctx.settings.YreadComments, true)
+        new TASTYRun(this, ctx2)
 
     new InspectorDriver
 

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

@@ -86,7 +86,10 @@ object TastyInspector:
 
       override def newRun(implicit ctx: Context): Run =
         reset()
-        new TASTYRun(this, ctx.fresh.addMode(Mode.ReadPositions).addMode(Mode.ReadComments))
+        val ctx2 = ctx.fresh
+            .addMode(Mode.ReadPositions)
+            .setSetting(ctx.settings.YreadComments, true)
+        new TASTYRun(this, ctx2)
 
     new InspectorDriver
 

tests/run-custom-args/Yread-comments/i12351/GetDocString_1.scala

@@ -0,0 +1,11 @@
+import scala.quoted.*
+
+/** HELLO */
+case class Data(test: Boolean)
+
+inline def getDocString[T]: Option[String] = ${ getDocStringImpl[T] }
+
+private def getDocStringImpl[T : Type](using Quotes): Expr[Option[String]] = {
+    import quotes.reflect.*
+    Expr(TypeRepr.of[T].typeSymbol.docstring)
+}

tests/run-custom-args/Yread-comments/i12351/Test_2.scala

@@ -0,0 +1,4 @@
+@main def Test(): Unit = {
+    println(getDocString[Data])
+    assert(getDocString[Data].nonEmpty)
+}

tests/run-custom-args/Yread-comments/i12352/Macro.scala

@@ -0,0 +1,8 @@
+import scala.quoted.*
+
+inline def getDocString[T]: Option[String] = ${ getDocStringImpl[T] }
+
+private def getDocStringImpl[T : Type](using Quotes): Expr[Option[String]] = {
+    import quotes.reflect.*
+    Expr(TypeRepr.of[T].typeSymbol.docstring)
+}

tests/run-custom-args/Yread-comments/i12352/Main.scala

@@ -0,0 +1,5 @@
+@main def Test(): Unit = {
+    val res = getDocString[scala.quoted.Quotes]
+    println(res)
+    assert(res.nonEmpty)
+}