scala.reflect.macros

Enclosures

trait Enclosures extends AnyRef

EXPERIMENTAL

A slice of the Scala macros context that exposes enclosing trees (method, class, compilation unit and currently compiled application), the enclosing position of the macro expansion, as well as macros and implicits that are currently in-flight.

Self Type
BlackboxContext
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Enclosures
  2. AnyRef
  3. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class EnclosureException(expected: Class[_], enclosingTrees: List[BlackboxContext.Tree]) extends Exception with Product with Serializable

    Indicates than one of the enclosure methods failed to find a tree of required type among enclosing trees.

  2. abstract type MacroRole

    The semantic role that macroApplication plays in the code.

Abstract Value Members

  1. abstract def APPLY_ROLE: BlackboxContext.MacroRole

    The role that represents an application of a term macro, e.

    The role that represents an application of a term macro, e.g. M(2)(3) in val x = M(2)(3) or M(a, b) in x match { case x @ M(a, b) => }.

  2. abstract def enclosingDef: Universe.DefDef

    Tree that corresponds to the enclosing DefDef tree.

    Tree that corresponds to the enclosing DefDef tree. Throws EnclosureException if there's no such enclosing tree.

  3. abstract def enclosingImpl: Universe.ImplDef

    Tree that corresponds to the enclosing ImplDef tree (i.

    Tree that corresponds to the enclosing ImplDef tree (i.e. either ClassDef or ModuleDef). Throws EnclosureException if there's no such enclosing tree.

  4. abstract def enclosingMacros: List[BlackboxContext]

    Contexts that represent macros in-flight, including the current one.

    Contexts that represent macros in-flight, including the current one. Very much like a stack trace, but for macros only. Can be useful for interoperating with other macros and for imposing compiler-friendly limits on macro expansion.

    Is also priceless for emitting sane error messages for macros that are called by other macros on synthetic (i.e. position-less) trees. In that dire case navigate the enclosingMacros stack, and it will most likely contain at least one macro with a position-ful macro application. See enclosingPosition for a default implementation of this logic.

    Unlike openMacros, this is a val, which means that it gets initialized when the context is created and always stays the same regardless of whatever happens during macro expansion.

  5. abstract def enclosingPackage: Universe.PackageDef

    Tree that corresponds to the enclosing PackageDef tree.

    Tree that corresponds to the enclosing PackageDef tree. Throws EnclosureException if there's no such enclosing tree.

  6. abstract def enclosingPosition: BlackboxContext.Position

    Tries to guess a position for the enclosing application.

    Tries to guess a position for the enclosing application. But that is simple, right? Just dereference pos of macroApplication? Not really. If we're in a synthetic macro expansion (no positions), we must do our best to infer the position of something that triggerd this expansion. Surprisingly, quite often we can do this by navigation the enclosingMacros stack.

  7. abstract def enclosingRun: BlackboxContext.Run

    Compilation run that contains this macro application.

  8. abstract def enclosingTemplate: Universe.Template

    Tree that corresponds to the enclosing Template tree.

    Tree that corresponds to the enclosing Template tree. Throws EnclosureException if there's no such enclosing tree.

  9. abstract def enclosingUnit: BlackboxContext.CompilationUnit

    Compilation unit that contains this macro application.

  10. abstract def macroApplication: BlackboxContext.Tree

    The tree that undergoes macro expansion.

    The tree that undergoes macro expansion. Can be useful to get an offset or a range position of the entire tree being processed.

  11. abstract def macroRole: BlackboxContext.MacroRole

    The semantic role that macroApplication plays in the code.

  12. abstract def enclosingClass: BlackboxContext.Tree

    Tree that corresponds to the enclosing class, or EmptyTree if not applicable.

    Tree that corresponds to the enclosing class, or EmptyTree if not applicable.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.1) Use enclosingImpl instead, but be wary of changes in semantics

  13. abstract def enclosingMethod: BlackboxContext.Tree

    Tree that corresponds to the enclosing method, or EmptyTree if not applicable.

    Tree that corresponds to the enclosing method, or EmptyTree if not applicable.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.1) Use enclosingDef instead, but be wary of changes in semantics

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

    Implicit information
    This member is added by an implicit conversion from Enclosures to ArrowAssoc[Enclosures] performed by method ArrowAssoc 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 clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (Enclosures) ⇒ Boolean, msg: ⇒ Any): Enclosures

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

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

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

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

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

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

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (Enclosures, B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Enclosures to StringAdd[Enclosures]

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

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

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

Ungrouped