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/
31 (** user hit the cancel button *)
44 type mathViewer_entry =
45 [ `About of abouts (* current proof *)
46 | `Check of string (* term *)
47 | `Cic of Cic.term * Cic.metasenv
48 | `NCic of NCic.term * NCic.context * NCic.metasenv * NCic.substitution
49 | `Dir of string (* "directory" in cic uris namespace *)
50 | `HBugs of [ `Tutors ] (* list of available HBugs tutors *)
51 | `Metadata of [ `Deps of [`Fwd | `Back] * UriManager.uri ]
52 | `Uri of UriManager.uri (* cic object uri *)
53 | `NRef of NReference.reference (* cic object uri *)
54 | `Whelp of string * UriManager.uri list (* query and results *)
55 | `Univs of UriManager.uri
58 let string_of_entry = function
59 | `About `Blank -> "about:blank"
60 | `About `Current_proof -> "about:proof"
61 | `About `Us -> "about:us"
62 | `About `Coercions -> "about:coercions?tred=true"
63 | `About `CoercionsFull -> "about:coercions"
64 | `About `TeX -> "about:tex"
65 | `About `Grammar -> "about:grammar"
66 | `Check _ -> "check:"
67 | `Cic (_, _) -> "term:"
68 | `NCic (_, _, _, _) -> "nterm:"
70 | `HBugs `Tutors -> "hbugs:/tutors/"
77 let suri = UriManager.string_of_uri uri in
78 let len = String.length suri in
79 String.sub suri 4 (len - 4) in (* strip "cic:" prefix *)
80 (match dir with | `Fwd -> "forward" | `Back -> "backward") ^ suri)
81 | `Uri uri -> UriManager.string_of_uri uri
82 | `NRef nref -> NReference.string_of_reference nref
83 | `Whelp (query, _) -> query
84 | `Univs uri -> "univs:" ^ UriManager.string_of_uri uri
86 let entry_of_string = function
87 | "about:blank" -> `About `Blank
88 | "about:proof" -> `About `Current_proof
89 | "about:us" -> `About `Us
90 | "about:coercions?tred=true" -> `About `Coercions
91 | "about:coercions" -> `About `CoercionsFull
92 | "about:tex" -> `About `TeX
93 | "about:grammar" -> `About `Grammar
94 | _ -> (* only about entries supported ATM *)
95 raise (Invalid_argument "entry_of_string")
97 class type mathViewer =
99 (** @param reuse if set reused last opened cic browser otherwise
100 * opens a new one. default is false
102 method show_entry: ?reuse:bool -> mathViewer_entry -> unit
103 method show_uri_list:
104 ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
106 GrafiteTypes.status -> int * NCic.conjecture -> NCic.metasenv ->
107 NCic.substitution -> string -> unit