scala.reflect.reify

Reifier

abstract class Reifier extends Phases with Errors

Given a tree or a type, generate a tree that when executed at runtime produces the original tree or type. See more info in the comments to reify in scala.reflect.api.Universe.

Source
Reifier.scala
Version

2.10

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Reifier
  2. Errors
  3. Phases
  4. Reify
  5. Util
  6. Positions
  7. AnnotationInfos
  8. Trees
  9. Names
  10. Types
  11. Symbols
  12. Metalevels
  13. Reshape
  14. Calculate
  15. AnyRef
  16. Any
Implicitly
  1. by any2stringfmt
  2. by any2stringadd
  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 Reifier()

Type Members

  1. implicit class RichSymbol extends AnyRef

  2. implicit class RichType extends AnyRef

Abstract Value Members

  1. abstract val concrete: Boolean

  2. abstract val dontSpliceAtTopLevel: Boolean

  3. abstract val mirror: Global

  4. abstract val prefix: Tree

  5. abstract val reifee: Any

  6. abstract val typer: Typer

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

    Implicit information
    This member is added by an implicit conversion from Reifier to ArrowAssoc[Reifier] 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. def CannotReifyConcreteTypeTagHavingUnresolvedTypeParameters(tpe: Type): Nothing

    Definition Classes
    Errors
  9. def CannotReifyErroneousPrefix(prefix: Tree): Nothing

    Definition Classes
    Errors
  10. def CannotReifyErroneousReifee(reifee: Any): Nothing

    Definition Classes
    Errors
  11. def CannotReifyReifeeThatHasTypeLocalToReifee(tree: Tree): Nothing

    Definition Classes
    Errors
  12. def CannotReifySymbol(sym: Symbol): Nothing

    Definition Classes
    Errors
  13. def CannotReifyType(tpe: Type): Nothing

    Definition Classes
    Errors
  14. def CannotReifyUntypedPrefix(prefix: Tree): Nothing

    Definition Classes
    Errors
  15. def CannotReifyUntypedReifee(reifee: Any): Nothing

    Definition Classes
    Errors
  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. val calculate: Traverser { ... /* 2 definitions in type refinement */ }

    Merely traverses the reifiee and records local symbols along with their metalevels.

    Merely traverses the reifiee and records local symbols along with their metalevels.

    Definition Classes
    Calculate
  18. def call(fname: String, args: Tree*): Tree

    Definition Classes
    Util
  19. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  20. def current: Any

    Definition Classes
    Reify
  21. def currentQuantified: List[Symbol]

    Definition Classes
    Reify
  22. def defaultErrorPosition: Position

    Definition Classes
    Errors
  23. def ensuring(cond: (Reifier) ⇒ Boolean, msg: ⇒ Any): Reifier

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

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

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

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

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

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  30. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any
  33. def isAnnotated(tpe: Type): Boolean

    Definition Classes
    Util
  34. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  35. def isTough(tpe: Type): Boolean

    Definition Classes
    Util
  36. var metalevels: Transformer { ... /* 5 definitions in type refinement */ }

    Makes sense of cross-stage bindings.

    Makes sense of cross-stage bindings.

    Analysis of cross-stage bindings becomes convenient if we introduce the notion of metalevels. Metalevel of a tree is a number that gets incremented every time you reify something and gets decremented when you splice something. Metalevel of a symbol is equal to the metalevel of its definition.

    Example 1. Consider the following snippet:

    reify { val x = 2 // metalevel of symbol x is 1, because it's declared inside reify val y = reify{x} // metalevel of symbol y is 1, because it's declared inside reify // metalevel of Ident(x) is 2, because it's inside two reifies y.eval // metalevel of Ident(y) is 0, because it's inside a designator of a splice }

    Cross-stage bindings are introduced when symbol.metalevel != curr_metalevel. Both bindings introduced in Example 1 are cross-stage.

    Depending on what side of the inequality is greater, the following situations might occur:

    1) symbol.metalevel < curr_metalevel. In this case reifier will generate a free variable that captures both the name of the symbol (to be compiled successfully) and its value (to be run successfully). For example, x in Example 1 will be reified as follows: Ident(newFreeVar("x", IntClass.tpe, x))

    2) symbol.metalevel > curr_metalevel. This leads to a metalevel breach that violates intuitive perception of splicing. As defined in macro spec, splicing takes a tree and inserts it into another tree - as simple as that. However, how exactly do we do that in the case of y.eval? In this very scenario we can use dataflow analysis and inline it, but what if y were a var, and what if it were calculated randomly at runtime?

    This question has a genuinely simple answer. Sure, we cannot resolve such splices statically (i.e. during macro expansion of reify), but now we have runtime toolboxes, so noone stops us from picking up that reified tree and evaluating it at runtime (in fact, this is something that Expr.eval and Expr.value do transparently).

    This is akin to early vs late binding dilemma. The prior is faster, plus, the latter (implemented with reflection) might not work because of visibility issues or might be not available on all platforms. But the latter still has its uses, so I'm allowing metalevel breaches, but introducing the -Xlog-runtime-evals to log them.

    As we can see, the only problem is the fact that lhs'es of eval can be code blocks that can capture variables from the outside. Code inside the lhs of an eval is not reified, while the code from the enclosing reify is.

    Hence some bindings become cross-stage, which is not bad per se (in fact, some cross-stage bindings have sane semantics, as in the example above). However this affects freevars, since they are delicate inter-dimensional beings that refer to both current and next planes of existence. When splicing tears the fabric of the reality apart, some freevars have to go single-dimensional to retain their sanity.

    Example 2. Consider the following snippet:

    reify { val x = 2 reify{x}.eval }

    Since the result of the inner reify is wrapped in an eval, it won't be reified together with the other parts of the outer reify, but will be inserted into that result verbatim.

    The inner reify produces an Expr[Int] that wraps Ident(freeVar("x", IntClass.tpe, x)). However the freevar the reification points to will vanish when the compiler processes the outer reify. That's why we need to replace that freevar with a regular symbol that will point to reified x.

    Example 3. Consider the following fragment:

    reify { val x = 2 val y = reify{x} y.eval }

    In this case the inner reify doesn't appear next to eval, so it will be reified together with x. This means that no special processing is needed here.

    Example 4. Consider the following fragment:

    reify { val x = 2 { val y = 2 val z = reify{reify{x + y}} z.eval }.eval }

    The reasoning from Example 2 still holds here - we do need to inline the freevar that refers to x. However, we must not touch anything inside the eval'd block, because it's not getting reified.

    Definition Classes
    Metalevels
  37. def mirrorCall(name: String, args: Tree*): Tree

    Definition Classes
    Util
  38. def mirrorCall(name: TermName, args: Tree*): Tree

    Definition Classes
    Util
  39. def mirrorFactoryCall(prefix: String, args: Tree*): Tree

    Definition Classes
    Util
  40. def mirrorFactoryCall(value: Product, args: Tree*): Tree

    Definition Classes
    Util
  41. def mirrorSelect(name: String): Tree

    Definition Classes
    Util
  42. def mkList(args: List[Tree]): Tree

    Definition Classes
    Util
  43. lazy val mkReificationPipeline: (Tree) ⇒ Tree

    Definition Classes
    Phases
  44. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  47. def origin(sym: Symbol): String

    Definition Classes
    Util
  48. def path(fullname: String, mkName: (String) ⇒ Name): Tree

    An (unreified) path that refers to definition with given fully qualified name

    An (unreified) path that refers to definition with given fully qualified name

    mkName

    Creator for last portion of name (either TermName or TypeName)

    Definition Classes
    Util
  49. def reificationIsConcrete: Boolean

    Definition Classes
    Types
  50. def reificationIsConcrete_=(value: Boolean): Unit

    Definition Classes
    Types
  51. lazy val reified: Tree

    For reifee and other reification parameters, generate a tree of the form

    For reifee and other reification parameters, generate a tree of the form

    { val $mr = <[ prefix ]> $mr.Expr[T](rtree) // if data is a Tree $mr.TypeTag[T](rtree) // if data is a Type }

    where

    • prefix is the tree that represents the universe the result will be bound to
    • rtree is code that generates reifee at runtime.
    • T is the type that corresponds to data.

    This is not a method, but a value to indicate the fact that Reifier instances are a one-off.

  52. object reifiedNodePrinters extends NodePrinters with NodePrinters

  53. val reifiedNodeToString: Reifier.this.reifiedNodePrinters.reifiedNodeToString.type

    Definition Classes
    Util
  54. def reify(reifee: Any): Tree

    Reifies any supported value.

    Reifies any supported value. For internal use only, use reified instead.

    Definition Classes
    Reify
  55. def reifyAnnotationInfo(ann: AnnotationInfo): Tree

    Definition Classes
    AnnotationInfos
  56. val reifyCopypaste: Boolean

    Definition Classes
    Util
  57. val reifyDebug: Boolean

    Definition Classes
    Util
  58. def reifyFreeTerm(sym: Symbol, value: Tree): Tree

    Definition Classes
    Symbols
  59. def reifyFreeType(sym: Symbol, value: Tree): Tree

    Definition Classes
    Symbols
  60. def reifyList(xs: List[Any]): Tree

    Definition Classes
    Util
  61. def reifyMirrorObject(x: Product): Tree

    Definition Classes
    Util
  62. def reifyMirrorObject(name: String): Tree

    Reify a case object defined in Mirror

    Reify a case object defined in Mirror

    Definition Classes
    Util
  63. def reifyModifiers(m: Modifiers): Tree

    Definition Classes
    Trees
  64. def reifyName(name: Name): Tree

    Definition Classes
    Names
  65. def reifyPosition(pos: Position): Tree

    Definition Classes
    Positions
  66. def reifyProduct(prefix: String, elements: List[Any]): Tree

    Definition Classes
    Util
  67. def reifyProduct(x: Product): Tree

    Definition Classes
    Util
  68. def reifySymDef(sym: Symbol): Tree

    Definition Classes
    Symbols
  69. def reifySymRef(sym0: Symbol): Tree

    Reify a reference to a symbol

    Reify a reference to a symbol

    Definition Classes
    Symbols
  70. val reifyTrace: SimpleTracer

    Definition Classes
    Util
  71. def reifyTree(tree: Tree): Tree

    Reify a tree.

    Reify a tree. For internal use only, use reified instead.

    Definition Classes
    Trees
  72. var reifyTreeSymbols: Boolean

    Definition Classes
    Trees
  73. var reifyTreeTypes: Boolean

    Definition Classes
    Trees
  74. def reifyType(tpe0: Type): Tree

    Reify a type.

    Reify a type. For internal use only, use reified instead.

    Definition Classes
    Types
  75. val reshape: Transformer { ... /* 2 definitions in type refinement */ }

    Rolls back certain changes that were introduced during typechecking of the reifee.

    Rolls back certain changes that were introduced during typechecking of the reifee.

    These include: * Replacing type trees with TypeTree(tpe) * Transforming Modifiers.annotations into Symbol.annotations * Transforming Annotated annotations into AnnotatedType annotations * Transforming Annotated(annot, expr) into Typed(expr, TypeTree(Annotated(annot, _)) * Non-idempotencies of the typechecker: https://issues.scala-lang.org/browse/SI-5464

    Definition Classes
    Reshape
  76. def scalaFactoryCall(name: String, args: Tree*): Tree

    Definition Classes
    Util
  77. val self: Any

    Implicit information
    This member is added by an implicit conversion from Reifier to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
  78. val self: Any

    Implicit information
    This member is added by an implicit conversion from Reifier to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  79. def spliceType(tpe: Type): Tree

    Definition Classes
    Types
  80. def symbolTable: List[Tree]

    Definition Classes
    Symbols
  81. def symbolTable_=(newSymbolTable: List[Tree]): Unit

    Definition Classes
    Symbols
  82. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  83. def termPath(fullname: String): Tree

    An (unreified) path that refers to term definition with given fully qualified name

    An (unreified) path that refers to term definition with given fully qualified name

    Definition Classes
    Util
  84. def toString(): String

    Definition Classes
    AnyRef → Any
  85. def typePath(fullname: String): Tree

    An (unreified) path that refers to type definition with given fully qualified name

    An (unreified) path that refers to type definition with given fully qualified name

    Definition Classes
    Util
  86. final def wait(): Unit

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

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

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

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

Deprecated Value Members

  1. def x: Reifier

    Implicit information
    This member is added by an implicit conversion from Reifier to ArrowAssoc[Reifier] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Reifier

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

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Errors

Inherited from Phases

Inherited from Reify

Inherited from Util

Inherited from Positions

Inherited from AnnotationInfos

Inherited from Trees

Inherited from Names

Inherited from Types

Inherited from Symbols

Inherited from Metalevels

Inherited from Reshape

Inherited from Calculate

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringfmt from Reifier to StringFormat

Inherited by implicit conversion any2stringadd from Reifier to StringAdd

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

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