helm/software/components/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 Lazy.t;;
  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  *)
  45 val get_obj :
  46   CicUniv.universe_graph -> UriManager.uri ->
  47     Cic.obj * CicUniv.universe_graph
  48
  49 type type_checked_obj =
  50  | CheckedObj of (Cic.obj * CicUniv.universe_graph)
  51  | UncheckedObj of Cic.obj * (CicUniv.universe_graph * CicUniv.universe list) option
  52
  53 val is_type_checked :
  54   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->
  55     type_checked_obj
  56
  57 (* set_type_checking_info uri                                         *)
  58 (* must be called once the type-checking of uri is finished           *)
  59 (* The object whose uri is uri is unfreezed and won't be type-checked *)
  60 (* again in the future (is_type_checked will return true)             *)
  61 (*                                                                    *)
  62 (* WARNING: THIS FUNCTION MUST BE CALLED ONLY BY CicTypeChecker       *)
  63 val set_type_checking_info : UriManager.uri ->
  64   (Cic.obj * CicUniv.universe_graph * CicUniv.universe list) -> unit
  65
  66 (* this function is called by CicTypeChecker.typecheck_obj to add to the *)
  67 (* environment a new well typed object that is not yet in the library    *)
  68 (* WARNING: THIS FUNCTION MUST BE CALLED ONLY BY CicTypeChecker *)
  69 val add_type_checked_obj :
  70   UriManager.uri ->
  71   (Cic.obj * CicUniv.universe_graph * CicUniv.universe list) -> unit
  72
  73   (** remove a type checked object
  74   * @raise Object_not_found when given term is not in the environment
  75   * @raise Failure when remove_term is invoked while type checking *)
  76 val remove_obj: UriManager.uri -> unit
  77
  78 (* get_cooked_obj ~trust uri                                        *)
  79 (* returns the object if it is already type-checked or if it can be *)
  80 (* trusted (if [trust] = true and the trusting function accepts it) *)
  81 (* Otherwise it raises Not_found                                    *)
  82 val get_cooked_obj :
  83   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->
  84     Cic.obj * CicUniv.universe_graph
  85
  86 (* get_cooked_obj_with_univlist ~trust uri                          *)
  87 (* returns the object if it is already type-checked or if it can be *)
  88 (* trusted (if [trust] = true and the trusting function accepts it) *)
  89 (* Otherwise it raises Not_found                                    *)
  90 val get_cooked_obj_with_univlist :
  91   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->
  92     Cic.obj * CicUniv.universe_graph * CicUniv.universe list
  93
  94 (* FUNCTIONS USED ONLY IN THE TOPLEVEL/PROOF-ENGINE *)
  95
  96 (* (de)serialization *)
  97 val dump_to_channel : ?callback:(string -> unit) -> out_channel -> unit
  98 val restore_from_channel : ?callback:(string -> unit) -> in_channel -> unit
  99 val empty : unit -> unit
 100
 101 (** Set trust function. Per default this function is set to (fun _ -> true) *)
 102 val set_trust: (UriManager.uri -> bool) -> unit
 103
 104   (** @return true for objects currently cooked/frozend/unchecked, false
 105   * otherwise (i.e. objects already parsed from XML) *)
 106 val in_cache : UriManager.uri -> bool
 107
 108 (* to debug the matitac batch compiler *)
 109 val list_obj: unit -> (UriManager.uri * Cic.obj * CicUniv.universe_graph) list
 110 val list_uri: unit -> UriManager.uri list
 111
 112   (** @return true for objects available in the library *)
 113 val in_library: UriManager.uri -> bool
 114
 115   (** total parsing time, only to benchmark the parser *)
 116 val total_parsing_time: float ref
 117
 118 val invalidate: unit -> unit
 119
 120 (* EOF *)