Remove placeholer inserted by inlined patterns

Author: nicolasstucki

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

@@ -79,6 +79,7 @@ class Compiler {
          new StringInterpolatorOpt,  // Optimizes raw and s string interpolators by rewriting them to string concatentations
          new CrossCastAnd) ::        // Normalize selections involving intersection types.
     List(new PruneErasedDefs,        // Drop erased definitions from scopes and simplify erased expressions
+         new InlinePatterns,         // Remove placeholders of inlined patterns
          new VCInlineMethods,        // Inlines calls to value class methods
          new SeqLiterals,            // Express vararg arguments as arrays
          new InterceptedMethods,     // Special handling of `==`, `|=`, `getClass` methods

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

@@ -0,0 +1,80 @@
+package dotty.tools
+package dotc
+package transform
+
+import core._
+import MegaPhase._
+import Symbols._, Contexts._, Types._, Decorators._
+import StdNames.nme
+import NameOps._
+import Names._
+import ast.Trees._
+import ast.TreeTypeMap
+
+/** Rewrite an application
+ *
+ *    {new { def unapply(x0: X0)(x1: X1,..., xn: Xn) = b }}.unapply(y0)(y1, ..., yn)
+ *
+ *  where
+ *
+ *    - the method is `unapply` or `unapplySeq`
+ *    - the method does not have type parameters
+ *
+ *  to
+ *
+ *    [xi := yi]b
+ *
+ *  This removes placeholders added by inline `unapply`/`unapplySeq` patterns.
+ */
+class InlinePatterns extends MiniPhase:
+  import ast.tpd._
+
+  def phaseName: String = "inlinePatterns"
+
+  override def runsAfterGroupsOf: Set[String] = Set(PatternMatcher.name)
+
+  override def transformApply(app: Apply)(using ctx: Context): Tree =
+    if app.symbol.name.isUnapplyName && !app.tpe.isInstanceOf[MethodicType] then
+      app match
+        case App(Select(fn, name), argss) =>
+          val app1 = betaReduce(app, fn, name, argss.flatten)
+          if app1 ne app then ctx.log(i"beta reduce $app -> $app1")
+          app1
+        case _ =>
+          app
+    else app
+
+  private object App:
+    def unapply(app: Tree): (Tree, List[List[Tree]]) =
+      app match
+        case Apply(App(fn, argss), args) => (fn, argss :+ args)
+        case _ => (app, Nil)
+
+  private def betaReduce(tree: Apply, fn: Tree, name: Name, args: List[Tree])(using ctx: Context): Tree =
+    fn match
+      case Block(Nil, expr) => betaReduce(tree, expr, name, args)
+      case Block(TypeDef(_, template: Template) :: Nil, Apply(Select(New(_),_), Nil)) if template.constr.rhs.isEmpty =>
+        template.body match
+          case List(ddef @ DefDef(`name`, _, _, _, _)) =>
+            val bindings = List.newBuilder[ValDef]
+            val vparams = ddef.vparamss.flatten
+            val argSyms =
+              for (arg, param) <- args.zip(vparams) yield
+                arg.tpe.dealias match
+                  case ref @ TermRef(NoPrefix, _) if isPurePath(arg) =>
+                    ref.symbol
+                  case _ =>
+                    val binding = SyntheticValDef(param.name, arg)
+                    bindings += binding
+                    binding.symbol
+            seq(
+              bindings.result(),
+              TreeTypeMap(
+                oldOwners = ddef.symbol :: Nil,
+                newOwners = ctx.owner :: Nil,
+                substFrom = vparams.map(_.symbol),
+                substTo = argSyms).transform(ddef.rhs)
+            )
+
+          case _ => tree
+      case _ => tree

compiler/src/dotty/tools/dotc/typer/Typer.scala

@@ -1252,8 +1252,11 @@ class Typer extends Namer
           b
         case t: UnApply if t.symbol.is(Inline) =>
           // An inline unapply `P.unapply` in a plattern `P(x1,x2,...)` is transformed into
-          // `{ class $anon { def unapply(x1: T1, x2: T2, ...): R = P.unapply(x1, x2, ...) }; new $anon }.unapply`
+          // `{ class $anon { def unapply(t0: T0)(using t1: T1, t2: T2, ...): R = P.unapply(t0)(using t1, t2, ...) }; new $anon }.unapply`
           // and the call `P.unapply(x1, x2, ...)` is inlined.
+          // This serves as a placeholder for the inlined body until the `patternMatcher` phase. After pattern matcher
+          // transforms the patterns into terms, the `inlinePatterns` phase removes this anonymous class by β-reducing
+          // the call to the `unapply`.
           val sym = t.symbol
           val cls = ctx.newNormalizedClassSymbol(ctx.owner, tpnme.ANON_CLASS, Synthetic | Final, List(defn.ObjectType), coord = sym.coord)
           val constr = ctx.newConstructor(cls, Synthetic, Nil, Nil, coord = sym.coord).entered

tests/pos/i8530.scala

@@ -14,7 +14,7 @@ object MySeqUnapply:
   inline def unapplySeq(x: Int): Seq[Int] = Seq(x, x)
 
 object MyWhiteboxUnapply:
-  inline def unapply(x: Int) <: Option[Any] = Some(x)
+  transparent inline def unapply(x: Int): Option[Any] = Some(x)
 
 def test: Unit =
   val x = 5 match

tests/run/i8530.scala

@@ -11,7 +11,7 @@ object MySeqUnapply:
   inline def unapplySeq(x: Int): Seq[Int] = Seq(x, x + 1)
 
 object MyWhiteboxUnapply:
-  inline def unapply(x: Int) <: Option[Any] = Some(x)
+  transparent inline def unapply(x: Int): Option[Any] = Some(x)
 
 
 @main def Test =