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 ast_command = (CicNotationPt.term, GrafiteAst.obj) GrafiteAst.command
  51 type moo = ast_command list * GrafiteAst.metadata list  (** <moo, metadata> *)
  52
  53 type status = {
  54   aliases: DisambiguateTypes.environment;         (** disambiguation aliases *)
  55   multi_aliases: DisambiguateTypes.multiple_environment;
  56   moo_content_rev: moo;
  57   proof_status: proof_status;                             (** logical status *)
  58   options: options;
  59   objects: (UriManager.uri * string) list;  (** in-scope objects, with paths *)
  60   notation_ids: CicNotation.notation_id list;      (** in-scope notation ids *)
  61 }
  62
  63 val set_metasenv: Cic.metasenv -> status -> status
  64
  65   (** list is not reversed, head command will be the first emitted *)
  66 val add_moo_content: ast_command list -> status -> status
  67 val add_moo_metadata: GrafiteAst.metadata list -> status -> status
  68
  69 val dump_status : status -> unit
  70 val get_option : status -> StringMap.key -> option_value
  71 val get_string_option : status -> StringMap.key -> string
  72 val set_option : status -> StringMap.key -> string -> status
  73
  74 class type console =
  75   object
  76     method choose_uri : string list -> string
  77     method clear : unit -> unit
  78     method echo_error : string -> unit
  79     method echo_message : string -> unit
  80     method show : ?msg:string -> unit -> unit
  81     method wrap_exn : (unit -> 'a) -> 'a option
  82   end
  83
  84 type abouts = [ `Blank | `Current_proof | `Us ]
  85
  86 type mathViewer_entry =
  87   [ `About of abouts
  88   | `Check of string
  89   | `Cic of Cic.term * Cic.metasenv
  90   | `Dir of string
  91   | `Uri of UriManager.uri
  92   | `Whelp of string * UriManager.uri list ]
  93
  94 val string_of_entry :
  95   [< `About of [< `Blank | `Current_proof | `Us ]
  96    | `Check of 'a
  97    | `Cic of 'b * 'c
  98    | `Dir of string
  99    | `Uri of UriManager.uri
 100    | `Whelp of string * 'd ] ->
 101   string
 102
 103 val entry_of_string :
 104   string -> [> `About of [> `Blank | `Current_proof | `Us ] ]
 105
 106 class type mathViewer =
 107   object
 108     method show_entry : ?reuse:bool -> mathViewer_entry -> unit
 109     method show_uri_list :
 110       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
 111   end