Skip to content

Commit

Permalink
Rename postTransform to prePrint in emitter
Browse files Browse the repository at this point in the history 
Further, we move the implementations fully into Emitter: At this point
its clear, that there won't really be any others (unless we
fundamentally change tree printing).
  • Loading branch information
@gzm0
gzm0 committed Mar 31, 2024
1 parent 448eb1e commit 09336f3
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 88 deletions.
8 changes: 3 additions & 5 deletions linker/jvm/src/main/scala/org/scalajs/linker/backend/closure/ClosureLinkerBackend.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,10 @@ final class ClosureLinkerBackend(config: LinkerBackendImpl.Config)
.withTrackAllGlobalRefs(true)
.withInternalModulePattern(m => OutputPatternsImpl.moduleName(config.outputPatterns, m.id))

// Do not apply ClosureAstTransformer eagerly:
// The ASTs used by closure are highly mutable, so re-using them is non-trivial.
// Since closure is slow anyways, we haven't built the optimization.
val postTransformer = Emitter.PostTransformer.Identity
// Do not pre-print trees: We do not want the printed form.
val prePrinter = Emitter.PrePrinter.Off

new Emitter(emitterConfig, postTransformer)
new Emitter(emitterConfig, prePrinter)
}

val symbolRequirements: SymbolRequirement = emitter.symbolRequirements
Expand Down
43 changes: 5 additions & 38 deletions linker/shared/src/main/scala/org/scalajs/linker/backend/BasicLinkerBackend.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,18 @@ final class BasicLinkerBackend(config: LinkerBackendImpl.Config)
private[this] val fragmentIndex = new SourceMapWriter.Index

private[this] val emitter: Emitter = {
val postTransformer = {
if (config.minify) Emitter.PostTransformer.Identity
else if (config.sourceMap) new PostTransformerWithSourceMap(fragmentIndex)
else PostTransformerWithoutSourceMap
val prePrinter = {
if (config.minify) Emitter.PrePrinter.Off
else if (config.sourceMap) new Emitter.PrePrinter.WithSourceMap(fragmentIndex)
else Emitter.PrePrinter.WithoutSourceMap
}

val emitterConfig = Emitter.Config(config.commonConfig.coreSpec)
.withJSHeader(config.jsHeader)
.withInternalModulePattern(m => OutputPatternsImpl.moduleName(config.outputPatterns, m.id))
.withMinify(config.minify)

new Emitter(emitterConfig, postTransformer)
new Emitter(emitterConfig, prePrinter)
}

val symbolRequirements: SymbolRequirement = emitter.symbolRequirements
Expand Down Expand Up @@ -245,37 +245,4 @@ private object BasicLinkerBackend {
wasUsed
}
}

private object PostTransformerWithoutSourceMap extends Emitter.PostTransformer {
def transformStats(trees: List[js.Tree], indent: Int): List[js.PrintedTree] = {
if (trees.isEmpty) {
Nil // Fast path
} else {
val jsCodeWriter = new ByteArrayWriter()
val printer = new Printers.JSTreePrinter(jsCodeWriter, indent)

trees.foreach(printer.printStat(_))

js.PrintedTree(jsCodeWriter.toByteArray(), SourceMapWriter.Fragment.Empty) :: Nil
}
}
}

private class PostTransformerWithSourceMap(fragmentIndex: SourceMapWriter.Index)
extends Emitter.PostTransformer {
def transformStats(trees: List[js.Tree], indent: Int): List[js.PrintedTree] = {
if (trees.isEmpty) {
Nil // Fast path
} else {
val jsCodeWriter = new ByteArrayWriter()
val smFragmentBuilder = new SourceMapWriter.FragmentBuilder(fragmentIndex)
val printer = new Printers.JSTreePrinterWithSourceMap(jsCodeWriter, smFragmentBuilder, indent)

trees.foreach(printer.printStat(_))
smFragmentBuilder.complete()

js.PrintedTree(jsCodeWriter.toByteArray(), smFragmentBuilder.result()) :: Nil
}
}
}
}
100 changes: 66 additions & 34 deletions linker/shared/src/main/scala/org/scalajs/linker/backend/emitter/Emitter.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ import EmitterNames._
import GlobalRefUtils._

/** Emits a desugared JS tree to a builder */
final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransformer) {
final class Emitter(config: Emitter.Config, prePrinter: Emitter.PrePrinter) {

import Emitter._
import config._

require(!config.minify || postTransformer == PostTransformer.Identity,
"When using the 'minify' option, the postTransformer must be Identity.")
require(!config.minify || prePrinter == PrePrinter.Off,
"When using the 'minify' option, the prePrinter must be Off.")

private implicit val globalRefTracking: GlobalRefTracking =
config.topLevelGlobalRefTracking
Expand All @@ -64,8 +64,8 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
val classEmitter: ClassEmitter = new ClassEmitter(sjsGen)

val everyFileStart: List[js.Tree] = {
// This postTransform does not count in the statistics
postTransformer.transformStats(sjsGen.declarePrototypeVar, 0)
// This prePrint does not count in the statistics
prePrinter.prePrint(sjsGen.declarePrototypeVar, 0)
}

val coreJSLibCache: CoreJSLibCache = new CoreJSLibCache
Expand All @@ -86,7 +86,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
private[this] var statsClassesInvalidated: Int = 0
private[this] var statsMethodsReused: Int = 0
private[this] var statsMethodsInvalidated: Int = 0
private[this] var statsPostTransforms: Int = 0
private[this] var statsPrePrints: Int = 0

val symbolRequirements: SymbolRequirement =
Emitter.symbolRequirements(config)
Expand Down Expand Up @@ -143,7 +143,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
statsClassesInvalidated = 0
statsMethodsReused = 0
statsMethodsInvalidated = 0
statsPostTransforms = 0
statsPrePrints = 0

// Update GlobalKnowledge.
val invalidateAll = knowledgeGuardian.update(moduleSet)
Expand All @@ -165,21 +165,21 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
logger.debug(
s"Emitter: Method tree cache stats: reused: $statsMethodsReused -- "+
s"invalidated: $statsMethodsInvalidated")
logger.debug(s"Emitter: Post transforms: $statsPostTransforms")
logger.debug(s"Emitter: Pre prints: $statsPrePrints")

// Inform caches about run completion.
state.moduleCaches.filterInPlace((_, c) => c.cleanAfterRun())
classCaches.filterInPlace((_, c) => c.cleanAfterRun())
}
}

private def postTransform(trees: List[js.Tree], indent: Int): List[js.Tree] = {
statsPostTransforms += 1
postTransformer.transformStats(trees, indent)
private def prePrint(trees: List[js.Tree], indent: Int): List[js.Tree] = {
statsPrePrints += 1
prePrinter.prePrint(trees, indent)
}

private def postTransform(tree: js.Tree, indent: Int): List[js.Tree] =
postTransform(tree :: Nil, indent)
private def prePrint(tree: js.Tree, indent: Int): List[js.Tree] =
prePrint(tree :: Nil, indent)

/** Emits all JavaScript code avoiding clashes with global refs.
*
Expand Down Expand Up @@ -248,7 +248,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo

val moduleImports = extractChangedAndWithGlobals {
moduleCache.getOrComputeImports(module.externalDependencies, module.internalDependencies) {
genModuleImports(module).map(postTransform(_, 0))
genModuleImports(module).map(prePrint(_, 0))
}
}

Expand All @@ -258,7 +258,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
*/
moduleCache.getOrComputeTopLevelExports(module.topLevelExports) {
classEmitter.genTopLevelExports(module.topLevelExports)(
moduleContext, moduleCache).map(postTransform(_, 0))
moduleContext, moduleCache).map(prePrint(_, 0))
}
}

Expand All @@ -268,7 +268,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
WithGlobals.list(initializers.map { initializer =>
classEmitter.genModuleInitializer(initializer)(
moduleContext, moduleCache)
}).map(postTransform(_, 0))
}).map(prePrint(_, 0))
}
}

Expand Down Expand Up @@ -450,7 +450,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
if (kind.isJSClass) {
val fieldDefs = classTreeCache.privateJSFields.getOrElseUpdate {
classEmitter.genCreatePrivateJSFieldDefsOfJSClass(className)(
moduleContext, classCache).map(postTransform(_, 0))
moduleContext, classCache).map(prePrint(_, 0))
}
main ++= extractWithGlobals(fieldDefs)
}
Expand All @@ -471,7 +471,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo

main ++= extractWithGlobalsAndChanged(methodCache.getOrElseUpdate(methodDef.version, {
classEmitter.genStaticLikeMethod(className, methodDef)(moduleContext, methodCache)
.map(postTransform(_, 0))
.map(prePrint(_, 0))
}))
}
}
Expand Down Expand Up @@ -522,7 +522,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
extractWithGlobals(classTreeCache.storeJSSuperClass.getOrElseUpdate({
val jsSuperClass = linkedClass.jsSuperClass.get
classEmitter.genStoreJSSuperClass(jsSuperClass)(moduleContext, classCache, linkedClass.pos)
.map(postTransform(_, 1))
.map(prePrint(_, 1))
}))
} else {
Nil
Expand Down Expand Up @@ -552,7 +552,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
hasJSSuperClass, // invalidated by class version
useESClass, // invalidated by class version
jsConstructorDef // part of ctor version
)(moduleContext, ctorCache, linkedClass.pos).map(postTransform(_, memberIndent)))
)(moduleContext, ctorCache, linkedClass.pos).map(prePrint(_, memberIndent)))
} else {
val ctorVersion = linkedInlineableInit.fold {
Version.combine(linkedClass.version)
Expand All @@ -566,7 +566,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
linkedClass.superClass, // invalidated by class version
useESClass, // invalidated by class version,
linkedInlineableInit // part of ctor version
)(moduleContext, ctorCache, linkedClass.pos).map(postTransform(_, memberIndent)))
)(moduleContext, ctorCache, linkedClass.pos).map(prePrint(_, memberIndent)))
}
}

Expand Down Expand Up @@ -620,7 +620,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
isJSClass, // invalidated by isJSClassVersion
useESClass, // invalidated by isJSClassVersion
method // invalidated by method.version
)(moduleContext, methodCache).map(postTransform(_, memberIndent))))
)(moduleContext, methodCache).map(prePrint(_, memberIndent))))
}

// Exported Members
Expand All @@ -635,7 +635,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
isJSClass, // invalidated by isJSClassVersion
useESClass, // invalidated by isJSClassVersion
member // invalidated by version
)(moduleContext, memberCache).map(postTransform(_, memberIndent))))
)(moduleContext, memberCache).map(prePrint(_, memberIndent))))
}

val hasClassInitializer: Boolean = {
Expand Down Expand Up @@ -695,7 +695,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
if (classEmitter.needInstanceTests(linkedClass)(classCache)) {
main ++= extractWithGlobals(classTreeCache.instanceTests.getOrElseUpdate({
classEmitter.genInstanceTests(className, kind)(moduleContext, classCache, linkedClass.pos)
.map(postTransform(_, 0))
.map(prePrint(_, 0))
}))
}

Expand All @@ -709,14 +709,14 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
linkedClass.ancestors, // invalidated by overall class cache (identity)
linkedClass.jsNativeLoadSpec, // invalidated by class version
linkedClass.hasDirectInstances // invalidated directly (it is the input to `getOrElseUpdate`)
)(moduleContext, classCache, linkedClass.pos).map(postTransform(_, 0))))
)(moduleContext, classCache, linkedClass.pos).map(prePrint(_, 0))))
}
}

if (linkedClass.kind.hasModuleAccessor && linkedClass.hasInstances) {
main ++= extractWithGlobals(classTreeCache.moduleAccessor.getOrElseUpdate({
classEmitter.genModuleAccessor(className, isJSClass)(moduleContext, classCache, linkedClass.pos)
.map(postTransform(_, 0))
.map(prePrint(_, 0))
}))
}

Expand All @@ -727,7 +727,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
} else {
extractWithGlobals(classTreeCache.staticFields.getOrElseUpdate({
classEmitter.genCreateStaticFieldsOfScalaClass(className)(moduleContext, classCache)
.map(postTransform(_, 0))
.map(prePrint(_, 0))
}))
}

Expand All @@ -736,7 +736,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo
val staticInitialization = if (classEmitter.needStaticInitialization(linkedClass)) {
classTreeCache.staticInitialization.getOrElseUpdate({
val tree = classEmitter.genStaticInitialization(className)(moduleContext, classCache, linkedClass.pos)
postTransform(tree, 0)
prePrint(tree, 0)
})
} else {
Nil
Expand Down Expand Up @@ -1063,7 +1063,7 @@ final class Emitter(config: Emitter.Config, postTransformer: Emitter.PostTransfo

def build(moduleContext: ModuleContext): WithGlobals[CoreJSLib.Lib[List[js.Tree]]] = {
if (_lib == null || _lastModuleContext != moduleContext) {
_lib = CoreJSLib.build(sjsGen, postTransform(_, 0), moduleContext, this)
_lib = CoreJSLib.build(sjsGen, prePrint(_, 0), moduleContext, this)
_lastModuleContext = moduleContext
}
_lib
Expand Down Expand Up @@ -1164,13 +1164,45 @@ object Emitter {
new Config(coreSpec.semantics, coreSpec.moduleKind, coreSpec.esFeatures)
}

trait PostTransformer {
def transformStats(trees: List[js.Tree], indent: Int): List[js.Tree]
sealed trait PrePrinter {
private[Emitter] def prePrint(trees: List[js.Tree], indent: Int): List[js.Tree]
}

object PostTransformer {
object Identity extends PostTransformer {
def transformStats(trees: List[js.Tree], indent: Int): List[js.Tree] = trees
object PrePrinter {
object Off extends PrePrinter {
private[Emitter] def prePrint(trees: List[js.Tree], indent: Int): List[js.Tree] = trees
}

object WithoutSourceMap extends PrePrinter {
private[Emitter] def prePrint(trees: List[js.Tree], indent: Int): List[js.PrintedTree] = {
if (trees.isEmpty) {
Nil // Fast path
} else {
val jsCodeWriter = new ByteArrayWriter()
val printer = new Printers.JSTreePrinter(jsCodeWriter, indent)

trees.foreach(printer.printStat(_))

js.PrintedTree(jsCodeWriter.toByteArray(), SourceMapWriter.Fragment.Empty) :: Nil
}
}
}

final class WithSourceMap(fragmentIndex: SourceMapWriter.Index) extends PrePrinter {
private[Emitter] def prePrint(trees: List[js.Tree], indent: Int): List[js.PrintedTree] = {
if (trees.isEmpty) {
Nil // Fast path
} else {
val jsCodeWriter = new ByteArrayWriter()
val smFragmentBuilder = new SourceMapWriter.FragmentBuilder(fragmentIndex)
val printer = new Printers.JSTreePrinterWithSourceMap(jsCodeWriter, smFragmentBuilder, indent)

trees.foreach(printer.printStat(_))
smFragmentBuilder.complete()

js.PrintedTree(jsCodeWriter.toByteArray(), smFragmentBuilder.result()) :: Nil
}
}
}
}

Expand Down
22 changes: 11 additions & 11 deletions linker/shared/src/test/scala/org/scalajs/linker/EmitterTest.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ class EmitterTest {
private val EmitterMethodTreeCacheStatsMessage =
raw"""Emitter: Method tree cache stats: reused: (\d+) -- invalidated: (\d+)""".r

private val EmitterPostTransformStatsMessage =
raw"""Emitter: Post transforms: (\d+)""".r
private val EmitterPrePrintsStatsMessage =
raw"""Emitter: Pre prints: (\d+)""".r

/** Makes sure that linking a "substantial" program (using `println`) twice
* does not invalidate any cache or top-level tree in the second run.
Expand Down Expand Up @@ -206,20 +206,20 @@ class EmitterTest {
assertEquals("Second run must reuse all method caches", methodCacheReused2, methodCacheInvalidated1)
assertEquals("Second run must not invalidate any method cache", 0, methodCacheInvalidated2)

// Post transforms
// Pre prints

val Seq(postTransforms1) =
lines1.assertContainsMatch(EmitterPostTransformStatsMessage).map(_.toInt)
val Seq(prePrints1) =
lines1.assertContainsMatch(EmitterPrePrintsStatsMessage).map(_.toInt)

val Seq(postTransforms2) =
lines2.assertContainsMatch(EmitterPostTransformStatsMessage).map(_.toInt)
val Seq(prePrints2) =
lines2.assertContainsMatch(EmitterPrePrintsStatsMessage).map(_.toInt)

// At the time of writing this test, postTransforms1 reports 188
// At the time of writing this test, prePrints1 reports 188
assertTrue(
s"Not enough post transforms (got $postTransforms1); extraction must have gone wrong",
postTransforms1 > 180)
s"Not enough pre prints (got $prePrints1); extraction must have gone wrong",
prePrints1 > 180)

assertEquals("Second run may not have post transforms", 0, postTransforms2)
assertEquals("Second run may not have pre prints", 0, prePrints2)
}
}
}
Expand Down

0 comments on commit 09336f3

Please sign in to comment.