Packages

  • package root
    Definition Classes
    root
  • package de
    Definition Classes
    root
  • package unruh
    Definition Classes
    de
  • package isabelle

    This library allows to control an Isabelle process from a Scala application.

    This library allows to control an Isabelle process from a Scala application. For first steps and pointers, see the README.

    In case of missing/incorrect documentation, create an issue.

    Definition Classes
    unruh
  • package control

    This package contains classes for instantiating and controlling an Isabelle process.

    This package contains classes for instantiating and controlling an Isabelle process. The main class is Isabelle, see there for documentation. Controlling the process via the classes in this package is quite low-level. See mlvalue.MLValue for a higher level mechanism.

    Definition Classes
    isabelle
  • object Isabelle
    Definition Classes
    control
  • DInt
  • DList
  • DObject
  • DString
  • Data
  • ID
  • Setup
  • SetupGeneral
  • SetupRunning

case class Setup(isabelleHome: Path, logic: String = "HOL", userDir: Option[Path] = None, workingDirectory: Path = Paths.get(""), sessionRoots: Seq[Path] = Nil, build: Boolean = true, verbose: Boolean = false, exceptionManager: (Isabelle) => ExceptionManager = new DefaultExceptionManager(_), isabelleCommandHandler: (Data) => Unit = Isabelle.defaultCommandHandler) extends SetupGeneral with Product with Serializable

Configuration for initializing an Isabelle instance.

(The fields of this class are documents in the source code. I am not sure why they do not occur in the generated API doc.)

isabelleHome

Path to the Isabelle distribution

logic

Heap image to load in Isabelle (e.g., HOL, HOL-Analysis, etc.)

userDir

User configuration directory for Isabelle. Must end in /.isabelle if provided. None (default) means to let Isabelle chose the default location. Here Isabelle stores user configuration and heap images (unless the location of the heap images is configured differently, see the Isabelle system manual)

workingDirectory

Working directory in which the Isabelle process should run. (Default: working directory of the Scala process.) All other paths described below are interpreted relative to workingDirectory (unless they are absolute).

sessionRoots

Additional session directories in which Isabelle will search for sessions (must contain ROOT files and optionally ROOTS files, see the Isabelle system manual). Default: no additional session directories

build

This option has currently no effect. The heap is always built. Old documentation: Whether to build the Isabelle heap before running Isabelle. If false, the heap will never be built. (This means changes in the Isabelle theories will not be reflected. And if the heap was never built, the Isabelle process fails.) If true, the Isabelle build command will be invoked. That command automatically checks for changed dependencies but may add a noticable delay even if the heap was already built.

verbose

Makes Isabelle run in verbose mode. (Only affects debug output, and only during build.)

exceptionManager

See SetupGeneral.exceptionManager

isabelleCommandHandler

See SetupGeneral.isabelleCommandHandler

Source
Isabelle.scala
Linear Supertypes
Serializable, Product, Equals, SetupGeneral, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Setup
  2. Serializable
  3. Product
  4. Equals
  5. SetupGeneral
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Setup(isabelleHome: Path, logic: String = "HOL", userDir: Option[Path] = None, workingDirectory: Path = Paths.get(""), sessionRoots: Seq[Path] = Nil, build: Boolean = true, verbose: Boolean = false, exceptionManager: (Isabelle) => ExceptionManager = new DefaultExceptionManager(_), isabelleCommandHandler: (Data) => Unit = Isabelle.defaultCommandHandler)

    isabelleHome

    Path to the Isabelle distribution

    logic

    Heap image to load in Isabelle (e.g., HOL, HOL-Analysis, etc.)

    userDir

    User configuration directory for Isabelle. Must end in /.isabelle if provided. None (default) means to let Isabelle chose the default location. Here Isabelle stores user configuration and heap images (unless the location of the heap images is configured differently, see the Isabelle system manual)

    workingDirectory

    Working directory in which the Isabelle process should run. (Default: working directory of the Scala process.) All other paths described below are interpreted relative to workingDirectory (unless they are absolute).

    sessionRoots

    Additional session directories in which Isabelle will search for sessions (must contain ROOT files and optionally ROOTS files, see the Isabelle system manual). Default: no additional session directories

    build

    This option has currently no effect. The heap is always built. Old documentation: Whether to build the Isabelle heap before running Isabelle. If false, the heap will never be built. (This means changes in the Isabelle theories will not be reflected. And if the heap was never built, the Isabelle process fails.) If true, the Isabelle build command will be invoked. That command automatically checks for changed dependencies but may add a noticable delay even if the heap was already built.

    verbose

    Makes Isabelle run in verbose mode. (Only affects debug output, and only during build.)

    exceptionManager

    See SetupGeneral.exceptionManager

    isabelleCommandHandler

    See SetupGeneral.isabelleCommandHandler

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val build: Boolean
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val exceptionManager: (Isabelle) => ExceptionManager

    Instance of ExceptionManager to use for this Isabelle process.

    Instance of ExceptionManager to use for this Isabelle process. The supplied function is called with the Isabelle instance to create the ExceptionManager.

    Definition Classes
    Setup → SetupGeneral
    See also

    DefaultExceptionManager and de.unruh.isabelle.pure.exceptions.MLException.ExceptionManager for useful implementations of ExceptionManager.

  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val isabelleCommandHandler: (Data) => Unit

    Installs a handler for commands sent from the Isabelle process to the Scala process.

    Installs a handler for commands sent from the Isabelle process to the Scala process. When invoking Control_Isabelle.sendToScala data (for data of ML type data), then isabelleCommandHandler is invoked as isabelleCommandHandler(data). (After transferring and converting data to type Data.)

    Definition Classes
    Setup → SetupGeneral
  12. val isabelleHome: Path
  13. def isabelleHomeAbsolute: Path

    isabelleHome as an absolute path

  14. val logic: String
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val sessionRoots: Seq[Path]
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val userDir: Option[Path]
  22. def userDirAbsolute: Path

    userDir as an absolute path.

    userDir as an absolute path. If userDir is None, the Isabelle default user directory is returned.

  23. val verbose: Boolean
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. val workingDirectory: Path

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SetupGeneral

Inherited from AnyRef

Inherited from Any

Ungrouped