matitaB/components/ng_library/nCicLibrary.ml

   1 (*
   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.
   5     ||I||
   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_______________________________________________________________ *)
  11
  12 (* $Id$ *)
  13
  14 exception LibraryOutOfSync of string Lazy.t
  15 exception IncludedFileNotCompiled of string * string
  16
  17 let magic = 2;;
  18
  19 let refresh_uri uri = NUri.uri_of_string (NUri.string_of_uri uri);;
  20
  21 let refresh_uri_in_universe =
  22  List.map (fun (x,u) -> x, refresh_uri u)
  23 ;;
  24
  25 let refresh_uri_in_reference (NReference.Ref (uri,spec)) =
  26  NReference.reference_of_spec (refresh_uri uri) spec
  27
  28 let refresh_uri_in_term status =
  29  let rec aux =
  30   function
  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
  43 in
  44  aux
  45 ;;
  46
  47 let refresh_uri_in_obj status (uri,height,metasenv,subst,obj_kind) =
  48  assert (metasenv = []);
  49  assert (subst = []);
  50  refresh_uri uri,height,metasenv,subst,
  51   NCicUntrusted.map_obj_kind (refresh_uri_in_term status) obj_kind
  52 ;;
  53
  54 let ng_path_of_baseuri ?(no_suffix=false) user 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 = match user with
  58  | Some u -> "/" ^ u ^ path
  59  | _ -> path
  60  in
  61  let path = Helm_registry.get "matita.basedir" ^ path in
  62  let dirname = Filename.dirname path in
  63   HExtlib.mkdir dirname;
  64   if no_suffix then
  65    path
  66   else
  67    path ^ ".ng"
  68 ;;
  69
  70 let require_path path =
  71  let ch = open_in path in
  72  let mmagic,dump = Marshal.from_channel ch in
  73   close_in ch;
  74   if mmagic <> magic then
  75    raise (LibraryOutOfSync (lazy "The library is out of sync with the implementation. Please recompile the library."))
  76   else
  77    dump
  78 ;;
  79
  80 let require0 user ~baseuri = require_path (ng_path_of_baseuri user baseuri)
  81
  82 let db_path () = Helm_registry.get "matita.basedir" ^ "/ng_db.ng";;
  83
  84 type timestamp =
  85  [ `Obj of NUri.uri * NCic.obj
  86  | `Constr of NCic.universe * NCic.universe] list *
  87  (NUri.uri * string * NReference.reference) list
  88 ;;
  89
  90 let time0 = [],[];;
  91
  92 let load_db,set_global_aliases,get_global_aliases,add_deps,get_deps,remove_deps=
  93  let global_aliases = ref [] in
  94  let rev_includes_map = ref NUri.UriMap.empty in
  95  let store_db () =
  96   let ch = open_out (db_path ()) in
  97   Marshal.to_channel ch (magic,(!global_aliases,!rev_includes_map)) [];
  98   close_out ch in
  99  let load_db () =
 100   HExtlib.mkdir (Helm_registry.get "matita.basedir");
 101   try
 102    let ga,im = require_path (db_path ()) in
 103    let ga =
 104     List.map
 105      (fun (uri,name,NReference.Ref (uri2,spec)) ->
 106        refresh_uri uri,name,NReference.reference_of_spec (refresh_uri uri2) spec
 107      ) ga in
 108    let im =
 109     NUri.UriMap.fold
 110      (fun u l im -> NUri.UriMap.add (refresh_uri u) (List.map refresh_uri l) im
 111      ) im NUri.UriMap.empty
 112    in
 113     global_aliases := ga;
 114     rev_includes_map := im
 115   with
 116    Sys_error _ -> () in
 117  let get_deps u =
 118   let get_deps_one_step u =
 119     try NUri.UriMap.find u !rev_includes_map with Not_found -> [] in
 120   let rec aux res =
 121    function
 122       [] -> res
 123     | he::tl ->
 124        if List.mem he res then
 125         aux res tl
 126        else
 127         aux (he::res) (get_deps_one_step he @ tl)
 128   in
 129    aux [] [u] in
 130  let remove_deps u =
 131   rev_includes_map := NUri.UriMap.remove u !rev_includes_map;
 132   rev_includes_map :=
 133    NUri.UriMap.map
 134     (fun l -> List.filter (fun uri -> not (NUri.eq u uri)) l) !rev_includes_map;
 135   store_db ()
 136  in
 137   load_db,
 138   (fun ga -> global_aliases := ga; store_db ()),
 139   (fun () -> !global_aliases),
 140   (fun u l ->
 141     rev_includes_map := NUri.UriMap.add u (l @ get_deps u) !rev_includes_map;
 142     store_db ()),
 143   get_deps,
 144   remove_deps
 145 ;;
 146
 147 let init = load_db;;
 148
 149 type db = {
 150   storage :
 151     [ `Obj of NUri.uri * NCic.obj
 152     | `Constr of NCic.universe * NCic.universe] list ref;
 153   local_aliases :
 154     (NUri.uri * string * NReference.reference) list ref
 155 }
 156
 157 class type g_status =
 158   object
 159     method lib_db : db
 160   end
 161
 162 class virtual status uid =
 163  object
 164   inherit NCicEnvironment.status uid
 165
 166   val lib_db = {
 167     storage = ref [];
 168     local_aliases = ref []
 169   }
 170   method lib_db = lib_db
 171
 172   val timestamp = (time0 : timestamp)
 173   method timestamp = timestamp
 174
 175   method set_timestamp v = {< timestamp = v >}
 176   method set_lib_db v = {< lib_db = v >}
 177   method set_lib_status : 's.#g_status as 's -> 'self
 178    = fun o -> {< lib_db = o#lib_db >}
 179  end
 180
 181 let reset_timestamp st =
 182   st#lib_db.storage := [];
 183   st#lib_db.local_aliases := []
 184 ;;
 185
 186 let time_travel0 st (sto,ali) =
 187  let diff_len = List.length !(st#lib_db.storage) - List.length sto in
 188  let to_be_deleted,_ = HExtlib.split_nth diff_len !(st#lib_db.storage) in
 189   if List.length to_be_deleted > 0 then
 190    List.iter (NCicEnvironment.invalidate_item st) to_be_deleted;
 191   st#lib_db.storage := sto; st#lib_db.local_aliases := ali
 192 ;;
 193
 194 let time_travel status = time_travel0 status status#timestamp;;
 195
 196 type obj = string * Obj.t
 197 (* includes are transitively closed; dependencies are only immediate *)
 198 type dump =
 199  { objs: obj list ; includes: NUri.uri list; dependencies: string list }
 200
 201 class type g_dumpable_status =
 202  object
 203   method dump: dump
 204  end
 205
 206 (* uid = None --> single user mode *)
 207 class dumpable_status uid =
 208  object
 209   inherit NCicPp.status uid
 210   inherit status uid
 211
 212   val db = { objs = []; includes = []; dependencies = [] }
 213   method dump = db
 214   method set_dump v = {< db = v >}
 215   method set_dumpable_status
 216    : 'status. #g_dumpable_status as 'status -> 'self
 217    = fun o -> {< db = o#dump >}
 218  end
 219
 220 let get_transitively_included status =
 221  status#dump.includes
 222 ;;
 223
 224 let dump_obj status obj =
 225  status#set_dump {status#dump with objs = obj::status#dump.objs }
 226 ;;
 227
 228 module type SerializerType =
 229  sig
 230   type dumpable_status
 231
 232   type 'a register_type =
 233    'a ->
 234     refresh_uri_in_universe:(NCic.universe -> NCic.universe) ->
 235     refresh_uri_in_term:(NCicEnvironment.status -> NCic.term -> NCic.term) ->
 236     refresh_uri_in_reference:(NReference.reference -> NReference.reference) ->
 237     alias_only:bool ->
 238      dumpable_status -> dumpable_status
 239
 240   val register: < run: 'a.  string -> 'a register_type -> ('a -> obj) >
 241   val serialize: baseuri:NUri.uri -> dumpable_status -> unit
 242   val require:
 243    baseuri:NUri.uri -> fname:string -> alias_only:bool ->
 244     dumpable_status -> dumpable_status
 245   val dependencies_of: string option -> baseuri:NUri.uri -> string list
 246  end
 247
 248 module Serializer(D: sig type dumpable_s val get: dumpable_s -> dumpable_status
 249   val set: dumpable_s -> dumpable_status -> dumpable_s (*val user : dumpable_s ->
 250   string option*) end) =
 251  struct
 252   type dumpable_status = D.dumpable_s
 253   type 'a register_type =
 254    'a ->
 255     refresh_uri_in_universe:(NCic.universe -> NCic.universe) ->
 256     refresh_uri_in_term:(NCicEnvironment.status -> NCic.term -> NCic.term) ->
 257     refresh_uri_in_reference:(NReference.reference -> NReference.reference) ->
 258     alias_only:bool ->
 259      dumpable_status -> dumpable_status
 260
 261   let require1 = ref (fun ~alias_only:_ _ -> assert false) (* unknown data*)
 262   let already_registered = ref []
 263
 264   let register =
 265    object
 266     method run : 'a.  string -> 'a register_type -> ('a -> obj)
 267     = fun tag require ->
 268      assert (not (List.mem tag !already_registered));
 269      already_registered := tag :: !already_registered;
 270      let old_require1 = !require1 in
 271      prerr_endline "let old_require 1 superata";
 272      require1 :=
 273       (fun ~alias_only ((tag',data) as x) ->
 274         if tag=tag' then
 275                 (prerr_endline ("requiring tag': " ^ tag');
 276          require (Obj.magic data) ~refresh_uri_in_universe ~refresh_uri_in_term
 277           ~refresh_uri_in_reference ~alias_only)
 278         else
 279          old_require1 ~alias_only x);
 280      prerr_endline ("added require tag" ^ tag);
 281      (fun x -> tag,Obj.repr x)
 282    end
 283
 284   let serialize ~baseuri status =
 285    let ch = open_out (ng_path_of_baseuri (D.get status)#user baseuri) in
 286    Marshal.to_channel ch (magic,((D.get status)#dump.dependencies,(D.get status)#dump.objs)) [];
 287    close_out ch;
 288    let deps = String.concat ", " ((D.get status)#dump.dependencies) in
 289    prerr_endline ("dumping dependencies:\n" ^ deps ^ "\nend of deps");
 290    List.iter
 291     (function
 292      | `Obj (uri,obj) ->
 293          let ch = open_out (ng_path_of_baseuri (D.get status)#user uri) in
 294          Marshal.to_channel ch (magic,obj) [];
 295          close_out ch
 296      | `Constr _ -> ()
 297     ) !((D.get status)#lib_db.storage);
 298    set_global_aliases (!((D.get status)#lib_db.local_aliases) @ get_global_aliases ());
 299    List.iter (fun u -> add_deps u [baseuri]) (D.get status)#dump.includes;
 300    reset_timestamp (D.get status)
 301
 302   let require2 ~baseuri ~alias_only status =
 303    try
 304     let s = D.get status in
 305     let status =
 306      D.set status
 307       (s#set_dump
 308         {s#dump with
 309         includes = baseuri::List.filter ((<>) baseuri) s#dump.includes}) in
 310     let _dependencies,dump = require0 (D.get status)#user ~baseuri in
 311      List.fold_right (!require1 ~alias_only) dump status
 312    with
 313     Sys_error _ ->
 314      raise (IncludedFileNotCompiled(ng_path_of_baseuri (D.get status)#user baseuri,NUri.string_of_uri baseuri))
 315
 316   let dependencies_of user ~baseuri = fst (require0 user ~baseuri)
 317
 318   let record_include =
 319    let aux (baseuri,fname) ~refresh_uri_in_universe:_ ~refresh_uri_in_term:_
 320    ~refresh_uri_in_reference:_ ~alias_only status =
 321      let alias_only =
 322       alias_only || List.mem baseuri (get_transitively_included (D.get status))
 323      in
 324       HLog.warn ("include " ^ (if alias_only then "alias " else "") ^ fname);
 325       let status = require2 ~baseuri ~alias_only status in
 326       HLog.warn ("done: include " ^ (if alias_only then "alias " else "") ^ fname);
 327       status
 328    in
 329     register#run "include" aux
 330
 331   let require ~baseuri ~fname ~alias_only status =
 332    let alias_only =
 333     alias_only || List.mem baseuri (get_transitively_included (D.get status)) in
 334    let status =
 335     if not alias_only then
 336      let s = D.get status in
 337       D.set status
 338        (s#set_dump
 339          {s#dump with
 340            includes = baseuri::s#dump.includes;
 341            dependencies = fname::s#dump.dependencies})
 342     else
 343      status in
 344    let status = require2 ~baseuri ~alias_only status in
 345    let s = D.get status in
 346     D.set status
 347      (s#set_dump
 348        {s#dump with
 349          objs = record_include (baseuri,fname)::s#dump.objs })
 350 end
 351
 352 let fetch_obj user status uri =
 353  let obj = require0 user ~baseuri:uri in
 354   refresh_uri_in_obj status obj
 355 ;;
 356
 357 let resolve st name =
 358  try
 359   HExtlib.filter_map
 360    (fun (_,name',nref) -> if name'=name then Some nref else None)
 361    (!(st#lib_db.local_aliases) @ get_global_aliases ())
 362  with
 363   Not_found -> raise (NCicEnvironment.ObjectNotFound (lazy name))
 364 ;;
 365
 366 let aliases_of st uri =
 367   HExtlib.filter_map
 368    (fun (uri',_,nref) ->
 369      if NUri.eq uri' uri then Some nref else None) !(st#lib_db.local_aliases)
 370 ;;
 371
 372 let add_obj status ((u,_,_,_,_) as obj) =
 373  NCicEnvironment.check_and_add_obj status obj;
 374  status#lib_db.storage := (`Obj (u,obj))::!(status#lib_db.storage);
 375   let _,height,_,_,obj = obj in
 376   let references =
 377    match obj with
 378       NCic.Constant (_,name,None,_,_) ->
 379        [u,name,NReference.reference_of_spec u NReference.Decl]
 380     | NCic.Constant (_,name,Some _,_,_) ->
 381        [u,name,NReference.reference_of_spec u (NReference.Def height)]
 382     | NCic.Fixpoint (is_ind,fl,_) ->
 383        HExtlib.list_mapi
 384         (fun (_,name,recno,_,_) i ->
 385           if is_ind then
 386            u,name,NReference.reference_of_spec u(NReference.Fix(i,recno,height))
 387           else
 388            u,name,NReference.reference_of_spec u (NReference.CoFix i)) fl
 389     | NCic.Inductive (inductive,leftno,il,_) ->
 390        List.flatten
 391         (HExtlib.list_mapi
 392          (fun (_,iname,_,cl) i ->
 393            HExtlib.list_mapi
 394             (fun (_,cname,_) j->
 395               u,cname,
 396                NReference.reference_of_spec u (NReference.Con (i,j+1,leftno))
 397             ) cl @
 398            [u,iname,
 399              NReference.reference_of_spec u
 400               (NReference.Ind (inductive,i,leftno))]
 401          ) il)
 402   in
 403   status#lib_db.local_aliases := references @ !(status#lib_db.local_aliases);
 404   status#set_timestamp (!(status#lib_db.storage),!(status#lib_db.local_aliases))
 405 ;;
 406
 407 let add_constraint status u1 u2 =
 408   if
 409    List.exists
 410     (function `Constr (u1',u2') when u1=u1' && u2=u2' -> true | _ -> false)
 411     !(status#lib_db.storage)
 412   then
 413    (*CSC: raise an exception here! *)
 414    (prerr_endline "CANNOT ADD A CONSTRAINT TWICE"; assert false);
 415   NCicEnvironment.add_lt_constraint status u1 u2;
 416   status#lib_db.storage := (`Constr (u1,u2)) :: !(status#lib_db.storage);
 417   status#set_timestamp (!(status#lib_db.storage),!(status#lib_db.local_aliases))
 418 ;;
 419
 420 let get_obj status u =
 421 (*
 422  try
 423   List.assq u
 424    (HExtlib.filter_map
 425     (function `Obj (u,o) -> Some (u,o) | _ -> None )
 426     !(status#lib_db.storage))
 427  with Not_found ->*)
 428   try fetch_obj (status#user) status u
 429   with Sys_error _ ->
 430    raise (NCicEnvironment.ObjectNotFound (lazy (NUri.string_of_uri u)))
 431 ;;
 432
 433 NCicEnvironment.set_get_obj
 434   (get_obj :> NCicEnvironment.status -> NUri.uri -> NCic.obj);;