info.hupel.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.

It is highly recommended to use 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 info.hupel.isabelle.impl. See also Setup.defaultPackageName.

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.

Self Type
Environment
Linear Supertypes
AnyRef, Any
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(context: Context)

    Attributes
    protected

Type Members

  1. abstract type Session

    Attributes
    protected[info.hupel.isabelle]

Abstract Value Members

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

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

    Attributes
    protected[info.hupel.isabelle]
  3. abstract def decode(text: @@[String, Raw]): @@[String, Unicode]

  4. abstract def dispose(session: Session): Unit

    Attributes
    protected[info.hupel.isabelle]
  5. abstract def encode(text: @@[String, Unicode]): @@[String, Raw]

  6. abstract def exec(tool: String, args: List[String]): Int

  7. abstract val exitTag: String

    Attributes
    protected[info.hupel.isabelle]
  8. abstract val functionTag: String

    Attributes
    protected[info.hupel.isabelle]
  9. abstract val initTag: String

    Attributes
    protected[info.hupel.isabelle]
  10. abstract def isabellePath(path: String): String

    Attributes
    protected[info.hupel.isabelle]
  11. abstract def isabelleSetting(name: String): String

    Attributes
    protected[info.hupel.isabelle]
  12. abstract val printTags: Set[String]

    Attributes
    protected[info.hupel.isabelle]
  13. abstract val protocolTag: String

    Attributes
    protected[info.hupel.isabelle]
  14. abstract def sendCommand(session: Session, name: String, args: List[String]): Unit

    Attributes
    protected[info.hupel.isabelle]
  15. abstract def sendOptions(session: Session): Unit

    Attributes
    protected[info.hupel.isabelle]
  16. abstract def settings: Map[String, String]

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. val context: Context

  9. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  11. implicit final val executionContext: ExecutionContext

  12. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  15. final val home: Path

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  17. final val logger: Logger

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

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

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

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

    Definition Classes
    AnyRef
  22. def toString(): String

    Definition Classes
    Environment → AnyRef → Any
  23. final val user: Path

  24. final val variables: Map[String, String]

  25. final val version: Version

  26. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped