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 (*                                                                           *)
  46 (* ~not_jet_cooked returns the object even if it is not in the               *)
  47 (* CacheOfCookedObjects searching it in the frozen list.                     *)
  48 (* This is necessary in cicUnivUtils.ml since (in the univ_maker phase       *)
  49 (* it has to traverse object before they are committed.                      *)
  50 (* see the .ml file for some reassuring invariants on this.                  *)
  51 val get_obj :
  52   ?not_jet_cooked:bool -> UriManager.uri -> CicUniv.universe_graph ->
  53   Cic.obj * CicUniv.universe_graph
  54
  55 type type_checked_obj =
  56    CheckedObj of (Cic.obj * CicUniv.universe_graph)    (* cooked obj *)
  57  | UncheckedObj of Cic.obj  (* uncooked obj *)
  58
  59 (* is_type_checked uri cookingsno                                   *)
  60 (*CSC commento falso ed obsoleto *)
  61 (* returns (true,object) if the object has been type-checked        *)
  62 (* otherwise it returns (false,object) and freeze the object for    *)
  63 (* type-checking                                                    *)
  64 (* set_type_checking_info must be called to unfreeze the object     *)
  65 val is_type_checked :
  66   ?trust:bool -> UriManager.uri -> CicUniv.universe_graph -> type_checked_obj
  67
  68 (* set_type_checking_info uri                                         *)
  69 (* must be called once the type-checking of uri is finished           *)
  70 (* The object whose uri is uri is unfreezed and won't be type-checked *)
  71 (* again in the future (is_type_checked will return true)             *)
  72 (*                                                                    *)
  73 (* Since the universes are not exported directly, but generated       *)
  74 (* typecheking the library, we can't find them in the library as we   *)
  75 (* do for the types. This means that when we commit uris during       *)
  76 (* univ generation we can't associate the uri with the universe graph *)
  77 (* we find in the library, we have to calculate it and then inject it *)
  78 (* in the cacke. This is an orrible backdoor used by univ_maker.      *)
  79 (* see the .ml file for some reassuring invariants                    *)
  80 val set_type_checking_info :
  81   ?replace_ugraph:(CicUniv.universe_graph option) -> UriManager.uri -> unit
  82
  83 (* We need this in the Qed. *)
  84 val add_type_checked_term :
  85   UriManager.uri -> (Cic.obj * CicUniv.universe_graph) -> unit
  86
  87   (** remove a type checked term
  88   * @raise Term_not_found when given term is not in the environment
  89   * @raise Failure when remove_term is invoked while type checking *)
  90 val remove_term: UriManager.uri -> unit
  91
  92 (* get_cooked_obj ~trust uri                                        *)
  93 (* returns the object if it is already type-checked or if it can be *)
  94 (* trusted (if [trust] = true and the trusting function accepts it) *)
  95 (* Otherwise it raises Not_found                                    *)
  96 val get_cooked_obj :
  97   ?trust:bool -> UriManager.uri ->
  98    CicUniv.universe_graph -> Cic.obj * CicUniv.universe_graph
  99
 100 (* FUNCTIONS USED ONLY IN THE TOPLEVEL/PROOF-ENGINE *)
 101
 102 exception OnlyPutOfInductiveDefinitionsIsAllowed
 103
 104 (* put_inductive_definition uri obj                                      *)
 105 (* put [obj] (that must be an InductiveDefinition and show URI is [uri]) *)
 106 (* in the environment.                                                   *)
 107 (* WARNING: VERY UNSAFE.                                                 *)
 108 (* This function should be called only on a well-typed definition.       *)
 109 val put_inductive_definition :
 110   UriManager.uri -> (Cic.obj * CicUniv.universe_graph) -> unit
 111
 112 (* (de)serialization *)
 113 val dump_to_channel : ?callback:(string -> unit) -> out_channel -> unit
 114 val restore_from_channel : ?callback:(string -> unit) -> in_channel -> unit
 115 val empty : unit -> unit
 116
 117 (** Set trust function. Per default this function is set to (fun _ -> true) *)
 118 val set_trust: (UriManager.uri -> bool) -> unit
 119
 120 (* for filtering in tacticChaser *)
 121 (* NEW *)
 122 val in_cache : UriManager.uri -> bool