matita/matita/matitacLib.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 open Printf
  29
  30 open GrafiteTypes
  31
  32 exception AttemptToInsertAnAlias of LexiconEngine.status
  33
  34 let slash_n_RE = Pcre.regexp "\\n" ;;
  35
  36 let pp_ast_statement grafite_status stm =
  37   let stm = GrafiteAstPp.pp_statement
  38     ~map_unicode_to_tex:(Helm_registry.get_bool "matita.paste_unicode_as_tex")
  39     ~term_pp:NotationPp.pp_term
  40     ~lazy_term_pp:NotationPp.pp_term ~obj_pp:(NotationPp.pp_obj
  41     NotationPp.pp_term) stm
  42   in
  43   let stm = Pcre.replace ~rex:slash_n_RE stm in
  44   let stm =
  45       if String.length stm > 50 then String.sub stm 0 50 ^ " ..."
  46       else stm
  47   in
  48     HLog.debug ("Executing: ``" ^ stm ^ "''")
  49 ;;
  50
  51 let clean_exit baseuri rc =
  52   LibraryClean.clean_baseuris ~verbose:false [baseuri]; rc
  53 ;;
  54
  55 let dump f =
  56    let module G = GrafiteAst in
  57    let module L = LexiconAst in
  58    let module H = HExtlib in
  59    let floc = H.dummy_floc in
  60    let nl_ast = G.Comment (floc, G.Note (floc, "")) in
  61    let pp_statement stm =
  62      GrafiteAstPp.pp_statement ~term_pp:NotationPp.pp_term
  63        ~map_unicode_to_tex:(Helm_registry.get_bool
  64          "matita.paste_unicode_as_tex")
  65        ~lazy_term_pp:NotationPp.pp_term
  66        ~obj_pp:(NotationPp.pp_obj NotationPp.pp_term) stm
  67    in
  68    let pp_lexicon = LexiconAstPp.pp_command in
  69    let och = open_out f in
  70    let nl () =  output_string och (pp_statement nl_ast) in
  71    MatitaMisc.out_preamble och;
  72    let grafite_parser_cb = function
  73       | G.Executable (loc, G.Command (_, G.Include (_, false, _, _))) -> ()
  74       | stm ->
  75          output_string och (pp_statement stm); nl (); nl ()
  76    in
  77    let lexicon_parser_cb cmd =
  78          output_string och (pp_lexicon cmd); nl (); nl ()
  79    in
  80    begin fun () ->
  81       Helm_registry.set_bool "matita.moo" false;
  82       GrafiteParser.set_grafite_callback grafite_parser_cb;
  83       GrafiteParser.set_lexicon_callback lexicon_parser_cb
  84    end,
  85    begin fun x ->
  86       close_out och;
  87       GrafiteParser.set_grafite_callback (fun _ -> ());
  88       GrafiteParser.set_lexicon_callback (fun _ -> ());
  89       Helm_registry.set_bool "matita.moo" true;
  90       x
  91    end
  92 ;;
  93
  94 let get_macro_context = function _ -> []
  95 ;;
  96
  97 let pp_times fname rc big_bang big_bang_u big_bang_s =
  98   if not (Helm_registry.get_bool "matita.verbose") then
  99     let { Unix.tms_utime = u ; Unix.tms_stime = s} = Unix.times () in
 100     let r = Unix.gettimeofday () -. big_bang in
 101     let u = u -. big_bang_u in
 102     let s = s -. big_bang_s in
 103     let extra = try Sys.getenv "BENCH_EXTRA_TEXT" with Not_found -> "" in
 104     let rc,rcascii =
 105       if rc then "\e[0;32mOK\e[0m","Ok" else "\e[0;31mFAIL\e[0m","Fail" in
 106     let times =
 107       let fmt t =
 108         let seconds = int_of_float t in
 109         let cents = int_of_float ((t -. floor t) *. 100.0) in
 110         let minutes = seconds / 60 in
 111         let seconds = seconds mod 60 in
 112         Printf.sprintf "%dm%02d.%02ds" minutes seconds cents
 113       in
 114       Printf.sprintf "%s %s %s" (fmt r) (fmt u) (fmt s)
 115     in
 116     let s = Printf.sprintf "%-4s %s %s" rc times extra in
 117     print_endline s;
 118     flush stdout;
 119     HLog.message ("Compilation of "^Filename.basename fname^": "^rc)
 120 ;;
 121
 122 let cut prefix s =
 123   let lenp = String.length prefix in
 124   let lens = String.length s in
 125   assert (lens > lenp);
 126   assert (String.sub s 0 lenp = prefix);
 127   String.sub s lenp (lens-lenp)
 128 ;;
 129
 130 let get_include_paths options =
 131   let include_paths =
 132     try List.assoc "include_paths" options with Not_found -> ""
 133   in
 134   let include_paths = Str.split (Str.regexp " ") include_paths in
 135   let include_paths =
 136     include_paths @
 137     Helm_registry.get_list Helm_registry.string "matita.includes"
 138   in
 139     include_paths
 140 ;;
 141
 142 let activate_extraction baseuri fname =
 143   ()
 144   (* MATITA 1.0
 145  if Helm_registry.get_bool "matita.extract" then
 146   let mangled_baseuri =
 147    let baseuri = String.sub baseuri 5 (String.length baseuri - 5) in
 148      let baseuri = Pcre.replace ~pat:"/" ~templ:"_" baseuri in
 149       String.uncapitalize baseuri in
 150   let f =
 151     open_out
 152      (Filename.dirname fname ^ "/" ^ mangled_baseuri ^ ".ml") in
 153    LibrarySync.add_object_declaration_hook
 154     (fun ~add_obj ~add_coercion _ obj ->
 155       output_string f (CicExportation.ppobj baseuri obj);
 156       flush f; []);
 157       *)
 158 ;;
 159
 160 let compile atstart options fname =
 161   let matita_debug = Helm_registry.get_bool "matita.debug" in
 162   let include_paths = get_include_paths options in
 163   let root,baseuri,fname,_tgt =
 164     Librarian.baseuri_of_script ~include_paths fname in
 165   if Http_getter_storage.is_read_only baseuri then assert false;
 166   activate_extraction baseuri fname ;
 167   let lexicon_status =
 168     CicNotation2.load_notation ~include_paths:[] (new LexiconEngine.status)
 169       BuildTimeConf.core_notation_script
 170   in
 171   atstart (); (* FG: do not invoke before loading the core notation script *)
 172   let grafite_status = GrafiteSync.init lexicon_status baseuri in
 173   let big_bang = Unix.gettimeofday () in
 174   let { Unix.tms_utime = big_bang_u ; Unix.tms_stime = big_bang_s} =
 175     Unix.times ()
 176   in
 177   let time = Unix.time () in
 178   try
 179     (* sanity checks *)
 180     let moo_fname =
 181      LibraryMisc.obj_file_of_baseuri ~must_exist:false ~baseuri ~writable:true
 182     in
 183     let lexicon_fname=
 184      LibraryMisc.lexicon_file_of_baseuri
 185        ~must_exist:false ~baseuri ~writable:true
 186     in
 187     (* cleanup of previously compiled objects *)
 188     if (not (Http_getter_storage.is_empty ~local:true baseuri))
 189       then begin
 190       HLog.message ("baseuri " ^ baseuri ^ " is not empty");
 191       HLog.message ("cleaning baseuri " ^ baseuri);
 192       LibraryClean.clean_baseuris [baseuri];
 193     end;
 194     HLog.message ("compiling " ^ Filename.basename fname ^ " in " ^ baseuri);
 195     if not (Helm_registry.get_bool "matita.verbose") then
 196       (let cc =
 197         let rex = Str.regexp ".*opt$" in
 198         if Str.string_match rex Sys.argv.(0) 0 then "matitac.opt"
 199         else "matitac"
 200       in
 201       let s = Printf.sprintf "%s %-35s " cc (cut (root^"/") fname) in
 202       print_string s; flush stdout);
 203     (* we dalay this error check until we print 'matitac file ' *)
 204     assert (Http_getter_storage.is_empty ~local:true baseuri);
 205     (* create dir for XML files *)
 206     if not (Helm_registry.get_opt_default Helm_registry.bool "matita.nodisk"
 207               ~default:false)
 208     then
 209       HExtlib.mkdir
 210         (Filename.dirname
 211           (Http_getter.filename ~local:true ~writable:true (baseuri ^
 212           "foo.con")));
 213     let buf = Ulexing.from_utf8_channel (open_in fname) in
 214     let print_cb =
 215       if not (Helm_registry.get_bool "matita.verbose") then (fun _ _ -> ())
 216       else pp_ast_statement
 217     in
 218     let grafite_status =
 219      let rec aux_for_dump x grafite_status =
 220      try
 221       match
 222        MatitaEngine.eval_from_stream ~first_statement_only:false ~include_paths
 223         grafite_status buf x
 224       with
 225       | [] -> grafite_status
 226       | (g,None)::_ -> g
 227       | (g,Some _)::_ ->
 228          raise (AttemptToInsertAnAlias (g :> LexiconEngine.status))
 229      with MatitaEngine.EnrichedWithStatus
 230             (GrafiteEngine.Macro (floc, f), grafite) as exn ->
 231             match f (get_macro_context (Some grafite)) with
 232             | _, GrafiteAst.Inline (_, _suri, _params) ->
 233 (*
 234               let str =
 235                ApplyTransformation.txt_of_inline_macro style prefix suri
 236                 ?flavour
 237                 ~map_unicode_to_tex:(Helm_registry.get_bool
 238                   "matita.paste_unicode_as_tex")
 239               in
 240               !out str;
 241 *)
 242               aux_for_dump x grafite
 243             |_-> raise exn
 244      in
 245        aux_for_dump print_cb grafite_status
 246     in
 247     let elapsed = Unix.time () -. time in
 248     let moo_content_rev,lexicon_content_rev =
 249       grafite_status#moo_content_rev,
 250        grafite_status#lstatus.LexiconEngine.lexicon_content_rev
 251     in
 252      (if Helm_registry.get_bool "matita.moo" then begin
 253         (* FG: we do not generate .moo when dumping .mma files *)
 254         GrafiteMarshal.save_moo moo_fname moo_content_rev;
 255         LexiconMarshal.save_lexicon lexicon_fname lexicon_content_rev;
 256         NCicLibrary.Serializer.serialize ~baseuri:(NUri.uri_of_string baseuri)
 257          grafite_status#dump
 258      end;
 259      let tm = Unix.gmtime elapsed in
 260      let sec = string_of_int tm.Unix.tm_sec ^ "''" in
 261      let min =
 262        if tm.Unix.tm_min > 0 then (string_of_int tm.Unix.tm_min^"' ") else ""
 263      in
 264      let hou =
 265        if tm.Unix.tm_hour > 0 then (string_of_int tm.Unix.tm_hour^"h ") else ""
 266      in
 267      HLog.message
 268        (sprintf "execution of %s completed in %s." fname (hou^min^sec));
 269      pp_times fname true big_bang big_bang_u big_bang_s;
 270 (*
 271      LexiconSync.time_travel
 272        ~present:lexicon_status ~past:initial_lexicon_status;
 273 *)
 274      true)
 275   with
 276   (* all exceptions should be wrapped to allow lexicon-undo (LS.time_travel) *)
 277   | AttemptToInsertAnAlias lexicon_status ->
 278      pp_times fname false big_bang big_bang_u big_bang_s;
 279 (*
 280      LexiconSync.time_travel
 281        ~present:lexicon_status ~past:initial_lexicon_status;
 282 *)
 283      clean_exit baseuri false
 284   | MatitaEngine.EnrichedWithStatus (exn, _grafite) as exn' ->
 285       (match exn with
 286       | Sys.Break -> HLog.error "user break!"
 287       | HExtlib.Localized (floc,CicNotationParser.Parse_error err) ->
 288           let (x, y) = HExtlib.loc_of_floc floc in
 289           HLog.error (sprintf "Parse error at %d-%d: %s" x y err)
 290       | exn when matita_debug -> raise exn'
 291       | exn -> HLog.error (snd (MatitaExcPp.to_string exn))
 292       );
 293 (*       LexiconSync.time_travel ~present:lexicon ~past:initial_lexicon_status;
 294  *       *)
 295       pp_times fname false big_bang big_bang_u big_bang_s;
 296       clean_exit baseuri false
 297   | Sys.Break when not matita_debug ->
 298      HLog.error "user break!";
 299      pp_times fname false big_bang big_bang_u big_bang_s;
 300      clean_exit baseuri false
 301   | exn when not matita_debug ->
 302        HLog.error
 303          ("Unwrapped exception, please fix: "^ snd (MatitaExcPp.to_string exn));
 304        pp_times fname false big_bang big_bang_u big_bang_s;
 305        clean_exit baseuri false
 306
 307 module F =
 308   struct
 309     type source_object = string
 310     type target_object = string
 311     let string_of_source_object s = s;;
 312     let string_of_target_object s = s;;
 313
 314     let is_readonly_buri_of opts file =
 315      let buri = List.assoc "baseuri" opts in
 316      Http_getter_storage.is_read_only (Librarian.mk_baseuri buri file)
 317     ;;
 318
 319     let root_and_target_of opts mafile =
 320       try
 321         let include_paths = get_include_paths opts in
 322         let root,baseuri,_,relpath =
 323           Librarian.baseuri_of_script ~include_paths mafile
 324         in
 325         let obj_writeable, obj_read_only =
 326            if Filename.check_suffix mafile ".mma" then
 327               Filename.chop_suffix mafile ".mma" ^ ".ma",
 328               Filename.chop_suffix mafile ".mma" ^ ".ma"
 329            else
 330               LibraryMisc.obj_file_of_baseuri
 331                         ~must_exist:false ~baseuri ~writable:true,
 332               LibraryMisc.obj_file_of_baseuri
 333                         ~must_exist:false ~baseuri ~writable:false
 334         in
 335         Some root, relpath, obj_writeable, obj_read_only
 336       with Librarian.NoRootFor x -> None, "", "", ""
 337     ;;
 338
 339     let mtime_of_source_object s =
 340       try Some (Unix.stat s).Unix.st_mtime
 341       with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = s -> None
 342     ;;
 343
 344     let mtime_of_target_object s =
 345       try Some (Unix.stat s).Unix.st_mtime
 346       with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = s -> None
 347     ;;
 348
 349 (* FG: a problem was noticed in relising memory between subsequent *)
 350 (*     invocations of the compiler. The following might help       *)
 351     let compact r = Gc.compact (); r
 352
 353     let build options fname =
 354       let matita_debug = Helm_registry.get_bool "matita.debug" in
 355       let compile atstart opts fname =
 356         try
 357           GrafiteSync.push ();
 358           GrafiteParser.push ();
 359           let rc = compile atstart opts fname in
 360           GrafiteParser.pop ();
 361           GrafiteSync.pop ();
 362           rc
 363         with
 364         | Sys.Break ->
 365             GrafiteParser.pop ();
 366             GrafiteSync.pop ();
 367             false
 368         | exn when not matita_debug ->
 369             HLog.error ("Unexpected " ^ snd(MatitaExcPp.to_string exn));
 370             assert false
 371       in
 372       if Filename.check_suffix fname ".mma" then
 373          let generated = Filename.chop_suffix fname ".mma" ^ ".ma" in
 374          let atstart, atexit = dump generated in
 375          let res = compile atstart options fname in
 376          let r = compact (atexit res) in
 377          if r then r else begin
 378 (*            Sys.remove generated; *)
 379             Printf.printf "rm %s\n" generated; flush stdout; r
 380          end
 381       else
 382          compact (compile ignore options fname)
 383     ;;
 384
 385     let load_deps_file = Librarian.load_deps_file;;
 386
 387   end
 388
 389 module Make = Librarian.Make(F)
 390