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
  40 (* get_obj uri                                                                *)
  41 (* returns the cic object whose uri is uri. If the term is not just in cache, *)
  42 (* then it is parsed via CicParser.term_of_xml from the file whose name is    *)
  43 (* the result of Getter.get uri                                               *)
  44 val get_obj : UriManager.uri -> Cic.obj
  45
  46 type type_checked_obj =
  47    CheckedObj of Cic.obj    (* cooked obj *)
  48  | UncheckedObj of Cic.obj  (* uncooked obj *)
  49
  50 (* is_type_checked uri cookingsno                                   *)
  51 (*CSC commento falso ed obsoleto *)
  52 (* returns (true,object) if the object has been type-checked        *)
  53 (* otherwise it returns (false,object) and freeze the object for    *)
  54 (* type-checking                                                    *)
  55 (* set_type_checking_info must be called to unfreeze the object     *)
  56 val is_type_checked : ?trust:bool -> UriManager.uri -> type_checked_obj
  57
  58 (* set_type_checking_info uri                                         *)
  59 (* must be called once the type-checking of uri is finished           *)
  60 (* The object whose uri is uri is unfreezed and won't be type-checked *)
  61 (* again in the future (is_type_checked will return true)             *)
  62 val set_type_checking_info : UriManager.uri -> unit
  63
  64 (* get_cooked_obj ~trust uri                                        *)
  65 (* returns the object if it is already type-checked or if it can be *)
  66 (* trusted (if [trust] = true and the trusting function accepts it) *)
  67 (* Otherwise it raises Not_found                                    *)
  68 val get_cooked_obj : ?trust:bool -> UriManager.uri -> Cic.obj
  69
  70 (* FUNCTIONS USED ONLY IN THE TOPLEVEL/PROOF-ENGINE *)
  71
  72 exception OnlyPutOfInductiveDefinitionsIsAllowed
  73
  74 (* put_inductive_definition uri obj                                      *)
  75 (* put [obj] (that must be an InductiveDefinition and show URI is [uri]) *)
  76 (* in the environment.                                                   *)
  77 (* WARNING: VERY UNSAFE.                                                 *)
  78 (* This function should be called only on a well-typed definition.       *)
  79 val put_inductive_definition : UriManager.uri -> Cic.obj -> unit
  80
  81 (* (de)serialization *)
  82 val dump_to_channel : ?callback:(string -> unit) -> out_channel -> unit
  83 val restore_from_channel : ?callback:(string -> unit) -> in_channel -> unit
  84 val empty : unit -> unit
  85
  86 (* for filtering in tacticChaser *)
  87 (* NEW *)
  88 val in_cache : UriManager.uri -> bool