helm/ocaml/library/librarySync.ml

   1 (* Copyright (C) 2004-2005, 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://helm.cs.unibo.it/
  24  *)
  25
  26 (* $Id$ *)
  27
  28 exception AlreadyDefined of UriManager.uri
  29
  30 let auxiliary_lemmas_hashtbl = UriManager.UriHashtbl.create 29
  31
  32 (* uri |-->  (derived_coercions_in_the_coercion_DB, derived_coercions_in_lib)
  33  *
  34  * in case of remove_coercion uri, the first component is removed from the
  35  * coercion DB, while the second is passed to remove_obj (and is not [] only if
  36  * add_coercion is called with add_composites
  37  * *)
  38 let coercion_hashtbl = UriManager.UriHashtbl.create 3
  39
  40 let merge_coercions obj =
  41   let module C = Cic in
  42   let rec aux2 = (fun (u,t) -> u,aux t)
  43   and aux = function
  44     | C.Rel _ | C.Sort _ as t -> t
  45     | C.Meta _ | C.Implicit _ -> assert false
  46     | C.Cast (te,ty) -> C.Cast (aux te, aux ty)
  47     | C.Prod (name,so,dest) ->
  48         C.Prod (name, aux so, aux dest)
  49     | C.Lambda (name,so,dest) ->
  50         C.Lambda (name, aux so, aux dest)
  51     | C.LetIn (name,so,dest) ->
  52         C.LetIn (name, aux so, aux dest)
  53     | (Cic.Appl [ c1 ; (Cic.Appl [c2; head]) ]) as t when
  54       CoercGraph.is_a_coercion c1 && CoercGraph.is_a_coercion c2 ->
  55         let source_carr = CoercGraph.source_of c2 in
  56         let tgt_carr = CoercGraph.target_of c1 in
  57         (match CoercGraph.look_for_coercion source_carr tgt_carr
  58         with
  59         | CoercGraph.SomeCoercion c -> Cic.Appl [ c ; head ]
  60         | _ -> assert false) (* the composite coercion must exist *)
  61     | C.Appl l -> C.Appl (List.map aux l)
  62     | C.Var (uri,exp_named_subst) ->
  63         let exp_named_subst = List.map aux2 exp_named_subst in
  64         C.Var (uri, exp_named_subst)
  65     | C.Const (uri,exp_named_subst) ->
  66         let exp_named_subst = List.map aux2 exp_named_subst in
  67         C.Const (uri, exp_named_subst)
  68     | C.MutInd (uri,tyno,exp_named_subst) ->
  69         let exp_named_subst = List.map aux2 exp_named_subst in
  70         C.MutInd (uri,tyno,exp_named_subst)
  71     | C.MutConstruct (uri,tyno,consno,exp_named_subst) ->
  72         let exp_named_subst = List.map aux2 exp_named_subst in
  73         C.MutConstruct (uri,tyno,consno,exp_named_subst)
  74     | C.MutCase (uri,tyno,out,te,pl) ->
  75         let pl = List.map aux pl in
  76         C.MutCase (uri,tyno,aux out,aux te,pl)
  77     | C.Fix (fno, fl) ->
  78         let fl = List.map (fun (name,idx,ty,bo)->(name,idx,aux ty,aux bo)) fl in
  79         C.Fix (fno, fl)
  80     | C.CoFix (fno, fl) ->
  81         let fl = List.map (fun (name,ty,bo) -> (name, aux ty, aux bo)) fl in
  82         C.CoFix (fno, fl)
  83   in
  84   match obj with
  85   | C.Constant (id, body, ty, params, attrs) ->
  86       let body =
  87         match body with
  88         | None -> None
  89         | Some body -> Some (aux body)
  90       in
  91       let ty = aux ty in
  92         C.Constant (id, body, ty, params, attrs)
  93   | C.Variable (name, body, ty, params, attrs) ->
  94       let body =
  95         match body with
  96         | None -> None
  97         | Some body -> Some (aux body)
  98       in
  99       let ty = aux ty in
 100         C.Variable (name, body, ty, params, attrs)
 101   | C.CurrentProof (_name, _conjectures, _body, _ty, _params, _attrs) ->
 102       assert false
 103   | C.InductiveDefinition (indtys, params, leftno, attrs) ->
 104       let indtys =
 105         List.map
 106           (fun (name, ind, arity, cl) ->
 107             let arity = aux arity in
 108             let cl = List.map (fun (name, ty) -> (name,aux ty)) cl in
 109             (name, ind, arity, cl))
 110           indtys
 111       in
 112         C.InductiveDefinition (indtys, params, leftno, attrs)
 113
 114 let uris_of_obj uri =
 115  let innertypesuri = UriManager.innertypesuri_of_uri uri in
 116  let bodyuri = UriManager.bodyuri_of_uri uri in
 117  let univgraphuri = UriManager.univgraphuri_of_uri uri in
 118   innertypesuri,bodyuri,univgraphuri
 119
 120 let paths_and_uris_of_obj uri ~basedir =
 121   let basedir = basedir ^ "/xml" in
 122   let innertypesuri, bodyuri, univgraphuri = uris_of_obj uri in
 123   let innertypesfilename = Str.replace_first (Str.regexp "^cic:") ""
 124         (UriManager.string_of_uri innertypesuri) ^ ".xml.gz" in
 125   let innertypespath = basedir ^ "/" ^ innertypesfilename in
 126   let xmlfilename = Str.replace_first (Str.regexp "^cic:/") ""
 127         (UriManager.string_of_uri uri) ^ ".xml.gz" in
 128   let xmlpath = basedir ^ "/" ^ xmlfilename in
 129   let xmlbodyfilename = Str.replace_first (Str.regexp "^cic:/") ""
 130         (UriManager.string_of_uri uri) ^ ".body.xml.gz" in
 131   let xmlbodypath = basedir ^ "/" ^  xmlbodyfilename in
 132   let xmlunivgraphfilename = Str.replace_first (Str.regexp "^cic:/") ""
 133         (UriManager.string_of_uri univgraphuri) ^ ".xml.gz" in
 134   let xmlunivgraphpath = basedir ^ "/" ^ xmlunivgraphfilename in
 135   xmlpath, xmlbodypath, innertypespath, bodyuri, innertypesuri,
 136   xmlunivgraphpath, univgraphuri
 137
 138 let save_object_to_disk ~basedir uri obj ugraph univlist =
 139   let ensure_path_exists path =
 140     let dir = Filename.dirname path in
 141     HExtlib.mkdir dir
 142   in
 143   (* generate annobj, ids_to_inner_sorts and ids_to_inner_types *)
 144   let annobj = Cic2acic.plain_acic_object_of_cic_object obj in
 145   (* prepare XML *)
 146   let xml, bodyxml =
 147    Cic2Xml.print_object
 148     uri ?ids_to_inner_sorts:None ~ask_dtd_to_the_getter:false annobj
 149   in
 150   let xmlpath, xmlbodypath, innertypespath, bodyuri, innertypesuri,
 151       xmlunivgraphpath, univgraphuri =
 152     paths_and_uris_of_obj uri basedir
 153   in
 154   List.iter HExtlib.mkdir (List.map Filename.dirname [xmlpath]);
 155   (* now write to disk *)
 156   ensure_path_exists xmlpath;
 157   Xml.pp ~gzip:true xml (Some xmlpath);
 158   CicUniv.write_xml_of_ugraph xmlunivgraphpath ugraph univlist;
 159   (* we return a list of uri,path we registered/created *)
 160   (uri,xmlpath) ::
 161   (univgraphuri,xmlunivgraphpath) ::
 162     (* now the optional body, both write and register *)
 163     (match bodyxml,bodyuri with
 164        None,None -> []
 165      | Some bodyxml,Some bodyuri->
 166          ensure_path_exists xmlbodypath;
 167          Xml.pp ~gzip:true bodyxml (Some xmlbodypath);
 168          [bodyuri, xmlbodypath]
 169      | _-> assert false)
 170
 171
 172 let typecheck_obj =
 173  let profiler = HExtlib.profile "add_obj.typecheck_obj" in
 174   fun uri obj -> profiler.HExtlib.profile (CicTypeChecker.typecheck_obj uri) obj
 175
 176 let index_obj =
 177  let profiler = HExtlib.profile "add_obj.index_obj" in
 178   fun ~dbd ~uri ->
 179    profiler.HExtlib.profile (fun uri -> MetadataDb.index_obj ~dbd ~uri) uri
 180
 181 let add_single_obj uri obj ~basedir =
 182   let obj =
 183     if List.mem `Generated (CicUtil.attributes_of_obj obj) &&
 184        not (CoercGraph.is_a_coercion (Cic.Const (uri, [])))
 185     then
 186       merge_coercions obj
 187     else
 188       obj
 189   in
 190   let dbd = LibraryDb.instance () in
 191   if CicEnvironment.in_library uri then
 192     raise (AlreadyDefined uri)
 193   else begin
 194     typecheck_obj uri obj; (* 1 *)
 195     let _, ugraph, univlist =
 196       CicEnvironment.get_cooked_obj_with_univlist CicUniv.empty_ugraph uri in
 197     try
 198       index_obj ~dbd ~uri; (* 2 must be in the env *)
 199       try
 200         (*3*)
 201         let new_stuff = save_object_to_disk ~basedir uri obj ugraph univlist in
 202         try
 203          HLog.message
 204           (Printf.sprintf "%s defined" (UriManager.string_of_uri uri))
 205         with exc ->
 206           List.iter HExtlib.safe_remove (List.map snd new_stuff); (* -3 *)
 207           raise exc
 208       with exc ->
 209         ignore(LibraryDb.remove_uri uri); (* -2 *)
 210         raise exc
 211     with exc ->
 212       CicEnvironment.remove_obj uri; (* -1 *)
 213     raise exc
 214   end
 215
 216 let remove_single_obj uri =
 217   let derived_uris_of_uri uri =
 218    let innertypesuri, bodyuri, univgraphuri = uris_of_obj uri in
 219     innertypesuri::univgraphuri::(match bodyuri with None -> [] | Some u -> [u])
 220   in
 221   let to_remove =
 222     uri ::
 223     (if UriManager.uri_is_ind uri then LibraryDb.xpointers_of_ind uri else []) @
 224     derived_uris_of_uri uri
 225   in
 226   List.iter
 227     (fun uri ->
 228       (try
 229         let file = Http_getter.resolve' uri in
 230          HExtlib.safe_remove file;
 231          HExtlib.rmdir_descend (Filename.dirname file)
 232       with Http_getter_types.Key_not_found _ -> ());
 233       ignore (LibraryDb.remove_uri uri);
 234       (*CoercGraph.remove_coercion uri;*)
 235       CicEnvironment.remove_obj uri)
 236   to_remove
 237
 238 (*** GENERATION OF AUXILIARY LEMMAS ***)
 239
 240 let generate_elimination_principles ~basedir uri =
 241   let uris = ref [] in
 242   let elim sort =
 243     try
 244       let uri,obj = CicElim.elim_of ~sort uri 0 in
 245        add_single_obj uri obj ~basedir;
 246        uris := uri :: !uris
 247     with CicElim.Can_t_eliminate -> ()
 248   in
 249   try
 250     List.iter elim [ Cic.Prop; Cic.Set; (Cic.Type (CicUniv.fresh ())) ];
 251     !uris
 252   with exn ->
 253    List.iter remove_single_obj !uris;
 254    raise exn
 255
 256 (* COERCIONS ***********************************************************)
 257
 258 let remove_all_coercions () =
 259   UriManager.UriHashtbl.clear coercion_hashtbl;
 260   CoercDb.remove_coercion (fun (_,_,u1) -> true)
 261
 262 let add_coercion ~basedir ~add_composites uri =
 263   let coer_ty,_ =
 264     let coer = CicUtil.term_of_uri uri in
 265     CicTypeChecker.type_of_aux' [] [] coer CicUniv.empty_ugraph
 266   in
 267   (* we have to get the source and the tgt type uri
 268    * in Coq syntax we have already their names, but
 269    * since we don't support Funclass and similar I think
 270    * all the coercion should be of the form
 271    * (A:?)(B:?)T1->T2
 272    * So we should be able to extract them from the coercion type
 273    *
 274    * Currently only (_:T1)T2 is supported.
 275    * should we saturate it with metas in case we insert it?
 276    *
 277    *)
 278   let extract_last_two_p ty =
 279     let rec aux = function
 280       | Cic.Prod( _, src, Cic.Prod (n,t1,t2)) ->
 281           assert false
 282           (* not implemented: aux (Cic.Prod(n,t1,t2)) *)
 283       | Cic.Prod( _, src, tgt) -> src, tgt
 284       | _ -> assert false
 285     in
 286     aux ty
 287   in
 288   let ty_src, ty_tgt = extract_last_two_p coer_ty in
 289   let src_uri = CoercDb.coerc_carr_of_term (CicReduction.whd [] ty_src) in
 290   let tgt_uri = CoercDb.coerc_carr_of_term (CicReduction.whd [] ty_tgt) in
 291   let new_coercions = CicCoercion.close_coercion_graph src_uri tgt_uri uri in
 292   let composite_uris = List.map (fun (_,_,uri,_) -> uri) new_coercions in
 293   (* update the DB *)
 294   List.iter
 295     (fun (src,tgt,uri,_) -> CoercDb.add_coercion (src,tgt,uri))
 296       new_coercions;
 297   CoercDb.add_coercion (src_uri, tgt_uri, uri);
 298   (* add the composites obj and they eventual lemmas *)
 299   let lemmas =
 300     if add_composites then
 301       List.fold_left
 302         (fun acc (_,_,uri,obj) ->
 303           add_single_obj ~basedir uri obj;
 304           uri::acc)
 305         composite_uris new_coercions
 306     else
 307       []
 308   in
 309   (* store that composite_uris are related to uri. the first component is the
 310    * stuff in the DB while the second is stuff for remove_obj *)
 311   UriManager.UriHashtbl.add coercion_hashtbl uri
 312     (composite_uris,if add_composites then composite_uris else []);
 313   lemmas
 314
 315 let remove_coercion uri =
 316   try
 317     let (composites_in_db, composites_in_lib) =
 318       UriManager.UriHashtbl.find coercion_hashtbl uri
 319     in
 320     UriManager.UriHashtbl.remove coercion_hashtbl uri;
 321     CoercDb.remove_coercion (fun (_,_,u) -> UriManager.eq uri u);
 322     (* remove from the DB *)
 323     List.iter
 324       (fun u -> CoercDb.remove_coercion (fun (_,_,u1) -> UriManager.eq u u1))
 325       composites_in_db;
 326     (* remove composites from the lib *)
 327     List.iter remove_single_obj composites_in_lib
 328   with
 329     Not_found -> () (* mhh..... *)
 330
 331
 332 let generate_projections ~basedir uri fields =
 333  let uris = ref [] in
 334  let projections = CicRecord.projections_of uri (List.map fst fields) in
 335   try
 336    List.iter2
 337     (fun (uri, name, bo) (_name, coercion) ->
 338       try
 339        let ty, ugraph =
 340          CicTypeChecker.type_of_aux' [] [] bo CicUniv.empty_ugraph in
 341        let attrs = [`Class `Projection; `Generated] in
 342        let obj = Cic.Constant (name,Some bo,ty,[],attrs) in
 343
 344         add_single_obj ~basedir uri obj;
 345         let composites =
 346          if coercion then
 347             add_coercion ~basedir ~add_composites:true uri
 348           else
 349             []
 350         in
 351         uris := uri :: composites @ !uris
 352       with
 353          CicTypeChecker.TypeCheckerFailure s ->
 354           HLog.message
 355            ("Unable to create projection " ^ name ^ " cause: " ^ Lazy.force s);
 356        | CicEnvironment.Object_not_found uri ->
 357           let depend = UriManager.name_of_uri uri in
 358            HLog.message
 359             ("Unable to create projection " ^ name ^ " because it requires " ^
 360                depend)
 361     ) projections fields;
 362    !uris
 363   with exn ->
 364    List.iter remove_single_obj !uris;
 365    raise exn
 366
 367
 368 let add_obj uri obj ~basedir =
 369  add_single_obj uri obj ~basedir;
 370  let uris = ref [] in
 371  try
 372   begin
 373    match obj with
 374     | Cic.Constant _ -> ()
 375     | Cic.InductiveDefinition (_,_,_,attrs) ->
 376         uris := !uris @ generate_elimination_principles ~basedir uri;
 377         let rec get_record_attrs =
 378           function
 379           | [] -> None
 380           | (`Class (`Record fields))::_ -> Some fields
 381           | _::tl -> get_record_attrs tl
 382         in
 383          (match get_record_attrs attrs with
 384          | None -> () (* not a record *)
 385          | Some fields ->
 386             uris := !uris @ (generate_projections ~basedir uri fields))
 387     | Cic.CurrentProof _
 388     | Cic.Variable _ -> assert false
 389   end;
 390   UriManager.UriHashtbl.add auxiliary_lemmas_hashtbl uri !uris;
 391   !uris
 392  with exn ->
 393   List.iter remove_single_obj !uris;
 394   raise exn
 395
 396 let remove_obj uri =
 397  let uris =
 398   try
 399    let res = UriManager.UriHashtbl.find auxiliary_lemmas_hashtbl uri in
 400     UriManager.UriHashtbl.remove auxiliary_lemmas_hashtbl uri;
 401     res
 402   with
 403     Not_found -> [] (*assert false*)
 404  in
 405   List.iter remove_single_obj (uri::uris)
 406