Merge pull request #1317 from gkossakowski/ant-style-inc

Add Ant-style incremental compilation mode

compile/inc/src/main/scala/sbt/inc/IncOptions.scala

@@ -65,7 +65,22 @@ final class IncOptions(
      *   3. Hashing of public names is enabled. See `sbt.inc.AnalysisCallback` for details.
      *
      */
-    val nameHashing: Boolean) extends Product with Serializable {
+    val nameHashing: Boolean,
+    /**
+     * THE `antStyle` OPTION IS UNSUPPORTED, MAY GO AWAY AT ANY POINT.
+     *
+     * Enables "ant-style" mode of incremental compilation. This mode emulates what Ant's scalac command does.
+     * The idea is to recompile just changed source files and not perform any invalidation of dependencies. This
+     * is a very naive mode of incremental compilation that very often leads to broken binaries.
+     *
+     * The Ant-style mode has been introduced because Scala team needs it for migration of Scala compiler to sbt.
+     * The name hashing algorithm doesn't work well with Scala compiler sources due to deep inheritance chains.
+     * There's a plan to refactor compiler's code to use more composition instead of inheritance.
+     *
+     * Once Scala compiler sources are refactored to work well with name hashing algorithm this option will be
+     * deleted immediately.
+     */
+    val antStyle: Boolean) extends Product with Serializable {
 
   /**
    * Secondary constructor introduced to make IncOptions to be binary compatible with version that didn't have
@@ -74,52 +89,60 @@ final class IncOptions(
   def this(transitiveStep: Int, recompileAllFraction: Double, relationsDebug: Boolean, apiDebug: Boolean,
     apiDiffContextSize: Int, apiDumpDirectory: Option[java.io.File], newClassfileManager: () => ClassfileManager) = {
     this(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, IncOptions.recompileOnMacroDefDefault, IncOptions.nameHashingDefault)
+      apiDumpDirectory, newClassfileManager, IncOptions.recompileOnMacroDefDefault, IncOptions.nameHashingDefault,
+      IncOptions.antStyleDefault)
   }
 
+  assert(!(antStyle && nameHashing), "Name hashing and Ant-style cannot be enabled at the same time.")
+
   def withTransitiveStep(transitiveStep: Int): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withRecompileAllFraction(recompileAllFraction: Double): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withRelationsDebug(relationsDebug: Boolean): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withApiDebug(apiDebug: Boolean): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withApiDiffContextSize(apiDiffContextSize: Int): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withApiDumpDirectory(apiDumpDirectory: Option[File]): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withNewClassfileManager(newClassfileManager: () => ClassfileManager): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withRecompileOnMacroDef(recompileOnMacroDef: Boolean): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   def withNameHashing(nameHashing: Boolean): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
+  }
+
+  def withAntStyle(antStyle: Boolean): IncOptions = {
+    new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   //- EXPANDED CASE CLASS METHOD BEGIN -//
@@ -130,14 +153,14 @@ final class IncOptions(
     apiDumpDirectory: Option[java.io.File] = this.apiDumpDirectory,
     newClassfileManager: () => ClassfileManager = this.newClassfileManager): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyle)
   }
 
   @deprecated("Methods generated for case class will be removed in the future.", "0.13.2")
   override def productPrefix: String = "IncOptions"
 
   @deprecated("Methods generated for case class will be removed in the future.", "0.13.2")
-  def productArity: Int = 9
+  def productArity: Int = 10
 
   @deprecated("Methods generated for case class will be removed in the future.", "0.13.2")
   def productElement(x$1: Int): Any = x$1 match {
@@ -150,6 +173,7 @@ final class IncOptions(
     case 6 => IncOptions.this.newClassfileManager
     case 7 => IncOptions.this.recompileOnMacroDef
     case 8 => IncOptions.this.nameHashing
+    case 9 => IncOptions.this.antStyle
     case _ => throw new IndexOutOfBoundsException(x$1.toString())
   }
 
@@ -171,6 +195,7 @@ final class IncOptions(
     acc = Statics.mix(acc, Statics.anyHash(newClassfileManager))
     acc = Statics.mix(acc, if (recompileOnMacroDef) 1231 else 1237)
     acc = Statics.mix(acc, if (nameHashing) 1231 else 1237)
+    acc = Statics.mix(acc, if (antStyle) 1231 else 1237)
     Statics.finalizeHash(acc, 9)
   }
 
@@ -183,7 +208,8 @@ final class IncOptions(
         relationsDebug == IncOptions$1.relationsDebug && apiDebug == IncOptions$1.apiDebug &&
         apiDiffContextSize == IncOptions$1.apiDiffContextSize && apiDumpDirectory == IncOptions$1.apiDumpDirectory &&
         newClassfileManager == IncOptions$1.newClassfileManager &&
-        recompileOnMacroDef == IncOptions$1.recompileOnMacroDef && nameHashing == IncOptions$1.nameHashing
+        recompileOnMacroDef == IncOptions$1.recompileOnMacroDef && nameHashing == IncOptions$1.nameHashing &&
+        antStyle == IncOptions$1.antStyle
     }))
   }
   //- EXPANDED CASE CLASS METHOD END -//
@@ -192,6 +218,7 @@ final class IncOptions(
 object IncOptions extends Serializable {
   private val recompileOnMacroDefDefault: Boolean = true
   private val nameHashingDefault: Boolean = false
+  private val antStyleDefault: Boolean = false
   val Default = IncOptions(
     //    1. recompile changed sources
     // 2(3). recompile direct dependencies and transitive public inheritance dependencies of sources with API changes in 1(2).
@@ -220,7 +247,7 @@ object IncOptions extends Serializable {
     newClassfileManager: () => ClassfileManager, recompileOnMacroDef: Boolean,
     nameHashing: Boolean): IncOptions = {
     new IncOptions(transitiveStep, recompileAllFraction, relationsDebug, apiDebug, apiDiffContextSize,
-      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing)
+      apiDumpDirectory, newClassfileManager, recompileOnMacroDef, nameHashing, antStyleDefault)
   }
   @deprecated("Methods generated for case class will be removed in the future.", "0.13.2")
   def unapply(x$0: IncOptions): Option[(Int, Double, Boolean, Boolean, Int, Option[java.io.File], () => AnyRef)] = {
@@ -248,6 +275,7 @@ object IncOptions extends Serializable {
   private val apiDiffContextSizeKey = "apiDiffContextSize"
   private val recompileOnMacroDefKey = "recompileOnMacroDef"
   private val nameHashingKey = "nameHashing"
+  private val antStyleKey = "antStyle"
 
   def fromStringMap(m: java.util.Map[String, String]): IncOptions = {
     // all the code below doesn't look like idiomatic Scala for a good reason: we are working with Java API
@@ -286,8 +314,13 @@ object IncOptions extends Serializable {
       if (m.containsKey(k)) m.get(k).toBoolean else Default.nameHashing
     }
 
+    def getAntStyle: Boolean = {
+      val k = antStyleKey
+      if (m.containsKey(k)) m.get(k).toBoolean else Default.antStyle
+    }
+
     new IncOptions(getTransitiveStep, getRecompileAllFraction, getRelationsDebug, getApiDebug, getApiDiffContextSize,
-      getApiDumpDirectory, ClassfileManager.deleteImmediately, getRecompileOnMacroDef, getNameHashing)
+      getApiDumpDirectory, ClassfileManager.deleteImmediately, getRecompileOnMacroDef, getNameHashing, getAntStyle)
   }
 
   def toStringMap(o: IncOptions): java.util.Map[String, String] = {

compile/inc/src/main/scala/sbt/inc/Incremental.scala

@@ -21,10 +21,12 @@ object Incremental {
     options: IncOptions)(implicit equivS: Equiv[Stamp]): (Boolean, Analysis) =
     {
       val incremental: IncrementalCommon =
-        if (!options.nameHashing)
-          new IncrementalDefaultImpl(log, options)
-        else
+        if (options.nameHashing)
           new IncrementalNameHashing(log, options)
+        else if (options.antStyle)
+          new IncrementalAntStyle(log, options)
+        else
+          new IncrementalDefaultImpl(log, options)
       val initialChanges = incremental.changedInitial(entry, sources, previous, current, forEntry)
       val binaryChanges = new DependencyChanges {
         val modifiedBinaries = initialChanges.binaryDeps.toArray
@@ -573,3 +575,22 @@ private final class IncrementalNameHashing(log: Logger, options: IncOptions) ext
     f => relations.memberRef.internal.reverse(f)
 
 }
+
+private final class IncrementalAntStyle(log: Logger, options: IncOptions) extends IncrementalCommon(log, options) {
+
+  /** Ant-style mode doesn't do anything special with package objects */
+  override protected def invalidatedPackageObjects(invalidated: Set[File], relations: Relations): Set[File] = Set.empty
+
+  /** In Ant-style mode we don't need to compare APIs because we don't perform any invalidation */
+  override protected def sameAPI[T](src: T, a: Source, b: Source): Option[APIChange[T]] = None
+
+  /** In Ant-style mode we don't perform any invalidation */
+  override protected def invalidateByExternal(relations: Relations, externalAPIChange: APIChange[String]): Set[File] = Set.empty
+
+  /** In Ant-style mode we don't perform any invalidation */
+  override protected def invalidateSource(relations: Relations, change: APIChange[File]): Set[File] = Set.empty
+
+  /** In Ant-style mode we don't need to perform any dependency analysis hence we can always return an empty set. */
+  override protected def allDeps(relations: Relations): File => Set[File] = _ => Set.empty
+
+}

sbt/src/sbt-test/compiler-project/inc-ant-style/build.sbt

@@ -0,0 +1,28 @@
+logLevel := Level.Debug
+
+incOptions := incOptions.value.withAntStyle(true)
+
+/* Performs checks related to compilations:
+ *  a) checks in which compilation given set of files was recompiled
+ *  b) checks overall number of compilations performed
+ */
+TaskKey[Unit]("check-compilations") <<= (compile in Compile, scalaSource in Compile) map { (a: sbt.inc.Analysis, src: java.io.File) =>
+  def relative(f: java.io.File): java.io.File =  f.relativeTo(src) getOrElse f
+  val allCompilations = a.compilations.allCompilations
+  val recompiledFiles: Seq[Set[java.io.File]] = allCompilations map { c =>
+    val recompiledFiles = a.apis.internal.collect {
+      case (file, api) if api.compilation.startTime == c.startTime => relative(file)
+    }
+    recompiledFiles.toSet
+  }
+  def recompiledFilesInIteration(iteration: Int, fileNames: Set[String]) = {
+    val files = fileNames.map(new java.io.File(_))
+    assert(recompiledFiles(iteration) == files, "%s != %s".format(recompiledFiles(iteration), files))
+  }
+  assert(allCompilations.size == 2)
+  // B.scala and C.scala are compiled at the beginning, in the Ant-style incremental compilation
+  // they are not rebuild when A.scala.
+  recompiledFilesInIteration(0, Set("B.scala", "C.scala"))
+  // A.scala is changed and recompiled
+  recompiledFilesInIteration(1, Set("A.scala"))
+}

sbt/src/sbt-test/compiler-project/inc-ant-style/changes/A1.scala

@@ -0,0 +1,3 @@
+package test3
+
+trait A

sbt/src/sbt-test/compiler-project/inc-ant-style/src/main/scala/A.scala

@@ -0,0 +1,5 @@
+package test3
+
+trait A {
+  def foo = 1
+}

sbt/src/sbt-test/compiler-project/inc-ant-style/src/main/scala/B.scala

@@ -0,0 +1,3 @@
+package test3
+
+trait B extends A

sbt/src/sbt-test/compiler-project/inc-ant-style/src/main/scala/C.scala

@@ -0,0 +1,5 @@
+package test3
+
+trait C {
+  def abc(a: A): Int = a.foo
+}

sbt/src/sbt-test/compiler-project/inc-ant-style/test

@@ -0,0 +1,9 @@
+# introduces first compile iteration
+> compile
+# this change is local to method and does not change api so introduces
+# only one additional compile iteration
+$ copy-file changes/A1.scala src/main/scala/A.scala
+# second iteration
+> compile
+# check if there are only two compile iterations performed
+> check-compilations