trait MacroPlugin extends AnyRef
- Alphabetic
- By Inheritance
- MacroPlugin
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 (AnalyzerPlugins.this)#MacroPlugin toany2stringadd[(AnalyzerPlugins.this)#MacroPlugin] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): ((AnalyzerPlugins.this)#MacroPlugin, B)
- Implicit
- This member is added by an implicit conversion from (AnalyzerPlugins.this)#MacroPlugin toArrowAssoc[(AnalyzerPlugins.this)#MacroPlugin] 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(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: ((AnalyzerPlugins.this)#MacroPlugin) => Boolean, msg: => Any): (AnalyzerPlugins.this)#MacroPlugin
- Implicit
- This member is added by an implicit conversion from (AnalyzerPlugins.this)#MacroPlugin toEnsuring[(AnalyzerPlugins.this)#MacroPlugin] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: ((AnalyzerPlugins.this)#MacroPlugin) => Boolean): (AnalyzerPlugins.this)#MacroPlugin
- Implicit
- This member is added by an implicit conversion from (AnalyzerPlugins.this)#MacroPlugin toEnsuring[(AnalyzerPlugins.this)#MacroPlugin] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): (AnalyzerPlugins.this)#MacroPlugin
- Implicit
- This member is added by an implicit conversion from (AnalyzerPlugins.this)#MacroPlugin toEnsuring[(AnalyzerPlugins.this)#MacroPlugin] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): (AnalyzerPlugins.this)#MacroPlugin
- Implicit
- This member is added by an implicit conversion from (AnalyzerPlugins.this)#MacroPlugin toEnsuring[(AnalyzerPlugins.this)#MacroPlugin] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isActive(): Boolean
Selectively activate this analyzer plugin, e.g.
Selectively activate this analyzer plugin, e.g. according to the compiler phase.
Note that the current phase can differ from the global compiler phase (look for
enteringPhase
invocations in the compiler). For instance, lazy types created by the UnPickler are completed at the phase in which their symbol is created. Observations show that this can even be the parser phase. Since symbol completion can trigger subtyping, typing etc, your plugin might need to be active also in phases other than namer and typer.Typically, this method can be implemented as
global.phase.id < global.currentRun.picklerPhase.id
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- def pluginsEnsureCompanionObject(namer: (AnalyzerPlugins.this)#Namer, cdef: Global.ClassDef, creator: (Global.ClassDef) => Global.Tree = companionModuleDef(_)): Option[Global.Symbol]
Makes sure that for the given class definition, there exists a companion object definition.
Makes sure that for the given class definition, there exists a companion object definition.
Default implementation provided in
namer.standardEnsureCompanionObject
looks up a companion symbol for the class definition and then checks whether the resulting symbol exists or not. If it exists, then nothing else is done. If not, a synthetic object definition is created using the provided factory, which is then entered into namer's scope.Returns
None
if the plugin doesn't want to customize the default behavior or something else if the plugin knows better that the implementation provided in scala-compiler.jar. If multiple plugins return a non-empty result, it's going to be a compilation error.. - def pluginsEnterStats(typer: (AnalyzerPlugins.this)#Typer, stats: List[Global.Tree]): List[Global.Tree]
Prepares a list of statements for being typechecked by performing domain-specific type-agnostic code synthesis.
Prepares a list of statements for being typechecked by performing domain-specific type-agnostic code synthesis.
Trees passed into this method are going to be named, but not typed. In particular, you can rely on the compiler having called
enterSym
on every stat prior to passing calling this method.Default implementation does nothing. Current approaches to code syntheses (generation of underlying fields for getters/setters, creation of companion objects for case classes, etc) are too disparate and ad-hoc to be treated uniformly, so I'm leaving this for future work.
- def pluginsEnterSym(namer: (AnalyzerPlugins.this)#Namer, tree: Global.Tree): Boolean
Creates a symbol for the given tree in lexical context encapsulated by the given namer.
Creates a symbol for the given tree in lexical context encapsulated by the given namer.
Default implementation provided in
namer.standardEnterSym
handles MemberDef's and Imports, doing nothing for other trees (DocDef's are seen through and rewrapped). Typical implementation ofenterSym
for a particular tree flavor creates a corresponding symbol, assigns it to the tree, enters the symbol into scope and then might even perform some code generation.Returns
None
if the plugin doesn't want to customize the default behavior or something else if the plugin knows better that the implementation provided in scala-compiler.jar. If multiple plugins return a non-empty result, it's going to be a compilation error.. - def pluginsIsBlackbox(macroDef: Global.Symbol): Option[Boolean]
Figures out whether the given macro definition is blackbox or whitebox.
Figures out whether the given macro definition is blackbox or whitebox.
Default implementation provided in
self.standardIsBlackbox
loads the macro impl binding and fetches boxity from the "isBlackbox" field of the macro signature.Returns
None
if the plugin doesn't want to customize the default behavior or something else if the plugin knows better that the implementation provided in scala-compiler.jar. If multiple plugins return a non-empty result, it's going to be a compilation error.. - def pluginsMacroArgs(typer: (AnalyzerPlugins.this)#Typer, expandee: Global.Tree): Option[(AnalyzerPlugins.this)#MacroArgs]
Computes the arguments that need to be passed to the macro impl corresponding to a particular expandee.
Computes the arguments that need to be passed to the macro impl corresponding to a particular expandee.
Default implementation provided in
self.standardMacroArgs
instantiates ascala.reflect.macros.contexts.Context
, gathers type and value arguments of the macro application and throws them together intoMacroArgs
.Returns
None
if the plugin doesn't want to customize the default behavior or something else if the plugin knows better that the implementation provided in scala-compiler.jar. If multiple plugins return a non-empty result, it's going to be a compilation error.. - def pluginsMacroExpand(typer: (AnalyzerPlugins.this)#Typer, expandee: Global.Tree, mode: Mode, pt: Global.Type): Option[Global.Tree]
Expands an application of a def macro (i.e.
Expands an application of a def macro (i.e. of a symbol that has the MACRO flag set), possibly using the current typer mode and the provided prototype.
Default implementation provided in
self.standardMacroExpand
figures out whether theexpandee
needs to be expanded right away or its expansion has to be delayed until all undetermined parameters are inferred, then loads the macro implementation usingself.pluginsMacroRuntime
, prepares the invocation arguments for the macro implementation usingself.pluginsMacroArgs
, and finally calls into the macro implementation. After the call returns, it typechecks the expansion and performs some bookkeeping.This method is typically implemented if your plugin requires significant changes to the macro engine. If you only need to customize the macro context, consider implementing
pluginsMacroArgs
. If you only need to customize how macro implementation are invoked, consider going forpluginsMacroRuntime
.Returns
None
if the plugin doesn't want to customize the default behavior or something else if the plugin knows better that the implementation provided in scala-compiler.jar. If multiple plugins return a non-empty result, it's going to be a compilation error.. - def pluginsMacroRuntime(expandee: Global.Tree): Option[(AnalyzerPlugins.this)#MacroRuntime]
Summons a function that encapsulates macro implementation invocations for a particular expandee.
Summons a function that encapsulates macro implementation invocations for a particular expandee.
Default implementation provided in
self.standardMacroRuntime
returns a function that loads the macro implementation binding from the macro definition symbol, then uses either Java or Scala reflection to acquire the method that corresponds to the impl, and then reflectively calls into that method.Returns
None
if the plugin doesn't want to customize the default behavior or something else if the plugin knows better that the implementation provided in scala-compiler.jar. If multiple plugins return a non-empty result, it's going to be a compilation error.. - def pluginsTypedMacroBody(typer: (AnalyzerPlugins.this)#Typer, ddef: Global.DefDef): Option[Global.Tree]
Typechecks the right-hand side of a macro definition (which typically features a mere reference to a macro implementation).
Typechecks the right-hand side of a macro definition (which typically features a mere reference to a macro implementation).
Default implementation provided in
self.standardTypedMacroBody
makes sure that the rhs resolves to a reference to a method in either a static object or a macro bundle, verifies that the referred method is compatible with the macro def and upon success attaches a macro impl binding to the macro def's symbol.Returns
None
if the plugin doesn't want to customize the default behavior or something else if the plugin knows better that the implementation provided in scala-compiler.jar. If multiple plugins return a non-empty result, it's going to be a compilation error.. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from (AnalyzerPlugins.this)#MacroPlugin toStringFormat[(AnalyzerPlugins.this)#MacroPlugin] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): ((AnalyzerPlugins.this)#MacroPlugin, B)
- Implicit
- This member is added by an implicit conversion from (AnalyzerPlugins.this)#MacroPlugin toArrowAssoc[(AnalyzerPlugins.this)#MacroPlugin] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
The Scala compiler and reflection APIs.