scala3-compiler-bootstrapped
DocsAPI
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL
scala3-compiler-bootstrapped/dotty.tools/dotty.tools.dotc/dotty.tools.dotc.cc/Setup

Setup

dotty.tools.dotc.cc.Setup
See theSetup companion object
class Setup extends PreRecheck, SymTransformer, SetupAPI

A tree traverser that prepares a compilation unit to be capture checked. It does the following:

  • For every inferred type, drop any retains annotations, add capture sets to all its parts, add refinements to class types and function types. (c.f. mapInferred)
  • For explicit capturing types, expand throws aliases to the underlying (pure) function, and add some implied capture sets to curried functions (c.f. expandThrowsAlias, expandAbbreviations).
  • Add capture sets to self types of classes and objects, unless the self type was written explicitly.
  • Box the types of mutable variables and type arguments to methods (type arguments of types are boxed on access).
  • Link the external types of val and def symbols with the inferred types based on their parameter symbols.

Attributes

Companion
object
Graph
Supertypes
trait SetupAPI
class PreRecheck
class Phase
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited types

type DefRecheck = (ValOrDefDef, Symbol) => Context ?=> Type

Attributes

Inherited from:
SetupAPI

Value members

Concrete methods

def addVar(tp: Type, owner: Symbol)(using Context): Type

Add a capture set variable to tp if necessary, or maybe pull out an embedded capture set variable from a part of tp.

Add a capture set variable to tp if necessary, or maybe pull out an embedded capture set variable from a part of tp.

Attributes

def decorate(tp: Type, addedSet: Type => CaptureSet)(using Context): Type

Add a capture set variable to tp if necessary, or maybe pull out an embedded capture set variable from a part of tp.

Add a capture set variable to tp if necessary, or maybe pull out an embedded capture set variable from a part of tp.

Attributes

def isPreCC(sym: Symbol)(using Context): Boolean
override def isRunnable(using Context): Boolean

This property is queried before a phase is run. If it is false, the phase is skipped.

This property is queried before a phase is run. If it is false, the phase is skipped.

Attributes

Definition Classes
def needsVariable(tp: Type)(using Context): Boolean

Should a capture set variable be added on type tp?

Should a capture set variable be added on type tp?

Attributes

def normalizeCaptures(tp: Type)(using Context): Type

Pull out an embedded capture set from a part of tp

Pull out an embedded capture set from a part of tp

Attributes

def postCheck()(using Context): Unit
def setupUnit(tree: Tree, recheckDef: DefRecheck)(using Context): Unit
def transformSym(symd: SymDenotation)(using Context): SymDenotation
  • Reset private flags of parameter accessors so that we can refine them in Setup if they have non-empty capture sets.
  • Special handling of some symbols defined for case classes. Enabled only until recheck is finished, and provided some compilation unit is CC-enabled.

Attributes

Inherited methods

final def <=(that: Phase): Boolean

Attributes

Inherited from:
Phase
def allowsImplicitSearch: Boolean

If set, implicit search is enabled

If set, implicit search is enabled

Attributes

Inherited from:
Phase
final def cancellable(body: Context ?=> Unit)(using Context): Boolean

Do not run if compile progress has been cancelled

Do not run if compile progress has been cancelled

Attributes

Inherited from:
Phase
override def changesBaseTypes: Boolean

Can this transform change the base types of a type?

Can this transform change the base types of a type?

Attributes

Definition Classes
Inherited from:
PreRecheck
def changesMembers: Boolean

Can this transform create or delete non-private members?

Can this transform create or delete non-private members?

Attributes

Inherited from:
Phase
def changesParents: Boolean

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
def description: String

Attributes

Inherited from:
Phase
def end: PhaseId

Attributes

Inherited from:
Phase
final def erasedTypes: Boolean

Attributes

Inherited from:
Phase
def exists: Boolean

True for all phases except NoPhase

True for all phases except NoPhase

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
def initContext(ctx: FreshContext): Unit

Attributes

Inherited from:
Phase
final def isAfterLastJavaPhase(using Context): Boolean

Attributes

Inherited from:
Phase
override def isCheckable: Boolean

Output should be checkable by TreeChecker

Output should be checkable by TreeChecker

Attributes

Definition Classes
Inherited from:
PreRecheck
def isEnabled(using Context): Boolean

This property is queried when phases are first assembled. If it is false, the phase will be dropped from the set of phases to traverse.

This property is queried when phases are first assembled. If it is false, the phase will be dropped from the set of phases to traverse.

Attributes

Inherited from:
Phase
def isTyper: Boolean

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
final def lambdaLifted: Boolean

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 megaPhase(using Context): Phase

Attributes

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

Cancellable region, if not cancelled, run the body in the context of the current compilation unit. Enrich crash messages.

Cancellable region, if not cancelled, run the body in the context of the current compilation unit. Enrich crash messages.

Attributes

Inherited from:
Phase
final def next: Phase

Attributes

Inherited from:
Phase
final def patternTranslated: Boolean

Attributes

Inherited from:
Phase
def period: Period

Attributes

Inherited from:
Phase
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

Inherited from:
PreRecheck
final def prev: Phase

Attributes

Inherited from:
Phase
def printingContext(ctx: Context): Context

A hook that allows to transform the usual context passed to the function that prints a compilation unit after a phase

A hook that allows to transform the usual context passed to the function that prints a compilation unit after a phase

Attributes

Inherited from:
Phase
final def refChecked: Boolean

Attributes

Inherited from:
Phase
def relaxedTyping: Boolean

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
def run(using Context): Unit

Attributes

Inherited from:
PreRecheck
def runOn(units: List[CompilationUnit])(using runCtx: Context): List[CompilationUnit]

Attributes

Inherited from:
Phase
inline def runSubPhase[T](id: SubPhase)(inline body: (SubPhase, Context) ?=> T)(using Context): T

Attributes

Inherited from:
Phase
def runsAfter: Set[String]

List of names of phases that should precede this phase

List of names of phases that should precede this phase

Attributes

Inherited from:
Phase
final def sameBaseTypesStartId: Int

Attributes

Inherited from:
Phase
final def sameMembersStartId: Int

Attributes

Inherited from:
Phase
final def sameParentsStartId: Int

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 skipIfJava(using Context): Boolean

skip the phase for a Java compilation unit, may depend on -Yjava-tasty

skip the phase for a Java compilation unit, may depend on -Yjava-tasty

Attributes

Inherited from:
Phase
def start: Int

Attributes

Inherited from:
Phase
def subPhases: List[SubPhase]

for purposes of progress tracking, overridden in TyperPhase

for purposes of progress tracking, overridden in TyperPhase

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
def transform(ref: SingleDenotation)(using Context): SingleDenotation

The transformation method

The transformation method

Attributes

Inherited from:
SymTransformer
final def traversals: Int

Attributes

Inherited from:
Phase
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

Inherited fields

var pastRecheck: Boolean

Attributes

Inherited from:
PreRecheck

Extensions

Extensions

extension (sym: Symbol)
def nextInfo(using Context): Type
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL