helm/matita/matitaTypes.mli

   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 exception Cancel
  27 exception Statement_error of string
  28 val statement_error : string -> 'a
  29
  30 exception Command_error of string
  31 val command_error : string -> 'a
  32
  33 exception Option_error of string * string
  34 exception Unbound_identifier of string
  35
  36 type proof_status =
  37     No_proof
  38   | Incomplete_proof of ProofEngineTypes.status
  39   | Proof of ProofEngineTypes.proof
  40   | Intermediate of Cic.metasenv
  41
  42 module StringMap : Map.S with type key = String.t
  43
  44 type option_value =
  45   | String of string
  46   | Int of int
  47 type options = option_value StringMap.t
  48 val no_options : 'a StringMap.t
  49
  50 type status = {
  51   aliases: DisambiguateTypes.environment;   (** disambiguation aliases *)
  52   moo_content_rev: string list;(*CSC: GrafiteAst.command list would be better *)
  53   proof_status: proof_status;
  54   options: options;
  55   objects: (UriManager.uri * string) list;  (** in-scope objects, with paths *)
  56   notation_ids: CicNotation.notation_id list; (** in-scope notation ids *)
  57 }
  58
  59 val dump_status : status -> unit
  60 val get_option : status -> StringMap.key -> option_value
  61 val get_string_option : status -> StringMap.key -> string
  62 val set_option : status -> StringMap.key -> string -> status
  63
  64 class type console =
  65   object
  66     method choose_uri : string list -> string
  67     method clear : unit -> unit
  68     method echo_error : string -> unit
  69     method echo_message : string -> unit
  70     method show : ?msg:string -> unit -> unit
  71     method wrap_exn : (unit -> 'a) -> 'a option
  72   end
  73
  74 type abouts = [ `Blank | `Current_proof | `Us ]
  75
  76 type mathViewer_entry =
  77   [ `About of abouts
  78   | `Check of string
  79   | `Cic of Cic.term * Cic.metasenv
  80   | `Dir of string
  81   | `Uri of UriManager.uri
  82   | `Whelp of string * UriManager.uri list ]
  83
  84 val string_of_entry :
  85   [< `About of [< `Blank | `Current_proof | `Us ]
  86    | `Check of 'a
  87    | `Cic of 'b * 'c
  88    | `Dir of string
  89    | `Uri of UriManager.uri
  90    | `Whelp of string * 'd ] ->
  91   string
  92
  93 val entry_of_string :
  94   string -> [> `About of [> `Blank | `Current_proof | `Us ] ]
  95
  96 class type mathViewer =
  97   object
  98     method show_entry : ?reuse:bool -> mathViewer_entry -> unit
  99     method show_uri_list :
 100       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
 101   end