edu.tum.cs.isabelle.api

Environment

abstract class Environment extends AnyRef

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. The Implementations class serves as a registry of those and using it is strongly recommended. (Since subclasses should protect their constructors, manual instantiation would not work anyway.)

For multi-home or multi-version scenarios, it is highly recommended that users create environments through the appropriate function of a registry. See its documentation for an explanation.

If in doubt, users should prefer the direct (manual) instantiation.

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 and their class name is also Environment.

Contract

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.

As the caveat above states, not even multi-home scenarios are supported without going through a registry. The user has to ensure that this happens, since this class does not attempt to detect such a situation. While in principle it could do so, it would require the introduction of even more global mutable state. It might do so in the future.

Self Type
Environment
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Environment
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Environment(home: Path)

    Attributes
    protected[edu.tum.cs.isabelle]

Type Members

  1. abstract type Session

    Attributes
    protected[edu.tum.cs.isabelle]

Abstract Value Members

  1. abstract def build(config: Configuration): Int

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

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

    Attributes
    protected[edu.tum.cs.isabelle]
  4. 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.

  5. abstract val exitTag: String

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

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

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

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

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

    Attributes
    protected[edu.tum.cs.isabelle]

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. val home: Path

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. final val logger: Logger

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

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  20. def toString(): String

    Definition Classes
    Environment → AnyRef → Any
  21. final val variables: Map[String, String]

  22. final val version: Version

  23. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped