helm/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 open Printf
  27 open GrafiteTypes
  28
  29   (** user hit the cancel button *)
  30 exception Cancel
  31
  32 type abouts =
  33   [ `Blank
  34   | `Current_proof
  35   | `Us
  36   ]
  37
  38 type mathViewer_entry =
  39   [ `About of abouts  (* current proof *)
  40   | `Check of string (* term *)
  41   | `Cic of Cic.term * Cic.metasenv
  42   | `Dir of string (* "directory" in cic uris namespace *)
  43   | `Uri of UriManager.uri (* cic object uri *)
  44   | `Whelp of string * UriManager.uri list (* query and results *)
  45   ]
  46
  47 let string_of_entry = function
  48   | `About `Blank -> "about:blank"
  49   | `About `Current_proof -> "about:proof"
  50   | `About `Us -> "about:us"
  51   | `Check _ -> "check:"
  52   | `Cic (_, _) -> "term:"
  53   | `Dir uri -> uri
  54   | `Uri uri -> UriManager.string_of_uri uri
  55   | `Whelp (query, _) -> query
  56
  57 let entry_of_string = function
  58   | "about:blank" -> `About `Blank
  59   | "about:proof" -> `About `Current_proof
  60   | "about:us"    -> `About `Us
  61   | _ ->  (* only about entries supported ATM *)
  62       raise (Invalid_argument "entry_of_string")
  63
  64 class type mathViewer =
  65   object
  66     (** @param reuse if set reused last opened cic browser otherwise
  67      *  opens a new one. default is false
  68      *)
  69     method show_entry: ?reuse:bool -> mathViewer_entry -> unit
  70     method show_uri_list:
  71       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
  72   end