Trait

scala.tools.nsc.transform.patmat.ScalacPatternExpanders

ScalacPatternExpander

Related Doc: package ScalacPatternExpanders

Permalink

trait ScalacPatternExpander extends PatternExpander[Global.Tree, Global.Type]

Source
ScalacPatternExpanders.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScalacPatternExpander
  2. PatternExpander
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Aligned(patterns: Patterns, extractor: Extractor) extends Product with Serializable

    Permalink

    If elementArity is...

    If elementArity is... 0: A perfect match between extractor and the fixed patterns. If there is a star pattern it will match any sequence. > 0: There are more patterns than products. There will have to be a sequence which can populate at least <elementArity> patterns. < 0: There are more products than patterns: compile time error.

    Definition Classes
    PatternExpander
  2. final case class Extractor(whole: Type, fixed: List[Type], repeated: Repeated, typeOfSinglePattern: Type) extends Product with Serializable

    Permalink

    An 'extractor' can be a case class or an unapply or unapplySeq method.

    An 'extractor' can be a case class or an unapply or unapplySeq method. Decoding what it is that they extract takes place before we arrive here, so that this class can concentrate only on the relationship between patterns and types.

    In a case class, the class is the unextracted type and the fixed and repeated types are derived from its constructor parameters.

    In an unapply, this is reversed: the parameter to the unapply is the unextracted type, and the other types are derived based on the return type of the unapply method.

    In other words, this case class and unapply are encoded the same:

    case class Foo(x: Int, y: Int, zs: Char*) def unapplySeq(x: Foo): Option[(Int, Int, Seq[Char])]

    Both are Extractor(Foo, Int :: Int :: Nil, Repeated(Seq[Char], Char, Char*))

    whole

    The type in its unextracted form

    fixed

    The non-sequence types which are extracted

    repeated

    The sequence type which is extracted

    Definition Classes
    PatternExpander
  3. final case class Patterns(fixed: List[Pattern], star: Pattern) extends Product with Serializable

    Permalink
    Definition Classes
    PatternExpander
  4. sealed case class Repeated(sequenceType: Type, elementType: Type, repeatedType: Type) extends Product with Serializable

    Permalink

    It's not optimal that we're carrying both sequence and repeated type here, but the implementation requires more unraveling before it can be avoided.

    It's not optimal that we're carrying both sequence and repeated type here, but the implementation requires more unraveling before it can be avoided.

    sequenceType is Seq[T], elementType is T, repeatedType is T*.

    Definition Classes
    PatternExpander
  5. final case class TypedPat(pat: Pattern, tpe: Type) extends Product with Serializable

    Permalink
    Definition Classes
    PatternExpander

Value Members

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

    Permalink

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

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

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

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

    Permalink

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  6. def NoPattern: Global.EmptyTree.type

    Permalink

    You'll note we're not inside the cake.

    You'll note we're not inside the cake. "Pattern" and "Type" are arbitrary types here, and NoPattern and NoType arbitrary values.

    Definition Classes
    ScalacPatternExpanderPatternExpander
  7. object NoRepeated extends Repeated

    Permalink
    Definition Classes
    PatternExpander
  8. def NoType: Global.NoType.type

    Permalink
    Definition Classes
    ScalacPatternExpanderPatternExpander
  9. def applyMethodTypes(method: Global.Type): Extractor

    Permalink

    In this case we are basing the pattern expansion on a case class constructor.

    In this case we are basing the pattern expansion on a case class constructor. The argument is the MethodType carried by the primary constructor.

  10. final def asInstanceOf[T0]: T0

    Permalink

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  11. def clone(): AnyRef

    Permalink

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

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

    not specified by SLS as a member of AnyRef

  12. def elementTypeOf(tpe: Global.Type): Global.Type

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

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

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

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

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

    Permalink

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

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

    Permalink

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

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

    Permalink

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

    not specified by SLS as a member of AnyRef

  20. def formatted(fmtstr: String): String

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

    Permalink

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  22. def hashCode(): Int

    Permalink

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Permalink

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean

    Permalink

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  25. def newExtractor(whole: Global.Type, fixed: List[Global.Type], repeated: Repeated): Extractor

    Permalink
  26. def newExtractor(whole: Global.Type, fixed: List[Global.Type], repeated: Repeated, typeOfSinglePattern: Global.Type): Extractor

    Permalink
  27. def newPatterns(patterns: List[Global.Tree]): Patterns

    Permalink
  28. final def notify(): Unit

    Permalink

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  29. final def notifyAll(): Unit

    Permalink

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  30. def repeatedFromSeq(seqType: Global.Type): Repeated

    Permalink
  31. def repeatedFromVarargs(repeated: Global.Type): Repeated

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

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  34. def unapplyMethodTypes(context: (analyzer)#Context, whole: Global.Type, result: Global.Type, isSeq: Boolean): Extractor

    Permalink

    In this case, expansion is based on an unapply or unapplySeq method.

    In this case, expansion is based on an unapply or unapplySeq method. Unfortunately the MethodType does not carry the information of whether it was unapplySeq, so we have to funnel that information in separately.

  35. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def [B](y: B): (ScalacPatternExpander, B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ScalacPatternExpander to any2stringadd[ScalacPatternExpander]

Inherited by implicit conversion StringFormat from ScalacPatternExpander to StringFormat[ScalacPatternExpander]

Inherited by implicit conversion Ensuring from ScalacPatternExpander to Ensuring[ScalacPatternExpander]

Inherited by implicit conversion ArrowAssoc from ScalacPatternExpander to ArrowAssoc[ScalacPatternExpander]

Ungrouped