1 (* Copyright (C) 2004-2005, HELM Team.
3 * This file is part of HELM, an Hypertextual, Electronic
4 * Library of Mathematics, developed at the Computer Science
5 * Department, University of Bologna, Italy.
7 * HELM is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * HELM is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with HELM; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
27 exception Statement_error of string
28 val statement_error : string -> 'a
30 exception Command_error of string
31 val command_error : string -> 'a
33 exception Option_error of string * string
34 exception Unbound_identifier of string
36 type incomplete_proof = {
37 proof: ProofEngineTypes.proof;
38 stack: Continuationals.Stack.t;
43 | Incomplete_proof of incomplete_proof
44 | Proof of ProofEngineTypes.proof
45 | Intermediate of Cic.metasenv
47 module StringMap : Map.S with type key = String.t
52 type options = option_value StringMap.t
53 val no_options : 'a StringMap.t
55 type ast_command = (CicNotationPt.term, CicNotationPt.obj) GrafiteAst.command
56 type moo = ast_command list * GrafiteAst.metadata list (** <moo, metadata> *)
59 aliases: DisambiguateTypes.environment; (** disambiguation aliases *)
60 multi_aliases: DisambiguateTypes.multiple_environment;
62 proof_status: proof_status; (** logical status *)
64 objects: (UriManager.uri * string) list; (** in-scope objects, with paths *)
65 coercions: UriManager.uri list; (** defined coercions *)
66 notation_ids: CicNotation.notation_id list; (** in-scope notation ids *)
69 val set_metasenv: Cic.metasenv -> status -> status
71 (** list is not reversed, head command will be the first emitted *)
72 val add_moo_content: ast_command list -> status -> status
73 val add_moo_metadata: GrafiteAst.metadata list -> status -> status
75 val dump_status : status -> unit
76 val get_option : status -> StringMap.key -> option_value
77 val get_string_option : status -> StringMap.key -> string
78 val set_option : status -> StringMap.key -> string -> status
82 method choose_uri : string list -> string
83 method clear : unit -> unit
84 method echo_error : string -> unit
85 method echo_message : string -> unit
86 method show : ?msg:string -> unit -> unit
87 method wrap_exn : (unit -> 'a) -> 'a option
90 type abouts = [ `Blank | `Current_proof | `Us ]
92 type mathViewer_entry =
95 | `Cic of Cic.term * Cic.metasenv
97 | `Uri of UriManager.uri
98 | `Whelp of string * UriManager.uri list ]
100 val string_of_entry :
101 [< `About of [< `Blank | `Current_proof | `Us ]
105 | `Uri of UriManager.uri
106 | `Whelp of string * 'd ] ->
109 val entry_of_string :
110 string -> [> `About of [> `Blank | `Current_proof | `Us ] ]
112 class type mathViewer =
114 method show_entry : ?reuse:bool -> mathViewer_entry -> unit
115 method show_uri_list :
116 ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
119 val qualify: status -> string -> string
121 val get_current_proof: status -> ProofEngineTypes.proof
122 val get_proof_metasenv: status -> Cic.metasenv
123 val get_proof_context: status -> ProofEngineTypes.goal -> Cic.context
124 val get_proof_conclusion: status -> ProofEngineTypes.goal -> Cic.term
125 val get_stack: status -> Continuationals.Stack.t
127 val set_stack: Continuationals.Stack.t -> status -> status