Trait

scala.reflect.macros

Aliases

Related Doc: package macros

Permalink

trait Aliases extends AnyRef

EXPERIMENTAL

A slice of the Scala macros context that defines shorthands for the most frequently used types and functions of the underlying compiler universe.

Self Type
blackbox.Context
Source
Aliases.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Aliases
  2. AnyRef
  3. 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. type Expr[+T] = Universe.Expr[T]

    Permalink

    Expr wraps an abstract syntax tree and tags it with its type.

  2. type Modifiers = Universe.Modifiers

    Permalink

    The type of tree modifiers.

  3. type Name = Universe.Name

    Permalink

    The abstract type of names.

  4. type Position = Universe.Position

    Permalink

    Defines a universe-specific notion of positions.

  5. type Scope = Universe.Scope

    Permalink

    The base type of all scopes.

  6. type Symbol = Universe.Symbol

    Permalink

    The type of symbols representing declarations.

  7. type TermName = Universe.TermName

    Permalink

    The abstract type of names representing terms.

  8. type Tree = Universe.Tree

    Permalink

    The type of Scala abstract syntax trees.

  9. type Type = Universe.Type

    Permalink

    The type of Scala types, and also Scala type signatures.

    The type of Scala types, and also Scala type signatures. (No difference is internally made between the two).

  10. type TypeName = Universe.TypeName

    Permalink

    The abstract type of names representing types.

  11. type TypeTag[T] = Universe.TypeTag[T]

    Permalink

    The type of type tags.

  12. type WeakTypeTag[T] = Universe.WeakTypeTag[T]

    Permalink

    The type of weak type tags.

  13. type CompilationUnit = Universe.CompilationUnit

    Permalink

    The type of compilation units.

    The type of compilation units.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) c.enclosingTree-style APIs are now deprecated; consult the scaladoc for more information

    See also

    scala.reflect.macros.Enclosures

  14. type Run = Universe.Run

    Permalink

    The type of compilation runs.

    The type of compilation runs.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) c.enclosingTree-style APIs are now deprecated; consult the scaladoc for more information

    See also

    scala.reflect.macros.Enclosures

Abstract Value Members

  1. abstract def Expr[T](tree: blackbox.Context.Tree)(implicit arg0: blackbox.Context.WeakTypeTag[T]): blackbox.Context.Expr[T]

    Permalink

    A shorthand to create an expr.

    A shorthand to create an expr.

    Unlike the conventional expr factory, which requires a scala.reflect.api.TreeCreator, this one accepts a regular tree, but the resulting exprs are unable of being migrated to other universes/mirrors (the functionality normally not needed for macros, since there is only one compile-time universe and only one compile-time mirror).

  2. abstract def TypeTag[T](tpe: blackbox.Context.Type): blackbox.Context.TypeTag[T]

    Permalink

    A shorthand to create a type tag.

    A shorthand to create a type tag.

    Unlike the conventional type tag factory, which requires a scala.reflect.api.TypeCreator, this one accepts a regular type, but the resulting type tags are unable of being migrated to other universes/mirrors (the functionality normally not needed for macros, since there is only one compile-time universe and only one compile-time mirror).

  3. abstract def WeakTypeTag[T](tpe: blackbox.Context.Type): blackbox.Context.WeakTypeTag[T]

    Permalink

    A shorthand to create a weak type tag.

    A shorthand to create a weak type tag.

    Unlike the conventional type tag factory, which requires a scala.reflect.api.TypeCreator, this one accepts a regular type, but the resulting type tags are unable of being migrated to other universes/mirrors (the functionality normally not needed for macros, since there is only one compile-time universe and only one compile-time mirror).

Concrete 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 Aliases to any2stringadd[Aliases] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Aliases, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aliases to ArrowAssoc[Aliases] 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. val Expr: Universe.Expr.type

    Permalink

    Constructor/Extractor for Expr.

  7. val TypeTag: Universe.TypeTag.type

    Permalink

    Constructor/Extractor for TypeTag.

  8. val WeakTypeTag: Universe.WeakTypeTag.type

    Permalink

    Constructor/Extractor for WeakTypeTag.

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

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

  11. def ensuring(cond: (Aliases) ⇒ Boolean, msg: ⇒ Any): Aliases

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aliases to Ensuring[Aliases] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. 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
  16. 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
  17. 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

  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aliases to StringFormat[Aliases] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. 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

  20. 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
  21. 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
  22. 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
  23. 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

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

  25. def symbolOf[T](implicit arg0: blackbox.Context.WeakTypeTag[T]): Universe.TypeSymbol

    Permalink

    Type symbol of x as derived from a type tag.

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

    Permalink
    Definition Classes
    AnyRef
  27. 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
  28. def typeOf[T](implicit ttag: blackbox.Context.TypeTag[T]): blackbox.Context.Type

    Permalink

    Shortcut for implicitly[TypeTag[T]].tpe

  29. def typeTag[T](implicit ttag: blackbox.Context.TypeTag[T]): blackbox.Context.TypeTag[T]

    Permalink

    Shortcut for implicitly[TypeTag[T]]

  30. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def weakTypeOf[T](implicit attag: blackbox.Context.WeakTypeTag[T]): blackbox.Context.Type

    Permalink

    Shortcut for implicitly[WeakTypeTag[T]].tpe

  34. def weakTypeTag[T](implicit attag: blackbox.Context.WeakTypeTag[T]): blackbox.Context.WeakTypeTag[T]

    Permalink

    Shortcut for implicitly[WeakTypeTag[T]]

  35. def [B](y: B): (Aliases, B)

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