scala3-compiler-bootstrapped/dotty.tools.repl/ReplDriver

ReplDriver

class ReplDriver(settings: Array[String], out: PrintStream, classLoader: Option[ClassLoader]) extends Driver

Main REPL instance, orchestrating input, compilation and presentation

class Driver
class Object
trait Matchable
class Any

Value members

Concrete methods

final def bind(name: String, value: Any)(implicit state: State): State
final def initialState: State

the initial, empty state of the REPL session

the initial, empty state of the REPL session

final def run(input: String)(implicit state: State): State
final def runUntilQuit(initialState: State): State

Run REPL with state until :quit command found

Run REPL with state until :quit command found

This method is the main entry point into the REPL. Its effects are not observable outside of the CLI, for this reason, most helper methods are protected final to facilitate testing.

override def sourcesRequired: Boolean

Overridden to false in order to not have to give sources on the commandline

Overridden to false in order to not have to give sources on the commandline

Definition Classes
final def tryRunning: Unit

Try to run REPL if there is nothing that prevents us doing so.

Try to run REPL if there is nothing that prevents us doing so.

Possible reason for unsuccessful run are raised flags in CLI like --help or --version

Inherited methods

def main(args: Array[String]): Unit
Inherited from
Driver
def process(args: Array[String], rootCtx: Context): Reporter

Entry point to the compiler using a custom Context.

Entry point to the compiler using a custom Context.

In most cases, you do not need a custom Context and should instead use one of the other overloads of process. However, the other overloads cannot be overridden, instead you should override this one which they call internally.

Usage example: https://github.com/lampepfl/dotty/tree/master/compiler/test/dotty/tools/dotc/EntryPointsTest.scala.disabled in method runCompilerWithContext

Value Params
args

Arguments to pass to the compiler.

rootCtx

The root Context to use.

Returns

The Reporter used. Use Reporter#hasErrors to check if compilation succeeded.

Inherited from
Driver
final def process(args: Array[String]): Reporter

Entry point to the compiler with no optional arguments.

Entry point to the compiler with no optional arguments.

This overload is provided for compatibility reasons: the RawCompiler of sbt expects this method to exist and calls it using reflection. Keeping it means that we can change the other overloads without worrying about breaking compatibility with sbt.

Inherited from
Driver
final def process(args: Array[String], reporter: Reporter, callback: CompilerCallback): Reporter

Principal entry point to the compiler.

Principal entry point to the compiler.

Usage example: https://github.com/lampepfl/dotty/tree/master/compiler/test/dotty/tools/dotc/EntryPointsTest.scala.disabled in method runCompiler

Value Params
args

Arguments to pass to the compiler.

callback

Used to execute custom code during the compilation process. No callbacks will be executed if this is null.

reporter

Used to log errors, warnings, and info messages. The default reporter is used if this is null.

Returns

The Reporter used. Use Reporter#hasErrors to check if compilation succeeded.

Inherited from
Driver
final def process(args: Array[String], simple: SimpleReporter, callback: CompilerCallback): ReporterResult

Entry point to the compiler that can be conveniently used with Java reflection.

Entry point to the compiler that can be conveniently used with Java reflection.

This entry point can easily be used without depending on the dotty package, you only need to depend on dotty-interfaces and call this method using reflection. This allows you to write code that will work against multiple versions of dotty without recompilation.

The trade-off is that you can only pass a SimpleReporter to this method and not a normal Reporter which is more powerful.

Usage example: https://github.com/lampepfl/dotty/tree/master/compiler/test/dotty/tools/dotc/InterfaceEntryPointTest.scala

Value Params
args

Arguments to pass to the compiler.

callback

Used to execute custom code during the compilation process. No callbacks will be executed if this is null.

simple

Used to log errors, warnings, and info messages. The default reporter is used if this is null.

Inherited from
Driver
def setup(args: Array[String], rootCtx: Context): Option[(List[AbstractFile], Context)]

Setup context with initialized settings from CLI arguments, then check if there are any settings that would change the default behaviour of the compiler.

Setup context with initialized settings from CLI arguments, then check if there are any settings that would change the default behaviour of the compiler.

Returns

If there is no setting like -help preventing us from continuing compilation, this method returns a list of files to compile and an updated Context. If compilation should be interrupted, this method returns None.

Inherited from
Driver