api

Type Members

1. final case class Configuration(path: Option[Path], session: String) extends Product with Serializable

   

   Represents the location and name of a session (Isabelle terminology).

   Represents the location and name of a session (Isabelle terminology).

   Refer to the Isabelle system manual for details about sessions. libisabelle assumes that users are familiar with the session handling of Isabelle.

   Creation of configurations is completely unchecked. Errors such as non-existing paths will only manifest themselves when attempting to build a configuration or create a system. Nonetheless, users should go through one of the constructors in the companion object.

2. abstract class Environment extends AnyRef

   

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

   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 througout 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

   • An implementation is a subclass of this class.
   • 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 protected, but must be accessible from any class in the isabelle package.
   • 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.

   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.

3. class Implementation extends Annotation with Annotation with ClassfileAnnotation

   

4. type Markup = (String, Properties)

   

5. type Properties = List[(String, String)]

   

6. final case class Version(identifier: String) extends Product with Serializable

   

   Represents the version of an Isabelle release.

   Represents the version of an Isabelle release.

   Repository snapshots are not supported.