Scala Compiler2.12.11 < Back
 

# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package reflect
  Definition Classes
    tools
- Eval
- FastTrack
- FormatInterpolator
- FrontEnd
- ReflectGlobal
- ReflectMain
- StdContextTags
- StdRuntimeTags
- StdTags
- ToolBox
- ToolBoxError
- ToolBoxFactory
- WrappedProperties

t

scala.tools.reflect

# ToolBox 

###

#### trait ToolBox[U <: Universe] extends AnyRef

Source
  ToolBox.scala

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ToolBox
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Type Members

1.  abstract type TypecheckMode

   Represents mode of operations of the typechecker underlying `c.typecheck` calls.

   Represents mode of operations of the typechecker underlying `c.typecheck` calls. Is necessary since the shape of the typechecked tree alone is not enough to guess how it should be typechecked. Can be TERMmode (typecheck as a term), TYPEmode (typecheck as a type) or PATTERNmode (typecheck as a pattern).

### Abstract Value Members

1.  abstract val PATTERNmode: TypecheckMode

   Indicates that an argument to `c.typecheck` should be typechecked as a pattern.

2.  abstract val TERMmode: TypecheckMode

   Indicates that an argument to `c.typecheck` should be typechecked as a term.

   Indicates that an argument to `c.typecheck` should be typechecked as a term. This is the default typechecking mode in Scala 2.11 and the only one supported in Scala 2.10.

3.  abstract val TYPEmode: TypecheckMode

   Indicates that an argument to `c.typecheck` should be typechecked as a type.

4.  abstract def compile(tree: U.Tree): () ⇒ Any

   Compiles a tree using this ToolBox.

   Compiles a tree using this ToolBox.

   If the tree has unresolved type variables (represented as instances of `FreeTypeSymbol` symbols), then they all have to be resolved first using `Tree.substituteTypes`, or an error occurs.

   This spawns the compiler at the Namer phase, and pipelines the tree through that compiler. Currently `compile` does not accept trees that already typechecked, because typechecking isn't idempotent. For more info, take a look at https://github.com/scala/bug/issues/5464.

5.  abstract def define(tree: U.ImplDef): U.Symbol

   Defines a top-level class, trait or module in this ToolBox, putting it into a uniquely-named package and returning a symbol that references the defined entity.

   Defines a top-level class, trait or module in this ToolBox, putting it into a uniquely-named package and returning a symbol that references the defined entity. For a ClassDef, a ClassSymbol is returned, and for a ModuleDef, a ModuleSymbol is returned (not a module class, but a module itself).

   This method can be used to generate definitions that will later be re-used by subsequent calls to `compile`, `define` or `eval`. To refer to the generated definition in a tree, use q"$sym".

6.  abstract def eval(tree: U.Tree): Any

   Compiles and runs a tree using this ToolBox.

   Compiles and runs a tree using this ToolBox. Is equivalent to `compile(tree)()`.

7.  abstract def frontEnd: FrontEnd

   Front end of the toolbox.

   Front end of the toolbox.

   Accumulates and displays warnings and errors, can drop to interactive mode (if supported). The latter can be useful to study the typechecker or to debug complex macros.

   scala.tools.reflect provides two predefined front ends that can be created using scala.tools.reflect.mkSilentFrontEnd and scala.tools.reflect.mkConsoleFrontEnd.

8.  abstract def inferImplicitValue(pt: U.Type, silent: Boolean = true, withMacrosDisabled: Boolean = false, pos: U.Position = u.NoPosition): U.Tree

   Infers an implicit value of the expected type `pt` in top-level context.

   Infers an implicit value of the expected type `pt` in top-level context. Optional `pos` parameter provides a position that will be associated with the implicit search.

   As mentioned in https://groups.google.com/forum/#!topic/scala-internals/ta-vbUT6JE8 this API won't take into account the lexical context of the callsite, because currently it's impossible to reify it.

   If `silent` is false, `ToolBoxError` will be thrown in case of an inference error. If `silent` is true, the typecheck is silent and will return `EmptyTree` if an error occurs. Such errors don't vanish and can be inspected by turning on -Xlog-implicits. Unlike in `typecheck`, `silent` is true by default.

9.  abstract def inferImplicitView(tree: U.Tree, from: U.Type, to: U.Type, silent: Boolean = true, withMacrosDisabled: Boolean = false, pos: U.Position = u.NoPosition): U.Tree

   Infers an implicit view from the provided tree `tree` from the type `from` to the type `to` in the toplevel context.

   Infers an implicit view from the provided tree `tree` from the type `from` to the type `to` in the toplevel context. Optional `pos` parameter provides a position that will be associated with the implicit search.

   As mentioned in https://groups.google.com/forum/#!topic/scala-internals/ta-vbUT6JE8 this API won't take into account the lexical context of the callsite, because currently it's impossible to reify it.

   If `silent` is false, `ToolBoxError` will be thrown in case of an inference error. If `silent` is true, the typecheck is silent and will return `EmptyTree` if an error occurs. Such errors don't vanish and can be inspected by turning on -Xlog-implicits. Unlike in `typecheck`, `silent` is true by default.

10.  abstract val mirror: U.Mirror

    Underlying mirror of a ToolBox

11.  abstract def parse(code: String): U.Tree

    ..

12.  abstract def typecheck(tree: U.Tree, mode: TypecheckMode = TERMmode, pt: U.Type = u.WildcardType, silent: Boolean = false, withImplicitViewsDisabled: Boolean = false, withMacrosDisabled: Boolean = false): U.Tree

    Typechecks a tree against the expected type `pt` under typechecking mode specified in `mode` with TERMmode being default.

    Typechecks a tree against the expected type `pt` under typechecking mode specified in `mode` with TERMmode being default. This populates symbols and types of the tree and possibly transforms it to reflect certain desugarings.

    If the tree has unresolved type variables (represented as instances of `FreeTypeSymbol` symbols), then they all have to be resolved first using `Tree.substituteTypes`, or an error occurs.

    If `silent` is false, `ToolBoxError` will be thrown in case of a typecheck error. If `silent` is true, the typecheck is silent and will return `EmptyTree` if an error occurs. Such errors don't vanish and can be inspected by turning on -Ydebug.

    Typechecking can be steered with the following optional parameters: `withImplicitViewsDisabled` recursively prohibits implicit views (though, implicit vals will still be looked up and filled in), default value is false `withMacrosDisabled` recursively prohibits macro expansions and macro-based implicits, default value is false

13.  abstract val u: U

    Underlying universe of a ToolBox

14.  abstract def untypecheck(tree: U.Tree): U.Tree

    See also

      scala.reflect.macros.Typers.untypecheck

15.  abstract def resetLocalAttrs(tree: U.Tree): U.Tree

    Recursively resets locally defined symbols and types in a given tree.

    Recursively resets locally defined symbols and types in a given tree. WARNING: Don't use this API, go for untypecheck instead.

    Annotations
      @deprecated
    Deprecated

      (Since version 2.11.0) Use `tb.untypecheck` instead

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from ToolBox[U] to any2stringadd[ToolBox[U]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (ToolBox[U], B)
   Implicit
     This member is added by an implicit conversion from ToolBox[U] to ArrowAssoc[ToolBox[U]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... ) @native()
8.  def ensuring(cond: (ToolBox[U]) ⇒ Boolean, msg: ⇒ Any): ToolBox[U]
   Implicit
     This member is added by an implicit conversion from ToolBox[U] to Ensuring[ToolBox[U]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (ToolBox[U]) ⇒ Boolean): ToolBox[U]
   Implicit
     This member is added by an implicit conversion from ToolBox[U] to Ensuring[ToolBox[U]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: ⇒ Any): ToolBox[U]
    Implicit
      This member is added by an implicit conversion from ToolBox[U] to Ensuring[ToolBox[U]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): ToolBox[U]
    Implicit
      This member is added by an implicit conversion from ToolBox[U] to Ensuring[ToolBox[U]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
15.  def formatted(fmtstr: String): String
    Implicit
      This member is added by an implicit conversion from ToolBox[U] to StringFormat[ToolBox[U]] performed by method StringFormat in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()
16.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
19.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
20.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
23.  def toString(): String
    Definition Classes
      AnyRef → Any
24.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
25.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
26.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
27.  def →[B](y: B): (ToolBox[U], B)
    Implicit
      This member is added by an implicit conversion from ToolBox[U] to ArrowAssoc[ToolBox[U]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Deprecated Value Members

1.  def typeCheck(tree: U.Tree, pt: U.Type = u.WildcardType, silent: Boolean = false, withImplicitViewsDisabled: Boolean = false, withMacrosDisabled: Boolean = false): U.Tree

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) Use `tb.typecheck` instead

   See also

     `Typers.typecheck`

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from ToolBox[U] to any2stringadd[ToolBox[U]]

### Inherited by implicit conversion StringFormat from ToolBox[U] to StringFormat[ToolBox[U]]

### Inherited by implicit conversion Ensuring from ToolBox[U] to Ensuring[ToolBox[U]]

### Inherited by implicit conversion ArrowAssoc from ToolBox[U] to ArrowAssoc[ToolBox[U]]

### Ungrouped