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