helm/ocaml/cic_proof_checking/cicEnvironment.mli

   1 (* Copyright (C) 2000, 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://cs.unibo.it/helm/.
  24  *)
  25
  26 (******************************************************************************)
  27 (*                                                                            *)
  28 (*                               PROJECT HELM                                 *)
  29 (*                                                                            *)
  30 (*                Claudio Sacerdoti Coen <sacerdot@cs.unibo.it>               *)
  31 (*                                 24/01/2000                                 *)
  32 (*                                                                            *)
  33 (* This module implements a trival cache system (an hash-table) for cic       *)
  34 (* objects. Uses the getter (getter.ml) and the parser (cicParser.ml)         *)
  35 (*                                                                            *)
  36 (******************************************************************************)
  37
  38 exception CircularDependency of string;;
  39 exception Term_not_found of UriManager.uri;;
  40
  41 (* get_obj uri                                                                *)
  42 (* returns the cic object whose uri is uri. If the term is not just in cache, *)
  43 (* then it is parsed via CicParser.term_of_xml from the file whose name is    *)
  44 (* the result of Getter.get uri                                               *)
  45 val get_obj : UriManager.uri -> Cic.obj
  46
  47 type type_checked_obj =
  48    CheckedObj of Cic.obj    (* cooked obj *)
  49  | UncheckedObj of Cic.obj  (* uncooked obj *)
  50
  51 (* is_type_checked uri cookingsno                                   *)
  52 (*CSC commento falso ed obsoleto *)
  53 (* returns (true,object) if the object has been type-checked        *)
  54 (* otherwise it returns (false,object) and freeze the object for    *)
  55 (* type-checking                                                    *)
  56 (* set_type_checking_info must be called to unfreeze the object     *)
  57 val is_type_checked : ?trust:bool -> UriManager.uri -> type_checked_obj
  58
  59 (* set_type_checking_info uri                                         *)
  60 (* must be called once the type-checking of uri is finished           *)
  61 (* The object whose uri is uri is unfreezed and won't be type-checked *)
  62 (* again in the future (is_type_checked will return true)             *)
  63 val set_type_checking_info : UriManager.uri -> unit
  64
  65 (* We need this in the Qed. *)
  66 val add_type_checked_term : UriManager.uri -> Cic.obj -> unit
  67
  68   (** remove a type checked term
  69   * @raise Term_not_found when given term is not in the environment
  70   * @raise Failure when remove_term is invoked while type checking *)
  71 val remove_term: UriManager.uri -> unit
  72
  73 (* get_cooked_obj ~trust uri                                        *)
  74 (* returns the object if it is already type-checked or if it can be *)
  75 (* trusted (if [trust] = true and the trusting function accepts it) *)
  76 (* Otherwise it raises Not_found                                    *)
  77 val get_cooked_obj : ?trust:bool -> UriManager.uri -> Cic.obj
  78
  79 (* FUNCTIONS USED ONLY IN THE TOPLEVEL/PROOF-ENGINE *)
  80
  81 exception OnlyPutOfInductiveDefinitionsIsAllowed
  82
  83 (* put_inductive_definition uri obj                                      *)
  84 (* put [obj] (that must be an InductiveDefinition and show URI is [uri]) *)
  85 (* in the environment.                                                   *)
  86 (* WARNING: VERY UNSAFE.                                                 *)
  87 (* This function should be called only on a well-typed definition.       *)
  88 val put_inductive_definition : UriManager.uri -> Cic.obj -> unit
  89
  90 (* (de)serialization *)
  91 val dump_to_channel : ?callback:(string -> unit) -> out_channel -> unit
  92 val restore_from_channel : ?callback:(string -> unit) -> in_channel -> unit
  93 val empty : unit -> unit
  94
  95 (** Set trust function. Per default this function is set to (fun _ -> true) *)
  96 val set_trust: (UriManager.uri -> bool) -> unit
  97
  98 (* for filtering in tacticChaser *)
  99 (* NEW *)
 100 val in_cache : UriManager.uri -> bool