Dotty Documentation



[-] Constructors

[-] Members

[+] abstract class AccessProxies

A utility class for generating access proxies. Currently used for inline accessors and protected accessors.

[+] object AccessProxies
[+] class ArrayConstructors

This phase rewrites calls to array constructors to newArray method in Dotty.runtime.Arrays module.

It assummes that generic arrays have already been handled by typer(see Applications.convertNewGenericArray). Additionally it optimizes calls to scala.Array.ofDim functions by replacing them with calls to newArray with specific dimensions

This phase augments Scala2 traits with additional members needed for mixin composition.

These symbols would have been added between Unpickling and Mixin in the Scala2 pipeline.

Specifically, we: - Mark all lazy val fields as @volatile to get the proper Scala 2 semantics. - Add trait setters for vals defined in traits. - Expand the names of all private getters and setters as well as super accessors in the trait and make not-private.

[+] object AugmentScala2Traits
[+] class Bridges

A helper class for generating bridge methods in class root.

[+] class ByNameClosures

This phase translates arguments to call-by-name parameters, using the rules

x           ==>    x                  if x is a => parameter
e.apply()   ==>    <cbn-arg>(e)       if e is pure
e           ==>    <cbn-arg>(() => e) for all other arguments


: [T](() => T): T

is a synthetic method defined in Definitions. Erasure will later strip the wrappers.

[+] object ByNameClosures
[+] class CapturedVars

This phase translates variables that are captured in closures to heap-allocated refs.

[+] class CheckReentrant

A no-op transform that checks whether the compiled sources are re-entrant. If -Ycheck:reentrant is set, the phase makes sure that there are no variables that are accessible from a global object. It excludes from checking paths that are labeled with one of the annotations

[+] class CheckStatic

A transformer that check that requirements of Static fields\methods are implemented: 1. Only objects can have members annotated with @static 2. The fields annotated with @static should precede any non-@static fields. This ensures that we do not introduce surprises for users in initialization order. 3. If a member foo of an object C is annotated with @static, the companion class C is not allowed to define term members with name foo. 4. If a member foo of an object C is annotated with @static, the companion class C is not allowed to inherit classes that define a term member with name foo. 5. Only @static methods and vals are supported in companions of traits. Java8 supports those, but not vars, and JavaScript does not have interfaces at all. 6. @static Lazy vals are currently unsupported.

[+] object CheckStatic
[+] class ClassOf

Rewrite classOf calls as follow:

For every primitive class C whose boxed class is called B: classOf[C] -> B.TYPE For every non-primitive class D: classOf[D] -> Literal(Constant(erasure(D)))

[+] class CollectEntryPoints

Collect fields that can be nulled out after use in lazy initialization.

This information is used during lazy val transformation to assign null to private fields that are only used within a lazy val initializer. This is not just an optimization, but is needed for correctness to prevent memory leaks. E.g.

class TestByNameLazy(byNameMsg: => String) {
  lazy val byLazyValMsg = byNameMsg

Here byNameMsg should be null out once byLazyValMsg is initialised.

A field is nullable if all the conditions below hold: - belongs to a non trait-class - is private[this] - is not lazy - its type is nullable - is only used in a lazy val initializer - defined in the same class as the lazy val

[+] class Constructors

This transform - moves initializers from body to constructor. - makes all supercalls explicit - also moves private fields that are accessed only from constructor into the constructor if possible.

[+] object Constructors
[+] class CookComments
[+] class CrossCastAnd

This transform makes sure that all private member selections from AndTypes are performed from the first component of AndType. This is needed for correctness of erasure. See tests/run/PrivateAnd.scala

[+] class CtxLazy

Utility class for lazy values whose evaluation depends on a context. This should be used whenever the evaluation of a lazy expression depends on some context, but the value can be re-used afterwards with a different context.

A typical use case is a lazy val in a phase object which exists once per root context where the expression intiializing the lazy val depends only on the root context, but not any changes afterwards.

[+] class ElimByName

This phase eliminates ExprTypes => T as types of method parameter references, and replaces them b nullary function types. More precisely:

For the types of parameter symbols:

   => T       ==>    () => T

For cbn parameter values

   x          ==>    x()

Note: This scheme to have inconsistent types between method types (whose formal types are still ExprTypes and parameter valdefs (which are now FunctionTypes) is not pretty. There are two other options which have been abandoned or not yet pursued.

Option 1: Transform => T to () => T also in method and function types. The problem with this is that is that it requires to look at every type, and this forces too much, causing Cyclic Reference errors. Abandoned for this reason.

Option 2: Merge ElimByName with erasure, or have it run immediately before. This has not been tried yet.

[+] object ElimByName

This phase erases ErasedValueType to their underlying type. It also removes the synthetic cast methods u2evt$ and evt2u$ which are no longer needed afterwards. Finally, it checks that we don't introduce "double definitions" of pairs of methods that now have the same signature but were not considered matching before erasure.

[+] object ElimErasedValueType
[+] class ElimOpaque

Rewrites opaque type aliases to normal alias types

[+] object ElimOpaque
[+] class ElimOuterSelect

This phase rewrites outer selects E.n_<outer> which were introduced by inlining to outer paths.

Eliminates syntactic references to package terms as prefixes of classes, so that there's no chance they accidentally end up in the backend.

[+] class ElimRepeated

A transformer that removes repeated parameters (T*) from all types, replacing them with Seq types.

[+] object ElimRepeated
[+] class ElimStaticThis

Replace This references to module classes in static methods by global identifiers to the corresponding modules.

[+] class Erasure
[+] object Erasure
[+] class ExpandPrivate

Make private term members that are accessed from another class non-private by resetting the Private flag and expanding their name.

Make private accessor in value class not-private. This is necessary to unbox the value class when accessing it from separate compilation units

Also, make non-private any private parameter forwarders that forward to an inherited public or protected parameter accessor with the same name as the forwarder. This is necessary since private methods are not allowed to have the same name as inherited public ones.

See discussion in and

[+] class ExpandSAMs

Expand SAM closures that cannot be represented by the JVM as lambdas to anonymous classes. These fall into five categories

  1. Partial function closures, we need to generate isDefinedAt and applyOrElse methods for these.
  2. Closures implementing non-trait classes
  3. Closures implementing classes that inherit from a class other than Object (a lambda cannot not be a run-time subtype of such a class)
  4. Closures that implement traits which run initialization code.
  5. Closures that get synthesized abstract methods in the transformation pipeline. These methods can be (1) superaccessors, (2) outer references, (3) accessors for fields.

However, implicit function types do not count as SAM types.

[+] class ExplicitOuter

This phase adds outer accessors to classes and traits that need them. Compared to Scala 2.x, it tries to minimize the set of classes that take outer accessors by scanning class implementations for outer references.

The following things are delayed until erasure and are performed by class OuterOps:

  • add outer parameters to constructors
  • pass outer arguments in constructor calls

replacement of outer this by outer paths is done in Erasure. needs to run after pattern matcher as it can add outer checks and force creation of $outer

[+] object ExplicitOuter
[+] class ExplicitSelf

Transform references of the form


where C is a class with explicit self type and C is not a subclass of the owner of m to

C.this.asInstanceOf[S & C.this.type].m

where S is the self type of C. See run/i789.scala for a test case why this is needed.

Also replaces idents referring to the self type with ThisTypes.

[+] class ExtensionMethods

Perform Step 1 in the inline classes SIP: Creates extension methods for all methods in a value class, except parameter or super accessors, or constructors.

Additionally, for a value class V, let U be the underlying type after erasure. We add to the companion module of V two cast methods: def u2evt$(x0: U): ErasedValueType(V, U) def evt2u$(x0: ErasedValueType(V, U)): U The casts are used in [[Erasure]] to make it typecheck, they are then removed in [[ElimErasedValueType]]. This is different from the implementation of value classes in Scala 2 (see SIP-15) which uses asInstanceOf which does not typecheck.

Finally, if the constructor of a value class is private pr protected it is widened to public.

Also, drop the Local flag from all private[this] and protected[this] members that will be moved to the companion object.

[+] object ExtensionMethods
[+] class FirstTransform

The first tree transform - eliminates some kinds of trees: Imports, NamedArgs - stubs out native methods - eliminates self tree in Template and self symbol in ClassInfo - collapses all type trees to trees of class TypeTree - converts idempotent expressions with constant types - drops branches of ifs using the rules if (true) A else B ==> A if (false) A else B ==> B

[+] object FirstTransform
[+] class Flatten

Lift nested classes to toplevel

Provides methods to produce fully parameterized versions of instance methods, where the this of the enclosing class is abstracted out in an extra leading $this parameter and type parameters of the class become additional type parameters of the fully parameterized method.

Example usage scenarios are:

  • extension methods of value classes
  • implementations of trait methods
  • static protected accessors
  • local methods produced by tailrec transform

Note that the methods lift out type parameters of the class containing the instance method, but not type parameters of enclosing classes. The fully instantiated method therefore needs to be put in a scope "close" to the original method, i.e. they need to share the same outer pointer. Examples of legal positions are: in the companion object, or as a local method inside the original method.

Note: The scheme does not handle yet methods where type parameter bounds depend on value parameters of the enclosing class, as in:

class C(val a: String) extends AnyVal {
  def foo[U <: a.type]: Unit = ...

The expansion of method foo would lead to

def foo$extension[U <: $this.a.type]($this: C): Unit = ...

which is not typable. Not clear yet what to do. Maybe allow PolyTypes to follow method parameters and translate to the following:

def foo$extension($this: C)[U <: $this.a.type]: Unit = ...

This phase adds forwarder for XXL functions apply methods that are implemented with a method with explicit parameters (not in Array[Object]).

In particular for every method def apply(x1: T1, ... xn: Tn): R in class M subtype of FunctionN[T1, ..., Tn, R] with N > 22 a forwarder def apply(xs: Array[Object]): R = this.apply(xs(0).asInstanceOf[T1], ..., xs(n-1).asInstanceOf[Tn]).asInstanceOf[R] is generated.

Rewires closures to implement more specific types of Functions.

[+] object GenericSignatures

Helper object to generate generic java signatures, as defined in the Java Virtual Machine Specification, ยง4.3.4

[+] class GetClass

Rewrite getClass calls as follow:

For every instance of primitive class C whose boxed class is called B: instanceC.getClass -> B.TYPE For every instance of non-primitive class D: instanceD.getClass -> instanceD.getClass

[+] class Getters

Performs the following rewritings for fields of a class:

val x: T = e --> def x: T = e var x: T = e --> def x: T = e

val x: T --> def x: T

lazy val x: T = e --> lazy def x: T =e

var x: T --> def x: T

non-static val x$ = e --> def x$ = e

Omitted from the rewritings are

  • private[this] fields in classes (excluding traits, value classes)
  • fields generated for static modules (TODO: needed?)
  • parameters, static fields, and fields coming from Java

Furthermore, assignments to mutable vars are replaced by setter calls

p.x = e --> p.x_=(e)

No fields are generated yet. This is done later in phase Memoize.

Also, drop the Local flag from all private[this] and protected[this] members. This allows subsequent code motions in Flatten.

[+] object Getters
[+] class HoistSuperArgs

This phase hoists complex arguments of supercalls and this-calls out of the enclosing class. Example:

class B(y: Int) extends A({ def f(x: Int) = x * x; f(y)})

is translated to

class B(y: Int) extends A(B#B$superArg$1(this.y)) {
  private <static> def B$superArg$1(y: Int): Int = {
    def f(x: Int): Int = x.*(x); f(y)

An argument is complex if it contains a method or template definition, a this or a new, or it contains an identifier which needs a this prefix to be accessed. This is the case if the identifer neither a global reference nor a reference to a parameter of the enclosing class.

[+] object HoistSuperArgs
[+] class Instrumentation

The phase is enabled if a -Yinstrument-... option is set. If enabled, it counts the number of closures or allocations for each source position. It does this by generating a call to

[+] class InterceptedMethods

Replace member references as follows:

  • x != y for != in class Any becomes !(x == y) with == in class Any.
  • x.## for ## in NullClass becomes 0
  • x.## for ## in Any becomes calls to ScalaRunTime.hash, using the most precise overload available
  • x.getClass for getClass in primitives becomes x.getClass with getClass in class Object.
[+] object InterceptedMethods
[+] class LambdaLift

This phase performs the necessary rewritings to eliminate classes and methods nested in other methods. In detail: 1. It adds all free variables of local functions as additional parameters (proxies). 2. It rebinds references to free variables to the corresponding proxies, 3. It lifts all local functions and classes out as far as possible, but at least to the enclosing class. 4. It stores free variables of non-trait classes as additional fields of the class. The fields serve as proxies for methods in the class, which avoids the need of passing additional parameters to these methods.

A particularly tricky case are local traits. These cannot store free variables as field proxies, because LambdaLift runs after Mixin, so the fields cannot be expanded anymore. Instead, methods of local traits get free variables of the trait as additional proxy parameters. The difference between local classes and local traits is illustrated by the two rewritings below.

def f(x: Int) = { def f(x: Int) = new C(x).f2 class C { ==> class C(x$1: Int) { def f2 = x def f2 = x$1 } } new C().f2 }

def f(x: Int) = { def f(x: Int) = new C().f2(x) trait T { ==> trait T def f2 = x def f2(x$1: Int) = x$1 } } class C extends T class C extends T new C().f2 }

[+] object LambdaLift
[+] class LazyVals
[+] object LazyVals
[+] class LiftTry

Lifts try's that might be executed on non-empty expression stacks to their own methods. I.e.

try body catch handler

is lifted to

{ def liftedTree$n() = try body catch handler; liftedTree$n() }

However, don't lift try's without catch expressions (try-finally). Lifting is needed only for try-catch expressions that are evaluated in a context where the stack might not be empty. finally does not attempt to continue evaluation after an exception, so the fact that values on the stack are 'lost' does not matter (copied from

[+] class LinkScala2Impls

Rewrite calls


where M is a Scala 2.x trait implemented by the current class to

M.f$(this, args)

where f$ is a static member of M.

[+] abstract class MacroTransform

A base class for transforms. A transform contains a compiler phase which applies a tree transformer.

[+] class MegaPhase
[+] object MegaPhase

A MegaPhase combines a number of mini-phases which are all executed in a single tree traversal.

This is an evolution of the previous "TreeTransformers.scala", which was written by @DarkDimius and is described in his thesis.

[+] class Memoize

Provides the implementations of all getters and setters, introducing fields to hold the value accessed by them. TODO: Make LazyVals a part of this phase?

def x(): T = e --> private val x: T = e def x(): T = x

def x(): T = e --> private[this] var x: T = e def x(): T = x

def x_=(y: T): Unit = () --> def x_=(y: T): Unit = x = y

[+] object Memoize
[+] class Mixin

This phase performs the following transformations:

  1. (done in traitDefs and transformSym) Map every concrete trait getter

    def x(): T = expr

to the pair of definitions:

 <mods> def x(): T
 protected def initial$x(): T = { stats; expr }

where stats comprises all statements between either the start of the trait or the previous field definition which are not definitions (i.e. are executed for their side effects).

  1. (done in traitDefs) Make every concrete trait setter

    def x_=(y: T) = ()

deferred by mapping it to

<mods> def x_=(y: T)
  1. For a non-trait class C:

    For every trait M directly implemented by the class (see SymUtils.mixin), in reverse linearization order, add the following definitions to C:

    3.1 (done in `traitInits`) For every parameter accessor `<mods> def x(): T` in M,
        in order of textual occurrence, add
         <mods> def x() = e
        where `e` is the constructor argument in C that corresponds to `x`. Issue
        an error if no such argument exists.
    3.2 (done in `traitInits`) For every concrete trait getter `<mods> def x(): T` in M
        which is not a parameter accessor, in order of textual occurrence, produce the following:
        3.2.1 If `x` is also a member of `C`, and is a lazy val,
          <mods> lazy val x: T = super[M].x
        3.2.2 If `x` is also a member of `C`, and M is a Dotty trait,
          <mods> def x(): T = super[M].initial$x()
        3.2.3 If `x` is also a member of `C`, and M is a Scala 2.x trait:
          <mods> def x(): T = _
        3.2.4 If `x` is not a member of `C`, and M is a Dotty trait:
        3.2.5 If `x` is not a member of `C`, and M is a Scala2.x trait, nothing gets added.
    3.3 (done in `superCallOpt`) The call:
    3.4 (done in `setters`) For every concrete setter `<mods> def x_=(y: T)` in M:
          <mods> def x_=(y: T) = ()
    3.5 (done in `mixinForwarders`) For every method
    `<mods> def f[Ts](ps1)...(psN): U` imn M` that needs to be disambiguated:
          <mods> def f[Ts](ps1)...(psN): U = super[M].f[Ts](ps1)...(psN)
    A method in M needs to be disambiguated if it is concrete, not overridden in C,
    and if it overrides another concrete method.
  2. (done in transformTemplate and transformSym) Drop all parameters from trait constructors.

  3. (done in transformSym) Drop ParamAccessor flag from all parameter accessors in traits.

Conceptually, this is the second half of the previous mixin phase. It needs to run after erasure because it copies references to possibly private inner classes and objects into enclosing classes where they are not visible. This can only be done if all references are symbolic.

[+] object Mixin
[+] class MixinOps
[+] class MoveStatics

Move static methods from companion to the class itself

[+] object MoveStatics
[+] class NonLocalReturns

Implement non-local returns using NonLocalReturnControl exceptions.

[+] object NonLocalReturns
[+] object OverridingPairs

A module that can produce a kind of iterator (Cursor), which yields all pairs of overriding/overridden symbols that are visible in some baseclass, unless there's a parent class that already contains the same pairs.

Adapted from the 2.9 version of OverridingPairs. The 2.10 version is IMO way too unwieldy to be maintained.

[+] class PCPCheckAndHeal

Checks that the Phase Consistency Principle (PCP) holds and heals types.

Type healing consists in transforming a phase inconsistent type T into a splice of implicitly[Type[T]].

[+] class ParamForwarding

For all parameter accessors

val x: T = ...

if (1) x is forwarded in the supercall to a parameter that's also named x (2) the superclass parameter accessor for x is accessible from the current class change the accessor to

def x: T = super.x.asInstanceOf[T]

Do the same also if there are intermediate inaccessible parameter accessor forwarders. The aim of this transformation is to avoid redundant parameter accessor fields.

[+] class PatternMatcher

The pattern matching transform. After this phase, the only Match nodes remaining in the code are simple switches where every pattern is an integer constant

[+] object PatternMatcher
[+] class Pickler

This phase pickles trees

[+] object Pickler
[+] class PostTyper

A macro transform that runs immediately after typer and that performs the following functions:

(1) Add super accessors (@see SuperAccessors)

(2) Convert parameter fields that have the same name as a corresponding public parameter field in a superclass to a forwarder to the superclass field (corresponding = super class field is initialized with subclass field) (@see ForwardParamAccessors)

(3) Add synthetic methods (@see SyntheticMethods)

(4) Check that New nodes can be instantiated, and that annotations are valid

(5) Convert all trees representing types to TypeTrees.

(6) Check the bounds of AppliedTypeTrees

(7) Insert .package for selections of package object members

(8) Replaces self references by name with this

(9) Adds SourceFile annotations to all top-level classes and objects

(10) Adds Child annotations to all sealed classes

(11) Minimizes call fields of Inlined nodes to just point to the toplevel class from which code was inlined.

The reason for making this a macro transform is that some functions (in particular super and protected accessors and instantiation checks) are naturally top-down and don't lend themselves to the bottom-up approach of a mini phase. The other two functions (forwarding param accessors and synthetic methods) only apply to templates and fit mini-phase or subfunction of a macro phase equally well. But taken by themselves they do not warrant their own group of miniphases before pickling.

[+] object PostTyper
[+] class ProtectedAccessors
[+] object ProtectedAccessors

Add accessors for all protected accesses. An accessor is needed if according to the rules of the JVM a protected class member is not accesissible from the point of access, but is accessible if the access is from an enclosing class. In this point a public access method is placed in that enclosing class.

[+] class PruneErasedDefs

This phase makes all erased term members of classes private so that they cannot conflict with non-erased members. This is needed so that subsequent phases like ResolveSuper that inspect class members work correctly. The phase also replaces all expressions that appear in an erased context by default values. This is necessary so that subsequent checking phases such as IsInstanceOfChecker don't give false negatives.

[+] object PruneErasedDefs
[+] class ReifyQuotes

Translates quoted terms and types to unpickle method calls.

Transforms top level quote

'{ ...
   val x1 = ???
   val x2 = ???
   ${ ... '{ ... x1 ... x2 ...} ... }


     val x1 = ???
     val x2 = ???
     Hole(0 | x1, x2)
     (args: Seq[Any]) => {
       val x1$1 = args(0).asInstanceOf[Expr[T]]
       val x2$1 = args(1).asInstanceOf[Expr[T]] // can be asInstanceOf[Type[T]]
       { ... '{ ... ${x1$1} ... ${x2$1} ...} ... }

and then performs the same transformation on '{ ... ${x1$1} ... ${x2$1} ...}.

[+] object ReifyQuotes
[+] class RenameLifted

Renames lifted classes to local numbering scheme

[+] class ResolveSuper

This phase implements super accessors in classes that need them.

For every trait M directly implemented by the class (see SymUtils.mixin), in reverse linearization order, add the following definitions to C:

For every superAccessor <mods> def super$f[Ts](ps1)...(psN): U in M:

 <mods> def super$f[Ts](ps1)...(psN): U = super[S].f[Ts](ps1)...(psN)

where S is the superclass of M in the linearization of C.

This is the first part of what was the mixin phase. It is complemented by Mixin, which runs after erasure.

[+] object ResolveSuper
[+] class RestoreScopes

The preceding lambda lift and flatten phases move symbols to different scopes and rename them. This miniphase cleans up afterwards and makes sure that all class scopes contain the symbols defined in them.

[+] class SelectStatic

Removes selects that would be compiled into GetStatic otherwise backend needs to be aware that some qualifiers need to be dropped. Similar transformation seems to be performed by flatten in nsc

[+] class SeqLiterals

A transformer that eliminates SeqLiteral's, transforming SeqLiteral(elems) to an operation equivalent to


Instead of toSeq, which takes an implicit, the appropriate "wrapArray" method is called directly. The reason for this step is that JavaSeqLiterals, being arrays keep a precise type after erasure, whereas SeqLiterals only get the erased type Seq,

[+] class SetRootTree

Set the rootTreeOrProvider property of class symbols.

[+] object SetRootTree
[+] class ShortcutImplicits

This phase optimizes code using implicit function types, by applying two rewrite rules. Let IF be the implicit function type

implicit Us => R

(1) A method definition

def m(xs: Ts): IF = implicit (ys: Us) => E

is expanded to two methods:

def m(xs: Ts): IF = implicit (ys: Us) => m$direct(xs)(ys)
def m$direct(xs: Ts)(ys: Us): R = E

(and equivalently for methods with type parameters or a different number of value parameter lists). An abstract method definition

def m(xs: Ts): IF

is expanded to:

def m(xs: Ts): IF def m$direct(xs: Ts)(ys: Us): R

(2) A reference qual.apply where qual has implicit function type and qual refers to a method m is rewritten to a reference to m$direct, keeping the same type and value arguments as they are found in qual.

Note: The phase adds direct methods for all methods with IFT results that are defined in the transformed compilation unit, as well as for all methods that are referenced from inside the unit. It does NOT do an info transformer that adds these methods everywhere where an IFT returning method exists (including in separately compiled classes). Adding such an info transformer is impractical because it would mean that we have to force the types of all members of classes that are referenced. But not adding an info transformer can lead to inconsistencies in RefChecks. We solve that by ignoring direct methods in Refchecks. Another, related issue is bridge generation, where we also generate shortcut methods on the fly.

[+] object ShortcutImplicits
[+] object Splicer

Utility class to splice quoted expressions

[+] class Staging

Checks that the Phase Consistency Principle (PCP) holds and heals types.

Type healing consists in transforming a phase inconsistent type T into ${ implicitly[Type[T]] }.

[+] object Staging
[+] class SuperAccessors

This class adds super accessors for all super calls that either appear in a trait or have as a target a member of some outer class.

It also checks that:

(1) Symbols accessed from super are not abstract, or are overridden by an abstract override.

(2) If a symbol accessed from super is defined in a real class (not a trait), there are no abstract members which override this member in Java's rules (see SI-4989; such an access would lead to illegal bytecode)

(3) Super calls do not go to some synthetic members of Any (see isDisallowed)

(4) Super calls do not go to synthetic field accessors

[+] final class SymUtils

A decorator that provides methods on symbols that are needed in the transformer pipeline.

[+] object SymUtils
[+] class SymbolOrdering
[+] class SyntheticMethods

Synthetic method implementations for case classes, case objects, and value classes.

Selectively added to case classes/objects, unless a non-default implementation already exists: def equals(other: Any): Boolean def hashCode(): Int def canEqual(other: Any): Boolean def toString(): String def productElement(i: Int): Any def productArity: Int def productPrefix: String

Add to serializable static objects, unless an implementation already exists: private def writeReplace(): AnyRef

Selectively added to value classes, unless a non-default implementation already exists: def equals(other: Any): Boolean def hashCode(): Int

[+] class TailRec

A Tail Rec Transformer.

What it does:

Finds method calls in tail-position and replaces them with jumps. A call is in a tail-position if it is the last instruction to be executed in the body of a method. This includes being in tail-position of a return from a Labeled block which is itself in tail-position (which is critical for tail-recursive calls in the cases of a match). To identify tail positions, we recurse over the trees that may contain calls in tail-position (trees that can't contain such calls are not transformed).

When a method contains at least one tail-recursive call, its rhs is wrapped in the following structure:

var localForParam1: T1 = param1
while (<empty>) {
  tailResult[ResultType]: {
    return {
      // original rhs with tail recursive calls transformed (see below)

Self-recursive calls in tail-position are then replaced by (a) reassigning the local vars substituting formal parameters and (b) a return from the tailResult labeled block, which has the net effect of looping back to the beginning of the method. If the receiver is modifed in a recursive call, an additional var is used to replace this.

As a complete example of the transformation, the classical fact function, defined as:

def fact(n: Int, acc: Int): Int =
  if (n == 0) acc
  else fact(n - 1, acc * n)

is rewritten as:

def fact(n: Int, acc: Int): Int = {
  var acc$tailLocal1: Int = acc
  var n$tailLocal1: Int = n
  while (<empty>) {
    tailLabel1[Unit]: {
      return {
        if (n$tailLocal1 == 0)
        else {
          val n$tailLocal1$tmp1: Int = n$tailLocal1 - 1
          val acc$tailLocal1$tmp1: Int = acc$tailLocal1 * n$tailLocal1
          n$tailLocal1 = n$tailLocal1$tmp1
          acc$tailLocal1 = acc$tailLocal1$tmp1
          (return[tailLabel1] ()): Int

As the JVM provides no way to jump from a method to another one, non-recursive calls in tail-position are not optimized.

A method call is self-recursive if it calls the current method and the method is final (otherwise, it could be a call to an overridden method in a subclass). Recursive calls on a different instance are optimized.

This phase has been moved after erasure to allow the use of vars for the parameters combined with a WhileDo. This is also beneficial to support polymorphic tail-recursive calls.

In scalac, if the method had type parameters, the call must contain the same parameters as type arguments. This is no longer the case in dotc thanks to being located after erasure. In scalac, this is named tailCall but it does only provide optimization for self recursive functions, that's why it's renamed to tailrec

[+] object TailRec
[+] abstract class TransformByNameApply

Abstract base class of ByNameClosures and ElimByName, factoring out the common functionality to transform arguments of by-name parameters.

[+] class TransformWildcards

This phase transforms wildcards in valdefs with their default value. In particular for every valdef that is declared: val x : T = _ to val x : T = <zero of T>

[+] class TreeChecker

Run by -Ycheck option after a given phase, this class retypes all syntax trees and verifies that the type of each tree node so obtained conforms to the type found in the tree node. It also performs the following checks:

  • The owner of each definition is the same as the owner of the current typing context.
  • Ident nodes do not refer to a denotation that would need a select to be accessible (see tpd.needsSelect).
  • After typer, identifiers and select nodes refer to terms only (all types should be represented as TypeTrees then).
[+] object TreeChecker
[+] object TreeExtractors
[+] abstract class TreeMapWithStages

The main transformer class

[+] object TreeMapWithStages
[+] class TryCatchPatterns

Compiles the cases that can not be handled by primitive catch cases as a common pattern match.

The following code:

try { <code> }
catch {
  <tryCases> // Cases that can be handled by catch
  <patternMatchCases> // Cases starting with first one that can't be handled by catch

will become:

try { <code> }
catch {
  case e => e match {

Cases that are not supported include: - Applies and unapplies - Idents - Alternatives - case _: T => where T is not Throwable

[+] object TypeTestsCasts

This transform normalizes type tests and type casts, also replacing type tests with singleton argument type with reference equality check Any remaining type tests - use the object methods $isInstanceOf and $asInstanceOf - have a reference type as receiver - can be translated directly to machine instructions

Unfortunately this phase ended up being not Y-checkable unless types are erased. A cast to an ConstantType(3) or x.type cannot be rewritten before erasure. That's why TypeTestsCasts is called from Erasure.

[+] object TypeUtils
[+] class VCElideAllocations

This phase elides unnecessary value class allocations

For a value class V defined as: class V(val underlying: U) extends AnyVal we avoid unnecessary allocations: new V(u1) == new V(u2) => u1 == u2 provided V does not redefine equals (new V(u)).underlying() => u

[+] class VCInlineMethods

This phase inlines calls to methods of value classes.

A value class V after [[ExtensionMethods]] will look like: class V[A, B, ...](val underlying: U) extends AnyVal { def foo[T, S, ...](arg1: A1, arg2: A2, ...) =$extensionT, S, ..., A, B, ...(arg1, arg2, ...)



Let e have type V, if e is a stable prefix or if V does not have any class type parameter, then we can rewrite: e.fooX, Y, ... as:$extensionX, Y, ..., A', B', ...(args) where A', B', ... are the class type parameters A, B, ... as seen from e. Otherwise, we need to evaluate e first: { val ev = e$extensionX, Y, ..., A', B', ...(args) }

This phase needs to be placed after phases which may introduce calls to value class methods (like [[PatternMatcher]]). This phase uses name mangling to find the correct extension method corresponding to a value class method (see [[ExtensionMethods.extensionMethod]]), therefore we choose to place it before phases which may perform their own name mangling on value class methods (like [[TypeSpecializer]]), this way [[VCInlineMethods]] does not need to have any knowledge of the name mangling done by other phases.

[+] object ValueClasses

Methods that apply to user-defined value classes

[+] class YCheckPositions

Ycheck inlined positions