Scala Compiler 2.13.16 - scala.tools.nsc.transform.patmat.MatchTreeMaking.TreeMakers.ExtractorTreeMaker
Keywords: Scala Compiler 2.13.16 scala.tools.nsc.transform.patmat.MatchTreeMaking.TreeMakers.ExtractorTreeMaker

Scala Compiler2.13.16 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package transform
  Definition Classes
    nsc
-  package patmat
  Definition Classes
    transform
-  trait MatchTreeMaking extends MatchCodeGen with Debugging

  Translate our IR (TreeMakers) into actual Scala Trees using the factory methods in MatchCodeGen.

  Translate our IR (TreeMakers) into actual Scala Trees using the factory methods in MatchCodeGen.

  The IR is mostly concerned with sequencing, substitution, and rendering all necessary conditions.

  Definition Classes
    patmat
-  trait TreeMakers extends TypedSubstitution with CodegenCore
  Definition Classes
    MatchTreeMaking
- AbsCodegen
- AlternativesTreeMaker
- BodyTreeMaker
- Casegen
- CommonCodegen
- CondTreeMaker
- DummyTreeMaker
- EmptySubstitution
- EqualityTestTreeMaker
- ExtractorTreeMaker
- FunTreeMaker
- GuardTreeMaker
- NoNewBinders
- NonNullTestTreeMaker
- PreserveSubPatBinders
- ProductExtractorTreeMaker
- SubstOnlyTreeMaker
- Substitution
- TreeMaker
- TrivialTreeMaker
- TypeTestTreeMaker

c

scala.tools.nsc.transform.patmat.MatchTreeMaking.TreeMakers

# ExtractorTreeMaker

###

#### case class ExtractorTreeMaker(extractor: Global.Tree, extraCond: Option[Global.Tree], nextBinder: Global.Symbol)(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], potentiallyMutableBinders: Set[Global.Symbol], extractorReturnsBoolean: Boolean, checkedLength: Option[Int], prevBinder: Global.Symbol, ignoredSubPatBinders: Set[Global.Symbol]) extends FunTreeMaker with PreserveSubPatBinders with Product with Serializable

Make a TreeMaker that will result in an extractor call specified by `extractor` the next TreeMaker (here, we don't know which it'll be) is chained after this one by flatMap'ing a function with binder `nextBinder` over our extractor's result the function's body is determined by the next TreeMaker (furthermore, the interpretation of `flatMap` depends on the codegen instance we're using).

The values for the subpatterns, as computed by the extractor call in `extractor`, are stored in local variables that re-use the symbols in `subPatBinders`. This makes extractor patterns more debuggable (scala/bug#5739).

Source
  MatchTreeMaking.scala

Linear Supertypes
java.io.Serializable, Product, Equals, PreserveSubPatBinders, FunTreeMaker, TreeMaker, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ExtractorTreeMaker
2. Serializable
3. Product
4. Equals
5. PreserveSubPatBinders
6. FunTreeMaker
7. TreeMaker
8. AnyRef
9. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new ExtractorTreeMaker(extractor: Global.Tree, extraCond: Option[Global.Tree], nextBinder: Global.Symbol)(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], potentiallyMutableBinders: Set[Global.Symbol], extractorReturnsBoolean: Boolean, checkedLength: Option[Int], prevBinder: Global.Symbol, ignoredSubPatBinders: Set[Global.Symbol])

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from ExtractorTreeMaker toany2stringadd[ExtractorTreeMaker] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (ExtractorTreeMaker, B)
   Implicit
     This member is added by an implicit conversion from ExtractorTreeMaker toArrowAssoc[ExtractorTreeMaker] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def bindSubPats(in: Global.Tree): Global.Tree
   Definition Classes
     PreserveSubPatBinders
8.  def chainBefore(next: Global.Tree)(casegen: TreeMakers.Casegen): Global.Tree
   Definition Classes
     ExtractorTreeMaker → TreeMaker
9.  val checkedLength: Option[Int]
10.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
11.  def emitVars: Boolean
    Definition Classes
      PreserveSubPatBinders
12.  def ensuring(cond: (ExtractorTreeMaker) => Boolean, msg: => Any): ExtractorTreeMaker
    Implicit
      This member is added by an implicit conversion from ExtractorTreeMaker toEnsuring[ExtractorTreeMaker] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  def ensuring(cond: (ExtractorTreeMaker) => Boolean): ExtractorTreeMaker
    Implicit
      This member is added by an implicit conversion from ExtractorTreeMaker toEnsuring[ExtractorTreeMaker] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: Boolean, msg: => Any): ExtractorTreeMaker
    Implicit
      This member is added by an implicit conversion from ExtractorTreeMaker toEnsuring[ExtractorTreeMaker] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  def ensuring(cond: Boolean): ExtractorTreeMaker
    Implicit
      This member is added by an implicit conversion from ExtractorTreeMaker toEnsuring[ExtractorTreeMaker] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
16.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
17.  val extraCond: Option[Global.Tree]
18.  def extraStoredBinders: Set[Global.Symbol]
    Definition Classes
      ExtractorTreeMaker → PreserveSubPatBinders
19.  val extractor: Global.Tree
20.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
21.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
22.  val ignoredSubPatBinders: Set[Global.Symbol]
    Definition Classes
      ExtractorTreeMaker → PreserveSubPatBinders
23.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
24.  lazy val localSubstitution: TreeMakers.Substitution
    Attributes
      protected
    Definition Classes
      PreserveSubPatBinders → TreeMaker
25.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
26.  val nextBinder: Global.Symbol
    Definition Classes
      ExtractorTreeMaker → FunTreeMaker
27.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
28.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
29.  def pos: Global.Position
    Definition Classes
      FunTreeMaker → TreeMaker
30.  val potentiallyMutableBinders: Set[Global.Symbol]
31.  val prevBinder: Global.Symbol
32.  def productElementNames: Iterator[String]
    Definition Classes
      Product
33.  val subPatBinders: List[Global.Symbol]
    Definition Classes
      ExtractorTreeMaker → PreserveSubPatBinders
34.  val subPatRefs: List[Global.Tree]
    Definition Classes
      ExtractorTreeMaker → PreserveSubPatBinders
35.  def subPatternsAsSubstitution: TreeMakers.Substitution

    The substitution that specifies the trees that compute the values of the subpattern binders.

    The substitution that specifies the trees that compute the values of the subpattern binders.

    We pretend to replace the subpattern binders by subpattern refs (Even though we don't do so anymore -- see scala/bug#5158, scala/bug#5739 and scala/bug#6070.)

    Definition Classes
      PreserveSubPatBinders → TreeMaker
36.  def substitution: TreeMakers.Substitution

    captures the scope and the value of the bindings in patterns important *when* the substitution happens (can't accumulate and do at once after the full matcher has been constructed)

    captures the scope and the value of the bindings in patterns important *when* the substitution happens (can't accumulate and do at once after the full matcher has been constructed)

    Definition Classes
      TreeMaker
37.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
38.  def toString(): String
    Definition Classes
      ExtractorTreeMaker → AnyRef → Any
39.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
40.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
41.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from ExtractorTreeMaker toStringFormat[ExtractorTreeMaker] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (ExtractorTreeMaker, B)
   Implicit
     This member is added by an implicit conversion from ExtractorTreeMaker toArrowAssoc[ExtractorTreeMaker] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from java.io.Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from PreserveSubPatBinders

### Inherited from FunTreeMaker

### Inherited from TreeMaker

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromExtractorTreeMaker to any2stringadd[ExtractorTreeMaker]

### Inherited by implicit conversion StringFormat fromExtractorTreeMaker to StringFormat[ExtractorTreeMaker]

### Inherited by implicit conversion Ensuring fromExtractorTreeMaker to Ensuring[ExtractorTreeMaker]

### Inherited by implicit conversion ArrowAssoc fromExtractorTreeMaker to ArrowAssoc[ExtractorTreeMaker]

### Ungrouped