* new interface matitaTypes.mli

[helm.git] / helm / matita / matitaTypes.mli

diff --git a/helm/matita/matitaTypes.mli b/helm/matita/matitaTypes.mli
new file mode 100644 (file)
index 0000000..662dad6
--- /dev/null
+++ b/helm/matita/matitaTypes.mli
@@ -0,0 +1,100 @@
+(* Copyright (C) 2004-2005, HELM Team.
+ * 
+ * This file is part of HELM, an Hypertextual, Electronic
+ * Library of Mathematics, developed at the Computer Science
+ * Department, University of Bologna, Italy.
+ * 
+ * HELM is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ * 
+ * HELM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HELM; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA  02111-1307, USA.
+ * 
+ * For details, see the HELM World-Wide-Web page,
+ * http://helm.cs.unibo.it/
+ *)
+
+exception Cancel
+exception Statement_error of string
+val statement_error : string -> 'a
+
+exception Command_error of string
+val command_error : string -> 'a
+
+exception Option_error of string * string
+exception Unbound_identifier of string
+
+type proof_status =
+    No_proof
+  | Incomplete_proof of ProofEngineTypes.status
+  | Proof of ProofEngineTypes.proof
+  | Intermediate of Cic.metasenv
+
+module StringMap : Map.S with type key = String.t
+
+type option_value =
+  | String of string
+  | Int of int
+type options = option_value StringMap.t
+val no_options : 'a StringMap.t
+
+type status = {
+  aliases : DisambiguateTypes.environment;
+  moo_content_rev : string list;
+  proof_status : proof_status;
+  options : options;
+  objects : (UriManager.uri * string) list;
+}
+
+val dump_status : status -> unit
+val get_option : status -> StringMap.key -> option_value
+val get_string_option : status -> StringMap.key -> string
+val set_option : status -> StringMap.key -> string -> status
+
+class type console =
+  object
+    method choose_uri : string list -> string
+    method clear : unit -> unit
+    method echo_error : string -> unit
+    method echo_message : string -> unit
+    method show : ?msg:string -> unit -> unit
+    method wrap_exn : (unit -> 'a) -> 'a option
+  end
+
+type abouts = [ `Blank | `Current_proof | `Us ]
+
+type mathViewer_entry =
+  [ `About of abouts
+  | `Check of string
+  | `Cic of Cic.term * Cic.metasenv
+  | `Dir of string
+  | `Uri of UriManager.uri
+  | `Whelp of string * UriManager.uri list ]
+
+val string_of_entry :
+  [< `About of [< `Blank | `Current_proof | `Us ]
+   | `Check of 'a
+   | `Cic of 'b * 'c
+   | `Dir of string
+   | `Uri of UriManager.uri
+   | `Whelp of string * 'd ] ->
+  string
+
+val entry_of_string :
+  string -> [> `About of [> `Blank | `Current_proof | `Us ] ]
+
+class type mathViewer =
+  object
+    method show_entry : ?reuse:bool -> mathViewer_entry -> unit
+    method show_uri_list :
+      ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
+  end