Make better-fors a preview feature

Author: WojciechMazur

compiler/src/dotty/tools/dotc/ast/Desugar.scala

@@ -1953,9 +1953,9 @@ object desugar {
     /** Create tree for for-comprehension `<for (enums) do body>` or
      *   `<for (enums) yield body>` where mapName and flatMapName are chosen
      *  corresponding to whether this is a for-do or a for-yield.
-     *  If sourceVersion >= 3.7 are enabled, the creation performs the following rewrite rules:
+     *  If betterFors are enabled, the creation performs the following rewrite rules:
      *
-     *  1. if sourceVersion >= 3.7:
+     *  1. if betterFors is enabled:
      *
      *    for () do E  ==>  E
      *      or
@@ -1986,13 +1986,13 @@ object desugar {
      *      ==>
      *    for (P <- G.withFilter (P => E); ...) ...
      *
-     *  6. For any N, if sourceVersion >= 3.7:
+     *  6. For any N, if betterFors is enabled:
      *
      *    for (P <- G; P_1 = E_1; ... P_N = E_N; P1 <- G1; ...) ...
      *      ==>
      *    G.flatMap (P => for (P_1 = E_1; ... P_N = E_N; ...))
      *
-     *  7. For any N, if sourceVersion >= 3.7:
+     *  7. For any N, if betterFors is enabled:
      *
      *    for (P <- G; P_1 = E_1; ... P_N = E_N) ...
      *      ==>
@@ -2013,7 +2013,7 @@ object desugar {
      *    If any of the P_i are variable patterns, the corresponding `x_i @ P_i` is not generated
      *    and the variable constituting P_i is used instead of x_i
      *
-     *  9. For any N, if sourceVersion >= 3.7:
+     *  9. For any N, if betterFors is enabled:
      *
      *    for (P_1 = E_1; ... P_N = E_N; ...)
      *      ==>
@@ -2157,15 +2157,15 @@ object desugar {
           case _ => false
 
       def markTrailingMap(aply: Apply, gen: GenFrom, selectName: TermName): Unit =
-        if sourceVersion.isAtLeast(`3.7`)
+        if sourceVersion.enablesBetterFors
           && selectName == mapName
           && gen.checkMode != GenCheckMode.Filtered // results of withFilter have the wrong type
           && (deepEquals(gen.pat, body) || deepEquals(body, Tuple(Nil)))
         then
           aply.putAttachment(TrailingForMap, ())
 
       enums match {
-        case Nil if sourceVersion.isAtLeast(`3.7`) => body
+        case Nil if sourceVersion.enablesBetterFors => body
         case (gen: GenFrom) :: Nil =>
           val aply = Apply(rhsSelect(gen, mapName), makeLambda(gen, body))
           markTrailingMap(aply, gen, mapName)
@@ -2174,7 +2174,7 @@ object desugar {
           val cont = makeFor(mapName, flatMapName, rest, body)
           Apply(rhsSelect(gen, flatMapName), makeLambda(gen, cont))
         case (gen: GenFrom) :: rest
-        if sourceVersion.isAtLeast(`3.7`)
+        if sourceVersion.enablesBetterFors
           && rest.dropWhile(_.isInstanceOf[GenAlias]).headOption.forall(e => e.isInstanceOf[GenFrom]) // possible aliases followed by a generator or end of for
           && !rest.takeWhile(_.isInstanceOf[GenAlias]).exists(a => isNestedGivenPattern(a.asInstanceOf[GenAlias].pat)) =>
           val cont = makeFor(mapName, flatMapName, rest, body)
@@ -2202,9 +2202,9 @@ object desugar {
           makeFor(mapName, flatMapName, vfrom1 :: rest1, body)
         case (gen: GenFrom) :: test :: rest =>
           val filtered = Apply(rhsSelect(gen, nme.withFilter), makeLambda(gen, test))
-          val genFrom = GenFrom(gen.pat, filtered, if sourceVersion.isAtLeast(`3.7`) then GenCheckMode.Filtered else GenCheckMode.Ignore)
+          val genFrom = GenFrom(gen.pat, filtered, if sourceVersion.enablesBetterFors then GenCheckMode.Filtered else GenCheckMode.Ignore)
           makeFor(mapName, flatMapName, genFrom :: rest, body)
-        case GenAlias(_, _) :: _ if sourceVersion.isAtLeast(`3.7`) =>
+        case GenAlias(_, _) :: _ if sourceVersion.enablesBetterFors =>
           val (valeqs, rest) = enums.span(_.isInstanceOf[GenAlias])
           val pats = valeqs.map { case GenAlias(pat, _) => pat }
           val rhss = valeqs.map { case GenAlias(_, rhs) => rhs }

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

@@ -3,6 +3,8 @@ package dotc
 package config
 
 import core.Decorators.*
+import core.Contexts.*
+import Feature.isPreviewEnabled
 import util.Property
 
 enum SourceVersion:
@@ -35,6 +37,7 @@ enum SourceVersion:
   def enablesClauseInterleaving = isAtLeast(`3.6`)
   def enablesNewGivens = isAtLeast(`3.6`)
   def enablesNamedTuples = isAtLeast(`3.7`)
+  def enablesBetterFors(using Context) = isAtLeast(`3.7`) && isPreviewEnabled
 
 object SourceVersion extends Property.Key[SourceVersion]:
   def defaultSourceVersion = `3.7`

compiler/src/dotty/tools/dotc/parsing/Parsers.scala

@@ -2956,7 +2956,7 @@ object Parsers {
     /** Enumerators ::= Generator {semi Enumerator | Guard}
      */
     def enumerators(): List[Tree] =
-      if sourceVersion.isAtLeast(`3.7`) then
+      if sourceVersion.enablesBetterFors then
         aliasesUntilGenerator() ++ enumeratorsRest()
       else
         generator() :: enumeratorsRest()

docs/_docs/reference/changed-features/better-fors.md renamed to docs/_docs/reference/preview/better-fors.md

@@ -4,7 +4,7 @@ title: "Better fors"
 nightlyOf: https://docs.scala-lang.org/scala3/reference/changed-features/better-fors.html
 ---
 
-Starting in Scala `3.7`, the usability of `for`-comprehensions is improved.
+Starting in Scala `3.7` under `-preview` mode, the usability of `for`-comprehensions is improved.
 
 The biggest user facing change is the new ability to start `for`-comprehensions with aliases. This means that the following previously invalid code is now valid:
 

docs/_docs/reference/preview/overview.md

@@ -0,0 +1,21 @@
+---
+layout: doc-page
+title: "Preview"
+nightlyOf: https://docs.scala-lang.org/scala3/reference/preview/overview.html
+redirectFrom: overview.html
+---
+
+## Preview language features
+
+New Scala language features or standard library APIs are initially introduced as experimental, but once they become fully implemented and accepted by the [SIP](https://docs.scala-lang.org/sips/) these can become a preview features.
+Preview language features and APIs are guaranteed to be standardized in some next Scala minor release, but allow the compiler team to introduce small, possibly binary incompatible, changes based on the community feedback.
+These can be used by early adopters who can accept the possibility of binary compatibility breakage. For instance, preview features could be used in some internal tool or application. On the other hand, preview features are discouraged in publicly available libraries.
+More information about preview featues can be found in [../other-new-features/preview-defs.md](preview defintions guide)
+
+## List of available preview features
+
+* [`better-fors`](./better-fors.md): Enables new for-comprehension behaviour under SIP-62 under `-source:3.7` or later
+
+### `-preview` compiler flag
+
+This flag enables the use of all preview language feature in the project.

docs/sidebar.yml

@@ -116,7 +116,6 @@ subsection:
           - page: reference/changed-features/lazy-vals-init.md
           - page: reference/changed-features/main-functions.md
           - page: reference/changed-features/interpolation-escapes.md
-          - page: reference/changed-features/better-fors.md
       - title: Dropped Features
         index: reference/dropped-features/dropped-features.md
         subsection:
@@ -140,6 +139,11 @@ subsection:
           - page: reference/dropped-features/nonlocal-returns.md
           - page: reference/dropped-features/this-qualifier.md
           - page: reference/dropped-features/wildcard-init.md
+      - title: Preview Features
+        directory: preview
+        index: reference/preview/overview.md
+        subsection:
+          - page: reference/preview/better-fors.md
       - title: Experimental Features
         directory: experimental
         index: reference/experimental/overview.md

library/src/scala/runtime/stdLibPatches/language.scala

@@ -140,7 +140,7 @@ object language:
      * @see [[https://github.com/scala/improvement-proposals/pull/79]]
      */
     @compileTimeOnly("`betterFors` can only be used at compile time in import statements")
-    @deprecated("The `experimental.betterFors` language import is no longer needed since the feature is now standard", since = "3.7")
+    @deprecated("The `experimental.betterFors` language import is no longer needed since the feature is now in preview", since = "3.7")
     object betterFors
 
     /** Experimental support for package object values

tests/pos/better-fors-given.scala

@@ -1,3 +1,5 @@
+//> using options -preview
+
 @main def Test: Unit =
   for
     x <- Option(23 -> "abc")

tests/run/better-fors.scala

@@ -1,3 +1,5 @@
+//> using options -preview
+
 def for1 =
   for {
     a = 1

tests/run/fors.scala

@@ -1,3 +1,4 @@
+//> using options -preview
 //############################################################################
 // for-comprehensions (old and new syntax)
 //############################################################################