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 *)
41 type mathViewer_entry =
42 [ `About of abouts (* current proof *)
43 | `Check of string (* term *)
44 | `Cic of Cic.term * Cic.metasenv
45 | `Development of string
46 | `Dir of string (* "directory" in cic uris namespace *)
47 | `HBugs of [ `Tutors ] (* list of available HBugs tutors *)
48 | `Metadata of [ `Deps of [`Fwd | `Back] * UriManager.uri ]
49 | `Uri of UriManager.uri (* cic object uri *)
50 | `Whelp of string * UriManager.uri list (* query and results *)
53 let string_of_entry = function
54 | `About `Blank -> "about:blank"
55 | `About `Current_proof -> "about:proof"
56 | `About `Us -> "about:us"
57 | `About `Coercions -> "about:coercions"
58 | `Check _ -> "check:"
59 | `Cic (_, _) -> "term:"
60 | `Development d -> "devel:/" ^ d
62 | `HBugs `Tutors -> "hbugs:/tutors/"
69 let suri = UriManager.string_of_uri uri in
70 let len = String.length suri in
71 String.sub suri 4 (len - 4) in (* strip "cic:" prefix *)
72 (match dir with | `Fwd -> "forward" | `Back -> "backward") ^ suri)
73 | `Uri uri -> UriManager.string_of_uri uri
74 | `Whelp (query, _) -> query
76 let entry_of_string = function
77 | "about:blank" -> `About `Blank
78 | "about:proof" -> `About `Current_proof
79 | "about:us" -> `About `Us
80 | "about:coercions" -> `About `Coercions
81 | _ -> (* only about entries supported ATM *)
82 raise (Invalid_argument "entry_of_string")
84 class type mathViewer =
86 (** @param reuse if set reused last opened cic browser otherwise
87 * opens a new one. default is false
89 method show_entry: ?reuse:bool -> mathViewer_entry -> unit
91 ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit