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   ]
  41
  42 type mathViewer_entry =
  43   [ `About of abouts  (* current proof *)
  44   | `Check of string  (* term *)
  45   | `Cic of Cic.term * Cic.metasenv
  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 *)
  51   ]
  52
  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?tred=true"
  58   | `About `CoercionsFull -> "about:coercions"
  59   | `Check _ -> "check:"
  60   | `Cic (_, _) -> "term:"
  61   | `Dir uri -> uri
  62   | `HBugs `Tutors -> "hbugs:/tutors/"
  63   | `Metadata meta ->
  64       "metadata:/" ^
  65       (match meta with
  66       | `Deps (dir, uri) ->
  67           "deps/" ^
  68           let suri =
  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
  75
  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?tred=true"    -> `About `Coercions
  81   | "about:coercions"    -> `About `CoercionsFull
  82   | _ ->  (* only about entries supported ATM *)
  83       raise (Invalid_argument "entry_of_string")
  84
  85 class type mathViewer =
  86   object
  87     (** @param reuse if set reused last opened cic browser otherwise
  88      *  opens a new one. default is false
  89      *)
  90     method show_entry: ?reuse:bool -> mathViewer_entry -> unit
  91     method show_uri_list:
  92       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
  93   end