scala3-compiler-bootstrapped
DocsAPI
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL
scala3-compiler-bootstrapped/dotty.tools/dotty.tools.dotc/dotty.tools.dotc.transform/Splicing

Splicing

dotty.tools.dotc.transform.Splicing
See theSplicing companion object
class Splicing extends MacroTransform

Transforms level 1 splices into holes. To do so it transforms the contents of the splice into a lambda that receives all cross-quote references.

Cross-quote reference is a reference to a definition that is not defined in the current quote. Those references appear in quotes that are nested in a splice.

After this phase we have the invariant where all splices have the following shape

{{{ <holeIdx> | <holeType> | <captures>* | (<capturedTerms>*) => <spliceContent> 
}}}

where <spliceContent> does not contain any free references to quoted definitions and <captures>* contains the quotes with references to all cross-quote references. There are some special rules for references in the LHS of assignments and cross-quote method references.

In the following code example x1 and x2 are cross-quote references.

'{ ...
  val x1: T1 = ???
  val x2: T2 = ???
  ${ (q: Quotes) ?=> f('{ g(x1, x2) }) }: T3
}

This phase identifies cross-quote references such as x1 and replaces it with an ${x1$}. All cross-quote arguments are directly applied in the lambda.

'{ ...
   val x1: T1 = ???
   val x2: T2 = ???
{{{
 0 | T3 | x1, x2 |
     (x1$: Expr[T1], x2$: Expr[T2]) => // body of this lambda does not contain references to x1 or x2
       (q: Quotes) ?=> f('{ g(${x1$}, ${x2$}) })

}}}
 }

and then performs the same transformation on '{ g(${x1$}, ${x2$}) }.

Attributes

Companion
object
Graph
Supertypes
class Phase
class Object
trait Matchable
class Any

Members list

Type members

Inherited classlikes

class Transformer extends TreeMapWithPreciseStatContexts

Attributes

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

Value members

Concrete methods

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

Attributes

Definition Classes

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
def changesBaseTypes: Boolean

Can this transform change the base types of a type?

Can this transform change the base types of a type?

Attributes

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

Output should be checkable by TreeChecker

Output should be checkable by TreeChecker

Attributes

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

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
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
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 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
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
final def traversals: Int

Attributes

Inherited from:
Phase
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL