]> matita.cs.unibo.it Git - helm.git/blob - helm/software/components/cic_proof_checking/cicEnvironment.mli
e449ade4a83e4cceb6758d57bc26c03cd39ea813
[helm.git] / 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)    (* cooked obj *)
51  | UncheckedObj of Cic.obj  (* uncooked obj *)
52
53 (*
54  * I think this should be the real semantic:
55  * 
56  * val is_type_checked: 
57  *  ?trust:bool -> UriManager.uri -> bool
58  *
59  *  but the old semantic is similar to get_cooked_obj, but 
60  *  returns an unchecked object intead of a Not_found
61  *)
62 val is_type_checked : 
63   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->  
64     type_checked_obj
65
66 (* set_type_checking_info uri                                         *)
67 (* must be called once the type-checking of uri is finished           *)
68 (* The object whose uri is uri is unfreezed and won't be type-checked *)
69 (* again in the future (is_type_checked will return true)             *)
70 (*                                                                    *)
71 (* Since the universes are not exported directly, but generated       *)
72 (* typecheking the library, we can't find them in the library as we   *)
73 (* do for the types. This means that when we commit uris during       *)
74 (* univ generation we can't associate the uri with the universe graph *)
75 (* we find in the library, we have to calculate it and then inject it *)
76 (* in the cacke. This is an orrible backdoor used by univ_maker.      *)
77 (* see the .ml file for some reassuring invariants                    *)
78 (* WARNING: THIS FUNCTION MUST BE CALLED ONLY BY CicTypeChecker *)
79 val set_type_checking_info : 
80   ?replace_ugraph_and_univlist:
81     ((CicUniv.universe_graph * CicUniv.universe list) option) -> 
82     UriManager.uri -> unit
83
84 (* this function is called by CicTypeChecker.typecheck_obj to add to the *)
85 (* environment a new well typed object that is not yet in the library    *)
86 (* WARNING: THIS FUNCTION MUST BE CALLED ONLY BY CicTypeChecker *)
87 val add_type_checked_obj : 
88   UriManager.uri -> 
89   (Cic.obj * CicUniv.universe_graph * CicUniv.universe list) -> unit
90
91   (** remove a type checked object
92   * @raise Object_not_found when given term is not in the environment
93   * @raise Failure when remove_term is invoked while type checking *)
94 val remove_obj: UriManager.uri -> unit
95
96 (* get_cooked_obj ~trust uri                                        *)
97 (* returns the object if it is already type-checked or if it can be *)
98 (* trusted (if [trust] = true and the trusting function accepts it) *)
99 (* Otherwise it raises Not_found                                    *)
100 val get_cooked_obj : 
101   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->
102     Cic.obj * CicUniv.universe_graph
103
104 (* get_cooked_obj_with_univlist ~trust uri                          *)
105 (* returns the object if it is already type-checked or if it can be *)
106 (* trusted (if [trust] = true and the trusting function accepts it) *)
107 (* Otherwise it raises Not_found                                    *)
108 val get_cooked_obj_with_univlist : 
109   ?trust:bool -> CicUniv.universe_graph -> UriManager.uri ->
110     Cic.obj * CicUniv.universe_graph * CicUniv.universe list
111
112 (* FUNCTIONS USED ONLY IN THE TOPLEVEL/PROOF-ENGINE *)
113
114 (* (de)serialization *)
115 val dump_to_channel : ?callback:(string -> unit) -> out_channel -> unit
116 val restore_from_channel : ?callback:(string -> unit) -> in_channel -> unit
117 val empty : unit -> unit
118
119 (** Set trust function. Per default this function is set to (fun _ -> true) *)
120 val set_trust: (UriManager.uri -> bool) -> unit
121
122   (** @return true for objects currently cooked/frozend/unchecked, false
123   * otherwise (i.e. objects already parsed from XML) *)
124 val in_cache : UriManager.uri -> bool
125
126 (* to debug the matitac batch compiler *)
127 val list_obj: unit -> (UriManager.uri * Cic.obj * CicUniv.universe_graph) list
128 val list_uri: unit -> UriManager.uri list
129
130   (** @return true for objects available in the library *)
131 val in_library: UriManager.uri -> bool
132
133   (** total parsing time, only to benchmark the parser *)
134 val total_parsing_time: float ref
135
136 val invalidate: unit -> unit
137
138 (* EOF *)