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 incomplete_proof = {
  37   proof: ProofEngineTypes.proof;
  38   stack: Continuationals.Stack.t;
  39 }
  40
  41 type proof_status =
  42     No_proof
  43   | Incomplete_proof of incomplete_proof
  44   | Proof of ProofEngineTypes.proof
  45   | Intermediate of Cic.metasenv
  46
  47 module StringMap : Map.S with type key = String.t
  48
  49 type option_value =
  50   | String of string
  51   | Int of int
  52 type options = option_value StringMap.t
  53 val no_options : 'a StringMap.t
  54
  55 type ast_command = (CicNotationPt.term, GrafiteAst.obj) GrafiteAst.command
  56 type moo = ast_command list * GrafiteAst.metadata list  (** <moo, metadata> *)
  57
  58 type status = {
  59   aliases: DisambiguateTypes.environment;         (** disambiguation aliases *)
  60   multi_aliases: DisambiguateTypes.multiple_environment;
  61   moo_content_rev: moo;
  62   proof_status: proof_status;                             (** logical status *)
  63   options: options;
  64   objects: (UriManager.uri * string) list;  (** in-scope objects, with paths *)
  65   notation_ids: CicNotation.notation_id list;      (** in-scope notation ids *)
  66 }
  67
  68 val set_metasenv: Cic.metasenv -> status -> status
  69
  70   (** list is not reversed, head command will be the first emitted *)
  71 val add_moo_content: ast_command list -> status -> status
  72 val add_moo_metadata: GrafiteAst.metadata list -> status -> status
  73
  74 val dump_status : status -> unit
  75 val get_option : status -> StringMap.key -> option_value
  76 val get_string_option : status -> StringMap.key -> string
  77 val set_option : status -> StringMap.key -> string -> status
  78
  79 class type console =
  80   object
  81     method choose_uri : string list -> string
  82     method clear : unit -> unit
  83     method echo_error : string -> unit
  84     method echo_message : string -> unit
  85     method show : ?msg:string -> unit -> unit
  86     method wrap_exn : (unit -> 'a) -> 'a option
  87   end
  88
  89 type abouts = [ `Blank | `Current_proof | `Us ]
  90
  91 type mathViewer_entry =
  92   [ `About of abouts
  93   | `Check of string
  94   | `Cic of Cic.term * Cic.metasenv
  95   | `Dir of string
  96   | `Uri of UriManager.uri
  97   | `Whelp of string * UriManager.uri list ]
  98
  99 val string_of_entry :
 100   [< `About of [< `Blank | `Current_proof | `Us ]
 101    | `Check of 'a
 102    | `Cic of 'b * 'c
 103    | `Dir of string
 104    | `Uri of UriManager.uri
 105    | `Whelp of string * 'd ] ->
 106   string
 107
 108 val entry_of_string :
 109   string -> [> `About of [> `Blank | `Current_proof | `Us ] ]
 110
 111 class type mathViewer =
 112   object
 113     method show_entry : ?reuse:bool -> mathViewer_entry -> unit
 114     method show_uri_list :
 115       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
 116   end
 117
 118 val qualify: status -> string -> string
 119
 120 val get_current_proof: status -> ProofEngineTypes.proof
 121 val get_proof_metasenv: status ->  Cic.metasenv
 122 val get_proof_context: status -> ProofEngineTypes.goal -> Cic.context
 123 val get_proof_conclusion: status -> ProofEngineTypes.goal -> Cic.term
 124 val get_stack: status -> Continuationals.Stack.t
 125
 126 val set_stack: Continuationals.Stack.t -> status -> status
 127