Skip to content

Commit 32a6cfc

Browse files
KordyjanKordyjan
authored
Backport "use new zinc 1.8 api for VirtualFile" to LTS (#19128)
Backports #18137 to the LTS branch. PR submitted by the release tooling. [skip ci]
2 parents 7169347 + 8b58415 commit 32a6cfc

28 files changed

+500
-205
lines changed

‎compiler/src/dotty/tools/backend/jvm/CodeGen.scala

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import scala.tools.asm
3030
import scala.tools.asm.tree._
3131
import tpd._
3232
import dotty.tools.io.AbstractFile
33+
import dotty.tools.dotc.util
3334
import dotty.tools.dotc.util.NoSourcePosition
3435

3536

@@ -106,7 +107,7 @@ class CodeGen(val int: DottyBackendInterface, val primitives: DottyPrimitives)(
106107
}
107108

108109
// Creates a callback that will be evaluated in PostProcessor after creating a file
109-
private def onFileCreated(cls: ClassNode, claszSymbol: Symbol, sourceFile: interfaces.SourceFile): AbstractFile => Unit = clsFile => {
110+
private def onFileCreated(cls: ClassNode, claszSymbol: Symbol, sourceFile: util.SourceFile): AbstractFile => Unit = clsFile => {
110111
val (fullClassName, isLocal) = atPhase(sbtExtractDependenciesPhase) {
111112
(ExtractDependencies.classNameAsString(claszSymbol), claszSymbol.isLocal)
112113
}
@@ -115,12 +116,9 @@ class CodeGen(val int: DottyBackendInterface, val primitives: DottyPrimitives)(
115116
if (ctx.compilerCallback != null)
116117
ctx.compilerCallback.onClassGenerated(sourceFile, convertAbstractFile(clsFile), className)
117118

118-
if (ctx.sbtCallback != null) {
119-
val jSourceFile = sourceFile.jfile.orElse(null)
120-
val cb = ctx.sbtCallback
121-
if (isLocal) cb.generatedLocalClass(jSourceFile, clsFile.file)
122-
else cb.generatedNonLocalClass(jSourceFile, clsFile.file, className, fullClassName)
123-
}
119+
ctx.withIncCallback: cb =>
120+
if (isLocal) cb.generatedLocalClass(sourceFile, clsFile.jpath)
121+
else cb.generatedNonLocalClass(sourceFile, clsFile.jpath, className, fullClassName)
124122
}
125123

126124
/** Convert a `dotty.tools.io.AbstractFile` into a

‎compiler/src/dotty/tools/dotc/core/Contexts.scala

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,25 @@ import scala.annotation.internal.sharable
3434

3535
import DenotTransformers.DenotTransformer
3636
import dotty.tools.dotc.profile.Profiler
37+
import dotty.tools.dotc.sbt.interfaces.IncrementalCallback
3738
import util.Property.Key
3839
import util.Store
39-
import xsbti.AnalysisCallback
4040
import plugins._
4141
import java.util.concurrent.atomic.AtomicInteger
4242
import java.nio.file.InvalidPathException
4343

4444
object Contexts {
4545

46-
private val (compilerCallbackLoc, store1) = Store.empty.newLocation[CompilerCallback]()
47-
private val (sbtCallbackLoc, store2) = store1.newLocation[AnalysisCallback]()
48-
private val (printerFnLoc, store3) = store2.newLocation[Context => Printer](new RefinedPrinter(_))
49-
private val (settingsStateLoc, store4) = store3.newLocation[SettingsState]()
50-
private val (compilationUnitLoc, store5) = store4.newLocation[CompilationUnit]()
51-
private val (runLoc, store6) = store5.newLocation[Run | Null]()
52-
private val (profilerLoc, store7) = store6.newLocation[Profiler]()
53-
private val (notNullInfosLoc, store8) = store7.newLocation[List[NotNullInfo]]()
54-
private val (importInfoLoc, store9) = store8.newLocation[ImportInfo | Null]()
55-
private val (typeAssignerLoc, store10) = store9.newLocation[TypeAssigner](TypeAssigner)
46+
private val (compilerCallbackLoc, store1) = Store.empty.newLocation[CompilerCallback]()
47+
private val (incCallbackLoc, store2) = store1.newLocation[IncrementalCallback | Null]()
48+
private val (printerFnLoc, store3) = store2.newLocation[Context => Printer](new RefinedPrinter(_))
49+
private val (settingsStateLoc, store4) = store3.newLocation[SettingsState]()
50+
private val (compilationUnitLoc, store5) = store4.newLocation[CompilationUnit]()
51+
private val (runLoc, store6) = store5.newLocation[Run | Null]()
52+
private val (profilerLoc, store7) = store6.newLocation[Profiler]()
53+
private val (notNullInfosLoc, store8) = store7.newLocation[List[NotNullInfo]]()
54+
private val (importInfoLoc, store9) = store8.newLocation[ImportInfo | Null]()
55+
private val (typeAssignerLoc, store10) = store9.newLocation[TypeAssigner](TypeAssigner)
5656

5757
private val initialStore = store10
5858

@@ -164,8 +164,18 @@ object Contexts {
164164
/** The compiler callback implementation, or null if no callback will be called. */
165165
def compilerCallback: CompilerCallback = store(compilerCallbackLoc)
166166

167-
/** The sbt callback implementation if we are run from sbt, null otherwise */
168-
def sbtCallback: AnalysisCallback = store(sbtCallbackLoc)
167+
/** The Zinc callback implementation if we are run from Zinc, null otherwise */
168+
def incCallback: IncrementalCallback | Null = store(incCallbackLoc)
169+
170+
/** Run `op` if there exists an incremental callback */
171+
inline def withIncCallback(inline op: IncrementalCallback => Unit): Unit =
172+
val local = incCallback
173+
if local != null then op(local)
174+
175+
def runZincPhases: Boolean =
176+
def forceRun = settings.YdumpSbtInc.value || settings.YforceSbtPhases.value
177+
val local = incCallback
178+
local != null && local.enabled || forceRun
169179

170180
/** The current plain printer */
171181
def printerFn: Context => Printer = store(printerFnLoc)
@@ -664,7 +674,7 @@ object Contexts {
664674
}
665675

666676
def setCompilerCallback(callback: CompilerCallback): this.type = updateStore(compilerCallbackLoc, callback)
667-
def setSbtCallback(callback: AnalysisCallback): this.type = updateStore(sbtCallbackLoc, callback)
677+
def setIncCallback(callback: IncrementalCallback): this.type = updateStore(incCallbackLoc, callback)
668678
def setPrinterFn(printer: Context => Printer): this.type = updateStore(printerFnLoc, printer)
669679
def setSettings(settingsState: SettingsState): this.type = updateStore(settingsStateLoc, settingsState)
670680
def setRun(run: Run | Null): this.type = updateStore(runLoc, run)

‎compiler/src/dotty/tools/dotc/sbt/APIUtils.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ object APIUtils {
3535
* a dummy empty class can be registered instead, using this method.
3636
*/
3737
def registerDummyClass(classSym: ClassSymbol)(using Context): Unit = {
38-
if (ctx.sbtCallback != null) {
38+
ctx.withIncCallback { cb =>
3939
val classLike = emptyClassLike(classSym)
40-
ctx.sbtCallback.api(ctx.compilationUnit.source.file.file, classLike)
40+
cb.api(ctx.compilationUnit.source, classLike)
4141
}
4242
}
4343

‎compiler/src/dotty/tools/dotc/sbt/ExtractAPI.scala

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,7 @@ class ExtractAPI extends Phase {
4949
override def description: String = ExtractAPI.description
5050

5151
override def isRunnable(using Context): Boolean = {
52-
def forceRun = ctx.settings.YdumpSbtInc.value || ctx.settings.YforceSbtPhases.value
53-
super.isRunnable && (ctx.sbtCallback != null || forceRun)
52+
super.isRunnable && ctx.runZincPhases
5453
}
5554

5655
// Check no needed. Does not transform trees
@@ -65,28 +64,27 @@ class ExtractAPI extends Phase {
6564

6665
override def run(using Context): Unit = {
6766
val unit = ctx.compilationUnit
68-
val sourceFile = unit.source.file
69-
if (ctx.sbtCallback != null)
70-
ctx.sbtCallback.startSource(sourceFile.file)
67+
val sourceFile = unit.source
68+
ctx.withIncCallback: cb =>
69+
cb.startSource(sourceFile)
7170

7271
val apiTraverser = new ExtractAPICollector
7372
val classes = apiTraverser.apiSource(unit.tpdTree)
7473
val mainClasses = apiTraverser.mainClasses
7574

7675
if (ctx.settings.YdumpSbtInc.value) {
7776
// Append to existing file that should have been created by ExtractDependencies
78-
val pw = new PrintWriter(File(sourceFile.jpath).changeExtension("inc").toFile
77+
val pw = new PrintWriter(File(sourceFile.file.jpath).changeExtension("inc").toFile
7978
.bufferedWriter(append = true), true)
8079
try {
8180
classes.foreach(source => pw.println(DefaultShowAPI(source)))
8281
} finally pw.close()
8382
}
8483

85-
if ctx.sbtCallback != null &&
86-
!ctx.compilationUnit.suspendedAtInliningPhase // already registered before this unit was suspended
87-
then
88-
classes.foreach(ctx.sbtCallback.api(sourceFile.file, _))
89-
mainClasses.foreach(ctx.sbtCallback.mainClass(sourceFile.file, _))
84+
ctx.withIncCallback: cb =>
85+
if !ctx.compilationUnit.suspendedAtInliningPhase then // already registered before this unit was suspended
86+
classes.foreach(cb.api(sourceFile, _))
87+
mainClasses.foreach(cb.mainClass(sourceFile, _))
9088
}
9189
}
9290

‎compiler/src/dotty/tools/dotc/sbt/ExtractDependencies.scala

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ package sbt
44
import scala.language.unsafeNulls
55

66
import java.io.File
7+
import java.nio.file.Path
78
import java.util.{Arrays, EnumSet}
89

910
import dotty.tools.dotc.ast.tpd
@@ -54,8 +55,7 @@ class ExtractDependencies extends Phase {
5455
override def description: String = ExtractDependencies.description
5556

5657
override def isRunnable(using Context): Boolean = {
57-
def forceRun = ctx.settings.YdumpSbtInc.value || ctx.settings.YforceSbtPhases.value
58-
super.isRunnable && (ctx.sbtCallback != null || forceRun)
58+
super.isRunnable && ctx.runZincPhases
5959
}
6060

6161
// Check no needed. Does not transform trees
@@ -90,18 +90,16 @@ class ExtractDependencies extends Phase {
9090
} finally pw.close()
9191
}
9292

93-
if (ctx.sbtCallback != null) {
93+
ctx.withIncCallback: cb =>
9494
collector.usedNames.foreach {
9595
case (clazz, usedNames) =>
9696
val className = classNameAsString(clazz)
9797
usedNames.names.foreach {
9898
case (usedName, scopes) =>
99-
ctx.sbtCallback.usedName(className, usedName.toString, scopes)
99+
cb.usedName(className, usedName.toString, scopes)
100100
}
101101
}
102-
103102
collector.dependencies.foreach(recordDependency)
104-
}
105103
}
106104

107105
/*
@@ -111,27 +109,20 @@ class ExtractDependencies extends Phase {
111109
*/
112110
def recordDependency(dep: ClassDependency)(using Context): Unit = {
113111
val fromClassName = classNameAsString(dep.from)
114-
val sourceFile = ctx.compilationUnit.source.file.file
112+
val sourceFile = ctx.compilationUnit.source
115113

116-
def binaryDependency(file: File, binaryClassName: String) =
117-
ctx.sbtCallback.binaryDependency(file, binaryClassName, fromClassName, sourceFile, dep.context)
114+
def binaryDependency(file: Path, binaryClassName: String) =
115+
ctx.withIncCallback(_.binaryDependency(file, binaryClassName, fromClassName, sourceFile, dep.context))
118116

119117
def processExternalDependency(depFile: AbstractFile, binaryClassName: String) = {
120118
depFile match {
121119
case ze: ZipArchive#Entry => // The dependency comes from a JAR
122120
ze.underlyingSource match
123-
case Some(zip) if zip.file != null =>
124-
binaryDependency(zip.file, binaryClassName)
121+
case Some(zip) if zip.jpath != null =>
122+
binaryDependency(zip.jpath, binaryClassName)
125123
case _ =>
126-
case pf: PlainFile => // The dependency comes from a class file
127-
// FIXME: pf.file is null for classfiles coming from the modulepath
128-
// (handled by JrtClassPath) because they cannot be represented as
129-
// java.io.File, since the `binaryDependency` callback must take a
130-
// java.io.File, this means that we cannot record dependencies coming
131-
// from the modulepath. For now this isn't a big deal since we only
132-
// support having the standard Java library on the modulepath.
133-
if pf.file != null then
134-
binaryDependency(pf.file, binaryClassName)
124+
case pf: PlainFile => // The dependency comes from a class file, Zinc handles JRT filesystem
125+
binaryDependency(pf.jpath, binaryClassName)
135126
case _ =>
136127
internalError(s"Ignoring dependency $depFile of unknown class ${depFile.getClass}}", dep.from.srcPos)
137128
}
@@ -144,11 +135,11 @@ class ExtractDependencies extends Phase {
144135
if (depFile.extension == "class") {
145136
// Dependency is external -- source is undefined
146137
processExternalDependency(depFile, dep.to.binaryClassName)
147-
} else if (allowLocal || depFile.file != sourceFile) {
138+
} else if (allowLocal || depFile != sourceFile.file) {
148139
// We cannot ignore dependencies coming from the same source file because
149140
// the dependency info needs to propagate. See source-dependencies/trait-trait-211.
150141
val toClassName = classNameAsString(dep.to)
151-
ctx.sbtCallback.classDependency(toClassName, fromClassName, dep.context)
142+
ctx.withIncCallback(_.classDependency(toClassName, fromClassName, dep.context))
152143
}
153144
}
154145
}

‎compiler/src/dotty/tools/dotc/sbt/interfaces/IncrementalCallback.java

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
package dotty.tools.dotc.sbt.interfaces;
2+
3+
import dotty.tools.dotc.util.SourceFile;
4+
5+
import java.util.EnumSet;
6+
import java.nio.file.Path;
7+
8+
/* User code should not implement this interface, it is intended to be a wrapper around xsbti.AnalysisCallback. */
9+
public interface IncrementalCallback {
10+
default void api(SourceFile sourceFile, xsbti.api.ClassLike classApi) {
11+
}
12+
13+
default void startSource(SourceFile sourceFile) {
14+
}
15+
16+
default void mainClass(SourceFile sourceFile, String className) {
17+
}
18+
19+
default boolean enabled() {
20+
return false;
21+
}
22+
23+
default void usedName(String className, String name, EnumSet<xsbti.UseScope> useScopes) {
24+
}
25+
26+
default void binaryDependency(Path onBinaryEntry, String onBinaryClassName, String fromClassName,
27+
SourceFile fromSourceFile, xsbti.api.DependencyContext context) {
28+
}
29+
30+
default void classDependency(String onClassName, String sourceClassName, xsbti.api.DependencyContext context) {
31+
}
32+
33+
default void generatedLocalClass(SourceFile source, Path classFile) {
34+
}
35+
36+
default void generatedNonLocalClass(SourceFile source, Path classFile, String binaryClassName,
37+
String srcClassName) {
38+
}
39+
}

‎project/Build.scala

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,33 @@ object Build {
525525
recur(lines, false)
526526
}
527527

528+
/** replace imports of `com.google.protobuf.*` with compiler implemented version */
529+
def replaceProtobuf(lines: List[String]): List[String] = {
530+
def recur(ls: List[String]): List[String] = ls match {
531+
case l :: rest =>
532+
val lt = l.trim()
533+
if (lt.isEmpty || lt.startsWith("package ") || lt.startsWith("import ")) {
534+
val newLine =
535+
if (lt.startsWith("import com.google.protobuf.")) {
536+
if (lt == "import com.google.protobuf.CodedInputStream") {
537+
"import dotty.tools.dotc.semanticdb.internal.SemanticdbInputStream as CodedInputStream"
538+
} else if (lt == "import com.google.protobuf.CodedOutputStream") {
539+
"import dotty.tools.dotc.semanticdb.internal.SemanticdbOutputStream as CodedOutputStream"
540+
} else {
541+
l
542+
}
543+
} else {
544+
l
545+
}
546+
newLine :: recur(rest)
547+
} else {
548+
ls // don't check rest of file
549+
}
550+
case _ => ls
551+
}
552+
recur(lines)
553+
}
554+
528555
// Settings shared between scala3-compiler and scala3-compiler-bootstrapped
529556
lazy val commonDottyCompilerSettings = Seq(
530557
// Generate compiler.properties, used by sbt
@@ -551,7 +578,7 @@ object Build {
551578
// get libraries onboard
552579
libraryDependencies ++= Seq(
553580
"org.scala-lang.modules" % "scala-asm" % "9.5.0-scala-1", // used by the backend
554-
Dependencies.oldCompilerInterface, // we stick to the old version to avoid deprecation warnings
581+
Dependencies.compilerInterface,
555582
"org.jline" % "jline-reader" % "3.19.0", // used by the REPL
556583
"org.jline" % "jline-terminal" % "3.19.0",
557584
"org.jline" % "jline-terminal-jna" % "3.19.0", // needed for Windows
@@ -668,7 +695,8 @@ object Build {
668695
val dottyTastyInspector = jars("scala3-tasty-inspector")
669696
val dottyInterfaces = jars("scala3-interfaces")
670697
val tastyCore = jars("tasty-core")
671-
run(insertClasspathInArgs(args1, List(dottyCompiler, dottyInterfaces, asm, dottyStaging, dottyTastyInspector, tastyCore).mkString(File.pathSeparator)))
698+
val compilerInterface = findArtifactPath(externalDeps, "compiler-interface")
699+
run(insertClasspathInArgs(args1, List(dottyCompiler, dottyInterfaces, asm, dottyStaging, dottyTastyInspector, tastyCore, compilerInterface).mkString(File.pathSeparator)))
672700
} else run(args)
673701
},
674702

@@ -707,7 +735,8 @@ object Build {
707735
val dottyTastyInspector = jars("scala3-tasty-inspector")
708736
val tastyCore = jars("tasty-core")
709737
val asm = findArtifactPath(externalDeps, "scala-asm")
710-
extraClasspath ++= Seq(dottyCompiler, dottyInterfaces, asm, dottyStaging, dottyTastyInspector, tastyCore)
738+
val compilerInterface = findArtifactPath(externalDeps, "compiler-interface")
739+
extraClasspath ++= Seq(dottyCompiler, dottyInterfaces, asm, dottyStaging, dottyTastyInspector, tastyCore, compilerInterface)
711740
}
712741

713742
val fullArgs = main :: (if (printTasty) args else insertClasspathInArgs(args, extraClasspath.mkString(File.pathSeparator)))
@@ -1051,8 +1080,7 @@ object Build {
10511080
// when sbt reads the settings.
10521081
Test / test := (LocalProject("scala3-sbt-bridge-tests") / Test / test).value,
10531082

1054-
// The `newCompilerInterface` is backward compatible with the `oldCompilerInterface`
1055-
libraryDependencies += Dependencies.newCompilerInterface % Provided
1083+
libraryDependencies += Dependencies.compilerInterface % Provided
10561084
)
10571085

10581086
// We use a separate project for the bridge tests since they can only be run
@@ -1134,7 +1162,8 @@ object Build {
11341162
val mtagsSharedSources = (targetDir ** "*.scala").get.toSet
11351163
mtagsSharedSources.foreach(f => {
11361164
val lines = IO.readLines(f)
1137-
IO.writeLines(f, insertUnsafeNullsImport(lines))
1165+
val substitutions = (replaceProtobuf(_)) andThen (insertUnsafeNullsImport(_))
1166+
IO.writeLines(f, substitutions(lines))
11381167
})
11391168
mtagsSharedSources
11401169
} (Set(mtagsSharedSourceJar)).toSeq

‎project/Dependencies.scala

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,5 @@ object Dependencies {
2828
"com.vladsch.flexmark" % "flexmark-ext-yaml-front-matter" % flexmarkVersion,
2929
)
3030

31-
val newCompilerInterface = "org.scala-sbt" % "compiler-interface" % "1.9.0"
32-
val oldCompilerInterface = "org.scala-sbt" % "compiler-interface" % "1.3.5"
31+
val compilerInterface = "org.scala-sbt" % "compiler-interface" % "1.9.0"
3332
}

0 commit comments

Comments
 (0)