helm/ocaml/grafite2/grafiteTypes.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 Option_error of string * string
  27 exception Statement_error of string
  28 exception Command_error of string
  29
  30 type incomplete_proof = {
  31   proof: ProofEngineTypes.proof;
  32   stack: Continuationals.Stack.t;
  33 }
  34
  35 type proof_status =
  36     No_proof
  37   | Incomplete_proof of incomplete_proof
  38   | Proof of ProofEngineTypes.proof
  39   | Intermediate of Cic.metasenv
  40
  41 type option_value =
  42   | String of string
  43   | Int of int
  44 type options
  45 val no_options: options
  46
  47 type status = {
  48   aliases: DisambiguateTypes.environment;         (** disambiguation aliases *)
  49   multi_aliases: DisambiguateTypes.multiple_environment;
  50   moo_content_rev: GrafiteMarshal.moo;
  51   metadata: LibraryNoDb.metadata list;
  52   proof_status: proof_status;                             (** logical status *)
  53   options: options;
  54   objects: UriManager.uri list;  (** in-scope objects *)
  55   coercions: UriManager.uri list;                      (** defined coercions *)
  56   notation_ids: CicNotation.notation_id list;      (** in-scope notation ids *)
  57 }
  58
  59 val dump_status : status -> unit
  60
  61   (** list is not reversed, head command will be the first emitted *)
  62 val add_moo_content: GrafiteMarshal.ast_command list -> status -> status
  63 val add_metadata: LibraryNoDb.metadata list -> status -> status
  64
  65 val get_option : status -> string -> option_value
  66 val get_string_option : status -> string -> string
  67 val set_option : status -> string -> string -> status
  68
  69 val qualify: status -> string -> string
  70
  71 val get_current_proof: status -> ProofEngineTypes.proof
  72 val get_proof_metasenv: status ->  Cic.metasenv
  73 val get_stack: status -> Continuationals.Stack.t
  74 val get_proof_context : status -> int -> Cic.context
  75 val get_proof_conclusion : status -> int -> Cic.term
  76
  77 val set_stack: Continuationals.Stack.t -> status -> status
  78 val set_metasenv: Cic.metasenv -> status -> status