Packages

final class ToplevelState extends MLValueWrapper[ToplevelState]

Represents a toplevel state (the state when processing an Isar .thy document). ML type: Toplevel.state

An instance of this class is merely a thin wrapper around an MLValue, all explanations and examples given for Context also apply here.

An implict MLValue.Converter can be imported from Implicits._. The representation of a toplevel state state as an ML exception is E_ToplevelState state.

Source
ToplevelState.scala
Linear Supertypes
MLValueWrapper[ToplevelState], FutureValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ToplevelState
  2. MLValueWrapper
  3. FutureValue
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def await: Unit

    Blocks until this future value is computed.

    Blocks until this future value is computed. (Or throws an exception if the computation fails.)

    Definition Classes
    MLValueWrapper → FutureValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  7. def context(implicit isabelle: Isabelle): Context

    Returns the proof context corresponding to this toplevel state (ML function Toplevel.context_of).

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def force: ToplevelState.this.type

    Waits till the computation of this value (in the Isabelle process) has finished.

    Waits till the computation of this value (in the Isabelle process) has finished. (Or until an exception is thrown.)

    returns

    this value, but it is guaranteed to have completed the computation

    Definition Classes
    FutureValue
  11. def forceFuture(implicit isabelle: Isabelle): Future[ToplevelState.this.type]

    A future containing this object with the computation completed.

    A future containing this object with the computation completed. In particular, if this value throws an exception upon computation, the future holds that exception.

    Roughly the same as Future { this.force }.

    Definition Classes
    FutureValue
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def isEndTheory(implicit isabelle: Isabelle): Boolean

    Returns whether the state is after a theory "end".

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def isLocalTheoryMode(implicit isabelle: Isabelle): Boolean

    Returns whether the state is in local theory mode.

  17. def isProofMode(implicit isabelle: Isabelle): Boolean

    Returns whether the state is in proof (non-skipped) mode.

  18. def isSkippedMode(implicit isabelle: Isabelle): Boolean

    Returns whether the state is in skipped-proof mode.

  19. def isTheoryMode(implicit isabelle: Isabelle): Boolean

    Returns whether the state is in theory mode, global or local.

  20. def isTopLevelMode(implicit isabelle: Isabelle): Boolean

    Returns whether the state is in top-level mode, meaning outside a theory (before "theory ..

    Returns whether the state is in top-level mode, meaning outside a theory (before "theory .. begin" or after "end").

  21. def localTheoryDescription(implicit isabelle: Isabelle): String

    Description of the current local theory, like "theory Foo" or "locale foo", or "class foo = ...".

  22. val mlValue: MLValue[ToplevelState]

    An MLValue referencing this (in the Isabelle process).

    An MLValue referencing this (in the Isabelle process). Since this is just a thin wrapper around an MLValue, mlValue carries exactly the same data as this and can be converted back and forth quickly (no transfer of data to/from the Isabelle process involved).

    Same as MLValue(this), assuming the correct MLValue.Converter from the companion object for A is imported.

    Definition Classes
    ToplevelState → MLValueWrapper
  23. def mode(implicit isabelle: Isabelle): Mode

    Returns the mode of the state (roughly similar to ML function Toplevel.str_of_state).

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  27. def proofLevel(implicit isabelle: Isabelle): Int

    Returns the proof level of this state (number of opened blocks, ML function Toplevel.level).

    Returns the proof level of this state (number of opened blocks, ML function Toplevel.level). Zero when outside of proofs. For Skipped_Proof, this is instead the depth (plus one).

  28. def proofStateDescription(implicit isabelle: Isabelle): String

    Description of the current proof state (often starting like "proof (prove) goal (1 subgoal):").

  29. def someFuture: Future[Any]

    Returns a future that completes when the computation of this object is complete.

    Returns a future that completes when the computation of this object is complete. (Or that holds an exception if that computation throws an exception.) However, upon successful completion, the future may return an arbitrary (and thus useless) value. May be faster to implement than forceFuture because there may be already a future available but that returns the wrong value.

    Definition Classes
    MLValueWrapper → FutureValue
  30. def stateString: String

    A utility method that returns "" if this value was successfully computed, " (computing)" if it still computes, and " (failed)" if it finished with an exception.

    A utility method that returns "" if this value was successfully computed, " (computing)" if it still computes, and " (failed)" if it finished with an exception.

    This can be useful to constructing human readable messages about this value.

    Definition Classes
    FutureValue
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def theory(implicit isabelle: Isabelle): Theory

    Returns the theory corresponding to this toplevel state (ML function Toplevel.theory_of).

  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from MLValueWrapper[ToplevelState]

Inherited from FutureValue

Inherited from AnyRef

Inherited from Any

Ungrouped