Trait scala.reflect.macros.Universe.MacroInternalApi
trait MacroInternalApi extends InternalApi
Type Members
trait DecoratorApi extends AnyRef
- Definition Classes
- InternalApi
- See also
abstract type Decorators <: MacroDecoratorApi
Syntactic conveniences for additional internal APIs for trees, symbols and types
- Definition Classes
- MacroInternalApi → InternalApi
trait MacroDecoratorApi extends DecoratorApi
Abstract Value Members
abstract def annotatedType(annotations: List[Universe.Annotation], underlying: Universe.Type): Universe.AnnotatedType
A creator for AnnotatedType
types.
- Definition Classes
- InternalApi
abstract def asFreeTerm(symbol: Universe.Symbol): Universe.FreeTermSymbol
This symbol cast to a free term symbol.
- Definition Classes
- InternalApi
- Exceptions thrown
ScalaReflectionException
ifisFreeTerm
is false.
abstract def asFreeType(symbol: Universe.Symbol): Universe.FreeTypeSymbol
This symbol cast to a free type symbol.
- Definition Classes
- InternalApi
- Exceptions thrown
ScalaReflectionException
ifisFreeType
is false.
abstract def attachments(tree: Universe.Tree): Attachments { type Pos = Universe.this.Position }
abstract def attachments(symbol: Universe.Symbol): Attachments { type Pos = Universe.this.Position }
abstract def boundedWildcardType(bounds: Universe.TypeBounds): Universe.BoundedWildcardType
A creator for BoundedWildcardType
types.
- Definition Classes
- InternalApi
abstract def captureVariable(vble: Universe.Symbol): Unit
Mark a variable as captured; i.e. force boxing in a *Ref type.
abstract def capturedVariableType(vble: Universe.Symbol): Universe.Type
abstract def changeOwner(tree: Universe.Tree, prev: Universe.Symbol, next: Universe.Symbol): tree.type
Collects all the symbols defined by subtrees of tree
that are owned by prev
, and then changes their owner to point to next
.
This is an essential tool to battle owner chain corruption when moving trees from one lexical context to another. Whenever you take an attributed tree that has been typechecked under the Context owned by some symbol (let's call it x
) and splice it elsewhere, into the Context owned by another symbol (let's call it y
), it is imperative that you either call untypecheck
or do changeOwner(tree, x, y)
.
Since at the moment untypecheck
has fundamental problem that can sometimes lead to tree corruption, changeOwner
becomes an indispensable tool in building 100% robust macros. Future versions of the reflection API might obviate the need in taking care of these low-level details, but at the moment this is what we've got.
abstract def classDef(sym: Universe.Symbol, impl: Universe.Template): Universe.ClassDef
A factory method for ClassDef
nodes.
- Definition Classes
- InternalApi
abstract def classInfoType(parents: List[Universe.Type], decls: Universe.Scope, typeSymbol: Universe.Symbol): Universe.ClassInfoType
A creator for ClassInfoType
types.
- Definition Classes
- InternalApi
abstract def constantType(value: Universe.Constant): Universe.ConstantType
A creator for ConstantType
types.
- Definition Classes
- InternalApi
abstract def createImporter(from0: api.Universe): Universe.Importer { val from: from0.type }
Creates an importer that moves reflection artifacts between universes.
- Definition Classes
- InternalApi
- See also
abstract def deSkolemize(symbol: Universe.Symbol): Universe.Symbol
If this symbol is a skolem, its corresponding type parameter, otherwise the symbol itself.
To quote Martin Odersky, skolems are synthetic type "constants" that are copies of existentially bound or universally bound type variables. E.g. if one is inside the right-hand side of a method:
def foo[T](x: T) = ... foo[List[T]]....
the skolem named T
refers to the unknown type instance of T
when foo
is called. It needs to be different from the type parameter because in a recursive call as in the foo[List[T]]
above the type parameter gets substituted with List[T]
, but the type skolem stays what it is.
The other form of skolem is an existential skolem. Say one has a function
def bar(xs: List[T] forSome { type T }) = xs.head
then each occurrence of xs
on the right will have type List[T']
where T'
is a fresh copy of T
.
- Definition Classes
- InternalApi
abstract val decorators: Decorators
- Definition Classes
- InternalApi
- See also
abstract def defDef(sym: Universe.Symbol, rhs: (List[List[Universe.Symbol]]) ⇒ Universe.Tree): Universe.DefDef
A factory method for DefDef
nodes.
- Definition Classes
- InternalApi
abstract def defDef(sym: Universe.Symbol, rhs: Universe.Tree): Universe.DefDef
A factory method for DefDef
nodes.
- Definition Classes
- InternalApi
abstract def defDef(sym: Universe.Symbol, mods: Universe.Modifiers, rhs: Universe.Tree): Universe.DefDef
A factory method for DefDef
nodes.
- Definition Classes
- InternalApi
abstract def defDef(sym: Universe.Symbol, vparamss: List[List[Universe.ValDef]], rhs: Universe.Tree): Universe.DefDef
A factory method for DefDef
nodes.
- Definition Classes
- InternalApi
abstract def defDef(sym: Universe.Symbol, mods: Universe.Modifiers, vparamss: List[List[Universe.ValDef]], rhs: Universe.Tree): Universe.DefDef
A factory method for DefDef
nodes.
- Definition Classes
- InternalApi
abstract def defineType(tree: Universe.Tree, tp: Universe.Type): tree.type
Like setType
, but if this is a previously empty TypeTree that fact is remembered so that untypecheck
will snap back.
\@PP: Attempting to elaborate on the above, I find: If defineType is called on a TypeTree whose type field is null or NoType, this is recorded as "wasEmpty = true". That value is used in ResetAttrsTraverser, which nulls out the type field of TypeTrees for which wasEmpty is true, leaving the others alone.
untypecheck
(or resetAttrs
in compiler parlance) is used in situations where some speculative typing of a tree takes place, fails, and the tree needs to be returned to its former state to try again. So according to me: using defineType
instead of setType
is how you communicate that the type being set does not depend on any previous state, and therefore should be abandoned if the current line of type inquiry doesn't work out.
abstract def enter(scope: Universe.Scope, sym: Universe.Symbol): scope.type
abstract def existentialAbstraction(tparams: List[Universe.Symbol], tpe0: Universe.Type): Universe.Type
A creator for existential types. This generates:
tpe1 where { tparams }
where tpe1
is the result of extrapolating tpe
with regard to tparams
. Extrapolating means that type variables in tparams
occurring in covariant positions are replaced by upper bounds, (minus any SingletonClass markers), type variables in tparams
occurring in contravariant positions are replaced by upper bounds, provided the resulting type is legal with regard to stability, and does not contain any type variable in tparams
.
The abstraction drops all type parameters that are not directly or indirectly referenced by type tpe1
. If there are no remaining type parameters, simply returns result type tpe
.
- Definition Classes
- InternalApi
abstract def existentialType(quantified: List[Universe.Symbol], underlying: Universe.Type): Universe.ExistentialType
A creator for ExistentialType
types.
- Definition Classes
- InternalApi
abstract def flags(symbol: Universe.Symbol): Universe.FlagSet
Returns internal flags associated with the symbol.
- Definition Classes
- InternalApi
abstract def freeTerms(tree: Universe.Tree): List[Universe.FreeTermSymbol]
Extracts free term symbols from a tree that is reified or contains reified subtrees.
- Definition Classes
- InternalApi
abstract def freeTypes(tree: Universe.Tree): List[Universe.FreeTypeSymbol]
Extracts free type symbols from a tree that is reified or contains reified subtrees.
- Definition Classes
- InternalApi
abstract def fullyInitialize(scope: Universe.Scope): scope.type
Calls initialize on all the symbols that the scope consists of.
- Definition Classes
- InternalApi
abstract def fullyInitialize(tp: Universe.Type): tp.type
Calls initialize on all the value and type parameters of the type.
- Definition Classes
- InternalApi
abstract def fullyInitialize(symbol: Universe.Symbol): symbol.type
Calls initialize on the owner and all the value and type parameters of the symbol.
- Definition Classes
- InternalApi
abstract val gen: TreeGen
abstract def initialize(symbol: Universe.Symbol): symbol.type
Forces all outstanding completers associated with this symbol. After this call returns, the symbol becomes immutable and thread-safe.
- Definition Classes
- InternalApi
abstract def intersectionType(tps: List[Universe.Type], owner: Universe.Symbol): Universe.Type
A creator for intersection type where intersections of a single type are replaced by the type itself, and repeated parent classes are merged.
!!! Repeated parent classes are not merged - is this a bug in the comment or in the code?
- Definition Classes
- InternalApi
abstract def intersectionType(tps: List[Universe.Type]): Universe.Type
A creator for intersection type where intersections of a single type are replaced by the type itself.
- Definition Classes
- InternalApi
abstract def isErroneous(symbol: Universe.Symbol): Boolean
Does this symbol or its underlying type represent a typechecking error?
- Definition Classes
- InternalApi
abstract def isFreeTerm(symbol: Universe.Symbol): Boolean
Does this symbol represent a free term captured by reification? If yes, isTerm
is also guaranteed to be true.
- Definition Classes
- InternalApi
abstract def isFreeType(symbol: Universe.Symbol): Boolean
Does this symbol represent a free type captured by reification? If yes, isType
is also guaranteed to be true.
- Definition Classes
- InternalApi
abstract def isSkolem(symbol: Universe.Symbol): Boolean
Does this symbol represent the definition of a skolem? Skolems are used during typechecking to represent type parameters viewed from inside their scopes.
- Definition Classes
- InternalApi
abstract def labelDef(sym: Universe.Symbol, params: List[Universe.Symbol], rhs: Universe.Tree): Universe.LabelDef
A factory method for LabelDef
nodes.
- Definition Classes
- InternalApi
abstract def methodType(params: List[Universe.Symbol], resultType: Universe.Type): Universe.MethodType
A creator for MethodType
types.
- Definition Classes
- InternalApi
abstract def moduleDef(sym: Universe.Symbol, impl: Universe.Template): Universe.ModuleDef
A factory method for ModuleDef
nodes.
- Definition Classes
- InternalApi
abstract def newClassSymbol(owner: Universe.Symbol, name: Universe.TypeName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.ClassSymbol
- Definition Classes
- InternalApi
abstract def newFreeTerm(name: String, value: ⇒ Any, flags: Universe.FlagSet = NoFlags, origin: String = null): Universe.FreeTermSymbol
- Definition Classes
- InternalApi
abstract def newFreeType(name: String, flags: Universe.FlagSet = NoFlags, origin: String = null): Universe.FreeTypeSymbol
- Definition Classes
- InternalApi
abstract def newMethodSymbol(owner: Universe.Symbol, name: Universe.TermName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.MethodSymbol
- Definition Classes
- InternalApi
abstract def newModuleAndClassSymbol(owner: Universe.Symbol, name: Universe.Name, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): (Universe.ModuleSymbol, Universe.ClassSymbol)
- Definition Classes
- InternalApi
abstract def newScopeWith(elems: Universe.Symbol*): Universe.Scope
Create a new scope with the given initial elements.
- Definition Classes
- InternalApi
abstract def newTermSymbol(owner: Universe.Symbol, name: Universe.TermName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.TermSymbol
- Definition Classes
- InternalApi
abstract def newTypeSymbol(owner: Universe.Symbol, name: Universe.TypeName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.TypeSymbol
- Definition Classes
- InternalApi
abstract def nullaryMethodType(resultType: Universe.Type): Universe.NullaryMethodType
A creator for NullaryMethodType
types.
- Definition Classes
- InternalApi
abstract def polyType(tparams: List[Universe.Symbol], tpe: Universe.Type): Universe.PolyType
A creator for type parameterizations that strips empty type parameter lists. Use this factory method to indicate the type has kind * (it's a polymorphic value) until we start tracking explicit kinds equivalent to typeFun (except that the latter requires tparams nonEmpty).
- Definition Classes
- InternalApi
abstract def referenceCapturedVariable(vble: Universe.Symbol): Universe.Tree
abstract def refinedType(parents: List[Universe.Type], owner: Universe.Symbol, decls: Universe.Scope, pos: Universe.Position): Universe.Type
A creator for RefinedType
types.
- Definition Classes
- InternalApi
abstract def refinedType(parents: List[Universe.Type], owner: Universe.Symbol, decls: Universe.Scope): Universe.Type
A creator for RefinedType
types.
- Definition Classes
- InternalApi
abstract def refinedType(parents: List[Universe.Type], owner: Universe.Symbol): Universe.Type
A creator for RefinedType
types.
- Definition Classes
- InternalApi
abstract def refinedType(parents: List[Universe.Type], decls: Universe.Scope, clazz: Universe.Symbol): Universe.RefinedType
A creator for RefinedType
types.
- Definition Classes
- InternalApi
abstract def refinedType(parents: List[Universe.Type], decls: Universe.Scope): Universe.RefinedType
A creator for RefinedType
types.
- Definition Classes
- InternalApi
abstract val reificationSupport: Universe.ReificationSupportApi
This is an internal implementation module.
- Definition Classes
- InternalApi
abstract def removeAttachment[T](tree: Universe.Tree)(implicit arg0: ClassTag[T]): tree.type
Update the attachment with the payload of the given class type T
removed. Returns the tree itself.
abstract def removeAttachment[T](symbol: Universe.Symbol)(implicit arg0: ClassTag[T]): symbol.type
Update the attachment with the payload of the given class type T
removed. Returns the symbol itself.
abstract def resetFlag(symbol: Universe.Symbol, flags: Universe.FlagSet): symbol.type
abstract def setAnnotations(symbol: Universe.Symbol, annots: Universe.Annotation*): symbol.type
abstract def setFlag(symbol: Universe.Symbol, flags: Universe.FlagSet): symbol.type
abstract def setInfo(symbol: Universe.Symbol, tpe: Universe.Type): symbol.type
abstract def setName(symbol: Universe.Symbol, name: Universe.Name): symbol.type
abstract def setOriginal(tt: Universe.TypeTree, original: Universe.Tree): Universe.TypeTree
abstract def setOwner(symbol: Universe.Symbol, newowner: Universe.Symbol): symbol.type
abstract def setPos(tree: Universe.Tree, newpos: Universe.Position): tree.type
Sets the pos
of the tree. Returns the tree itself.
abstract def setPrivateWithin(symbol: Universe.Symbol, sym: Universe.Symbol): symbol.type
abstract def setSymbol(tree: Universe.Tree, sym: Universe.Symbol): tree.type
Sets the symbol
of the tree. Returns the tree itself.
abstract def setType(tree: Universe.Tree, tp: Universe.Type): tree.type
Sets the tpe
of the tree. Returns the tree itself.
abstract def singleType(pre: Universe.Type, sym: Universe.Symbol): Universe.Type
A creator for SingleType
types.
- Definition Classes
- InternalApi
abstract def subpatterns(tree: Universe.Tree): Option[List[Universe.Tree]]
Retrieves the untyped list of subpatterns attached to selector dummy of an UnApply node. Useful in writing quasiquoting macros that do pattern matching.
abstract def substituteSymbols(tree: Universe.Tree, from: List[Universe.Symbol], to: List[Universe.Symbol]): Universe.Tree
Substitute symbols in to
for corresponding occurrences of references to symbols from
in this type.
- Definition Classes
- InternalApi
abstract def substituteThis(tree: Universe.Tree, clazz: Universe.Symbol, to: ⇒ Universe.Tree): Universe.Tree
Substitute given tree to
for occurrences of nodes that represent C.this
, where C
refers to the given class clazz
.
- Definition Classes
- InternalApi
abstract def substituteTypes(tree: Universe.Tree, from: List[Universe.Symbol], to: List[Universe.Type]): Universe.Tree
Substitute types in to
for corresponding occurrences of references to symbols from
in this tree.
- Definition Classes
- InternalApi
abstract def superType(thistpe: Universe.Type, supertpe: Universe.Type): Universe.Type
A creator for SuperType
types.
- Definition Classes
- InternalApi
abstract def thisType(sym: Universe.Symbol): Universe.Type
A creator for ThisType
types.
- Definition Classes
- InternalApi
abstract def typeBounds(lo: Universe.Type, hi: Universe.Type): Universe.TypeBounds
A creator for TypeBounds
types.
- Definition Classes
- InternalApi
abstract def typeDef(sym: Universe.Symbol): Universe.TypeDef
A factory method for TypeDef
nodes.
- Definition Classes
- InternalApi
abstract def typeDef(sym: Universe.Symbol, rhs: Universe.Tree): Universe.TypeDef
A factory method for TypeDef
nodes.
- Definition Classes
- InternalApi
abstract def typeRef(pre: Universe.Type, sym: Universe.Symbol, args: List[Universe.Type]): Universe.Type
A creator for TypeRef
types.
- Definition Classes
- InternalApi
abstract def unlink(scope: Universe.Scope, sym: Universe.Symbol): scope.type
abstract def updateAttachment[T](tree: Universe.Tree, attachment: T)(implicit arg0: ClassTag[T]): tree.type
Updates the attachment with the payload slot of T added/updated with the provided value. Replaces an existing payload of the same type, if exists. Returns the tree itself.
abstract def updateAttachment[T](symbol: Universe.Symbol, attachment: T)(implicit arg0: ClassTag[T]): symbol.type
Updates the attachment with the payload slot of T added/updated with the provided value. Replaces an existing payload of the same type, if exists. Returns the symbol itself.
abstract def valDef(sym: Universe.Symbol): Universe.ValDef
A factory method for ValDef
nodes.
- Definition Classes
- InternalApi
abstract def valDef(sym: Universe.Symbol, rhs: Universe.Tree): Universe.ValDef
A factory method for ValDef
nodes.
- Definition Classes
- InternalApi
Concrete Value Members
final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
final def ##(): Int
- Definition Classes
- AnyRef → Any
def +(other: String): String
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to any2stringadd[MacroInternalApi] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
def ->[B](y: B): (MacroInternalApi, B)
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to ArrowAssoc[MacroInternalApi] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
final def asInstanceOf[T0]: T0
- Definition Classes
- Any
def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
def ensuring(cond: (MacroInternalApi) ⇒ Boolean, msg: ⇒ Any): MacroInternalApi
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to Ensuring[MacroInternalApi] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (MacroInternalApi) ⇒ Boolean): MacroInternalApi
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to Ensuring[MacroInternalApi] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): MacroInternalApi
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to Ensuring[MacroInternalApi] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): MacroInternalApi
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to Ensuring[MacroInternalApi] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
def equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to StringFormat[MacroInternalApi] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
final def getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
def manifestToTypeTag[T](mirror: Any, manifest: Manifest[T]): api.Universe.TypeTag[T]
Convert a scala.reflect.Manifest to a scala.reflect.api.TypeTags#TypeTag.
Compiler usually generates these conversions automatically, when a manifest for a type T
is in scope, and an implicit of type TypeTag[T]
is requested, but this method can also be called manually. For example:
manifestToTypeTag(scala.reflect.runtime.currentMirror, implicitly[Manifest[String]])
- Definition Classes
- InternalApi
final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
def toString(): String
- Definition Classes
- AnyRef → Any
def typeTagToManifest[T](mirror: Any, tag: api.Universe.TypeTag[T])(implicit arg0: ClassTag[T]): Manifest[T]
Convert a scala.reflect.api.TypeTags#TypeTag to a scala.reflect.Manifest.
Compiler usually generates these conversions automatically, when a type tag for a type T
is in scope, and an implicit of type Manifest[T]
is requested, but this method can also be called manually. For example:
typeTagToManifest(scala.reflect.runtime.currentMirror, implicitly[TypeTag[String]])
- Definition Classes
- InternalApi
final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
def →[B](y: B): (MacroInternalApi, B)
- Implicit
- This member is added by an implicit conversion from MacroInternalApi to ArrowAssoc[MacroInternalApi] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala-reflect/scala/reflect/macros/Universe$MacroInternalApi.html
<invalid inheritdoc annotation>