scala.reflect.macros

Synthetics

trait Synthetics extends AnyRef

EXPERIMENTAL

A slice of the Scala macros context that exposes functions to introduce synthetic definitions.

Self Type
Context
Source
Synthetics.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Synthetics
  2. AnyRef
  3. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait PackageSpec[T] extends AnyRef

    A factory which can create a package def from a prototype and a list of declarations.

Abstract Value Members

  1. abstract def introduceTopLevel[T](packagePrototype: T, definitions: Universe.ImplDef*)(implicit arg0: Context.PackageSpec[T]): List[Universe.RefTree]

    Adds a list of top-level definitions to the compiler's symbol table.

    Adds a list of top-level definitions to the compiler's symbol table. _TOP_LEVEL Allowed definitions include classes (represented by ClassDef trees), traits (represented by ClassDef trees having the TRAIT flag set in mods) and objects (represented by ModuleDef trees).

    The definitions are put into the package with a prototype provided in packagePrototype. Supported prototypes are (see PackageSpec for more details): * Strings and names representing a fully-qualified name of the package * Trees that can work as package ids * Package or package class symbols

    Typical value for a package prototype is a fully-qualified name in a string. For example, to generate a class available at foo.bar.Test, call this method as follows:

    introduceTopLevel("foo.bar", ClassDef(<mods>, TypeName("Test"), <tparams>, <template>))

    It is possible to add definitions to the empty package by using nme.EMPTY_PACKAGE_NAME.toString, but that's not recommended, since such definitions cannot be seen from outside the empty package.

    Only the multi-parameter overload of this method can be used to introduce companions. If companions are introduced by two different calls, then they will be put into different virtual files, and scalac will show an error about companions being defined in different files. By the way, this also means that there's currently no way to define a companion for an existing class or module_TOP_LEVEL.

    Returns a list of fully-qualified references to the introduced definitions.

  2. abstract def introduceTopLevel[T](packagePrototype: T, definition: Universe.ImplDef)(implicit arg0: Context.PackageSpec[T]): Universe.RefTree

    Adds a top-level definition to the compiler's symbol table.

    Adds a top-level definition to the compiler's symbol table. _TOP_LEVEL Allowed definitions include classes (represented by ClassDef trees), traits (represented by ClassDef trees having the TRAIT flag set in mods) and objects (represented by ModuleDef trees).

    The definitions are put into the package with a prototype provided in packagePrototype. Supported prototypes are (see PackageSpec for more details): * Strings and names representing a fully-qualified name of the package * Trees that can work as package ids * Package or package class symbols

    Typical value for a package prototype is a fully-qualified name in a string. For example, to generate a class available at foo.bar.Test, call this method as follows:

    introduceTopLevel("foo.bar", ClassDef(<mods>, TypeName("Test"), <tparams>, <template>))

    It is possible to add definitions to the empty package by using nme.EMPTY_PACKAGE_NAME.toString, but that's not recommended, since such definitions cannot be seen from outside the empty package.

    Only the multi-parameter overload of this method can be used to introduce companions. If companions are introduced by two different calls, then they will be put into different virtual files, and scalac will show an error about companions being defined in different files. By the way, this also means that there's currently no way to define a companion for an existing class or module_TOP_LEVEL.

    Returns a fully-qualified reference to the introduced definition.

  3. abstract def mkPackageDef(sym: Context.Symbol, stats: List[Context.Tree]): Universe.PackageDef

    Attributes
    protected
  4. abstract def mkPackageDef(tree: Universe.RefTree, stats: List[Context.Tree]): Universe.PackageDef

    Attributes
    protected
  5. abstract def mkPackageDef(name: Context.TermName, stats: List[Context.Tree]): Universe.PackageDef

    Attributes
    protected
  6. abstract def mkPackageDef(name: String, stats: List[Context.Tree]): Universe.PackageDef

    Attributes
    protected
  7. abstract def topLevelDef(name: Context.Name): Context.Tree

    Looks up a top-level definition tree with a given fully-qualified name (term name for modules, type name for classes).

    Looks up a top-level definition tree with a given fully-qualified name (term name for modules, type name for classes). _TREE Top-level tree is a tree that represents a non-inner class or object in one of the currently compiled source files. Note that top-level isn't equivalent to scala.reflect.api.Symbols#SymbolApi.isStatic, because static also embraces definitions nested in static objects _TREE. If such a tree does not exist, returns EmptyTree.

  8. abstract def topLevelRef(name: Context.Name): Context.Tree

    Returns a reference to a top-level definition tree with a given fully-qualified name (term name for modules, type name for classes).

    Returns a reference to a top-level definition tree with a given fully-qualified name (term name for modules, type name for classes). _TREE Top-level tree is a tree that represents a non-inner class or object in one of the currently compiled source files. Note that top-level isn't equivalent to scala.reflect.api.Symbols#SymbolApi.isStatic, because static also embraces definitions nested in static objects _TREE. If such a tree does not exist, returns EmptyTree.

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

    Implicit information
    This member is added by an implicit conversion from Synthetics to ArrowAssoc[Synthetics] performed by method ArrowAssoc 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. object PackageSpec

    Hosts supported package specs.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. def ensuring(cond: (Synthetics) ⇒ Boolean, msg: ⇒ Any): Synthetics

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

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

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

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

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

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

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

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

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

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

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. def toString(): String

    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

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

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

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

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Synthetics to StringAdd[Synthetics]

Inherited by implicit conversion StringFormat from Synthetics to StringFormat[Synthetics]

Inherited by implicit conversion Ensuring from Synthetics to Ensuring[Synthetics]

Inherited by implicit conversion ArrowAssoc from Synthetics to ArrowAssoc[Synthetics]

Ungrouped