matitaB/matita/matitaEngine.ml

   1 (* Copyright (C) 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 module G = GrafiteAst
  29 open GrafiteTypes
  30 open Printf
  31
  32 class status baseuri =
  33  object
  34   inherit GrafiteTypes.status baseuri
  35   inherit ApplyTransformation.status
  36  end
  37
  38 exception TryingToAdd of string Lazy.t
  39 exception EnrichedWithStatus of exn * status
  40 exception AlreadyLoaded of string Lazy.t
  41 exception FailureCompiling of string * exn
  42 exception CircularDependency of string
  43
  44 let debug = false ;;
  45 let debug_print = if debug then prerr_endline else ignore ;;
  46
  47 let slash_n_RE = Pcre.regexp "\\n" ;;
  48
  49 let pp_ast_statement status stm =
  50   let stm = GrafiteAstPp.pp_statement status stm
  51     ~map_unicode_to_tex:(Helm_registry.get_bool "matita.paste_unicode_as_tex")
  52   in
  53   let stm = Pcre.replace ~rex:slash_n_RE stm in
  54   let stm =
  55       if String.length stm > 50 then String.sub stm 0 50 ^ " ..."
  56       else stm
  57   in
  58     HLog.debug ("Executing: ``" ^ stm ^ "''")
  59 ;;
  60
  61 let clean_exit baseuri exn =
  62   LibraryClean.clean_baseuris ~verbose:false [baseuri];
  63   raise (FailureCompiling (baseuri,exn))
  64 ;;
  65
  66
  67 let pp_times fname rc big_bang big_bang_u big_bang_s =
  68   if not (Helm_registry.get_bool "matita.verbose") then
  69     let { Unix.tms_utime = u ; Unix.tms_stime = s} = Unix.times () in
  70     let r = Unix.gettimeofday () -. big_bang in
  71     let u = u -. big_bang_u in
  72     let s = s -. big_bang_s in
  73     let extra = try Sys.getenv "BENCH_EXTRA_TEXT" with Not_found -> "" in
  74     let rc,rcascii =
  75       if rc then "\e[0;32mOK\e[0m","Ok" else "\e[0;31mFAIL\e[0m","Fail" in
  76     let times =
  77       let fmt t =
  78         let seconds = int_of_float t in
  79         let cents = int_of_float ((t -. floor t) *. 100.0) in
  80         let minutes = seconds / 60 in
  81         let seconds = seconds mod 60 in
  82         Printf.sprintf "%dm%02d.%02ds" minutes seconds cents
  83       in
  84       Printf.sprintf "%s %s %s" (fmt r) (fmt u) (fmt s)
  85     in
  86     let s = Printf.sprintf "%-4s %s %s" rc times extra in
  87     print_endline s;
  88     flush stdout;
  89     HLog.message ("Compilation of "^Filename.basename fname^": "^rc)
  90 ;;
  91
  92 let cut prefix s =
  93   let lenp = String.length prefix in
  94   let lens = String.length s in
  95   assert (lens > lenp);
  96   assert (String.sub s 0 lenp = prefix);
  97   String.sub s lenp (lens-lenp)
  98 ;;
  99
 100 let activate_extraction baseuri fname =
 101   ()
 102   (* MATITA 1.0
 103  if Helm_registry.get_bool "matita.extract" then
 104   let mangled_baseuri =
 105    let baseuri = String.sub baseuri 5 (String.length baseuri - 5) in
 106      let baseuri = Pcre.replace ~pat:"/" ~templ:"_" baseuri in
 107       String.uncapitalize baseuri in
 108   let f =
 109     open_out
 110      (Filename.dirname fname ^ "/" ^ mangled_baseuri ^ ".ml") in
 111    LibrarySync.add_object_declaration_hook
 112     (fun ~add_obj ~add_coercion _ obj ->
 113       output_string f (CicExportation.ppobj baseuri obj);
 114       flush f; []);
 115       *)
 116 ;;
 117
 118
 119 let eval_ast ~include_paths ?do_heavy_checks status (text,prefix_len,ast) =
 120  let baseuri = status#baseuri in
 121  (*
 122  let new_aliases,new_status =
 123   GrafiteDisambiguate.eval_with_new_aliases status
 124    (fun status ->
 125      GrafiteEngine.eval_ast ~include_paths ?do_heavy_checks status
 126       (text,prefix_len,ast)) in
 127  *)
 128  let new_status =
 129    GrafiteEngine.eval_ast ~include_paths ?do_heavy_checks status
 130     (text,prefix_len,ast) in
 131  (*
 132  let _,intermediate_states =
 133   List.fold_left
 134    (fun (status,acc) (k,value) ->
 135      let v = GrafiteAst.description_of_alias value in
 136      let b =
 137       try
 138        let NReference.Ref (uri,_) = NReference.reference_of_string v in
 139         NUri.baseuri_of_uri uri = baseuri
 140       with
 141        NReference.IllFormedReference _ ->
 142         false (* v is a description, not a URI *)
 143      in
 144       if b then
 145        status,acc
 146       else
 147        let status =
 148         GrafiteDisambiguate.set_proof_aliases status ~implicit_aliases:false
 149          GrafiteAst.WithPreferences [k,value]
 150        in
 151         status, (status ,Some (k,value))::acc
 152    ) (status,[]) new_aliases (* WARNING: this must be the old status! *)
 153  in
 154   (new_status,None)::intermediate_states
 155   *)
 156  [new_status,None]
 157 ;;
 158
 159 let baseuri_of_script ~include_paths fname =
 160  try Librarian.baseuri_of_script ~include_paths fname
 161  with
 162    Librarian.NoRootFor _ ->
 163     HLog.error ("The included file '"^fname^"' has no root file,");
 164     HLog.error "please create it.";
 165     raise (Failure ("No root file for "^fname))
 166   | Librarian.FileNotFound _ ->
 167     raise (Failure ("File not found: "^fname))
 168 ;;
 169
 170 let rec get_ast status ~compiling ~asserted ~include_paths strm =
 171   match GrafiteParser.parse_statement status strm with
 172      (GrafiteAst.Executable
 173        (_,GrafiteAst.NCommand (_,GrafiteAst.Include (_,_,mafilename)))) as cmd
 174      ->
 175        let already_included = NCicLibrary.get_transitively_included status in
 176        let asserted,_ =
 177         assert_ng ~already_included ~compiling ~asserted ~include_paths
 178          mafilename
 179        in
 180         asserted,cmd
 181    | cmd -> asserted,cmd
 182
 183 and eval_from_stream ~compiling ~asserted ~include_paths ?do_heavy_checks status str cb =
 184  let matita_debug = Helm_registry.get_bool "matita.debug" in
 185  let rec loop asserted status =
 186   let asserted,stop,status =
 187    try
 188      let cont =
 189        try Some (get_ast status ~compiling ~asserted ~include_paths str)
 190        with End_of_file -> None in
 191      match cont with
 192      | None -> asserted, true, status
 193      | Some (asserted,ast) ->
 194         cb status ast;
 195         let new_statuses =
 196           eval_ast ~include_paths ?do_heavy_checks status ("",0,ast) in
 197         let status =
 198          match new_statuses with
 199             [s,None] -> s
 200           | _::(_,Some (_,value))::_ ->
 201                 raise (TryingToAdd (lazy (GrafiteAstPp.pp_alias value)))
 202           | _ -> assert false
 203         in
 204          asserted, false, status
 205    with exn when not matita_debug ->
 206      raise (EnrichedWithStatus (exn, status))
 207   in
 208   if stop then asserted,status else loop asserted status
 209  in
 210   loop asserted status
 211
 212 and compile ~compiling ~asserted ~include_paths fname =
 213   if List.mem fname compiling then raise (CircularDependency fname);
 214   let compiling = fname::compiling in
 215   let matita_debug = Helm_registry.get_bool "matita.debug" in
 216   let root,baseuri,fname,_tgt =
 217     Librarian.baseuri_of_script ~include_paths fname in
 218   if Http_getter_storage.is_read_only baseuri then assert false;
 219   activate_extraction baseuri fname ;
 220   (* MATITA 1.0: debbo fare time_travel sulla ng_library? *)
 221   let status = new status baseuri in
 222   let big_bang = Unix.gettimeofday () in
 223   let { Unix.tms_utime = big_bang_u ; Unix.tms_stime = big_bang_s} =
 224     Unix.times ()
 225   in
 226   let time = Unix.time () in
 227   try
 228     (* cleanup of previously compiled objects *)
 229     if (not (Http_getter_storage.is_empty ~local:true baseuri))
 230       then begin
 231       HLog.message ("baseuri " ^ baseuri ^ " is not empty");
 232       HLog.message ("cleaning baseuri " ^ baseuri);
 233       LibraryClean.clean_baseuris [baseuri];
 234     end;
 235     HLog.message ("compiling " ^ Filename.basename fname ^ " in " ^ baseuri);
 236     if not (Helm_registry.get_bool "matita.verbose") then
 237       (let cc =
 238         let rex = Str.regexp ".*opt$" in
 239         if Str.string_match rex Sys.argv.(0) 0 then "matitac.opt"
 240         else "matitac"
 241       in
 242       let s = Printf.sprintf "%s %-35s " cc (cut (root^"/") fname) in
 243       print_string s; flush stdout);
 244     (* we dalay this error check until we print 'matitac file ' *)
 245     assert (Http_getter_storage.is_empty ~local:true baseuri);
 246     (* create dir for XML files *)
 247     if not (Helm_registry.get_opt_default Helm_registry.bool "matita.nodisk"
 248               ~default:false)
 249     then
 250       HExtlib.mkdir
 251         (Filename.dirname
 252           (Http_getter.filename ~local:true ~writable:true (baseuri ^
 253           "foo.con")));
 254     let buf =
 255      GrafiteParser.parsable_statement status
 256       (Ulexing.from_utf8_channel (open_in fname))
 257     in
 258     let print_cb =
 259       if not (Helm_registry.get_bool "matita.verbose") then (fun _ _ -> ())
 260       else pp_ast_statement
 261     in
 262     let asserted, status =
 263      eval_from_stream ~compiling ~asserted ~include_paths status buf print_cb in
 264     let elapsed = Unix.time () -. time in
 265      (if Helm_registry.get_bool "matita.moo" then begin
 266        GrafiteTypes.Serializer.serialize ~baseuri:(NUri.uri_of_string baseuri)
 267         status
 268      end;
 269      let tm = Unix.gmtime elapsed in
 270      let sec = string_of_int tm.Unix.tm_sec ^ "''" in
 271      let min =
 272        if tm.Unix.tm_min > 0 then (string_of_int tm.Unix.tm_min^"' ") else ""
 273      in
 274      let hou =
 275        if tm.Unix.tm_hour > 0 then (string_of_int tm.Unix.tm_hour^"h ") else ""
 276      in
 277      HLog.message
 278        (sprintf "execution of %s completed in %s." fname (hou^min^sec));
 279      pp_times fname true big_bang big_bang_u big_bang_s;
 280      (* XXX: update script -- currently to stdout *)
 281      let origbuf = Ulexing.from_utf8_channel (open_in fname) in
 282      let outfile = open_out (fname ^ ".mad") in
 283      let interpr = GrafiteDisambiguate.get_interpr status#disambiguate_db in
 284      ignore (SmallLexer.mk_small_printer interpr outfile origbuf);
 285      close_out outfile;
 286      asserted
 287 (* MATITA 1.0: debbo fare time_travel sulla ng_library?
 288      LexiconSync.time_travel
 289        ~present:lexicon_status ~past:initial_lexicon_status;
 290 *))
 291   with
 292   (* all exceptions should be wrapped to allow lexicon-undo (LS.time_travel) *)
 293   | exn when not matita_debug ->
 294 (* MATITA 1.0: debbo fare time_travel sulla ng_library?
 295        LexiconSync.time_travel ~present:lexicon ~past:initial_lexicon_status;
 296  *       *)
 297       pp_times fname false big_bang big_bang_u big_bang_s;
 298       clean_exit baseuri exn
 299
 300 and assert_ng ~already_included ~compiling ~asserted ~include_paths mapath =
 301  let _,baseuri,fullmapath,_ = Librarian.baseuri_of_script ~include_paths mapath in
 302  if List.mem fullmapath asserted then asserted,false
 303  else
 304   begin
 305    let baseuri = NUri.uri_of_string baseuri in
 306    let ngtime_of baseuri =
 307     let ngpath = NCicLibrary.ng_path_of_baseuri baseuri in
 308     try
 309      Some (Unix.stat ngpath).Unix.st_mtime
 310     with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = ngpath -> None in
 311    let matime =
 312     try (Unix.stat fullmapath).Unix.st_mtime
 313     with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = fullmapath -> assert false
 314    in
 315    let ngtime = ngtime_of baseuri in
 316    let asserted,to_be_compiled =
 317     match ngtime with
 318        Some ngtime ->
 319         let preamble = GrafiteTypes.Serializer.dependencies_of baseuri in
 320         let asserted,children_bad =
 321          List.fold_left
 322           (fun (asserted,b) mapath ->
 323             let asserted,b1 =
 324               assert_ng ~already_included ~compiling ~asserted ~include_paths
 325                mapath
 326             in
 327              asserted, b || b1
 328               || let _,baseuri,_,_ =
 329                    Librarian.baseuri_of_script ~include_paths mapath in
 330                  let baseuri = NUri.uri_of_string baseuri in
 331                   (match ngtime_of baseuri with
 332                       Some child_ngtime -> child_ngtime > ngtime
 333                     | None -> assert false)
 334           ) (asserted,false) preamble
 335         in
 336          asserted, children_bad || matime > ngtime
 337      | None -> asserted,true
 338    in
 339     if not to_be_compiled then fullmapath::asserted,false
 340     else
 341      if List.mem baseuri already_included then
 342        (* maybe recompiling it I would get the same... *)
 343        raise (AlreadyLoaded (lazy mapath))
 344      else
 345       let asserted = compile ~compiling ~asserted ~include_paths fullmapath in
 346        fullmapath::asserted,true
 347   end
 348 ;;
 349
 350 let assert_ng ~include_paths mapath =
 351  snd (assert_ng ~include_paths ~already_included:[] ~compiling:[] ~asserted:[]
 352   mapath)
 353 let get_ast status ~include_paths strm =
 354  snd (get_ast status ~compiling:[] ~asserted:[] ~include_paths strm)