scala.tools.nsc.typechecker.AnalyzerPlugins
MacroPlugin
Related Doc:
package AnalyzerPlugins
Test two objects for inequality.
Test two objects for inequality.
true if !(this == that), false otherwise.
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.
a hash value consistent with ==
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).
true if the receiver object is equivalent to the argument; false otherwise.
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.
the receiver object.
ClassCastException if the receiver object is not an instance of the erasure of type T0.
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
not specified by SLS as a member of AnyRef
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:
x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.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).
true if the argument is a reference to the receiver object; false otherwise.
The equality method for reference types.
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.
not specified by SLS as a member of AnyRef
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.
a representation that corresponds to the dynamic class of the receiver object.
not specified by SLS as a member of AnyRef
The hashCode method for reference types.
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
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.
true if the receiver object is an instance of erasure of type T0; false otherwise.
Equivalent to !(this eq that).
Equivalent to !(this eq that).
true if the argument is not a reference to the receiver object; false otherwise.
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.
not specified by SLS as a member of AnyRef
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.
not specified by SLS as a member of AnyRef
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..
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.
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
of enterSym 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..
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..
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 a scala.reflect.macros.contexts.Context,
gathers type and value arguments of the macro application and throws them together into MacroArgs.
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..
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 the expandee
needs to be expanded right away or its expansion has to be delayed until all undetermined
parameters are inferred, then loads the macro implementation using self.pluginsMacroRuntime,
prepares the invocation arguments for the macro implementation using self.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 for pluginsMacroRuntime.
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..
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..
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..
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.
a String representation of the object.