1 (* Copyright (C) 2004, 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/
26 exception Not_implemented of string
27 let not_implemented feature = raise (Not_implemented feature)
29 (** exceptions whose content should be presented to the user *)
30 exception Failure of string
31 let error s = raise (Failure s)
32 let warning s = prerr_endline ("MATITA WARNING:\t" ^ s)
34 if BuildTimeConf.debug then prerr_endline ("MATITA DEBUG:\t" ^ s)
36 exception No_proof (** no current proof is available *)
38 let untitled_con_uri = UriManager.uri_of_string "cic:/untitled.con"
39 let untitled_def_uri = UriManager.uri_of_string "cic:/untitled.ind"
41 let unopt_uri ?(kind = `Con) = function
44 (match kind with `Con -> untitled_con_uri | `Def -> untitled_def_uri)
46 class type parserr = (* "parser" is a keyword :-( *)
48 method parseTerm: char Stream.t -> DisambiguateTypes.term
49 method parseTactical: char Stream.t -> DisambiguateTypes.tactical
52 class type disambiguator =
54 method parserr: parserr
55 method setParserr: parserr -> unit
57 method env: DisambiguateTypes.environment
58 method setEnv: DisambiguateTypes.environment -> unit
60 (* TODO Zack: as long as matita doesn't support MDI inteface,
61 * disambiguateTerm will return a single term *)
62 (** @param env disambiguation environment. If this parameter is given the
63 * disambiguator act statelessly, that is internal disambiguation status
64 * want be changed but only returned. If this parameter is not given the
65 * internal one will be used and updated with the disambiguation status
66 * resulting from the disambiguation *)
67 method disambiguateTerm:
68 ?context:Cic.context -> ?metasenv:Cic.metasenv ->
69 ?env:DisambiguateTypes.environment ->
71 (DisambiguateTypes.environment * Cic.metasenv * Cic.term)
72 (** @param env @see disambiguateTerm above *)
73 method disambiguateTermAst:
74 ?context:Cic.context -> ?metasenv:Cic.metasenv ->
75 ?env:DisambiguateTypes.environment ->
76 DisambiguateTypes.term ->
77 (DisambiguateTypes.environment * Cic.metasenv * Cic.term)
81 type sequents_metadata =
82 (int * (** sequent (meta) index *)
83 (Cic.annconjecture * (** annotated conjecture *)
84 (Cic.id, Cic.term) Hashtbl.t * (** ids_to_terms *)
85 (Cic.id, Cic.id option) Hashtbl.t * (** ids_to_father_ids *)
86 (Cic.id, string) Hashtbl.t * (** ids_to_inner_sorts *)
87 (Cic.id, Cic.hypothesis) Hashtbl.t)) (** ids_to_hypotheses *)
90 Cic.annobj * (** annotated object *)
91 (Cic.id, Cic.term) Hashtbl.t * (** ids_to_terms *)
92 (Cic.id, Cic.id option) Hashtbl.t * (** ids_to_father_ids *)
93 (Cic.id, string) Hashtbl.t * (** ids_to_inner_sorts *)
94 (Cic.id, Cic2acic.anntypes) Hashtbl.t * (** ids_to_inner_types *)
95 (Cic.id, Cic.conjecture) Hashtbl.t * (** ids_to_conjectures *)
96 (Cic.id, Cic.hypothesis) Hashtbl.t (** ids_to_hypotheses *)
97 type hist_metadata = proof_metadata * sequents_metadata
102 inherit [unit] StatefulProofEngine.status
104 (** return a pair of "xml" (as defined in Xml module) representing the *
105 * current proof type and body, respectively *)
106 method toXml: Xml.token Stream.t * Xml.token Stream.t
107 method toString: string
111 { get_proof: unit -> proof; (* return current proof or fail *)
112 set_proof: proof option -> unit;
113 abort_proof: unit -> unit;(* abort current proof, cleaning up garbage *)
114 has_proof: unit -> bool; (* check if a current proof is available or not *)
115 new_proof: proof -> unit; (* as a set_proof but takes care also to register
120 (** interpreter for toplevel phrases given via console *)
121 class type interpreter =
123 method reset: unit (** return the interpreter to the initial state *)
125 (** parse a single phrase contained in the input string. Additional
126 * garbage at the end of the phrase is ignored *)
127 method evalPhrase: string -> unit
130 (** eval zero or more phrases contained in the input string. Additional
131 * garbage contained at the end of the last phrase is ignored.
132 * @return offset from the beginning of the string pointing to the end of
133 * the last parsed phrase. Next invocations of evalAll should start from
135 method evalAll: string -> int
139 (** {2 MathML widgets} *)
141 type mml_of_cic_sequent =
142 Cic.metasenv -> Cic.conjecture ->
144 ((Cic.id, Cic.term) Hashtbl.t *
145 (Cic.id, Cic.id option) Hashtbl.t *
146 (string, Cic.hypothesis) Hashtbl.t)
148 type mml_of_cic_object =
149 explode_all:bool -> UriManager.uri -> Cic.annobj ->
150 (string, string) Hashtbl.t -> (string, Cic2acic.anntypes) Hashtbl.t ->
153 class type proof_viewer =
155 inherit GMathViewAux.single_selection_math_view
157 method load_proof: StatefulProofEngine.proof_status -> unit
160 class type sequent_viewer =
162 inherit GMathViewAux.multi_selection_math_view
164 (** @return the list of selected terms. Selections which are not terms are
166 method get_selected_terms: Cic.term list
168 (** @return the list of selected hypothese. Selections which are not
169 * hypotheses are ignored *)
170 method get_selected_hypotheses: Cic.hypothesis list
172 (** load a sequent and render it into parent widget *)
173 method load_sequent: Cic.metasenv -> int -> unit
176 class type sequents_viewer =
179 method load_sequents: Cic.metasenv -> unit
180 method goto_sequent: int -> unit (* to be called _after_ load_sequents *)
183 (** {2 shorthands} *)
185 type namer = ProofEngineTypes.mk_fresh_name_type
187 type choose_uris_callback =
188 selection_mode:[`MULTIPLE|`SINGLE] ->
189 ?title:string -> ?msg:string -> ?nonvars_button:bool ->
193 type choose_interp_callback = (string * string) list list -> int list