Fix scala#1312: Improve Xprint

* Do not reprint a tree that has not changed.
* Highlight changes with yellow and insertions in green.
* -Xprint-diff-del: Inserts the deleted parts of the tree in red
  and the parts that where changed in magenta.

Author: nicolasstucki

project/Build.scala

@@ -100,6 +100,7 @@ object DottyBuild extends Build {
                                   "org.scala-lang.modules" %% "scala-partest" % "1.0.11" % "test",
                                   "com.novocode" % "junit-interface" % "0.11" % "test",
                                   "jline" % "jline" % "2.12",
+                                  "com.googlecode.java-diff-utils" % "diffutils" % "1.3.0",
                                   "com.typesafe.sbt" % "sbt-interface" % sbtVersion.value),
       // enable improved incremental compilation algorithm
       incOptions := incOptions.value.withNameHashing(true),

src/dotty/tools/dotc/Run.scala

@@ -10,12 +10,20 @@ import reporting.Reporter
 import transform.TreeChecker
 import rewrite.Rewrites
 import java.io.{BufferedWriter, OutputStreamWriter}
+
+import scala.annotation.tailrec
 import scala.reflect.io.VirtualFile
 import scala.util.control.NonFatal
 
 /** A compiler run. Exports various methods to compile source files */
 class Run(comp: Compiler)(implicit ctx: Context) {
 
+  private final val ANSI_DEFAULT = "\u001B[0m"
+  private final val ANSI_RED = "\u001B[31m"
+  private final val ANSI_GREEN = "\u001B[32m"
+  private final val ANSI_YELLOW = "\u001B[33m"
+  private final val ANSI_MAGENTA = "\u001B[35m"
+
   assert(comp.phases.last.last.id <= Periods.MaxPossiblePhaseId)
   assert(ctx.runId <= Periods.MaxPossibleRunId)
 
@@ -56,26 +64,103 @@ class Run(comp: Compiler)(implicit ctx: Context) {
     val phases = ctx.squashPhases(ctx.phasePlan,
       ctx.settings.Yskip.value, ctx.settings.YstopBefore.value, ctx.settings.YstopAfter.value, ctx.settings.Ycheck.value)
     ctx.usePhases(phases)
+    var lastPrintedTree: PrintedTree = NoPrintedTree
     for (phase <- ctx.allPhases)
       if (!ctx.reporter.hasErrors) {
         val start = System.currentTimeMillis
         units = phase.runOn(units)
-        def foreachUnit(op: Context => Unit)(implicit ctx: Context): Unit =
-          for (unit <- units) op(ctx.fresh.setPhase(phase.next).setCompilationUnit(unit))
-        if (ctx.settings.Xprint.value.containsPhase(phase))
-          foreachUnit(printTree)
+        if (ctx.settings.Xprint.value.containsPhase(phase)) {
+          for (unit <- units) {
+            lastPrintedTree =
+              printTree(ctx.fresh.setPhase(phase.next).setCompilationUnit(unit), lastPrintedTree)
+          }
+        }
         ctx.informTime(s"$phase ", start)
       }
     if (!ctx.reporter.hasErrors) Rewrites.writeBack()
   }
 
-  private def printTree(ctx: Context) = {
+  private sealed trait PrintedTree
+  private final case class SomePrintedTree(phase: String, tree: String) extends PrintedTree
+  private object NoPrintedTree extends PrintedTree
+
+  private def printTree(ctx: Context, last: PrintedTree): PrintedTree = {
     val unit = ctx.compilationUnit
     val prevPhase = ctx.phase.prev // can be a mini-phase
     val squashedPhase = ctx.squashed(prevPhase)
+    val treeString = unit.tpdTree.show(ctx)
+
+    ctx.echo(s"result of $unit after $squashedPhase:")
+
+    last match {
+      case SomePrintedTree(phase, lastTreeSting) if lastTreeSting != treeString =>
+        ctx.echo(mkColoredDiffTree(treeString, lastTreeSting))
+        SomePrintedTree(squashedPhase.toString, treeString)
+
+      case SomePrintedTree(phase, lastTreeSting) =>
+        ctx.echo("  Unchanged since " + phase)
+        last
+
+      case NoPrintedTree =>
+        ctx.echo(treeString)
+        SomePrintedTree(squashedPhase.toString, treeString)
+    }
+  }
+
+  private def mkColoredDiffTree(treeString: String, lastTreeSting: String): String = {
+    import difflib._
+    import scala.collection.JavaConversions._
+
+    @tailrec def split(str: String, acc: List[String]): List[String] = {
+      if (str == "") {
+        acc.reverse
+      } else {
+        val head = str.charAt(0)
+        val (token, rest) = if (Character.isAlphabetic(head) || Character.isDigit(head)) {
+          str.span(c => Character.isAlphabetic(c) || Character.isDigit(c))
+        } else if (Character.isMirrored(head) || Character.isWhitespace(head)) {
+          str.splitAt(1)
+        } else {
+          str.span { c =>
+            !Character.isAlphabetic(c) && !Character.isDigit(c) &&
+            !Character.isMirrored(c) && !Character.isWhitespace(c)
+          }
+        }
+        split(rest, token :: acc)
+      }
+    }
+
+    val lines = split(treeString, Nil).toArray
+
+    val printDiffDel = ctx.settings.XprintDiffDel.value
+    val diff = DiffUtils.diff(split(lastTreeSting, Nil), lines.toList)
+
+    for (delta <- diff.getDeltas) {
+      val pos = delta.getRevised.getPosition
+      val endPos = pos + delta.getRevised.getLines.size - 1
+
+      delta.getType.toString match { // Issue #1355 forces us to use the toString
+        case "INSERT" =>
+          lines(pos) = ANSI_GREEN + lines(pos)
+          lines(endPos) = lines(endPos) + ANSI_DEFAULT
+
+        case "CHANGE" =>
+          val old = if (!printDiffDel) "" else
+            ANSI_MAGENTA + delta.getOriginal.getLines.mkString + ANSI_DEFAULT
+          lines(pos) = old + ANSI_YELLOW + lines(pos)
+          lines(endPos) = lines(endPos) + ANSI_DEFAULT
+
+        case "DELETE" if printDiffDel =>
+          val deleted = delta.getOriginal.getLines.mkString
+          if (!deleted.forall(Character.isWhitespace)) {
+            lines(pos) = ANSI_RED + deleted + ANSI_DEFAULT + lines(pos)
+          }
+
+        case _ =>
+      }
+    }
 
-    ctx.echo(s"result of $unit after ${squashedPhase}:")
-    ctx.echo(unit.tpdTree.show(ctx))
+    lines.mkString
   }
 
   def compile(sourceCode: String): Unit = {

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

@@ -86,6 +86,7 @@ class ScalaSettings extends Settings.SettingGroup {
   val writeICode = PhasesSetting("-Xprint-icode", "Log internal icode to *.icode files after", "icode")
   val Xprintpos = BooleanSetting("-Xprint-pos", "Print tree positions, as offsets.")
   val printtypes = BooleanSetting("-Xprint-types", "Print tree types (debugging option).")
+  val XprintDiffDel = BooleanSetting("-Xprint-diff-del", "Print deleted parts of the tree since last print.")
   val prompt = BooleanSetting("-Xprompt", "Display a prompt after each error (debugging option).")
   val script = StringSetting("-Xscript", "object", "Treat the source file as a script and wrap it in a main method.", "")
   val mainClass = StringSetting("-Xmain-class", "path", "Class for manifest's Main-Class entry (only useful with -d <jar>)", "")