2 ||M|| This file is part of HELM, an Hypertextual, Electronic
3 ||A|| Library of Mathematics, developed at the Computer Science
4 ||T|| Department, University of Bologna, Italy.
6 ||T|| HELM is free software; you can redistribute it and/or
7 ||A|| modify it under the terms of the GNU General Public License
8 \ / version 2 or (at your option) any later version.
9 \ / This software is distributed as is, NO WARRANTY.
10 V_______________________________________________________________ *)
14 exception LibraryOutOfSync of string Lazy.t
15 exception IncludedFileNotCompiled of string * string
19 let refresh_uri uri = NUri.uri_of_string (NUri.string_of_uri uri);;
21 let refresh_uri_in_universe =
22 List.map (fun (x,u) -> x, refresh_uri u)
25 let refresh_uri_in_reference (NReference.Ref (uri,spec)) =
26 NReference.reference_of_spec (refresh_uri uri) spec
28 let refresh_uri_in_term status =
31 | NCic.Meta (i,(n,NCic.Ctx l)) ->
32 NCic.Meta (i,(n,NCic.Ctx (List.map aux l)))
33 | NCic.Meta _ as t -> t
34 | NCic.Const ref -> NCic.Const (refresh_uri_in_reference ref)
35 | NCic.Sort (NCic.Type l) -> NCic.Sort (NCic.Type (refresh_uri_in_universe l))
36 | NCic.Match (NReference.Ref (uri,spec),outtype,term,pl) ->
37 let r = NReference.reference_of_spec (refresh_uri uri) spec in
38 let outtype = aux outtype in
39 let term = aux term in
40 let pl = List.map aux pl in
41 NCic.Match (r,outtype,term,pl)
42 | t -> NCicUtils.map status (fun _ _ -> ()) () (fun _ -> aux) t
47 let refresh_uri_in_obj status (uri,height,metasenv,subst,obj_kind) =
48 assert (metasenv = []);
50 refresh_uri uri,height,metasenv,subst,
51 NCicUntrusted.map_obj_kind (refresh_uri_in_term status) obj_kind
54 let ng_path_of_baseuri ?(no_suffix=false) baseuri =
55 let uri = NUri.string_of_uri baseuri in
56 let path = String.sub uri 4 (String.length uri - 4) in
57 let path = Helm_registry.get "matita.basedir" ^ path in
58 let dirname = Filename.dirname path in
59 HExtlib.mkdir dirname;
66 let require_path path =
67 let ch = open_in path in
68 let mmagic,dump = Marshal.from_channel ch in
70 if mmagic <> magic then
71 raise (LibraryOutOfSync (lazy "The library is out of sync with the implementation. Please recompile the library."))
76 let require0 ~baseuri = require_path (ng_path_of_baseuri baseuri)
78 let db_path () = Helm_registry.get "matita.basedir" ^ "/ng_db.ng";;
81 [ `Obj of NUri.uri * NCic.obj
82 | `Constr of NCic.universe * NCic.universe] list *
83 (NUri.uri * string * NReference.reference) list
87 let storage = ref [];;
88 let local_aliases = ref [];;
90 let load_db,set_global_aliases,get_global_aliases,add_deps,get_deps,remove_deps=
91 let global_aliases = ref [] in
92 let rev_includes_map = ref NUri.UriMap.empty in
94 let ch = open_out (db_path ()) in
95 Marshal.to_channel ch (magic,(!global_aliases,!rev_includes_map)) [];
98 HExtlib.mkdir (Helm_registry.get "matita.basedir");
100 let ga,im = require_path (db_path ()) in
103 (fun (uri,name,NReference.Ref (uri2,spec)) ->
104 refresh_uri uri,name,NReference.reference_of_spec (refresh_uri uri2) spec
108 (fun u l im -> NUri.UriMap.add (refresh_uri u) (List.map refresh_uri l) im
109 ) im NUri.UriMap.empty
111 global_aliases := ga;
112 rev_includes_map := im
116 let get_deps_one_step u =
117 try NUri.UriMap.find u !rev_includes_map with Not_found -> [] in
122 if List.mem he res then
125 aux (he::res) (get_deps_one_step he @ tl)
129 rev_includes_map := NUri.UriMap.remove u !rev_includes_map;
132 (fun l -> List.filter (fun uri -> not (NUri.eq u uri)) l) !rev_includes_map;
136 (fun ga -> global_aliases := ga; store_db ()),
137 (fun () -> !global_aliases),
139 rev_includes_map := NUri.UriMap.add u (l @ get_deps u) !rev_includes_map;
147 class virtual status =
150 val timestamp = (time0 : timestamp)
151 method timestamp = timestamp
152 method set_timestamp v = {< timestamp = v >}
155 let time_travel0 (sto,ali) =
156 let diff_len = List.length !storage - List.length sto in
157 let to_be_deleted,_ = HExtlib.split_nth diff_len !storage in
158 if List.length to_be_deleted > 0 then
159 List.iter NCicEnvironment.invalidate_item to_be_deleted;
160 storage := sto; local_aliases := ali
163 let time_travel status = time_travel0 status#timestamp;;
166 let sto,ali = status#timestamp in
167 storage := sto; local_aliases := ali
170 type obj = string * Obj.t
171 (* includes are transitively closed; dependencies are only immediate *)
173 { objs: obj list ; includes: NUri.uri list; dependencies: string list }
175 class type g_dumpable_status =
180 class dumpable_status =
182 val db = { objs = []; includes = []; dependencies = [] }
184 method set_dump v = {< db = v >}
185 method set_dumpable_status
186 : 'status. #g_dumpable_status as 'status -> 'self
187 = fun o -> {< db = o#dump >}
190 let get_transitively_included status =
194 let dump_obj status obj =
195 status#set_dump {status#dump with objs = obj::status#dump.objs }
198 let remove_objects ~baseuri =
199 let uri = NUri.string_of_uri baseuri in
200 let path = String.sub uri 4 (String.length uri - 4) in
201 let path = Helm_registry.get "matita.basedir" ^ path in
202 let map name = Sys.remove (Filename.concat path name) in
203 if HExtlib.is_dir path && HExtlib.is_regular (path ^ ".ng") then begin
204 HLog.warn ("removing contents of baseuri: " ^ uri);
205 Array.iter map (Sys.readdir path)
208 module type SerializerType =
212 type 'a register_type =
214 refresh_uri_in_universe:(NCic.universe -> NCic.universe) ->
215 refresh_uri_in_term:(NCic.status -> NCic.term -> NCic.term) ->
216 refresh_uri_in_reference:(NReference.reference -> NReference.reference) ->
218 dumpable_status -> dumpable_status
220 val register: < run: 'a. string -> 'a register_type -> ('a -> obj) >
221 val serialize: baseuri:NUri.uri -> dumpable_status -> unit
223 baseuri:NUri.uri -> fname:string -> alias_only:bool ->
224 dumpable_status -> dumpable_status
225 val dependencies_of: baseuri:NUri.uri -> string list
228 module Serializer(D: sig type dumpable_s = private #dumpable_status end) =
230 type dumpable_status = D.dumpable_s
231 type 'a register_type =
233 refresh_uri_in_universe:(NCic.universe -> NCic.universe) ->
234 refresh_uri_in_term:(NCic.status -> NCic.term -> NCic.term) ->
235 refresh_uri_in_reference:(NReference.reference -> NReference.reference) ->
237 dumpable_status -> dumpable_status
239 let require1 = ref (fun ~alias_only:_ _ -> assert false) (* unknown data*)
240 let already_registered = ref []
244 method run : 'a. string -> 'a register_type -> ('a -> obj)
246 assert (not (List.mem tag !already_registered));
247 already_registered := tag :: !already_registered;
248 let old_require1 = !require1 in
250 (fun ~alias_only ((tag',data) as x) ->
252 require (Obj.magic data) ~refresh_uri_in_universe ~refresh_uri_in_term
253 ~refresh_uri_in_reference ~alias_only
255 old_require1 ~alias_only x);
256 (fun x -> tag,Obj.repr x)
259 let serialize ~baseuri status =
260 let ch = open_out (ng_path_of_baseuri baseuri) in
261 Marshal.to_channel ch (magic,(status#dump.dependencies,status#dump.objs)) [];
264 remove_objects ~baseuri; (* FG: we remove the old objects before putting the new ones*)
269 let ch = open_out (ng_path_of_baseuri uri) in
270 Marshal.to_channel ch (magic,obj) [];
274 set_global_aliases (!local_aliases @ get_global_aliases ());
275 List.iter (fun u -> add_deps u [baseuri]) status#dump.includes;
278 let require2 ~baseuri ~alias_only status =
283 includes = baseuri::List.filter ((<>) baseuri) status#dump.includes} in
284 let _dependencies,dump = require0 ~baseuri in
285 List.fold_right (!require1 ~alias_only) dump status
288 raise (IncludedFileNotCompiled(ng_path_of_baseuri baseuri,NUri.string_of_uri baseuri))
290 let dependencies_of ~baseuri = fst (require0 ~baseuri)
293 let aux (baseuri,fname) ~refresh_uri_in_universe:_ ~refresh_uri_in_term:_
294 ~refresh_uri_in_reference:_ ~alias_only status =
295 let baseuri = refresh_uri baseuri in
296 if not alias_only && List.mem baseuri (get_transitively_included status) then status
298 (HLog.warn ("include " ^ (if alias_only then "alias " else "") ^ fname);
299 let status = require2 ~baseuri ~alias_only status in
300 HLog.warn ("done: include " ^ (if alias_only then "alias " else "") ^ fname);
303 register#run "include" aux
305 let require ~baseuri ~fname ~alias_only status =
306 if not alias_only && List.mem baseuri (get_transitively_included status) then status
309 if not alias_only then
311 {status#dump with dependencies = fname::status#dump.dependencies}
314 let status = require2 ~baseuri ~alias_only status in
317 objs = record_include (baseuri,fname)::status#dump.objs })
320 let fetch_obj status uri =
321 let obj = require0 ~baseuri:uri in
322 refresh_uri_in_obj status obj
328 (fun (_,name',nref) -> if name'=name then Some nref else None)
329 (!local_aliases @ get_global_aliases ())
331 Not_found -> raise (NCicEnvironment.ObjectNotFound (lazy name))
336 (fun (uri',_,nref) ->
337 if NUri.eq uri' uri then Some nref else None) !local_aliases
340 let add_obj status ((u,_,_,_,_) as orig_obj) =
341 NCicEnvironment.check_and_add_obj status orig_obj;
342 storage := (`Obj (u,orig_obj))::!storage;
343 let _,height,_,_,obj = orig_obj in
346 NCic.Constant (_,name,None,_,_) ->
347 [u,name,NReference.reference_of_spec u NReference.Decl]
348 | NCic.Constant (_,name,Some _,_,_) ->
349 [u,name,NReference.reference_of_spec u (NReference.Def height)]
350 | NCic.Fixpoint (is_ind,fl,_) ->
352 (fun (_,name,recno,_,_) i ->
354 u,name,NReference.reference_of_spec u(NReference.Fix(i,recno,height))
356 u,name,NReference.reference_of_spec u (NReference.CoFix i)) fl
357 | NCic.Inductive (inductive,leftno,il,_) ->
360 (fun (_,iname,_,cl) i ->
364 NReference.reference_of_spec u (NReference.Con (i,j+1,leftno))
367 NReference.reference_of_spec u
368 (NReference.Ind (inductive,i,leftno))]
371 local_aliases := references @ !local_aliases;
372 status#set_timestamp (!storage,!local_aliases)
375 let add_constraint status u1 u2 =
378 (function `Constr (u1',u2') when u1=u1' && u2=u2' -> true | _ -> false)
381 (*CSC: raise an exception here! *)
382 (prerr_endline "CANNOT ADD A CONSTRAINT TWICE"; assert false);
383 NCicEnvironment.add_lt_constraint u1 u2;
384 storage := (`Constr (u1,u2)) :: !storage;
385 status#set_timestamp (!storage,!local_aliases)
388 let get_obj status u =
392 (function `Obj (u,o) -> Some (u,o) | _ -> None )
395 try fetch_obj status u
397 raise (NCicEnvironment.ObjectNotFound (lazy (NUri.string_of_uri u)))
400 NCicEnvironment.set_get_obj get_obj