scala.tools.nsc.transform.patmat

PatternMatching

trait PatternMatching extends SubComponent with Transform with TypingTransformers with Debugging with Interface with MatchTranslation with MatchTreeMaking with MatchCodeGen with ScalaLogic with Solving with MatchAnalysis with MatchOptimization

Translate pattern matching.

Either into optimized if/then/else's, or virtualized as method calls (these methods form a zero-plus monad), similar in spirit to how for-comprehensions are compiled.

For each case, express all patterns as extractor calls, guards as 0-ary extractors, and sequence them using flatMap (lifting the body of the case into the monad using one).

Cases are combined into a pattern match using the orElse combinator (the implicit failure case is expressed using the monad's zero).

TODO:

(longer-term) TODO:

Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PatternMatching
  2. MatchOptimization
  3. MatchAnalysis
  4. MatchApproximation
  5. Solving
  6. ScalaLogic
  7. TreeAndTypeAnalysis
  8. Logic
  9. MatchTreeMaking
  10. MatchCodeGen
  11. MatchTranslation
  12. Interface
  13. TreeDSL
  14. Debugging
  15. TypingTransformers
  16. Transform
  17. SubComponent
  18. AnyRef
  19. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait CNF extends PropositionalLogic

    Definition Classes
    Solving
  2. trait CheckableTreeAndTypeAnalysis extends AnyRef

    Definition Classes
    TreeAndTypeAnalysis
  3. trait CodegenCore extends MatchMonadInterface

    Definition Classes
    MatchCodeGen
  4. trait CommonSubconditionElimination extends OptimizedCodegen with MatchApproximator

    Definition Classes
    MatchOptimization
  5. trait MatchAnalyzer extends MatchApproximator

    Definition Classes
    MatchAnalysis
  6. trait MatchApproximator extends TreeMakers with TreesAndTypesDomain

    Represent a match as a formula in propositional logic that encodes whether the match matches (abstractly: we only consider types)

  7. trait MatchMonadInterface extends AnyRef

    Interface with user-defined match monad? if there's a match in scope, we use this as the match strategy, assuming it conforms to MatchStrategy as defined below:

  8. trait MatchOptimizer extends OptimizedCodegen with SwitchEmission with CommonSubconditionElimination

    Definition Classes
    MatchOptimization
  9. class MatchTransformer extends TypingTransformer

  10. trait MatchTranslator extends PatternMatching.TreeMakers

    Definition Classes
    MatchTranslation
  11. trait OptimizedCodegen extends CodegenCore with TypedSubstitution with OptimizedMatchMonadInterface

    Definition Classes
    MatchCodeGen
  12. trait OptimizedMatchMonadInterface extends MatchMonadInterface

    Definition Classes
    MatchCodeGen
  13. class OptimizingMatchTranslator extends MatchTranslator with MatchOptimizer with MatchAnalyzer with Solver

  14. class Phase extends StdPhase

    The phase defined by this transform

  15. trait PropositionalLogic extends AnyRef

    Definition Classes
    Logic
  16. trait PureCodegen extends CodegenCore with PureMatchMonadInterface

    Definition Classes
    MatchCodeGen
  17. trait PureMatchMonadInterface extends MatchMonadInterface

    Definition Classes
    MatchCodeGen
  18. class PureMatchTranslator extends MatchTranslator with PureCodegen

  19. trait Solver extends CNF

    Definition Classes
    Solving
  20. abstract class StdPhase extends GlobalPhase

    A standard phase template

  21. final case class Suppression(exhaustive: Boolean, unreachable: Boolean) extends Product with Serializable

    Definition Classes
    MatchTreeMaking
  22. trait SwitchEmission extends TreeMakers with OptimizedMatchMonadInterface

    Definition Classes
    MatchOptimization
  23. trait TreeMakers extends TypedSubstitution with CodegenCore

    Definition Classes
    MatchTreeMaking
  24. trait TreesAndTypesDomain extends PropositionalLogic with CheckableTreeAndTypeAnalysis

    Definition Classes
    ScalaLogic
  25. trait TypedSubstitution extends MatchMonadInterface

    Definition Classes
    Interface
  26. abstract class TypingTransformer extends Global.Transformer

    Definition Classes
    TypingTransformers

Abstract Value Members

  1. abstract val global: Global

    Definition Classes
    TreeDSL
  2. abstract val runsAfter: List[String]

    List of phase names, this phase should run after

    List of phase names, this phase should run after

    Definition Classes
    SubComponent
  3. abstract val runsRightAfter: Option[String]

    Phase name this phase will attach itself to, not allowing any phase to come between it and the phase name declared

    Phase name this phase will attach itself to, not allowing any phase to come between it and the phase name declared

    Definition Classes
    SubComponent

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from PatternMatching to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (PatternMatching, B)

    Implicit information
    This member is added by an implicit conversion from PatternMatching to ArrowAssoc[PatternMatching] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. object CODE

    Definition Classes
    TreeDSL
  9. object Suppression extends Serializable

    Definition Classes
    MatchTreeMaking
  10. final def afterOwnPhase[T](op: ⇒ T): T

    Definition Classes
    SubComponent
    Annotations
    @inline()
  11. def alignAcrossRows(xss: List[List[AnyRef]], sep: String, lineSep: String = "\n"): String

    Definition Classes
    Logic
  12. final def asInstanceOf[T0]: T0

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. final def dealiasWiden(tp: Global.Type): Global.Type

    Attributes
    protected
    Definition Classes
    Interface
  16. object debug

    Definition Classes
    Debugging
  17. final def devWarning(str: String): Unit

    Attributes
    protected
    Definition Classes
    Interface
  18. def ensuring(cond: (PatternMatching) ⇒ Boolean, msg: ⇒ Any): PatternMatching

    Implicit information
    This member is added by an implicit conversion from PatternMatching to Ensuring[PatternMatching] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: (PatternMatching) ⇒ Boolean): PatternMatching

    Implicit information
    This member is added by an implicit conversion from PatternMatching to Ensuring[PatternMatching] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean, msg: ⇒ Any): PatternMatching

    Implicit information
    This member is added by an implicit conversion from PatternMatching to Ensuring[PatternMatching] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean): PatternMatching

    Implicit information
    This member is added by an implicit conversion from PatternMatching to Ensuring[PatternMatching] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from PatternMatching to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  26. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  27. final def hasStableSymbol(p: Global.Tree): Boolean

    Attributes
    protected
    Definition Classes
    Interface
  28. def hashCode(): Int

    SubComponent are added to a HashSet and two phases are the same if they have the same name

    SubComponent are added to a HashSet and two phases are the same if they have the same name

    Definition Classes
    SubComponent → AnyRef → Any
  29. def instanceOfTpImplies(tp: Global.Type, tpImplied: Global.Type): Boolean

    Definition Classes
    TreeAndTypeAnalysis
  30. val internal: Boolean

    Internal flag to tell external from internal phases

    Internal flag to tell external from internal phases

    Definition Classes
    SubComponent
  31. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  32. final def mkFALSE: Global.Literal

    Attributes
    protected
    Definition Classes
    Interface
  33. final def mkTRUE: Global.Literal

    Attributes
    protected
    Definition Classes
    Interface
  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. def newPhase(prev: nsc.Phase): StdPhase

    Create a new phase which applies transformer

    Create a new phase which applies transformer

    Definition Classes
    TransformSubComponent
  36. def newTransformer(unit: Global.CompilationUnit): Global.Transformer

    The transformer factory

    The transformer factory

    Definition Classes
    PatternMatchingTransform
  37. final def notify(): Unit

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

    Definition Classes
    AnyRef
  39. def ownPhase: nsc.Phase

    The phase corresponding to this subcomponent in the current compiler run

    The phase corresponding to this subcomponent in the current compiler run

    Definition Classes
    SubComponent
  40. val phaseName: String

    The name of the phase

    The name of the phase

    Definition Classes
    PatternMatchingSubComponent
  41. def phaseNewFlags: Long

    New flags defined by the phase which are not valid before

    New flags defined by the phase which are not valid before

    Definition Classes
    SubComponent
  42. def phaseNextFlags: Long

    New flags defined by the phase which are not valid until immediately after it

    New flags defined by the phase which are not valid until immediately after it

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

    List of phase names, this phase should run before

    List of phase names, this phase should run before

    Definition Classes
    SubComponent
  44. def sameValue(a: Global.Tree, b: Global.Tree): Boolean

    Definition Classes
    TreeAndTypeAnalysis
  45. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  46. def toString(): String

    Definition Classes
    AnyRef → Any
  47. object vpmName

    Definition Classes
    Interface
  48. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. def [B](y: B): (PatternMatching, B)

    Implicit information
    This member is added by an implicit conversion from PatternMatching to ArrowAssoc[PatternMatching] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from PatternMatching to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (patternMatching: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from PatternMatching to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (patternMatching: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: PatternMatching

    Implicit information
    This member is added by an implicit conversion from PatternMatching to ArrowAssoc[PatternMatching] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (patternMatching: ArrowAssoc[PatternMatching]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: PatternMatching

    Implicit information
    This member is added by an implicit conversion from PatternMatching to Ensuring[PatternMatching] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (patternMatching: Ensuring[PatternMatching]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from MatchOptimization

Inherited from MatchAnalysis

Inherited from MatchApproximation

Inherited from Solving

Inherited from ScalaLogic

Inherited from TreeAndTypeAnalysis

Inherited from Logic

Inherited from MatchTreeMaking

Inherited from MatchCodeGen

Inherited from MatchTranslation

Inherited from Interface

Inherited from TreeDSL

Inherited from Debugging

Inherited from TypingTransformers

Inherited from Transform

Inherited from SubComponent

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PatternMatching to StringAdd

Inherited by implicit conversion any2stringfmt from PatternMatching to StringFormat

Inherited by implicit conversion any2ArrowAssoc from PatternMatching to ArrowAssoc[PatternMatching]

Inherited by implicit conversion any2Ensuring from PatternMatching to Ensuring[PatternMatching]

Ungrouped