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

ProductExtractorTreeMaker

case class ProductExtractorTreeMaker(prevBinder: Global.Symbol, extraCond: Option[Global.Tree])(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], mutableBinders: List[Global.Symbol], binderKnownNonNull: Boolean, 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 (SI-5739) as well as avoiding mutation after the pattern has been matched (SI-5158, SI-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.

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, PreserveSubPatBinders, FunTreeMaker, TreeMaker, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ProductExtractorTreeMaker
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PreserveSubPatBinders
  7. FunTreeMaker
  8. TreeMaker
  9. AnyRef
  10. 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

Instance Constructors

  1. new ProductExtractorTreeMaker(prevBinder: Global.Symbol, extraCond: Option[Global.Tree])(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], mutableBinders: List[Global.Symbol], binderKnownNonNull: Boolean, ignoredSubPatBinders: Set[Global.Symbol])

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 ProductExtractorTreeMaker to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (ProductExtractorTreeMaker, B)

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to ArrowAssoc[ProductExtractorTreeMaker] 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def bindSubPats(in: Global.Tree): Global.Tree

    Definition Classes
    PreserveSubPatBinders

  10. def chainBefore(next: Global.Tree)(casegen: TreeMakers.Casegen): Global.Tree

    Definition Classes
    ProductExtractorTreeMaker → TreeMaker

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def emitVars: Boolean

    Definition Classes
    PreserveSubPatBinders

  13. def ensuring(cond: (ProductExtractorTreeMaker) ⇒ Boolean, msg: ⇒ Any): ProductExtractorTreeMaker

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to Ensuring[ProductExtractorTreeMaker] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: (ProductExtractorTreeMaker) ⇒ Boolean): ProductExtractorTreeMaker

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to Ensuring[ProductExtractorTreeMaker] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean, msg: ⇒ Any): ProductExtractorTreeMaker

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to Ensuring[ProductExtractorTreeMaker] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. def ensuring(cond: Boolean): ProductExtractorTreeMaker

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to Ensuring[ProductExtractorTreeMaker] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  17. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. val extraCond: Option[Global.Tree]

  19. def extraStoredBinders: Set[Global.Symbol]

    Definition Classes
    ProductExtractorTreeMaker → PreserveSubPatBinders

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  23. val ignoredSubPatBinders: Set[Global.Symbol]

    Definition Classes
    ProductExtractorTreeMaker → PreserveSubPatBinders

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  25. lazy val localSubstitution: TreeMakers.Substitution

    Attributes
    protected
    Definition Classes
    PreserveSubPatBinders → TreeMaker

  26. val mutableBinders: List[Global.Symbol]

  27. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  28. val nextBinder: Global.Symbol

    Definition Classes
    ProductExtractorTreeMaker → FunTreeMaker

  29. final def notify(): Unit

    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  31. def pos: Global.Position

    Definition Classes
    FunTreeMaker → TreeMaker

  32. val prevBinder: Global.Symbol

  33. lazy val storedBinders: Set[Global.Symbol]

    Definition Classes
    PreserveSubPatBinders

  34. val subPatBinders: List[Global.Symbol]

    Definition Classes
    ProductExtractorTreeMaker → PreserveSubPatBinders

  35. val subPatRefs: List[Global.Tree]

    Definition Classes
    ProductExtractorTreeMaker → PreserveSubPatBinders

  36. 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 SI-5158, SI-5739 and SI-6070.)

    Definition Classes
    PreserveSubPatBinders → TreeMaker

  37. 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

  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  39. def toString(): String

    Definition Classes
    ProductExtractorTreeMaker → AnyRef → Any

  40. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. def →[B](y: B): (ProductExtractorTreeMaker, B)

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to ArrowAssoc[ProductExtractorTreeMaker] 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 ProductExtractorTreeMaker 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:
    (productExtractorTreeMaker: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker 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:
    (productExtractorTreeMaker: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ProductExtractorTreeMaker

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to ArrowAssoc[ProductExtractorTreeMaker] 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:
    (productExtractorTreeMaker: ArrowAssoc[ProductExtractorTreeMaker]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ProductExtractorTreeMaker

    Implicit information
    This member is added by an implicit conversion from ProductExtractorTreeMaker to Ensuring[ProductExtractorTreeMaker] 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:
    (productExtractorTreeMaker: Ensuring[ProductExtractorTreeMaker]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

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 from ProductExtractorTreeMaker to StringAdd

Inherited by implicit conversion any2stringfmt from ProductExtractorTreeMaker to StringFormat

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

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

Ungrouped