case class ProductExtractorTreeMaker(prevBinder: Global.Symbol, extraCond: Option[Global.Tree])(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], mutableBinders: List[Global.Symbol], ignoredSubPatBinders: Set[Global.Symbol]) extends FunTreeMaker with PreserveSubPatBinders with Product with Serializable
An optimized version of ExtractorTreeMaker for Products. For now, this is hard-coded to case classes, and we simply extract the case class fields.
The values for the subpatterns, as specified by the case class fields at the time of extraction,
are stored in local variables that re-use the symbols in subPatBinders
.
This makes extractor patterns more debuggable (scala/bug#5739) as well as
avoiding mutation after the pattern has been matched (scala/bug#5158, scala/bug#6070)
TODO: make this user-definable as follows
When a companion object defines a method def unapply_1(x: T): U_1
, but no def unapply
or def unapplySeq
,
the extractor is considered to match any non-null value of type T
the pattern is expected to have as many sub-patterns as there are def unapply_I(x: T): U_I
methods,
and the type of the I'th sub-pattern is U_I
.
The same exception for Seq patterns applies: if the last extractor is of type Seq[U_N]
,
the pattern must have at least N arguments (exactly N if the last argument is annotated with : _*
).
The arguments starting at N (and beyond) are taken from the sequence returned by apply_N,
and it is checked that that sequence has enough elements to provide values for all expected sub-patterns.
For a case class C, the implementation is assumed to be def unapply_I(x: C) = x._I
,
and the extractor call is inlined under that assumption.
- Source
- MatchTreeMaking.scala
- Alphabetic
- By Inheritance
- ProductExtractorTreeMaker
- Serializable
- Product
- Equals
- PreserveSubPatBinders
- FunTreeMaker
- TreeMaker
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ProductExtractorTreeMaker(prevBinder: Global.Symbol, extraCond: Option[Global.Tree])(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], mutableBinders: List[Global.Symbol], ignoredSubPatBinders: Set[Global.Symbol])
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toany2stringadd[ProductExtractorTreeMaker] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ProductExtractorTreeMaker, B)
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toArrowAssoc[ProductExtractorTreeMaker] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bindSubPats(in: Global.Tree): Global.Tree
- Definition Classes
- PreserveSubPatBinders
- def chainBefore(next: Global.Tree)(casegen: TreeMakers.Casegen): Global.Tree
- Definition Classes
- ProductExtractorTreeMaker → TreeMaker
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def emitVars: Boolean
- Definition Classes
- PreserveSubPatBinders
- def ensuring(cond: (ProductExtractorTreeMaker) => Boolean, msg: => Any): ProductExtractorTreeMaker
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toEnsuring[ProductExtractorTreeMaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ProductExtractorTreeMaker) => Boolean): ProductExtractorTreeMaker
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toEnsuring[ProductExtractorTreeMaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ProductExtractorTreeMaker
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toEnsuring[ProductExtractorTreeMaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ProductExtractorTreeMaker
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toEnsuring[ProductExtractorTreeMaker] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val extraCond: Option[Global.Tree]
- def extraStoredBinders: Set[Global.Symbol]
- Definition Classes
- ProductExtractorTreeMaker → PreserveSubPatBinders
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toStringFormat[ProductExtractorTreeMaker] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val ignoredSubPatBinders: Set[Global.Symbol]
- Definition Classes
- ProductExtractorTreeMaker → PreserveSubPatBinders
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- lazy val localSubstitution: TreeMakers.Substitution
- Attributes
- protected
- Definition Classes
- PreserveSubPatBinders → TreeMaker
- val mutableBinders: List[Global.Symbol]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nextBinder: Global.Symbol
- Definition Classes
- ProductExtractorTreeMaker → FunTreeMaker
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def pos: Global.Position
- Definition Classes
- FunTreeMaker → TreeMaker
- val prevBinder: Global.Symbol
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- lazy val storedBinders: Set[Global.Symbol]
- Definition Classes
- PreserveSubPatBinders
- val subPatBinders: List[Global.Symbol]
- Definition Classes
- ProductExtractorTreeMaker → PreserveSubPatBinders
- val subPatRefs: List[Global.Tree]
- Definition Classes
- ProductExtractorTreeMaker → PreserveSubPatBinders
- 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
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ProductExtractorTreeMaker → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (ProductExtractorTreeMaker, B)
- Implicit
- This member is added by an implicit conversion from ProductExtractorTreeMaker toArrowAssoc[ProductExtractorTreeMaker] 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.
The Scala compiler and reflection APIs.