Add interfaces.AbstractFile

Author: smarter

interfaces/src/main/java/dotty/tools/dotc/interfaces/AbstractFile.java

@@ -0,0 +1,24 @@
+package dotty.tools.dotc.interfaces;
+
+import java.io.File;
+import java.util.Optional;
+
+/** An abstract file may either be a file on disk or a virtual file.
+ *
+ *  Do not rely on the identity of instances of this class.
+ *
+ *  User code should not implement this interface, but it may have to
+ *  manipulate objects of this type.
+ */
+public interface AbstractFile {
+  /** The name of this file, note that two files may have the same name. */
+  String name();
+
+  /** The path of this file, this might be a virtual path of an unspecified format. */
+  String path();
+
+  /** If this is a real file on disk, a `java.io.File` that corresponds to this file.
+   *  Otherwise, an empty `Optional`.
+   */
+  Optional<File> jfile();
+}

interfaces/src/main/java/dotty/tools/dotc/interfaces/CompilerCallback.java

@@ -1,7 +1,5 @@
 package dotty.tools.dotc.interfaces;
 
-import java.io.File;
-
 /** Set of callbacks called in response to events during the compilation process.
  *
  *  You should implement this interface if you want to react to one or more of
@@ -19,12 +17,12 @@ public interface CompilerCallback {
    *  @param className      The name of this class.
    *                        Example: scala.collection.Seq$
    */
-  default void onClassGenerated(File source, File generatedClass, String className) {};
+  default void onClassGenerated(SourceFile source, AbstractFile generatedClass, String className) {};
 
   /** Called when every class for this file has been generated.
    *
    *  @param source         The source file.
    *                        Example: ./src/library/scala/collection/Seq.scala
    */
-  default void onSourceCompiled(File source) {};
+  default void onSourceCompiled(SourceFile source) {};
 }

interfaces/src/main/java/dotty/tools/dotc/interfaces/SourceFile.java

@@ -2,18 +2,12 @@
 
 import java.io.File;
 
-/** A source file that may correspond to a file on disk but may also be virtual.
+/** A source file.
  *
  *  User code should not implement this interface, but it may have to
  *  manipulate objects of this type.
  */
-public interface SourceFile {
-  /** The name of this file, note that two files may have the same name. */
-  String name();
-
-  /** The path of this file, this might be a virtual path of an unspecified format. */
-  String path();
-
+public interface SourceFile extends AbstractFile {
   /** The content of this file as seen by the compiler. */
   char[] content();
 }

src/dotty/tools/backend/jvm/GenBCode.scala

@@ -13,6 +13,9 @@ import dotty.tools.dotc
 import dotty.tools.dotc.backend.jvm.DottyPrimitives
 import dotty.tools.dotc.transform.Erasure
 
+import dotty.tools.dotc.interfaces
+import java.util.Optional
+
 import scala.reflect.ClassTag
 import dotty.tools.dotc.core._
 import Periods._
@@ -51,7 +54,17 @@ class GenBCodePipeline(val entryPoints: List[Symbol], val int: DottyBackendInter
 
   var tree: Tree = _
 
-  val sourceJFile: JFile = ctx.compilationUnit.source.file.file
+  val sourceFile = ctx.compilationUnit.source
+
+  /** Convert a `scala.reflect.io.AbstractFile` into a
+   *  `dotty.tools.dotc.interfaces.AbstractFile`.
+   */
+  private[this] def convertAbstractFile(absfile: scala.reflect.io.AbstractFile): interfaces.AbstractFile =
+    new interfaces.AbstractFile {
+      override def name = absfile.name
+      override def path = absfile.path
+      override def jfile = Optional.ofNullable(absfile.file)
+    }
 
   final class PlainClassBuilder(cunit: CompilationUnit) extends SyncAndTryBuilder(cunit)
 
@@ -307,7 +320,7 @@ class GenBCodePipeline(val entryPoints: List[Symbol], val int: DottyBackendInter
       // Statistics.stopTimer(BackendStats.bcodeTimer, bcodeStart)
 
       if (ctx.compilerCallback != null)
-        ctx.compilerCallback.onSourceCompiled(sourceJFile)
+        ctx.compilerCallback.onSourceCompiled(sourceFile)
 
       /* TODO Bytecode can be verified (now that all classfiles have been written to disk)
        *
@@ -373,10 +386,9 @@ class GenBCodePipeline(val entryPoints: List[Symbol], val int: DottyBackendInter
               else getFileForClassfile(outFolder, jclassName, ".class")
             bytecodeWriter.writeClass(jclassName, jclassName, jclassBytes, outFile)
 
-            val outJFile = outFile.file
             val className = jclassName.replace('/', '.')
             if (ctx.compilerCallback != null)
-              ctx.compilerCallback.onClassGenerated(sourceJFile, outJFile, className)
+              ctx.compilerCallback.onClassGenerated(sourceFile, convertAbstractFile(outFile), className)
           }
           catch {
             case e: FileConflictException =>

src/dotty/tools/dotc/util/SourceFile.scala

@@ -11,6 +11,8 @@ import Chars._
 import ScriptSourceFile._
 import Positions._
 
+import java.util.Optional
+
 object ScriptSourceFile {
   @sharable private val headerPattern = Pattern.compile("""^(::)?!#.*(\r|\n|\r\n)""", Pattern.MULTILINE)
   private val headerStarts  = List("#!", "::#!")
@@ -43,6 +45,7 @@ case class SourceFile(file: AbstractFile, content: Array[Char]) extends interfac
 
   override def name = file.name
   override def path = file.path
+  override def jfile = Optional.ofNullable(file.file)
 
   override def equals(that : Any) = that match {
     case that : SourceFile => file.path == that.file.path && start == that.start

test/test/InterfaceEntryPointTest.scala

@@ -3,7 +3,6 @@ package test
 import org.junit.Test
 import org.junit.Assert._
 import dotty.tools.dotc.interfaces._
-import java.io.File
 import scala.collection.mutable.ListBuffer
 
 /** Test that demonstrates how to use dotty-interfaces
@@ -53,8 +52,9 @@ class InterfaceEntryPointTest {
     private val pathsBuffer = new ListBuffer[String]
     def paths = pathsBuffer.toList
 
-    override def onSourceCompiled(source: File): Unit = {
-      pathsBuffer += source.getPath
+    override def onSourceCompiled(source: SourceFile): Unit = {
+      if (source.jfile.isPresent)
+        pathsBuffer += source.jfile.get.getPath
     }
   }
 }

test/test/OtherEntryPointsTest.scala

@@ -3,7 +3,7 @@ package test
 import org.junit.Test
 import org.junit.Assert._
 import dotty.tools.dotc.Main
-import dotty.tools.dotc.interfaces.CompilerCallback
+import dotty.tools.dotc.interfaces.{CompilerCallback, SourceFile}
 import dotty.tools.dotc.reporting._
 import dotty.tools.dotc.core.Contexts._
 import java.io.File
@@ -58,8 +58,9 @@ class OtherEntryPointsTest {
     private val pathsBuffer = new ListBuffer[String]
     def paths = pathsBuffer.toList
 
-    override def onSourceCompiled(source: File): Unit = {
-      pathsBuffer += source.getPath
+    override def onSourceCompiled(source: SourceFile): Unit = {
+      if (source.jfile.isPresent)
+        pathsBuffer += source.jfile.get.getPath
     }
   }
 }