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 (*                          ^^^^^^                                          *)
  35 (* objects. Uses the getter (getter.ml) and the parser (cicParser.ml)       *)
  36 (*                                                                          *)
  37 (****************************************************************************)
  38
  39 exception CircularDependency of string;;
  40 exception Object_not_found of UriManager.uri;;
  41
  42 (* as the get cooked, but if not present the object is only fetched,
  43  * not unfreezed and committed
  44  * @raise Object_not_found
  45  *)
  46 val get_obj :
  47   CicUniv.universe_graph -> UriManager.uri ->
  48     Cic.obj * CicUniv.universe_graph
  49
  50 type type_checked_obj =
  51    CheckedObj of (Cic.obj * CicUniv.universe_graph)    (* cooked obj *)
  52  | UncheckedObj of Cic.obj  (* uncooked obj *)
  53
  54 (*
  55  * I think this should be the real semantic:
  56  *
  57  * val is_type_checked:
  58  *  ?trust:bool -> UriManager.uri -> bool
  59  *
  60  *  but the old semantic is similar to get_cooked_obj, but
  61  *  returns an unchecked object intead of a Not_found
  62  *)
  63 val is_type_checked :
  64   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->
  65     type_checked_obj
  66
  67 (* set_type_checking_info uri                                         *)
  68 (* must be called once the type-checking of uri is finished           *)
  69 (* The object whose uri is uri is unfreezed and won't be type-checked *)
  70 (* again in the future (is_type_checked will return true)             *)
  71 (*                                                                    *)
  72 (* Since the universes are not exported directly, but generated       *)
  73 (* typecheking the library, we can't find them in the library as we   *)
  74 (* do for the types. This means that when we commit uris during       *)
  75 (* univ generation we can't associate the uri with the universe graph *)
  76 (* we find in the library, we have to calculate it and then inject it *)
  77 (* in the cacke. This is an orrible backdoor used by univ_maker.      *)
  78 (* see the .ml file for some reassuring invariants                    *)
  79 val set_type_checking_info :
  80   ?replace_ugraph:(CicUniv.universe_graph option) -> UriManager.uri -> unit
  81
  82 (* We need this in the Qed. *)
  83 val add_type_checked_term :
  84   UriManager.uri -> (Cic.obj * CicUniv.universe_graph) -> unit
  85
  86   (** remove a type checked term
  87   * @raise Term_not_found when given term is not in the environment
  88   * @raise Failure when remove_term is invoked while type checking *)
  89 val remove_term: UriManager.uri -> unit
  90
  91 (* get_cooked_obj ~trust uri                                        *)
  92 (* returns the object if it is already type-checked or if it can be *)
  93 (* trusted (if [trust] = true and the trusting function accepts it) *)
  94 (* Otherwise it raises Not_found                                    *)
  95 val get_cooked_obj :
  96   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->
  97     Cic.obj * CicUniv.universe_graph
  98
  99 (* FUNCTIONS USED ONLY IN THE TOPLEVEL/PROOF-ENGINE *)
 100
 101 exception OnlyPutOfInductiveDefinitionsIsAllowed
 102
 103 (* put_inductive_definition uri obj                                      *)
 104 (* put [obj] (that must be an InductiveDefinition and show URI is [uri]) *)
 105 (* in the environment.                                                   *)
 106 (* WARNING: VERY UNSAFE.                                                 *)
 107 (* This function should be called only on a well-typed definition.       *)
 108 val put_inductive_definition :
 109   UriManager.uri -> (Cic.obj * CicUniv.universe_graph) -> unit
 110
 111 (* (de)serialization *)
 112 val dump_to_channel : ?callback:(string -> unit) -> out_channel -> unit
 113 val restore_from_channel : ?callback:(string -> unit) -> in_channel -> unit
 114 val empty : unit -> unit
 115
 116 (** Set trust function. Per default this function is set to (fun _ -> true) *)
 117 val set_trust: (UriManager.uri -> bool) -> unit
 118
 119   (** @return true for objects currently cooked/frozend/unchecked, false
 120   * otherwise (i.e. objects already parsed from XML) *)
 121 val in_cache : UriManager.uri -> bool
 122
 123 (* to debug the matitac batch compiler *)
 124 val list_obj: unit -> (UriManager.uri * Cic.obj * CicUniv.universe_graph) list
 125 val list_uri: unit -> UriManager.uri list
 126
 127   (** @return true for objects available in the library *)
 128 val in_library: UriManager.uri -> bool
 129
 130 (* EOF *)