helm/software/matita/matitaTypes.ml

   1 (* Copyright (C) 2004-2005, HELM Team.
   2  *
   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.
   6  *
   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.
  11  *
  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.
  16  *
  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,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 (* $Id$ *)
  27
  28 open Printf
  29 open GrafiteTypes
  30
  31   (** user hit the cancel button *)
  32 exception Cancel
  33
  34 type abouts =
  35   [ `Blank
  36   | `Current_proof
  37   | `Us
  38   | `Coercions
  39   | `CoercionsFull
  40   | `TeX
  41   | `Grammar
  42   ]
  43
  44 type mathViewer_entry =
  45   [ `About of abouts  (* current proof *)
  46   | `Check of string  (* term *)
  47   | `Cic of Cic.term * Cic.metasenv
  48   | `Dir of string  (* "directory" in cic uris namespace *)
  49   | `HBugs of [ `Tutors ] (* list of available HBugs tutors *)
  50   | `Metadata of [ `Deps of [`Fwd | `Back] * UriManager.uri ]
  51   | `Uri of UriManager.uri (* cic object uri *)
  52   | `NRef of NReference.reference (* cic object uri *)
  53   | `Whelp of string * UriManager.uri list (* query and results *)
  54   | `Univs of UriManager.uri
  55   ]
  56
  57 let string_of_entry = function
  58   | `About `Blank -> "about:blank"
  59   | `About `Current_proof -> "about:proof"
  60   | `About `Us -> "about:us"
  61   | `About `Coercions -> "about:coercions?tred=true"
  62   | `About `CoercionsFull -> "about:coercions"
  63   | `About `TeX -> "about:tex"
  64   | `About `Grammar -> "about:grammar"
  65   | `Check _ -> "check:"
  66   | `Cic (_, _) -> "term:"
  67   | `Dir uri -> uri
  68   | `HBugs `Tutors -> "hbugs:/tutors/"
  69   | `Metadata meta ->
  70       "metadata:/" ^
  71       (match meta with
  72       | `Deps (dir, uri) ->
  73           "deps/" ^
  74           let suri =
  75             let suri = UriManager.string_of_uri uri in
  76             let len = String.length suri in
  77             String.sub suri 4 (len - 4) in (* strip "cic:" prefix *)
  78           (match dir with | `Fwd -> "forward" | `Back -> "backward") ^ suri)
  79   | `Uri uri -> UriManager.string_of_uri uri
  80   | `NRef nref -> NReference.string_of_reference nref
  81   | `Whelp (query, _) -> query
  82   | `Univs uri -> "univs:" ^ UriManager.string_of_uri uri
  83
  84 let entry_of_string = function
  85   | "about:blank" -> `About `Blank
  86   | "about:proof" -> `About `Current_proof
  87   | "about:us"    -> `About `Us
  88   | "about:coercions?tred=true"    -> `About `Coercions
  89   | "about:coercions"    -> `About `CoercionsFull
  90   | "about:tex"    -> `About `TeX
  91   | "about:grammar"    -> `About `Grammar
  92   | _ ->  (* only about entries supported ATM *)
  93       raise (Invalid_argument "entry_of_string")
  94
  95 class type mathViewer =
  96   object
  97     (** @param reuse if set reused last opened cic browser otherwise
  98      *  opens a new one. default is false
  99      *)
 100     method show_entry: ?reuse:bool -> mathViewer_entry -> unit
 101     method show_uri_list:
 102       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
 103   end