Environment

Abstract interface for an Isabelle environment of a particular version in a path with an underlying PIDE machinery.

As opposed to a mere logic-less Setup, an environment knows how to manage Isabelle processes. It can also manage multiple running processes at the same time.

A subclass of this class is called implementation throughout libisabelle.

It is highly recommended to use edu.tum.cs.isabelle.setup.Setup#makeEnvironment to instantiate implementations.

While implementations may be created freely by users, it is recommended to only use the bundled implementations for the supported Isabelle versions. By convention, they live in the package edu.tum.cs.isabelle.impl. See also Setup.defaultPackageName.

Contract

An implementation is a subclass of this class.
The class name of the implementation must be Environment. There must be a BuildInfo class in the same package.
Implementations must be final and provide a constructor with exactly one argument (of type java.nio.file.Path). There must be no other constructors. The constructor should be private.
Implementations must be annotated with Implementation, where the given identifier corresponds to the version identifier.

Footnote

Due to name clashes in the underlying PIDE machinery (which is provided by Isabelle itself and is not under control of libisabelle), it is impossible to have multiple environments for different versions in the same class loader. This is the primary reason why this class exists in the first place, to enable seamless abstraction over multiple PIDEs.

Self Type: Environment

Linear Supertypes

AnyRef, Any

Instance Constructors

new Environment(home: Path)

Attributes
protected

Type Members

abstract type Session

Attributes
protected[edu.tum.cs.isabelle]

Abstract Value Members

abstract def build(config: Configuration): Int

Attributes
protected[edu.tum.cs.isabelle]
abstract def create(config: Configuration, consumer: (Markup, Body) ⇒ Unit): Session

Attributes
protected[edu.tum.cs.isabelle]
abstract def decode(text: @@[String, Raw]): @@[String, Unicode]
abstract def dispose(session: Session): Unit

Attributes
protected[edu.tum.cs.isabelle]
abstract def encode(text: @@[String, Unicode]): @@[String, Raw]
implicit abstract val executionContext: ExecutionContext

The execution context internally used by the underlying PIDE implementation.
The execution context internally used by the underlying PIDE implementation.
It is allowed to override the execution context of internal PIDE implementation during initialization, but it must remain fixed afterwards. This field must be set to that execution context.
Implementations should ensure that the underlying thread pool consists of daemon threads, rendering disposing of running systems unnecessary. (The secondary reason is to avoid a hanging JVM when user code did not handle an exception, the main thread gets terminated, but worker threads are keeping the JVM alive.)
This is exposed to the user via System#executionContext.
abstract val exitTag: String

Attributes
protected[edu.tum.cs.isabelle]
abstract val functionTag: String

Attributes
protected[edu.tum.cs.isabelle]
abstract val initTag: String

Attributes
protected[edu.tum.cs.isabelle]
abstract val protocolTag: String

Attributes
protected[edu.tum.cs.isabelle]
abstract def sendCommand(session: Session, name: String, args: List[String]): Unit

Attributes
protected[edu.tum.cs.isabelle]
abstract def sendOptions(session: Session): Unit

Attributes
protected[edu.tum.cs.isabelle]

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val home: Path
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final val logger: Logger

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
Environment → AnyRef → Any
final val variables: Map[String, String]
final val version: Version
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Environment | package api

abstract class Environment extends AnyRef

Instance Constructors

new Environment(home: Path)

Type Members

abstract type Session

Abstract Value Members

abstract def build(config: Configuration): Int

abstract def create(config: Configuration, consumer: (Markup, Body) ⇒ Unit): Session

abstract def decode(text: @@[String, Raw]): @@[String, Unicode]

abstract def dispose(session: Session): Unit

abstract def encode(text: @@[String, Unicode]): @@[String, Raw]

implicit abstract val executionContext: ExecutionContext

abstract val exitTag: String

abstract val functionTag: String

abstract val initTag: String

abstract val protocolTag: String

abstract def sendCommand(session: Session, name: String, args: List[String]): Unit

abstract def sendOptions(session: Session): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val home: Path

final def isInstanceOf[T0]: Boolean

final val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final val variables: Map[String, String]

final val version: Version

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped