virtpatmat: initial CPS support

typers&patmatvirtualizer have ad-hoc support for dropping annotations
in a way that makes the CPS plugins happy... this is not ideal,
but unless virtpatmat runs after the plugin phases, I don't see how to solve it
running virtpatmat after the CPS plugin would mean the pattern matching evaluation
cannot be captured by CPS, so it's not even desirable to move it to a later phase

- typedIf must lub annotated types
- drop selector.tpe's annotations
- drop annots in matchEnd's argument type
- deal with annots in casts synth by in virtpatmat
  (drop them from type arg to asInstanceof, recover them using type ascription)
- workaround skolemize existential dropping annots

CPS is the main reason why typedMatchAnonFun is not used anymore,
and PartialFunction synthesis is moved back to uncurry (which is quite painful due to labeldefs being so broken)
we can't synth partialfunction during typer since T @cps[U] does not conform to Any,
so we can't pass it as a type arg to PartialFunction, so we can't type a cps-transformed PF
after the CPS plugin, T @cps[U] becomes ControlContext[...], which is a type we can pass
to PartialFunction

virtpatmat is now also run until right before uncurry
(so, can't use isPastTyper, although it means more or less the same thing -- we don't run after uncurry)

the main functional improvements are in the selective ANF transform
its treatment of labeldefs was broken: for example,
LabelDef L1; LabelDef L2 --> DefDef L1; L1(); DefDef L2; L2()
but this does not take into account L1 may jump over L2 to another label
since methods always return (or fail), and the ANF transform generates ValDefs
to store the result of those method calls, both L1 and L2 would always be executed
(so you would run a match with N cases N times, with each partial run starting at a later case)

also fixed a couple of weird bugs in selective anf that caused matches to be duplicated
(with the duplicate being nested in the original)

since label defs are turned into method defs, and later defs
will be nested in the flatMap calls on the controlcontext
yielded by earlier statements, we reverse the list of method
definitions, so that earlier (in the control flow sense) methods
are visible in later ones

selective CPS now generates a catch that's directly digestible by backend

Author: Adriaan Moors

src/compiler/scala/tools/nsc/typechecker/PatMatVirtualiser.scala

@@ -132,10 +132,10 @@ trait PatMatVirtualiser extends ast.TreeDSL { self: Analyzer =>
       *   this could probably optimized... (but note that the matchStrategy must be solved for each nested patternmatch)
       */
     def translateMatch(scrut: Tree, cases: List[CaseDef], pt: Type, scrutType: Type, matchFailGenOverride: Option[Tree => Tree] = None): Tree = {
-      // we don't transform after typers
-      // (that would require much more sophistication when generating trees,
+      // we don't transform after uncurry
+      // (that would require more sophistication when generating trees,
       //  and the only place that emits Matches after typers is for exception handling anyway)
-      assert(phase.id <= currentRun.typerPhase.id, phase)
+      assert(phase.id < currentRun.uncurryPhase.id, phase)
 
       val scrutSym  = freshSym(scrut.pos, pureType(scrutType)) setFlag SYNTH_CASE
       // pt = Any* occurs when compiling test/files/pos/annotDepMethType.scala  with -Xexperimental
@@ -1105,22 +1105,14 @@ class Foo(x: Other) { x._1 } // no error in this order
       def _equals(checker: Tree, binder: Symbol): Tree = checker MEMBER_== REF(binder)          // NOTE: checker must be the target of the ==, that's the patmat semantics for ya
       def and(a: Tree, b: Tree): Tree                  = a AND b
 
+      // drop annotations generated by CPS plugin etc, since its annotationchecker rejects T @cps[U] <: Any
+      // let's assume for now annotations don't affect casts, drop them there, and bring them back using the outer Typed tree
+      private def mkCast(t: Tree, tp: Type) = Typed(gen.mkAsInstanceOf(t, tp.withoutAnnotations, true, false), TypeTree() setType tp)
       // the force is needed mainly to deal with the GADT typing hack (we can't detect it otherwise as tp nor pt need contain an abstract type, we're just casting wildly)
-      def _asInstanceOf(t: Tree, tp: Type, force: Boolean = false): Tree      = { val tpX = /*repackExistential*/(tp)
-        if (!force && (t.tpe ne NoType) && t.isTyped && typesConform(t.tpe, tpX))  t //{ println("warning: emitted redundant asInstanceOf: "+(t, t.tpe, tp)); t } //.setType(tpX)
-        else gen.mkAsInstanceOf(t, tpX, true, false)
-      }
-
-      def _isInstanceOf(b: Symbol, tp: Type): Tree    = gen.mkIsInstanceOf(REF(b), /*repackExistential*/(tp), true, false)
-      // { val tpX = /*repackExistential*/(tp)
+      def _asInstanceOf(t: Tree, tp: Type, force: Boolean = false): Tree = if (!force && (t.tpe ne NoType) && t.isTyped && typesConform(t.tpe, tp)) t else mkCast(t, tp)
+      def _asInstanceOf(b: Symbol, tp: Type): Tree = if (typesConform(b.info, tp)) REF(b) else mkCast(REF(b), tp)
+      def _isInstanceOf(b: Symbol, tp: Type): Tree = gen.mkIsInstanceOf(REF(b), tp.withoutAnnotations, true, false)
       //   if (typesConform(b.info, tpX)) { println("warning: emitted spurious isInstanceOf: "+(b, tp)); TRUE }
-      //   else gen.mkIsInstanceOf(REF(b), tpX, true, false)
-      // }
-
-      def _asInstanceOf(b: Symbol, tp: Type): Tree    = { val tpX = /*repackExistential*/(tp)
-        if (typesConform(b.info, tpX)) REF(b) //{ println("warning: emitted redundant asInstanceOf: "+(b, b.info, tp)); REF(b) } //.setType(tpX)
-        else gen.mkAsInstanceOf(REF(b), tpX, true, false)
-      }
 
       // duplicated out of frustration with cast generation
       def mkZero(tp: Type): Tree = {
@@ -1658,7 +1650,7 @@ class Foo(x: Other) { x._1 } // no error in this order
        */
       def matcher(scrut: Tree, scrutSym: Symbol, restpe: Type)(cases: List[Casegen => Tree], matchFailGen: Option[Tree => Tree]): Tree = {
         val matchEnd = NoSymbol.newLabel(freshName("matchEnd"), NoPosition) setFlag SYNTH_CASE
-        val matchRes = NoSymbol.newValueParameter(newTermName("x"), NoPosition, SYNTHETIC) setInfo restpe
+        val matchRes = NoSymbol.newValueParameter(newTermName("x"), NoPosition, SYNTHETIC) setInfo restpe.withoutAnnotations //
         matchEnd setInfo MethodType(List(matchRes), restpe)
 
         def newCaseSym = NoSymbol.newLabel(freshName("case"), NoPosition) setInfo MethodType(Nil, restpe) setFlag SYNTH_CASE

src/compiler/scala/tools/nsc/typechecker/Typers.scala

@@ -2199,7 +2199,7 @@ trait Typers extends Modes with Adaptations with PatMatVirtualiser {
         case s => (s, true)
       }
       val selector1                = checkDead(typed(selector, EXPRmode | BYVALmode, WildcardType))
-      val selectorTp               = packCaptured(selector1.tpe.widen)
+      val selectorTp               = packCaptured(selector1.tpe.widen.withoutAnnotations)
 
       val casesTyped               = typedCases(cases, selectorTp, resTp)
       val caseTypes                = casesTyped map (c => packedType(c, context.owner).deconst)
@@ -2223,7 +2223,9 @@ trait Typers extends Modes with Adaptations with PatMatVirtualiser {
         // we've packed the type for each case in typedMatch so that if all cases have the same existential case, we get a clean lub
         // here, we should open up the existential again
         // relevant test cases: pos/existentials-harmful.scala, pos/gadt-gilles.scala, pos/t2683.scala, pos/virtpatmat_exist4.scala
-        MatchTranslator(this).translateMatch(selector1, casesAdapted, repeatedToSeq(ownType.skolemizeExistential(context.owner, context.tree)), scrutType, matchFailGen)
+        // TODO: fix skolemizeExistential (it should preserve annotations, right?)
+        val ownTypeSkolemized = ownType.skolemizeExistential(context.owner, context.tree) withAnnotations ownType.annotations
+        MatchTranslator(this).translateMatch(selector1, casesAdapted, repeatedToSeq(ownTypeSkolemized), scrutType, matchFailGen)
       }
     }
 
@@ -3772,12 +3774,16 @@ trait Typers extends Modes with Adaptations with PatMatVirtualiser {
 
           lazy val thenTp = packedType(thenp1, context.owner)
           lazy val elseTp = packedType(elsep1, context.owner)
+          // println("typedIf: "+(thenp1.tpe, elsep1.tpe, ptOrLub(List(thenp1.tpe, elsep1.tpe)),"\n", thenTp, elseTp, thenTp =:= elseTp))
           val (owntype, needAdapt) =
             // in principle we should pack the types of each branch before lubbing, but lub doesn't really work for existentials anyway
             // in the special (though common) case where the types are equal, it pays to pack before comparing
             // especially virtpatmat needs more aggressive unification of skolemized types
             // this breaks src/library/scala/collection/immutable/TrieIterator.scala
-            if (opt.virtPatmat && !isPastTyper && thenTp =:= elseTp) (thenp1.tpe, false) // use unpacked type
+            if ( opt.virtPatmat && !isPastTyper
+              && thenp1.tpe.annotations.isEmpty && elsep1.tpe.annotations.isEmpty // annotated types need to be lubbed regardless (at least, continations break if you by pass them like this)
+              && thenTp =:= elseTp
+               ) (thenp1.tpe, false) // use unpacked type
             // TODO: skolemize (lub of packed types) when that no longer crashes on files/pos/t4070b.scala
             else ptOrLub(List(thenp1.tpe, elsep1.tpe))
 
@@ -3802,7 +3808,7 @@ trait Typers extends Modes with Adaptations with PatMatVirtualiser {
           val selector1 = atPos(tree.pos.focusStart) { if (arity == 1) ids.head else gen.mkTuple(ids) }
           val body = treeCopy.Match(tree, selector1, cases)
           typed1(atPos(tree.pos) { Function(params, body) }, mode, pt)
-        } else if (!opt.virtPatmat || isPastTyper) {
+        } else if (!((phase.id < currentRun.uncurryPhase.id) && opt.virtPatmat)) {
           val selector1 = checkDead(typed(selector, EXPRmode | BYVALmode, WildcardType))
           var cases1 = typedCases(cases, packCaptured(selector1.tpe.widen), pt)
           val (owntype, needAdapt) = ptOrLub(cases1 map (_.tpe))
@@ -4688,7 +4694,7 @@ trait Typers extends Modes with Adaptations with PatMatVirtualiser {
             catches1 = catches1 map (adaptCase(_, mode, owntype))
           }
 
-          if(!isPastTyper && opt.virtPatmat) {
+          if((phase.id < currentRun.uncurryPhase.id) && opt.virtPatmat) {
             catches1 = (MatchTranslator(this)).translateTry(catches1, owntype, tree.pos)
           }
 

src/continuations/plugin/scala/tools/selectivecps/SelectiveANFTransform.scala

@@ -71,24 +71,46 @@ abstract class SelectiveANFTransform extends PluginComponent with Transform with
             // { x => x match { case A => ... }} to
             // { x => shiftUnit(x match { case A => ... })}
             // which Uncurry cannot handle (see function6.scala)
+            // thus, we push down the shiftUnit to each of the case bodies
 
             val ext = getExternalAnswerTypeAnn(body.tpe)
+            val pureBody = getAnswerTypeAnn(body.tpe).isEmpty
+
+            def transformPureMatch(tree: Tree, selector: Tree, cases: List[CaseDef]) = {
+              val caseVals = cases map { case cd @ CaseDef(pat, guard, body) =>
+                // if (!hasPlusMarker(body.tpe)) body.tpe = body.tpe withAnnotation newPlusMarker() // TODO: to avoid warning
+                val bodyVal = transExpr(body, None, ext) // ??? triggers "cps-transformed unexpectedly" warning in transTailValue
+                treeCopy.CaseDef(cd, transform(pat), transform(guard), bodyVal)
+              }
+              treeCopy.Match(tree, transform(selector), caseVals)
+            }
+
+            def transformPureVirtMatch(body: Block, selDef: ValDef, cases: List[Tree], matchEnd: Tree) = {
+              val stats = transform(selDef) :: (cases map (transExpr(_, None, ext)))
+              treeCopy.Block(body, stats, transExpr(matchEnd, None, ext))
+            }
 
             val body1 = body match {
-              case Match(selector, cases) if (ext.isDefined && getAnswerTypeAnn(body.tpe).isEmpty) =>
-                val cases1 = for {
-                  cd @ CaseDef(pat, guard, caseBody) <- cases
-                  caseBody1 = transExpr(body, None, ext)
-                } yield {
-                  treeCopy.CaseDef(cd, transform(pat), transform(guard), caseBody1)
-                }
-                treeCopy.Match(tree, transform(selector), cases1)
+              case Match(selector, cases) if ext.isDefined && pureBody =>
+                transformPureMatch(body, selector, cases)
+
+              // virtpatmat switch
+              case Block(List(selDef: ValDef), mat@Match(selector, cases)) if ext.isDefined && pureBody =>
+                treeCopy.Block(body, List(transform(selDef)), transformPureMatch(mat, selector, cases))
+
+              // virtpatmat
+              case b@Block(matchStats@((selDef: ValDef) :: cases), matchEnd) if ext.isDefined && pureBody && (matchStats forall gen.hasSynthCaseSymbol) =>
+                transformPureVirtMatch(b, selDef, cases, matchEnd)
+
+              // virtpatmat that stores the scrut separately -- TODO: can we eliminate this case??
+              case Block(List(selDef0: ValDef), mat@Block(matchStats@((selDef: ValDef) :: cases), matchEnd)) if ext.isDefined && pureBody  && (matchStats forall gen.hasSynthCaseSymbol)=>
+                treeCopy.Block(body, List(transform(selDef0)), transformPureVirtMatch(mat, selDef, cases, matchEnd))
 
               case _ =>
                 transExpr(body, None, ext)
             }
 
-            debuglog("result "+body1)
+            debuglog("anf result "+body1)
             debuglog("result is of type "+body1.tpe)
 
             treeCopy.Function(ff, transformValDefs(vparams), body1)
@@ -170,63 +192,72 @@ abstract class SelectiveANFTransform extends PluginComponent with Transform with
       tree match {
         case Block(stms, expr) =>
           val (cpsA2, cpsR2) = (cpsA, linearize(cpsA, getAnswerTypeAnn(tree.tpe))) // tbd
-//          val (cpsA2, cpsR2) = (None, getAnswerTypeAnn(tree.tpe))
-          val (a, b) = transBlock(stms, expr, cpsA2, cpsR2)
+          //          val (cpsA2, cpsR2) = (None, getAnswerTypeAnn(tree.tpe))
 
-          val tree1 = (treeCopy.Block(tree, a, b)) // no updateSynthFlag here!!!
+          val (a, b) = transBlock(stms, expr, cpsA2, cpsR2)
+          val tree1  = (treeCopy.Block(tree, a, b)) // no updateSynthFlag here!!!
 
           (Nil, tree1, cpsA)
 
-          case If(cond, thenp, elsep) =>
-            /* possible situations:
-            cps before (cpsA)
-            cps in condition (spc)  <-- synth flag set if *only* here!
-            cps in (one or both) branches */
-            val (condStats, condVal, spc) = transInlineValue(cond, cpsA)
-            val (cpsA2, cpsR2) = if (hasSynthMarker(tree.tpe))
-              (spc, linearize(spc, getAnswerTypeAnn(tree.tpe))) else
-              (None, getAnswerTypeAnn(tree.tpe)) // if no cps in condition, branches must conform to tree.tpe directly
-            val thenVal = transExpr(thenp, cpsA2, cpsR2)
-            val elseVal = transExpr(elsep, cpsA2, cpsR2)
-
-            // check that then and else parts agree (not necessary any more, but left as sanity check)
-            if (cpsR.isDefined) {
-              if (elsep == EmptyTree)
-                unit.error(tree.pos, "always need else part in cps code")
-            }
-            if (hasAnswerTypeAnn(thenVal.tpe) != hasAnswerTypeAnn(elseVal.tpe)) {
-              unit.error(tree.pos, "then and else parts must both be cps code or neither of them")
-            }
-
-            (condStats, updateSynthFlag(treeCopy.If(tree, condVal, thenVal, elseVal)), spc)
+        case If(cond, thenp, elsep) =>
+          /* possible situations:
+          cps before (cpsA)
+          cps in condition (spc)  <-- synth flag set if *only* here!
+          cps in (one or both) branches */
+          val (condStats, condVal, spc) = transInlineValue(cond, cpsA)
+          val (cpsA2, cpsR2) = if (hasSynthMarker(tree.tpe))
+            (spc, linearize(spc, getAnswerTypeAnn(tree.tpe))) else
+            (None, getAnswerTypeAnn(tree.tpe)) // if no cps in condition, branches must conform to tree.tpe directly
+          val thenVal = transExpr(thenp, cpsA2, cpsR2)
+          val elseVal = transExpr(elsep, cpsA2, cpsR2)
+
+          // check that then and else parts agree (not necessary any more, but left as sanity check)
+          if (cpsR.isDefined) {
+            if (elsep == EmptyTree)
+              unit.error(tree.pos, "always need else part in cps code")
+          }
+          if (hasAnswerTypeAnn(thenVal.tpe) != hasAnswerTypeAnn(elseVal.tpe)) {
+            unit.error(tree.pos, "then and else parts must both be cps code or neither of them")
+          }
 
-          case Match(selector, cases) =>
+          (condStats, updateSynthFlag(treeCopy.If(tree, condVal, thenVal, elseVal)), spc)
 
-            val (selStats, selVal, spc) = transInlineValue(selector, cpsA)
-            val (cpsA2, cpsR2) = if (hasSynthMarker(tree.tpe))
-              (spc, linearize(spc, getAnswerTypeAnn(tree.tpe))) else
-              (None, getAnswerTypeAnn(tree.tpe))
+        case Match(selector, cases) =>
+          val (selStats, selVal, spc) = transInlineValue(selector, cpsA)
+          val (cpsA2, cpsR2) =
+            if (hasSynthMarker(tree.tpe)) (spc, linearize(spc, getAnswerTypeAnn(tree.tpe)))
+            else (None, getAnswerTypeAnn(tree.tpe))
 
-            val caseVals = for {
-              cd @ CaseDef(pat, guard, body) <- cases
-              bodyVal = transExpr(body, cpsA2, cpsR2)
-            } yield {
-              treeCopy.CaseDef(cd, transform(pat), transform(guard), bodyVal)
-            }
+          val caseVals = cases map { case cd @ CaseDef(pat, guard, body) =>
+            val bodyVal = transExpr(body, cpsA2, cpsR2)
+            treeCopy.CaseDef(cd, transform(pat), transform(guard), bodyVal)
+          }
 
-            (selStats, updateSynthFlag(treeCopy.Match(tree, selVal, caseVals)), spc)
+          (selStats, updateSynthFlag(treeCopy.Match(tree, selVal, caseVals)), spc)
 
+        // this is utterly broken: LabelDefs need to be considered together when transforming them to DefDefs:
+        // suppose a Block {L1; ... ; LN}
+        // this should become {D1def ; ... ; DNdef ; D1()}
+        // where D$idef = def L$i(..) = {L$i.body; L${i+1}(..)}
 
         case ldef @ LabelDef(name, params, rhs) =>
           if (hasAnswerTypeAnn(tree.tpe)) {
-            val sym    = currentOwner.newMethod(name, tree.pos, Flags.SYNTHETIC) setInfo ldef.symbol.info
-            val rhs1   = new TreeSymSubstituter(List(ldef.symbol), List(sym)).transform(rhs)
+            // currentOwner.newMethod(name, tree.pos, Flags.SYNTHETIC) setInfo ldef.symbol.info
+            val sym    = ldef.symbol resetFlag Flags.LABEL
+            val rhs1   = rhs //new TreeSymSubstituter(List(ldef.symbol), List(sym)).transform(rhs)
             val rhsVal = transExpr(rhs1, None, getAnswerTypeAnn(tree.tpe)) changeOwner (currentOwner -> sym)
 
             val stm1 = localTyper.typed(DefDef(sym, rhsVal))
-            val expr = localTyper.typed(Apply(Ident(sym), List()))
-
-            (List(stm1), expr, cpsA)
+            // since virtpatmat does not rely on fall-through, don't call the labels it emits
+            // transBlock will take care of calling the first label
+            // calling each labeldef is wrong, since some labels may be jumped over
+            // we can get away with this for now since the only other labels we emit are for tailcalls/while loops,
+            // which do not have consecutive labeldefs (and thus fall-through is irrelevant)
+            if (gen.hasSynthCaseSymbol(ldef)) (List(stm1), localTyper.typed{Literal(Constant(()))}, cpsA)
+            else {
+              assert(params.isEmpty, "problem in ANF transforming label with non-empty params "+ ldef)
+              (List(stm1), localTyper.typed{Apply(Ident(sym), List())}, cpsA)
+            }
           } else {
             val rhsVal = transExpr(rhs, None, None)
             (Nil, updateSynthFlag(treeCopy.LabelDef(tree, name, params, rhsVal)), cpsA)
@@ -412,18 +443,29 @@ abstract class SelectiveANFTransform extends PluginComponent with Transform with
     }
 
     def transBlock(stms: List[Tree], expr: Tree, cpsA: CPSInfo, cpsR: CPSInfo): (List[Tree], Tree) = {
-      stms match {
-        case Nil =>
-          transTailValue(expr, cpsA, cpsR)
-
-        case stm::rest =>
-          var (rest2, expr2) = (rest, expr)
-          val (headStms, headSpc) = transInlineStm(stm, cpsA)
-          val (restStms, restExpr) = transBlock(rest2, expr2, headSpc, cpsR)
-          (headStms:::restStms, restExpr)
-       }
+      def rec(currStats: List[Tree], currAns: CPSInfo, accum: List[Tree]): (List[Tree], Tree) =
+        currStats match {
+          case Nil =>
+            val (anfStats, anfExpr) = transTailValue(expr, currAns, cpsR)
+            (accum ++ anfStats, anfExpr)
+
+          case stat :: rest =>
+            val (stats, nextAns) = transInlineStm(stat, currAns)
+            rec(rest, nextAns, accum ++ stats)
+         }
+
+      val (anfStats, anfExpr) = rec(stms, cpsA, List())
+      // println("\nanf-block:\n"+ ((stms :+ expr) mkString ("{", "\n", "}")) +"\nBECAME\n"+ ((anfStats :+ anfExpr) mkString ("{", "\n", "}")))
+
+      if (anfStats.nonEmpty && (anfStats forall gen.hasSynthCaseSymbol)) {
+        val (prologue, rest) = (anfStats :+ anfExpr) span (s => !s.isInstanceOf[DefDef]) // find first case
+        // val (defs, calls) = rest partition (_.isInstanceOf[DefDef])
+        if (rest nonEmpty){
+          val stats = prologue ++ rest.reverse // ++ calls
+          // println("REVERSED "+ (stats mkString ("{", "\n", "}")))
+          (stats, localTyper.typed{Apply(Ident(rest.head.symbol), List())}) // call first label to kick-start the match
+        } else (anfStats, anfExpr)
+      } else (anfStats, anfExpr)
     }
-
-
   }
 }