org.scalajs.nscplugin

ExplicitLocalJS

Related Doc: package nscplugin

abstract class ExplicitLocalJS[G <: Global with Singleton] extends PluginComponent with Transform with TypingTransformers with CompatComponent

Makes the references to local JS classes explicit and desugars calls to js.constructorOf.

It also makes explicit all references to inner JS classes, using the pointers created by ExplicitInnerJS, and otherwise makes sure the back-end will receive all the information it needs to translate inner- and local JS classes and objects.

Note that in this comment, by "class" we mean *only* classes. traits and objects are not implied.

Similarly to how ExplicitInnerJS creates explicit fields in the enclosing templates of inner JS classes to hold the JS class values, this phase creates local vals for local JS classes in the enclosing statement list.

For every local JS class of the form:

def outer() = {
  class Local extends ParentJSClass
}

this phase creates a local val Local$jslass in the body of outer() to hold the JS class value for Local. The rhs of that val is a call to a magic method, used to retain information that the back-end will need:

The latter will be augmented by lambdalift with the appropriate actual parameters for the captures of Local, which will be needed by the back-end. In code, this looks like:

def outer() = {
  class Local extends ParentJSClass
  val Local$jsclass: AnyRef = createLocalJSClass(
      classOf[Local],
      js.constructorOf[ParentJSClass],
      Array[AnyRef](new Local(), ...))
}

Since we need to insert fake new Inner()s, this scheme does not work for abstract local classes. We therefore reject them as implementation restriction.

If the body of Local references itself, then the val Local$jsclass is instead declared as a var to work around the cyclic dependency:

def outer() = {
  var Local$jsclass: AnyRef = null
  class Local extends ParentJSClass {
    ...
  }
  Local$jsclass = createLocalJSClass(...)
}

In addition to the above, ExplicitLocalJS transforms all *call sites* of local JS classes *and* inner JS classes, so that they refer to the synthesized local vals and fields.

The primary transformation is the desugaring of js.constructorOf[C], which depends on the nature of C:

The other transformations build on top of the desugaring of js.constructorOf[C], and apply only to inner JS classes and local JS classes (not for statically accessible classes):

Finally, for inner- and local JS *objects*, their (only) instantiation point of the form new O.type() is rewritten as withContextualJSClassValue(js.constructorOf[ParentClassOfO], new O.type()), so that the back-end receives a reified reference to the parent class of O. A similar treatment is applied on anonymous JS classes, which basically define something very similar to an object, although without its own JS class.

Linear Supertypes
CompatComponent, TypingTransformers, Transform, PluginComponent, SubComponent, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExplicitLocalJS
  2. CompatComponent
  3. TypingTransformers
  4. Transform
  5. PluginComponent
  6. SubComponent
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExplicitLocalJS(global: G)

Type Members

  1. class ExplicitLocalJSTransformer extends TypingTransformer

  2. implicit final class GlobalCompat extends AnyRef

    Definition Classes
    CompatComponent
  3. class Phase extends scala.tools.nsc.transform.Transform.StdPhase

    Definition Classes
    Transform
  4. type SAMFunctionCompat = SAMFunction

    Definition Classes
    CompatComponent
  5. implicit final class SAMFunctionCompatOps extends AnyRef

    Definition Classes
    CompatComponent
  6. abstract class StdPhase extends GlobalPhase

    Definition Classes
    SubComponent
  7. implicit final class StdTermNamesCompat extends AnyRef

    Definition Classes
    CompatComponent
  8. implicit final class StdTypeNamesCompat extends AnyRef

    Definition Classes
    CompatComponent
  9. implicit final class SymbolCompat extends AnyRef

    Definition Classes
    CompatComponent
  10. abstract class TypingTransformer extends scala.tools.nsc.Global.Transformer

    Definition Classes
    TypingTransformers

Abstract Value Members

  1. abstract val jsAddons: JSGlobalAddons { val global: ExplicitLocalJS.this.global.type }

  2. abstract val runsAfter: List[String]

    Definition Classes
    SubComponent

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. object LowPrioGenBCodeCompat

    Definition Classes
    CompatComponent
  5. object SAMFunctionAttachCompat

    Definition Classes
    CompatComponent
  6. object SAMFunctionAttachCompatDef

    Definition Classes
    CompatComponent
  7. lazy val SAMFunctionCompat: SAMFunction.type

    Definition Classes
    CompatComponent
  8. final def afterOwnPhase[T](op: ⇒ T): T

    Definition Classes
    SubComponent
    Annotations
    @inline()
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. final def beforeOwnPhase[T](op: ⇒ T): T

    Definition Classes
    SubComponent
    Annotations
    @inline()
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def description: String

    Definition Classes
    ExplicitLocalJS → PluginComponent
  13. def enabled: Boolean

    Definition Classes
    SubComponent
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. val global: G

    Definition Classes
    ExplicitLocalJSCompatComponent → TypingTransformers → SubComponent
  19. def hashCode(): Int

    Definition Classes
    SubComponent → AnyRef → Any
  20. val initial: Boolean

    Definition Classes
    SubComponent
  21. def initializeCoreBTypesCompat(): Unit

    Definition Classes
    CompatComponent
  22. final val internal: Boolean(false)

    Definition Classes
    PluginComponent → SubComponent
  23. def isImplClass(sym: G.Symbol): Boolean

    Definition Classes
    CompatComponent
  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. def newPhase(prev: scala.tools.nsc.Phase): StdPhase

    Definition Classes
    Transform → SubComponent
  27. def newTransformer(unit: G.CompilationUnit): G.Transformer

    Attributes
    protected
    Definition Classes
    ExplicitLocalJS → Transform
  28. final def notify(): Unit

    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  30. def ownPhase: scala.tools.nsc.Phase

    Definition Classes
    SubComponent
  31. val phaseName: String

    Definition Classes
    ExplicitLocalJS → SubComponent
  32. def phaseNewFlags: Long

    Definition Classes
    SubComponent
  33. def phaseNextFlags: Long

    Definition Classes
    SubComponent
  34. val requires: List[String]

    Definition Classes
    SubComponent
  35. val runsBefore: List[String]

    Definition Classes
    SubComponent
  36. val runsRightAfter: Option[String]

    Definition Classes
    PluginComponent → SubComponent
  37. lazy val scalaUsesImplClasses: Boolean

    Definition Classes
    CompatComponent
  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  39. val terminal: Boolean

    Definition Classes
    SubComponent
  40. def toString(): String

    Definition Classes
    AnyRef → Any
  41. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CompatComponent

Inherited from TypingTransformers

Inherited from Transform

Inherited from PluginComponent

Inherited from SubComponent

Inherited from AnyRef

Inherited from Any

Ungrouped