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