PrepJSInterop

dotty.tools.dotc.transform.sjs.PrepJSInterop
See thePrepJSInterop companion object

A macro transform that runs after typer and before pickler to perform additional Scala.js-specific checks and transformations necessary for interoperability with JavaScript.

It performs the following functions:

  • Sanity checks for the js.Any hierarchy
  • Annotate subclasses of js.Any to be treated specially
  • Create JSExport methods: Dummy methods that are propagated through the whole compiler chain to mark exports. This allows exports to have the same semantics than methods.

This is the equivalent of PrepJSInterop in Scala 2, minus the handling of scala.Enumeration.

The reason for making this a macro transform is that some functions (in particular all the checks that behave differently depending on properties of classes in the enclosing class chain) are naturally top-down and don't lend themselves to the bottom-up approach of a mini phase.

In addition, the addition of export forwarders must be done before pickling to be signature-compatible with scalac, and there are only macro transforms before pickling.

Attributes

Companion:
object
Graph
Supertypes
class Phase
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Type members

Classlikes

Attributes

Graph
Supertypes
trait Checking
class TreeMap
class Object
trait Matchable
class Any

Inherited classlikes

Attributes

Inherited from:
MacroTransform
Graph
Supertypes
class TreeMap
class Object
trait Matchable
class Any
Known subtypes

Value members

Concrete methods

override def changesMembers: Boolean

Can this transform create or delete non-private members?

Can this transform create or delete non-private members?

Attributes

Definition Classes
override def description: String

Attributes

Definition Classes
override def isEnabled(using Context): Boolean

Attributes

Definition Classes
override def phaseName: String

A name given to the Phase that can be used to debug the compiler. For instance, it is possible to print trees after a given phase using:

A name given to the Phase that can be used to debug the compiler. For instance, it is possible to print trees after a given phase using:

$ ./bin/scalac -Xprint:<phaseNameHere> sourceFile.scala

Attributes

Definition Classes

Inherited methods

final def <=(that: Phase): Boolean

Attributes

Inherited from:
Phase

If set, implicit search is enabled

If set, implicit search is enabled

Attributes

Inherited from:
Phase

Can this transform change the base types of a type?

Can this transform change the base types of a type?

Attributes

Inherited from:
Phase

Can this transform change the parents of a class?

Can this transform change the parents of a class?

Attributes

Inherited from:
Phase
def checkPostCondition(tree: Tree)(using Context): Unit

Check what the phase achieves, to be called at any point after it is finished.

Check what the phase achieves, to be called at any point after it is finished.

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase
final def erasedTypes: Boolean

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase
final def flatClasses: Boolean

Attributes

Inherited from:
Phase
final def hasNext: Boolean

Attributes

Inherited from:
Phase
def id: Int

The sequence position of this phase in the given context where 0 is reserved for NoPhase and the first real phase is at position 1. -1 if the phase is not installed in the context.

The sequence position of this phase in the given context where 0 is reserved for NoPhase and the first real phase is at position 1. -1 if the phase is not installed in the context.

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase

Output should be checkable by TreeChecker

Output should be checkable by TreeChecker

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase

Is this phase the standard typerphase? True for TyperPhase, but not for other first phases (such as FromTasty or Parser). The predicate is tested in some places that perform checks and corrections. It's different from ctx.isAfterTyper (and cheaper to test).

Is this phase the standard typerphase? True for TyperPhase, but not for other first phases (such as FromTasty or Parser). The predicate is tested in some places that perform checks and corrections. It's different from ctx.isAfterTyper (and cheaper to test).

Attributes

Inherited from:
Phase
final def iterator: Iterator[Phase]

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase
def lastPhaseId(using Context): Int

The last phase during which the transformed denotations are valid

The last phase during which the transformed denotations are valid

Attributes

Inherited from:
DenotTransformer
final def monitor(doing: String)(body: => Unit)(using Context): Unit

Attributes

Inherited from:
Phase
final def next: Phase

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase
final def prev: Phase

Attributes

Inherited from:
Phase
final def prevMega(using Context): Phase

Attributes

Inherited from:
Phase
final def refChecked: Boolean

Attributes

Inherited from:
Phase

If set, allow missing or superfluous arguments in applications and type applications.

If set, allow missing or superfluous arguments in applications and type applications.

Attributes

Inherited from:
Phase
override def run(using Context): Unit

Attributes

Definition Classes
Inherited from:
MacroTransform

Attributes

Inherited from:
Phase

List of names of phases that should precede this phase

List of names of phases that should precede this phase

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase

Attributes

Inherited from:
Phase
def show(tree: Tree)(using Context): String

Convert a compilation unit's tree to a string; can be overridden

Convert a compilation unit's tree to a string; can be overridden

Attributes

Inherited from:
Phase
def start: Int

Attributes

Inherited from:
Phase
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Phase -> Any
Inherited from:
Phase

The transformation method

The transformation method

Attributes

Inherited from:
IdentityDenotTransformer
protected def transformPhase(using Context): Phase

The phase in which the transformation should be run. By default this is the phase given by the this macro transformer, but it could be overridden to be the phase following that one.

The phase in which the transformation should be run. By default this is the phase given by the this macro transformer, but it could be overridden to be the phase following that one.

Attributes

Inherited from:
MacroTransform
def validFor(using Context): Period

The validity period of the transformed denotations in the given context

The validity period of the transformed denotations in the given context

Attributes

Inherited from:
DenotTransformer