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

Translator

dotty.tools.dotc.transform.PatternMatcher.Translator
class Translator(resultType: Type, thisPhase: MiniPhase)(using x$3: Context)

The pattern matching translator. Its general structure is a pipeline:

Match tree ---matchPlan---> Plan ---optimize---> Plan ---emit---> Tree

The pipeline consists of three steps:

  • build a plan, using methods matchPlan, caseDefPlan, patternPlan.
  • optimize the plan, using methods listed in optimization,
  • emit the translated tree, using methods emit, collectSwitchCases, emitSwitchCases, and emitCondition.

A plan represents the underlying decision graph. It consists of tests, let bindings, labeled blocks, return from said labeled blocks and code blocks. It's represented by its own data type. Plans are optimized by merging common tests and eliminating dead code.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Type members

Classlikes

case class EqualTest(tree: Tree) extends Test

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Test
class Object
trait Matchable
class Any
Show all
case object GuardTest extends Test

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Translator.this.Test
class Object
trait Matchable
class Any
Show all
Self type
case class LabeledPlan(sym: TermSymbol, var expr: Translator.this.Plan) extends Plan

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Plan
class Object
trait Matchable
class Any
Show all
case class LengthTest(len: Int, exact: Boolean) extends Test

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Test
class Object
trait Matchable
class Any
Show all
case class LetPlan(sym: TermSymbol, var body: Translator.this.Plan) extends Plan

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Plan
class Object
trait Matchable
class Any
Show all
case object NonEmptyTest extends Test

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Translator.this.Test
class Object
trait Matchable
class Any
Show all
Self type
case object NonNullTest extends Test

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Translator.this.Test
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class Plan

The different kinds of plans

The different kinds of plans

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Translator.this.LabeledPlan
class Translator.this.LetPlan
class Translator.this.ResultPlan
class Translator.this.ReturnPlan
class Translator.this.SeqPlan
class Translator.this.TestPlan
Show all
class PlanTransform extends Plan => Plan

A superclass for plan transforms

A superclass for plan transforms

Attributes

Supertypes
trait Translator.this.Plan => Translator.this.Plan
class Object
trait Matchable
class Any
case class ResultPlan(var tree: Tree) extends Plan

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Plan
class Object
trait Matchable
class Any
Show all
case class ReturnPlan(var label: TermSymbol) extends Plan

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Plan
class Object
trait Matchable
class Any
Show all
case class SeqPlan(var head: Translator.this.Plan, var tail: Translator.this.Plan) extends Plan

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Plan
class Object
trait Matchable
class Any
Show all
sealed abstract class Test

The different kinds of tests

The different kinds of tests

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Translator.this.EqualTest
object Translator.this.GuardTest
class Translator.this.LengthTest
object Translator.this.NonEmptyTest
object Translator.this.NonNullTest
class Translator.this.TypeTest
Show all
case class TestPlan(test: Translator.this.Test, var scrutinee: Tree, span: Span, var onSuccess: Translator.this.Plan) extends Plan

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Plan
class Object
trait Matchable
class Any
Show all
object TestPlan

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Translator.this.Translator.this.TestPlan.type
case class TypeTest(tpt: Tree, trusted: Boolean) extends Test

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Translator.this.Test
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def mergeTests(plan: Plan): Plan

Merge identical consecutive tests.

Merge identical consecutive tests.

When we have the following shape:

if (testA) plan1 if (testA) plan2 nextPlan?

transform it to

if (testA) { plan1 plan2 } nextPlan?

Similarly, when we have equivalent let bindings:

let x1 = rhs1 in plan1 let x2 = rhs2 in plan2 nextPlan?

and rhs1 and rhs2 are equivalent, transform it to

let x1 = rhs1 in { plan1 plan2[x1/x2] }

where plan2[x1/x2] means substituting x1 for x2 in plan2.

There are some tricks to "ignore" non-patmat-generated let bindings, i.e., captures written in the source code, while identifying common subplans.

Attributes

def show(plan: Plan): String

Pretty-print plan; used for debugging

Pretty-print plan; used for debugging

Attributes

def translateMatch(tree: Match): Tree

Translate pattern match to sequence of tests.

Translate pattern match to sequence of tests.

Attributes

Concrete fields

Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL