Use jvm 8 compatible API, refactor deprecation, schedule YoutputOnlyTasty for removal

Author: rochala

community-build/src/scala/dotty/communitybuild/projects.scala

@@ -503,7 +503,7 @@ object projects:
     project        = "verify",
     sbtTestCommand = "verifyJVM/test",
     sbtDocCommand = "verifyJVM/doc",
-    scalacOptions = SbtCommunityProject.scalacOptions.filter(flag != "-Xcheck-macros" && flag != "-Xlint") // TODO enable -Xcheck-macros, wrong flag -Xlint
+    scalacOptions = SbtCommunityProject.scalacOptions.filter(flag => flag != "-Xcheck-macros" && flag != "-Xlint") // TODO enable -Xcheck-macros, wrong flag -Xlint
   )
 
   lazy val discipline = SbtCommunityProject(

compiler/src/dotty/tools/backend/jvm/PostProcessorFrontendAccess.scala

@@ -127,6 +127,8 @@ object PostProcessorFrontendAccess {
       override val jarCompressionLevel: Int = s.XjarCompressionLevel.value
       override val backendParallelism: Int = s.YbackendParallelism.value
       override val backendMaxWorkerQueue: Option[Int] = s.YbackendWorkerQueue.valueSetByUser
+
+      @annotation.nowarn("cat=deprecation")
       override val outputOnlyTasty: Boolean = s.YoutputOnlyTasty.value
      }
 

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

@@ -371,7 +371,7 @@ private sealed trait XSettings:
       ChoiceWithHelp("type-parameter-shadow", "Warn when a type parameter shadows a type already in the scope"),
     ),
     default = Nil,
-    deprecation = Some(Deprecation("Use -Wshadow to enable shadowing lints.", "-Wshadow")),
+    deprecation = Deprecation.renamed("-Wshadow"),
   )
 
 end XSettings
@@ -435,7 +435,6 @@ private sealed trait YSettings:
   val YnoExperimental: Setting[Boolean] = BooleanSetting(ForkSetting, "Yno-experimental", "Disable experimental language features by default in NIGHTLY/SNAPSHOT versions of the compiler.")
   val YlegacyLazyVals: Setting[Boolean] = BooleanSetting(ForkSetting, "Ylegacy-lazy-vals", "Use legacy (pre 3.3.0) implementation of lazy vals.")
   val YcompileScala2Library: Setting[Boolean] = BooleanSetting(ForkSetting, "Ycompile-scala2-library", "Used when compiling the Scala 2 standard library.")
-  val YoutputOnlyTasty: Setting[Boolean] = BooleanSetting(ForkSetting, "Youtput-only-tasty", "Used to only generate the TASTy file without the classfiles")
   val YprofileEnabled: Setting[Boolean] = BooleanSetting(ForkSetting, "Yprofile-enabled", "Enable profiling.")
   val YprofileDestination: Setting[String] = StringSetting(ForkSetting, "Yprofile-destination", "file", "Where to send profiling output - specify a file, default is to the console.", "")
       //.withPostSetHook( _ => YprofileEnabled.value = true )
@@ -469,36 +468,40 @@ private sealed trait YSettings:
 
   // Deprecated: lifted from -Y to -X
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YtermConflict: Setting[String] = ChoiceSetting(ForkSetting, "Yresolve-term-conflict", "strategy", "Resolve term conflicts", List("package", "object", "error"), "error", deprecation = Some(Deprecation("Use -Xresolve-term-conflict instead.", "-Xresolve-term-conflict")))
+  val YtermConflict: Setting[String] = ChoiceSetting(ForkSetting, "Yresolve-term-conflict", "strategy", "Resolve term conflicts", List("package", "object", "error"), "error", deprecation = Deprecation.renamed("-Xresolve-term-conflict"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YnoGenericSig: Setting[Boolean] = BooleanSetting(ForkSetting, "Yno-generic-signatures", "Suppress generation of generic signatures for Java.", deprecation = Some(Deprecation("Use -Xno-generic-signatures instead.", "-Xno-generic-signatures")))
+  val YnoGenericSig: Setting[Boolean] = BooleanSetting(ForkSetting, "Yno-generic-signatures", "Suppress generation of generic signatures for Java.", deprecation = Deprecation.renamed("-Xno-generic-signatures"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val Ydumpclasses: Setting[String] = StringSetting(ForkSetting, "Ydump-classes", "dir", "Dump the generated bytecode to .class files (useful for reflective compilation that utilizes in-memory classloaders).", default = "", deprecation = Some(Deprecation("Use -Xdump-classes instead.", "-Xdump-classes")))
+  val Ydumpclasses: Setting[String] = StringSetting(ForkSetting, "Ydump-classes", "dir", "Dump the generated bytecode to .class files (useful for reflective compilation that utilizes in-memory classloaders).", default = "", deprecation = Deprecation.renamed("-Xdump-classes"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YjarCompressionLevel: Setting[Int] = IntChoiceSetting(ForkSetting, "Yjar-compression-level", "compression level to use when writing jar files", Deflater.DEFAULT_COMPRESSION to Deflater.BEST_COMPRESSION, Deflater.DEFAULT_COMPRESSION, deprecation = Some(Deprecation("Use -Xjar-compression-level instead.", "-Xjar-compression-level")))
+  val YjarCompressionLevel: Setting[Int] = IntChoiceSetting(ForkSetting, "Yjar-compression-level", "compression level to use when writing jar files", Deflater.DEFAULT_COMPRESSION to Deflater.BEST_COMPRESSION, Deflater.DEFAULT_COMPRESSION, deprecation = Deprecation.renamed("-Xjar-compression-level"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YkindProjector: Setting[String] = ChoiceSetting(ForkSetting, "Ykind-projector", "[underscores, enable, disable]", "Allow `*` as type lambda placeholder to be compatible with kind projector. When invoked as -Ykind-projector:underscores will repurpose `_` to be a type parameter placeholder, this will disable usage of underscore as a wildcard.", List("disable", "", "underscores"), "disable", legacyArgs = true, deprecation = Some(Deprecation("Use -Xkind-projector instead.", "-Xkind-projector")))
+  val YkindProjector: Setting[String] = ChoiceSetting(ForkSetting, "Ykind-projector", "[underscores, enable, disable]", "Allow `*` as type lambda placeholder to be compatible with kind projector. When invoked as -Ykind-projector:underscores will repurpose `_` to be a type parameter placeholder, this will disable usage of underscore as a wildcard.", List("disable", "", "underscores"), "disable", legacyArgs = true, deprecation = Deprecation.renamed("-Xkind-projector"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YdropComments: Setting[Boolean] = BooleanSetting(ForkSetting, "Ydrop-docs", "Drop documentation when scanning source files.", aliases = List("-Ydrop-comments"), deprecation = Some(Deprecation("Use -Xdrop-docs instead.", "-Xdrop-docs")))
+  val YdropComments: Setting[Boolean] = BooleanSetting(ForkSetting, "Ydrop-docs", "Drop documentation when scanning source files.", aliases = List("-Ydrop-comments"), deprecation = Deprecation.renamed("-Xdrop-docs"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YcookComments: Setting[Boolean] = BooleanSetting(ForkSetting, "Ycook-docs", "Cook the documentation (type check `@usecase`, etc.)", aliases = List("-Ycook-comments"), deprecation = Some(Deprecation("Use -Xcook-docs instead.", "-Xcook-docs")))
+  val YcookComments: Setting[Boolean] = BooleanSetting(ForkSetting, "Ycook-docs", "Cook the documentation (type check `@usecase`, etc.)", aliases = List("-Ycook-comments"), deprecation = Deprecation.renamed("-Xcook-docs"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YreadComments: Setting[Boolean] = BooleanSetting(ForkSetting, "Yread-docs", "Read documentation from tasty.", deprecation = Some(Deprecation("Use -Xread-docs instead.", "-Xread-docs")))
+  val YreadComments: Setting[Boolean] = BooleanSetting(ForkSetting, "Yread-docs", "Read documentation from tasty.", deprecation = Deprecation.renamed("-Xread-docs"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YnoDecodeStacktraces: Setting[Boolean] = BooleanSetting(ForkSetting, "Yno-decode-stacktraces", "Show raw StackOverflow stacktraces, instead of decoding them into triggering operations.", deprecation = Some(Deprecation("Use -Xno-decode-stacktraces instead.", "-Xno-decode-stacktraces")))
+  val YnoDecodeStacktraces: Setting[Boolean] = BooleanSetting(ForkSetting, "Yno-decode-stacktraces", "Show raw StackOverflow stacktraces, instead of decoding them into triggering operations.", deprecation = Deprecation.renamed("-Xno-decode-stacktraces"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YnoEnrichErrorMessages: Setting[Boolean] = BooleanSetting(ForkSetting, "Yno-enrich-error-messages", "Show raw error messages, instead of enriching them with contextual information.", deprecation = Some(Deprecation("Use -Xno-enrich-error-messages instead.", "-Xno-enrich-error-messages")))
+  val YnoEnrichErrorMessages: Setting[Boolean] = BooleanSetting(ForkSetting, "Yno-enrich-error-messages", "Show raw error messages, instead of enriching them with contextual information.", deprecation = Deprecation.renamed("-Xno-enrich-error-messages"))
   @deprecated(message = "Lifted to -X, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YdebugMacros: Setting[Boolean] = BooleanSetting(ForkSetting, "Ydebug-macros", "Show debug info when quote pattern match fails", deprecation = Some(Deprecation("Use -Xdebug-macros instead.", "-Xdebug-macros")))
+  val YdebugMacros: Setting[Boolean] = BooleanSetting(ForkSetting, "Ydebug-macros", "Show debug info when quote pattern match fails", deprecation = Deprecation.renamed("-Xdebug-macros"))
 
   // @deprecated(message = "Lifted to -X, Scheduled for removal in 3.8.0", since = "3.7.0")
-  // val YjavaTasty: Setting[Boolean] = BooleanSetting(ForkSetting, "Yjava-tasty", "Pickler phase should compute TASTy for .java defined symbols for use by build tools", aliases = List("-Ypickle-java"), preferPrevious = true, deprecation = Some(Deprecation("Use -Xjava-tasty instead.", "-Xjava-tasty")))
+  // val YjavaTasty: Setting[Boolean] = BooleanSetting(ForkSetting, "Yjava-tasty", "Pickler phase should compute TASTy for .java defined symbols for use by build tools", aliases = List("-Ypickle-java"), preferPrevious = true, deprecation = Deprecation.lifted("-Xjava-tasty"))
   // @deprecated(message = "Lifted to -X, Scheduled for removal in 3.8.0", since = "3.7.0")
-  // val YearlyTastyOutput: Setting[AbstractFile] = OutputSetting(ForkSetting, "Yearly-tasty-output", "directory|jar", "Destination to write generated .tasty files to for use in pipelined compilation.", NoAbstractFile, aliases = List("-Ypickle-write"), preferPrevious = true, deprecation = Some(Deprecation("Use -Xearly-tasty-output instead.", "-Xearly-tasty-output")))
+  // val YearlyTastyOutput: Setting[AbstractFile] = OutputSetting(ForkSetting, "Yearly-tasty-output", "directory|jar", "Destination to write generated .tasty files to for use in pipelined compilation.", NoAbstractFile, aliases = List("-Ypickle-write"), preferPrevious = true, deprecation = Deprecation.lifted("-Xearly-tasty-output"))
   // @deprecated(message = "Lifted to -X, Scheduled for removal in 3.8.0", since = "3.7.0")
-  // val YallowOutlineFromTasty: Setting[Boolean] = BooleanSetting(ForkSetting, "Yallow-outline-from-tasty", "Allow outline TASTy to be loaded with the -from-tasty option.", deprecation = Some(Deprecation("Use -Xallow-outline-from-tasty instead.", "-Xallow-outline-from-tasty")))
+  // val YallowOutlineFromTasty: Setting[Boolean] = BooleanSetting(ForkSetting, "Yallow-outline-from-tasty", "Allow outline TASTy to be loaded with the -from-tasty option.", deprecation = Deprecation.lifted("-Xallow-outline-from-tasty"))
 
   // Deprecated: lifted from -Y to -W
   @deprecated(message = "Lifted to -W, Scheduled for removal in 3.6.0", since = "3.5.0")
-  val YcheckInit: Setting[Boolean] = BooleanSetting(ForkSetting, "Ysafe-init", "Ensure safe initialization of objects.", deprecation = Some(Deprecation("Use -Wsafe-init instead.", "-Wsafe-init")))
+  val YcheckInit: Setting[Boolean] = BooleanSetting(ForkSetting, "Ysafe-init", "Ensure safe initialization of objects.", deprecation = Deprecation.renamed("-Wsafe-init"))
+
+  // Deprecated: Scheduled for removal
+  @deprecated(message = "Scheduled for removal in 3.6.0", since = "3.5.0")
+  val YoutputOnlyTasty: Setting[Boolean] = BooleanSetting(ForkSetting, "Youtput-only-tasty", "Used to only generate the TASTy file without the classfiles", deprecation = Deprecation.removed("3.6.0"))
 end YSettings

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

@@ -61,8 +61,8 @@ object Settings:
     def warn(msg: String): Settings.ArgsSummary =
       ArgsSummary(sstate, arguments.tail, errors, warnings :+ msg)
 
-    def deprecated(extraArg: String, msg: String): Settings.ArgsSummary =
-      ArgsSummary(sstate, extraArg +: arguments.tail, errors, warnings :+ msg)
+    def deprecated(msg: String, extraArgs: List[String] = Nil): Settings.ArgsSummary =
+      ArgsSummary(sstate, extraArgs ++ arguments.tail, errors, warnings :+ msg)
 
   @unshared
   val settingCharacters = "[a-zA-Z0-9_\\-]*".r
@@ -129,11 +129,12 @@ object Settings:
         */
       def update(getValue: => Any, argStringValue: String, args: List[String]): ArgsSummary =
         deprecation match
-          case Some(Deprecation(msg, replacedBy)) =>
+          case Some(Deprecation(msg, Some(replacedBy))) =>
             val deprecatedMsg = s"Option $name is deprecated: $msg"
-            if argStringValue.isEmpty then state.deprecated(replacedBy, deprecatedMsg)
-            else state.deprecated(s"$replacedBy:$argStringValue", deprecatedMsg)
+            if argStringValue.isEmpty then state.deprecated(deprecatedMsg, List(replacedBy))
+            else state.deprecated(deprecatedMsg, List(s"$replacedBy:$argStringValue"))
 
+          case Some(Deprecation(msg, _)) => state.deprecated(msg)
           case None =>
             val value = getValue
             var dangers = warnings
@@ -262,11 +263,15 @@ object Settings:
     * @param msg           deprecation message that will be displayed in following format: s"Option $name is deprecated: $msg"
     * @param replacedBy    option that is substituting current option
     */
-  case class Deprecation(
+  case class Deprecation private(
     msg: String,
-    replacedBy: String,
+    replacedBy: Option[String] = None,
   )
 
+  object Deprecation:
+    def renamed(replacement: String) = Some(Deprecation(s"Use $replacement instead.", Some(replacement)))
+    def removed(removedVersion: String) = Some(Deprecation(s"Scheduled for removal in s$removedVersion", None))
+
   object Setting:
     extension [T](setting: Setting[T])
       def value(using Context): T = setting.valueIn(ctx.settingsState)

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

@@ -232,28 +232,28 @@ class SettingsTests {
 
       import Settings._
 
-      Files.writeString(file1, "test1")
-      Files.writeString(file2, "test2")
+      Files.write(file1, "test1".getBytes())
+      Files.write(file2, "test2".getBytes())
 
-      val file1StateBefore = Files.readString(file1)
-      val file2StateBefore = Files.readString(file2)
+      val file1StateBefore = String(Files.readAllBytes(file1))
+      val file2StateBefore = String(Files.readAllBytes(file2))
 
       val creationTime = Files.getLastModifiedTime(file1)
       val args = List(s"-testOutput:${file1.toString}", s"-testOutput:${file2.toString}")
       val summary = processArguments(args, processAll = true)
 
       // The output is a new filesystem without information of original path
       // We can't check the `testOutput.value` as in other tests.
-      assertNotEquals(file1StateBefore, Files.readString(file1))
-      assertEquals(file2StateBefore, Files.readString(file2))
+      assertNotEquals(file1StateBefore, String(Files.readAllBytes(file1)))
+      assertEquals(file2StateBefore, String(Files.readAllBytes(file2)))
 
     }(Files.deleteIfExists(_), Files.deleteIfExists(_))
 
   @Test def `Output side effect is not present when setting is deprecated`: Unit =
     val result = Using.resource(Files.createTempFile("myfile", ".jar").nn){ file =>
       object Settings extends SettingGroup:
         val defaultDir = new PlainDirectory(Directory("."))
-        val testOutput = OutputSetting(RootSetting, "testOutput", "testOutput", "", defaultDir, preferPrevious = true, deprecation = Some(Deprecation("deprecated", "XtestOutput")))
+        val testOutput = OutputSetting(RootSetting, "testOutput", "testOutput", "", defaultDir, preferPrevious = true, deprecation = Deprecation.renamed("XtestOutput"))
 
       import Settings._