Packages

class IMain extends Imports with PresentationCompilation with Closeable

An interpreter for Scala code.

The main public entry points are compile(), interpret(), and bind(). The compile() method loads a complete Scala file. The interpret() method executes one line of Scala code at the request of the user. The bind() method binds an object to a variable that can then be used by later interpreted code.

The overall approach is based on compiling the requested code and then using a Java classloader and Java reflection to run the code and access its results.

In more detail, a single compiler instance is used to accumulate all successfully compiled or interpreted Scala code. To "interpret" a line of code, the compiler generates a fresh object that includes the line of code and which has public member(s) to export all variables defined by that code. To extract the result of an interpreted line to show the user, a second "result object" is created which imports the variables exported by the above object and then exports members called "$eval" and "$print". To accommodate user expressions that read from variables or methods defined in previous statements, "import" statements are used.

This interpreter shares the strengths and weaknesses of using the full compiler-to-Java. The main strength is that interpreted code behaves exactly as does compiled code, including running at full speed. The main weakness is that redefining classes and methods is not handled properly, because rebinding at the Java level is technically difficult.

Self Type
IMain
Source
IMain.scala
Linear Supertypes
Closeable, AutoCloseable, PresentationCompilation, Imports, AnyRef, Any
Known Subclasses
ILoopInterpreter, Interpreter
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IMain
  2. Closeable
  3. AutoCloseable
  4. PresentationCompilation
  5. Imports
  6. AnyRef
  7. Any
Implicitly
  1. by IMainOps
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IMain(initialSettings: Settings)
  2. new IMain(initialSettings: Settings, out: JPrintWriter)

Type Members

  1. abstract class PhaseDependentOps extends AnyRef
  2. class ReadEvalPrint extends AnyRef

    Here is where we:

    Here is where we:

    1) Read some source code, and put it in the "read" object. 2) Evaluate the read object, and put the result in the "eval" object. 3) Create a String for human consumption, and put it in the "print" object.

    Read! Eval! Print! Some of that not yet centralized here.

  3. implicit class ReplTypeOps extends AnyRef
  4. class Request extends AnyRef

    One line of code submitted by the user for interpretation

  5. case class ComputedImports(header: String, prepend: String, append: String, access: String) extends Product with Serializable

    Compute imports that allow definitions from previous requests to be visible in a new request.

    Compute imports that allow definitions from previous requests to be visible in a new request. Returns three or four pieces of related code:

    0. Header code fragment that should go at the beginning of the compilation unit, specifically, import Predef.

    1. An initial code fragment that should go before the code of the new request.

    2. A code fragment that should go after the code of the new request.

    3. An access path which can be traversed to access any bindings inside code wrapped by #1 and #2 .

    The argument is a set of Names that need to be imported.

    Limitations: This method is not as precise as it could be. (1) It does not process wildcard imports to see what exactly they import. (2) If it imports any names from a request, it imports all of them, which is not really necessary. (3) It imports multiple same-named implicits, but only the last one imported is actually usable.

    Definition Classes
    Imports
  6. abstract class PresentationCompileResult extends AnyRef
    Definition Classes
    PresentationCompilation

Value Members

  1. def addUrlsToClassPath(urls: URL*): Unit

    Adds all specified jars to the compile and runtime classpaths.

    Adds all specified jars to the compile and runtime classpaths.

    urls

    The list of items to add to the compile and runtime classpaths.

    Note

    Currently only supports jars, not directories.

  2. def allDefinedNames: List[Global.Name]
  3. def allHandlers: collection.immutable.List[(memberHandlers)#MemberHandler]
  4. def backticked(s: String): String
  5. def beQuietDuring[T](body: ⇒ T): T

    Temporarily be quiet

  6. def beSilentDuring[T](operation: ⇒ T): T
  7. def bind[T](name: String, value: T)(implicit arg0: reflect.api.JavaUniverse.TypeTag[T], arg1: ClassTag[T]): Result
  8. def bind(p: NamedParam): Result
  9. def bind(name: String, boundType: String, value: Any, modifiers: List[String] = Nil): Result

    Bind a specified name to a specified value.

    Bind a specified name to a specified value. The name may later be used by expressions passed to interpret.

    A fresh ReadEvalPrint, which defines a line package, is used to compile a custom eval object that wraps the bound value.

    If the bound value is successfully installed, then bind the name by interpreting val name = $line42.$eval.value.

    name

    the variable name to bind

    boundType

    the type of the variable, as a string

    value

    the object value to bind to it

    returns

    an indication of whether the binding succeeded

  10. def classLoader: util.AbstractFileClassLoader
  11. def classOfTerm(id: String): Option[JClass]
  12. def cleanMemberDecl(owner: Global.Symbol, member: Global.Name): Global.Type
  13. def cleanTypeAfterTyper(sym: ⇒ Global.Symbol): Global.Type
  14. def clearExecutionWrapper(): Unit
  15. def close(): Unit

    This instance is no longer needed, so release any resources it is using.

    This instance is no longer needed, so release any resources it is using. The reporter's output gets flushed.

    Definition Classes
    IMain → Closeable → AutoCloseable
  16. def compileSources(sources: SourceFile*): Boolean

    Compile an nsc SourceFile.

    Compile an nsc SourceFile. Returns true if there are no compilation errors, or false otherwise.

  17. def compileSourcesKeepingRun(sources: SourceFile*): (Boolean, Run)
  18. def compileString(code: String): Boolean

    Compile a string.

    Compile a string. Returns true if there are no compilation errors, or false otherwise.

  19. def compilerClasspath: Seq[URL]
  20. def dealiasNonPublic(tp: Global.Type): Global.Type
  21. def debugging[T](msg: String)(res: T): T
  22. def definedSymbolList: collection.immutable.List[Global.Symbol]
  23. def definedTerms: collection.immutable.List[Global.TermName]
  24. def definedTypes: List[Global.TypeName]
  25. def directBind[T](name: String, value: T)(implicit arg0: reflect.api.JavaUniverse.TypeTag[T], arg1: ClassTag[T]): Result
  26. def directBind(p: NamedParam): Result
  27. def directBind(name: String, boundType: String, value: Any): Result
  28. def echoKind: ((tpe: _1.intp.global.Type, kind: _1.intp.global.Kind, verbose: Boolean)Unit) forSome {val _1: IMainOps}
    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  29. def echoTypeSignature: ((sym: _1.intp.global.Symbol, verbose: Boolean)Unit) forSome {val _1: IMainOps}
    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  30. def echoTypeStructure: ((sym: _1.intp.global.Symbol)Unit) forSome {val _1: IMainOps}
    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  31. final def ensureClassLoader(): Unit
  32. def executionWrapper: String
  33. def finalize(): Unit
    Definition Classes
    IMain → AnyRef
  34. def flatPath(sym: Global.Symbol): String
  35. def getClassIfDefined(path: String): Global.Symbol
  36. def getModuleIfDefined(path: String): Global.Symbol
  37. lazy val global: Global
  38. def implicitSymbolsBySource: List[(Global.Symbol, List[Global.Symbol])]
    Definition Classes
    Imports
  39. def implicitsCommand(line: String): String
    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  40. def importHandlers: collection.immutable.List[(memberHandlers)#ImportHandler]
  41. def initialize(postInitSignal: ⇒ Unit): Unit
  42. def initializeSynchronous(): Unit
  43. def interpret(line: String, synthetic: Boolean): Result
  44. def interpret(line: String): Result

    Interpret one line of input.

    Interpret one line of input. All feedback, including parse errors and evaluation results, are printed via the supplied compiler's reporter. Values defined are available for future interpreted strings.

    The return value is whether the line was interpreter successfully, e.g. that there were no parse errors.

  45. def interpretSynthetic(line: String): Result
  46. val intp: IMain
    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  47. lazy val isClassBased: Boolean
  48. def isInitializeComplete: Boolean
  49. lazy val isettings: ISettings

    interpreter settings

  50. def kindCommandInternal(typeString: String, verbose: Boolean): Unit
    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  51. def languageWildcardHandlers: collection.immutable.List[(memberHandlers)#ImportHandler]
    Definition Classes
    Imports
  52. def lastRequest: Request
  53. def lastWarnings: List[(Global.Position, String)]
  54. lazy val memberHandlers: MemberHandlers { val intp: IMain.this.type }
  55. def mostRecentVar: String

    Returns the name of the most recent interpreter result.

    Returns the name of the most recent interpreter result. Mostly this exists so you can conveniently invoke methods on the previous result.

  56. def namedDefinedTerms: collection.immutable.List[Global.TermName]
  57. def newPresentationCompiler(): interactive.Global

    Create an instance of the presentation compiler with a classpath comprising the REPL's configured classpath and the classes output by previously compiled REPL lines.

    Create an instance of the presentation compiler with a classpath comprising the REPL's configured classpath and the classes output by previously compiled REPL lines.

    You may directly interact with this compiler from any thread, although you must not access it concurrently from multiple threads.

    You may downcast the reporter to StoreReporter to access type errors.

    Definition Classes
    PresentationCompilation
  58. def originalPath(sym: Global.Symbol): String
  59. def originalPath(name: Global.Name): String
  60. def originalPath(name: String): String
  61. var partialInput: String
  62. def prevRequestList: collection.immutable.List[Request]
  63. def printAfterTyper(msg: ⇒ String): Unit
    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  64. def quietBind(p: NamedParam): Result
  65. def quietRun[T](code: String): Result
  66. val readInstanceName: String
  67. def readRootPath(readPath: String): Global.Symbol
  68. def rebind(p: NamedParam): Result
  69. def recordRequest(req: Request): Unit
  70. def replScope: Global.Scope
  71. lazy val reporter: ReplReporter
  72. def reset(): Unit

    Reset this interpreter, forgetting all user-specified requests.

  73. def resetClassLoader(): Unit
  74. def runtimeClassAndTypeOfTerm(id: String): Option[(JClass, Global.Type)]
  75. def runtimeMirror: Mirror
  76. def runtimeTypeOfTerm(id: String): Global.Type
  77. def setExecutionWrapper(code: String): Unit
  78. def settings: Settings
  79. def showCodeIfDebugging(code: String): Unit
  80. def showDirectory(): Unit
  81. def symbolDefString(sym: Global.Symbol): String
  82. def symbolOfIdent(id: String): Global.Symbol
  83. def symbolOfLine(code: String): Global.Symbol
  84. def symbolOfName(id: Global.Name): Global.Symbol
  85. def symbolOfTerm(id: String): Global.Symbol
  86. def symbolOfType(id: String): Global.Symbol
  87. def translateEnclosingClass(n: String): Option[String]
  88. def translateOriginalPath(p: String): String
  89. def translatePath(path: String): Option[String]
  90. def translateSimpleResource(path: String): Option[String]

    If path represents a class resource in the default package, see if the corresponding symbol has a class file that is a REPL artifact residing at a different resource path.

    If path represents a class resource in the default package, see if the corresponding symbol has a class file that is a REPL artifact residing at a different resource path. Translate X.class to $line3/$read$iw$X.class.

  91. def tryTwice(op: ⇒ Global.Symbol): Global.Symbol

    It's a bit of a shotgun approach, but for now we will gain in robustness.

    It's a bit of a shotgun approach, but for now we will gain in robustness. Try a symbol-producing operation at phase typer, and if that is NoSymbol, try again at phase flatten. I'll be able to lose this and run only from exitingTyper as soon as I figure out exactly where a flat name is sneaking in when calculating imports.

  92. def typeCommandInternal(expr: String, verbose: Boolean): Unit

    TODO - -n normalize -l label with case class parameter names -c complete - leave nothing out

    TODO - -n normalize -l label with case class parameter names -c complete - leave nothing out

    Implicit
    This member is added by an implicit conversion from IMain to IMainOps performed by method IMainOps in scala.tools.nsc.interpreter.
    Definition Classes
    IMainOps
  93. def typeOfExpression(expr: String, silent: Boolean = true): Global.Type
  94. def typeOfTerm(id: String): Global.Type
  95. def unqualifiedIds: List[String]
  96. def valueOfTerm(id: String): Option[Any]
  97. def withLabel[A](temp: String)(body: ⇒ A): A
  98. def withoutTruncating[A](body: ⇒ A): A
  99. def withoutUnwrapping(op: ⇒ Unit): Unit
  100. def withoutWarnings[T](body: ⇒ T): T
  101. object deconstruct extends StructuredTypeStrings
  102. object exprTyper extends ExprTyper
  103. object flatOp extends PhaseDependentOps
  104. object naming extends Naming
  105. object parse

    Parse a line into and return parsing result (error, incomplete or success with list of trees)

  106. object replOutput extends ReplOutput
  107. object typerOp extends PhaseDependentOps
  108. object PresentationCompileResult
    Definition Classes
    PresentationCompilation

Deprecated Value Members

  1. def setContextClassLoader(): Unit
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.0) The thread context classloader is now set and restored around execution of REPL line, this method is now a no-op.

  2. def virtualDirectory: ReplDir
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Use replOutput.dir instead