MacroAnnotationHandler

Instance Constructors

new MacroAnnotationHandler()

Type Members

case class ClassParts(name: scala.reflect.macros.Universe.TypeName, tparams: Seq[scala.reflect.macros.Universe.Tree], params: Seq[scala.reflect.macros.Universe.Tree], parents: Seq[scala.reflect.macros.Universe.Tree], self: scala.reflect.macros.Universe.Tree, body: Seq[scala.reflect.macros.Universe.Tree], fullName: String, modifiers: scala.reflect.macros.Universe.Modifiers, ctorMods: scala.reflect.macros.Universe.Modifiers, companion: Option[ObjectParts] = None) extends TypeParts with Product with Serializable

Definition Classes
WhiteboxMacroTools
sealed trait CommonParts extends AnyRef

Definition Classes
WhiteboxMacroTools
type Data = Map[String, Any]
case class ObjectParts(name: scala.reflect.macros.Universe.TermName, modifiers: scala.reflect.macros.Universe.Modifiers, parents: Seq[scala.reflect.macros.Universe.Tree], body: Seq[scala.reflect.macros.Universe.Tree], fullName: String, isCompanion: Boolean = false) extends CommonParts with Product with Serializable

Definition Classes
WhiteboxMacroTools
case class TraitParts(name: scala.reflect.macros.Universe.TypeName, tparams: Seq[scala.reflect.macros.Universe.Tree], params: Seq[scala.reflect.macros.Universe.Tree], parents: Seq[scala.reflect.macros.Universe.Tree], self: scala.reflect.macros.Universe.Tree, body: Seq[scala.reflect.macros.Universe.Tree], fullName: String, modifiers: scala.reflect.macros.Universe.Modifiers, companion: Option[ObjectParts] = None) extends TypeParts with Product with Serializable

Definition Classes
WhiteboxMacroTools
sealed trait TypeParts extends CommonParts

Definition Classes
WhiteboxMacroTools
type UniverseProvider = AnyRef { val universe: scala.reflect.macros.Universe }

Definition Classes
CommonMacroTools

Abstract Value Members

abstract def annotationName: String
abstract val c: Context

Definition Classes
WhiteboxMacroTools → CommonMacroTools
abstract def createCompanion: Boolean
abstract def supportsClasses: Boolean
abstract def supportsObjects: Boolean
abstract def supportsTraits: Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def error(msg: String): Unit

Attributes
protected[this]
Definition Classes
CommonMacroTools
def extractAnnotationParameters(symbol: scala.reflect.macros.Universe.Symbol, annotation: String, paramNames: Seq[String]): Option[Map[String, Option[scala.reflect.macros.Universe.Tree]]]

Checks if the provided symbol is annotated with the specified type and returns the trees for all arguments of this annotation.
Checks if the provided symbol is annotated with the specified type and returns the trees for all arguments of this annotation.
symbol
Symbol to be checked for the annotation
annotation
fully qualified name of the annotation
paramNames
list with all allowed parameter names of the annotation (in the correct order)

Attributes
protected[this]
Definition Classes
CommonMacroTools
def extractAnnotationParameters(annotation: scala.reflect.macros.Universe.Tree, paramNames: Seq[String]): Map[String, Option[scala.reflect.macros.Universe.Tree]]

Takes a tree representing an annotation value and a list with the names of all valid parameter names for this annotation (in the correct order), and returns a map containing the tree for each specified parameter, or None for unspecified parameters.
Takes a tree representing an annotation value and a list with the names of all valid parameter names for this annotation (in the correct order), and returns a map containing the tree for each specified parameter, or None for unspecified parameters.
annotation
complete annotation tree
paramNames
list with all allowed parameter names (in the correct order)

Attributes
protected[this]
Definition Classes
CommonMacroTools
def extractObjectParts(moduleDef: scala.reflect.macros.Universe.ModuleDef): ObjectParts

Definition Classes
WhiteboxMacroTools
def extractStringConstant(arg: scala.reflect.macros.Universe.Tree): Option[String]

Attributes
protected[this]
Definition Classes
CommonMacroTools
def extractTypeParts(classDef: scala.reflect.macros.Universe.ClassDef): TypeParts

Extracts the name, constructor parameters, parent types (extends), and the body of the specified class declaration.
Extracts the name, constructor parameters, parent types (extends), and the body of the specified class declaration.

Definition Classes
WhiteboxMacroTools
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def findAnnotation(annotations: Seq[scala.reflect.macros.Universe.Tree], annotation: String): Option[scala.reflect.macros.Universe.Tree]

Attributes
protected[this]
Definition Classes
CommonMacroTools
def findAnnotation(symbol: scala.reflect.macros.Universe.Symbol, annotation: String): Option[scala.reflect.macros.Universe.Tree]

Returns the tree for the first annotation of the specified type found on the symbol, or None.
Returns the tree for the first annotation of the specified type found on the symbol, or None.
symbol
Symbol to be searched for the specified annotation type
annotation
Fully qualified name of the annotation type

Attributes
protected[this]
Definition Classes
CommonMacroTools
def findAnnotations(annotations: Seq[scala.reflect.macros.Universe.Tree]): Seq[(String, scala.reflect.macros.Universe.Tree)]

Attributes
protected[this]
Definition Classes
CommonMacroTools
def findAnnotations(symbol: scala.reflect.macros.Universe.Symbol): Seq[(String, scala.reflect.macros.Universe.Tree)]

Returns a list of tuples containing all annotations found on the specified symbol.
Returns a list of tuples containing all annotations found on the specified symbol. The first element of each tuple is the fully qualified annotation name, the second element represents the annotation tree.
symbol
type symbol to be parsed for annotations

Attributes
protected[this]
Definition Classes
CommonMacroTools
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getDebugConfig(modifiers: scala.reflect.macros.Universe.Modifiers): DebugConfig

Returns the debug configuration from the provided modifiers
Returns the debug configuration from the provided modifiers

Definition Classes
CommonMacroTools
def getEnclosingNamespace(): Option[String]

Returns the full path name of the enclosing package (at the current position), or None, if there is no enclosing package.
Returns the full path name of the enclosing package (at the current position), or None, if there is no enclosing package.

Attributes
protected[this]
Definition Classes
CommonMacroTools
def getQualifiedTypeName(tree: scala.reflect.macros.Universe.Tree): String

Takes a tree and returns the fully qualified name of its type.
Takes a tree and returns the fully qualified name of its type.

Attributes
protected[this]
Definition Classes
CommonMacroTools
def hashCode(): Int

Definition Classes
AnyRef → Any
def impl(annottees: scala.reflect.macros.whitebox.Context.Expr[Any]*): scala.reflect.macros.whitebox.Context.Expr[Any]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isSet(flag: String): Boolean

Returns true if the specified macro-setting is defined as an option to scalac
Returns true if the specified macro-setting is defined as an option to scalac

Attributes
protected[this]
Definition Classes
CommonMacroTools
def modifiedAnnotations(parts: CommonParts, data: Data): (List[scala.reflect.macros.Universe.Tree], Data)
def modifiedBody(parts: CommonParts, data: Data): (Iterable[scala.reflect.macros.Universe.Tree], Data)
def modifiedClassDef(classParts: ClassParts, data: Data): (scala.reflect.macros.Universe.Tree, Data)

Override this to modify the class declaration entirely with your own code.
def modifiedFlags(parts: CommonParts, data: Data): (scala.reflect.macros.Universe.FlagSet, Data)
def modifiedModifiers(parts: CommonParts, data: Data): (scala.reflect.macros.Universe.Modifiers, Data)
def modifiedObjectDef(objectParts: ObjectParts, data: Data): (scala.reflect.macros.Universe.Tree, Data)
def modifiedParents(parts: CommonParts, data: Data): (Seq[scala.reflect.macros.Universe.Tree], Data)
def modifiedTraitDef(traitParts: TraitParts, data: Data): (scala.reflect.macros.Universe.Tree, Data)
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def normalizeParents(parents: Seq[scala.reflect.macros.Universe.Tree]): Seq[scala.reflect.macros.Universe.Tree]
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def paramNames(params: Iterable[scala.reflect.macros.Universe.Tree]): Iterable[scala.reflect.macros.Universe.TermName]

Takes a sequence of parameter definition trees and returns the corresponding parameter names.
Takes a sequence of parameter definition trees and returns the corresponding parameter names.

Attributes
protected[this]
Definition Classes
CommonMacroTools
def printTree(tree: scala.reflect.macros.Universe.Tree): Unit

Attributes
protected[this]
Definition Classes
CommonMacroTools
def setting(flag: String, default: String): String

Attributes
protected[this]
Definition Classes
CommonMacroTools
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package smacrotools

abstract class MacroAnnotationHandler extends WhiteboxMacroTools

Instance Constructors

new MacroAnnotationHandler()

Type Members

sealed trait CommonParts extends AnyRef

type Data = Map[String, Any]

sealed trait TypeParts extends CommonParts

type UniverseProvider = AnyRef { val universe: scala.reflect.macros.Universe }

Abstract Value Members

abstract def annotationName: String

abstract val c: Context

abstract def createCompanion: Boolean

abstract def supportsClasses: Boolean

abstract def supportsObjects: Boolean

abstract def supportsTraits: Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(msg: String): Unit

def extractAnnotationParameters(symbol: scala.reflect.macros.Universe.Symbol, annotation: String, paramNames: Seq[String]): Option[Map[String, Option[scala.reflect.macros.Universe.Tree]]]

def extractAnnotationParameters(annotation: scala.reflect.macros.Universe.Tree, paramNames: Seq[String]): Map[String, Option[scala.reflect.macros.Universe.Tree]]

def extractObjectParts(moduleDef: scala.reflect.macros.Universe.ModuleDef): ObjectParts

def extractStringConstant(arg: scala.reflect.macros.Universe.Tree): Option[String]

def extractTypeParts(classDef: scala.reflect.macros.Universe.ClassDef): TypeParts

def finalize(): Unit

def findAnnotation(annotations: Seq[scala.reflect.macros.Universe.Tree], annotation: String): Option[scala.reflect.macros.Universe.Tree]

def findAnnotation(symbol: scala.reflect.macros.Universe.Symbol, annotation: String): Option[scala.reflect.macros.Universe.Tree]

def findAnnotations(annotations: Seq[scala.reflect.macros.Universe.Tree]): Seq[(String, scala.reflect.macros.Universe.Tree)]

def findAnnotations(symbol: scala.reflect.macros.Universe.Symbol): Seq[(String, scala.reflect.macros.Universe.Tree)]

final def getClass(): Class[_]

def getDebugConfig(modifiers: scala.reflect.macros.Universe.Modifiers): DebugConfig

def getEnclosingNamespace(): Option[String]

def getQualifiedTypeName(tree: scala.reflect.macros.Universe.Tree): String

def hashCode(): Int

def impl(annottees: scala.reflect.macros.whitebox.Context.Expr[Any]*): scala.reflect.macros.whitebox.Context.Expr[Any]

final def isInstanceOf[T0]: Boolean

def isSet(flag: String): Boolean

def modifiedAnnotations(parts: CommonParts, data: Data): (List[scala.reflect.macros.Universe.Tree], Data)

def modifiedBody(parts: CommonParts, data: Data): (Iterable[scala.reflect.macros.Universe.Tree], Data)

def modifiedClassDef(classParts: ClassParts, data: Data): (scala.reflect.macros.Universe.Tree, Data)

def modifiedFlags(parts: CommonParts, data: Data): (scala.reflect.macros.Universe.FlagSet, Data)

def modifiedModifiers(parts: CommonParts, data: Data): (scala.reflect.macros.Universe.Modifiers, Data)

def modifiedObjectDef(objectParts: ObjectParts, data: Data): (scala.reflect.macros.Universe.Tree, Data)

def modifiedParents(parts: CommonParts, data: Data): (Seq[scala.reflect.macros.Universe.Tree], Data)

def modifiedTraitDef(traitParts: TraitParts, data: Data): (scala.reflect.macros.Universe.Tree, Data)

final def ne(arg0: AnyRef): Boolean

def normalizeParents(parents: Seq[scala.reflect.macros.Universe.Tree]): Seq[scala.reflect.macros.Universe.Tree]

final def notify(): Unit

final def notifyAll(): Unit

def paramNames(params: Iterable[scala.reflect.macros.Universe.Tree]): Iterable[scala.reflect.macros.Universe.TermName]

def printTree(tree: scala.reflect.macros.Universe.Tree): Unit

def setting(flag: String, default: String): String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from WhiteboxMacroTools

Inherited from CommonMacroTools

Inherited from AnyRef

Inherited from Any

Ungrouped