1 (* Copyright (C) 2005, HELM Team.
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.
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.
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.
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,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
32 class status baseuri =
34 inherit GrafiteTypes.status baseuri
35 inherit ApplyTransformation.status
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
45 let debug_print = if debug then prerr_endline else ignore ;;
47 let slash_n_RE = Pcre.regexp "\\n" ;;
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")
53 let stm = Pcre.replace ~rex:slash_n_RE stm in
55 if String.length stm > 50 then String.sub stm 0 50 ^ " ..."
58 HLog.debug ("Executing: ``" ^ stm ^ "''")
61 let clean_exit baseuri exn =
62 LibraryClean.clean_baseuris ~verbose:false [baseuri];
63 raise (FailureCompiling (baseuri,exn))
67 let lenp = String.length prefix in
68 let lens = String.length s in
70 assert (String.sub s 0 lenp = prefix);
71 String.sub s lenp (lens-lenp)
76 let print_string ~right_justify s =
78 match right_justify with
81 String.make (80 - !indent - len_ss - String.length s) ' ' ^ ss
83 print_string (String.make !indent ' ' ^ s ^ ss) in
84 fun enter ?right_justify s ->
85 if enter then (print_string ~right_justify s; incr indent) else (decr indent; print_string ~right_justify s)
88 let pp_times ss fname rc big_bang big_bang_u big_bang_s =
89 if not (Helm_registry.get_bool "matita.verbose") then
90 let { Unix.tms_utime = u ; Unix.tms_stime = s} = Unix.times () in
91 let r = Unix.gettimeofday () -. big_bang in
92 let u = u -. big_bang_u in
93 let s = s -. big_bang_s in
94 let extra = try Sys.getenv "BENCH_EXTRA_TEXT" with Not_found -> "" in
96 if rc then "
\e[0;32mOK
\e[0m" else "
\e[0;31mFAIL
\e[0m" in
99 let seconds = int_of_float t in
100 let cents = int_of_float ((t -. floor t) *. 100.0) in
101 let minutes = seconds / 60 in
102 let seconds = seconds mod 60 in
103 Printf.sprintf "%dm%02d.%02ds" minutes seconds cents
105 Printf.sprintf "%s %s %s" (fmt r) (fmt u) (fmt s)
107 let s = Printf.sprintf "%-14s %s %s\n" rc times extra in
108 print_string false ~right_justify:(s,31) ss;
110 HLog.message ("Compilation of "^Filename.basename fname^": "^rc)
113 let activate_extraction baseuri fname =
116 if Helm_registry.get_bool "matita.extract" then
117 let mangled_baseuri =
118 let baseuri = String.sub baseuri 5 (String.length baseuri - 5) in
119 let baseuri = Pcre.replace ~pat:"/" ~templ:"_" baseuri in
120 String.uncapitalize baseuri in
123 (Filename.dirname fname ^ "/" ^ mangled_baseuri ^ ".ml") in
124 LibrarySync.add_object_declaration_hook
125 (fun ~add_obj ~add_coercion _ obj ->
126 output_string f (CicExportation.ppobj baseuri obj);
132 let eval_ast ~include_paths ?do_heavy_checks status (text,prefix_len,ast) =
133 let baseuri = status#baseuri in
134 let new_aliases,new_status =
135 GrafiteDisambiguate.eval_with_new_aliases status
137 GrafiteEngine.eval_ast ~include_paths ?do_heavy_checks status
138 (text,prefix_len,ast)) in
139 let _,intermediate_states =
141 (fun (status,acc) (k,value) ->
142 let v = GrafiteAst.description_of_alias value in
145 let NReference.Ref (uri,_) = NReference.reference_of_string v in
146 NUri.baseuri_of_uri uri = baseuri
148 NReference.IllFormedReference _ ->
149 false (* v is a description, not a URI *)
155 GrafiteDisambiguate.set_proof_aliases status ~implicit_aliases:false
156 GrafiteAst.WithPreferences [k,value]
158 status, (status ,Some (k,value))::acc
159 ) (status,[]) new_aliases (* WARNING: this must be the old status! *)
161 (new_status,None)::intermediate_states
164 let baseuri_of_script ~include_paths fname =
165 try Librarian.baseuri_of_script ~include_paths fname
167 Librarian.NoRootFor _ ->
168 HLog.error ("The included file '"^fname^"' has no root file,");
169 HLog.error "please create it.";
170 raise (Failure ("No root file for "^fname))
171 | Librarian.FileNotFound _ ->
172 raise (Failure ("File not found: "^fname))
175 (* given a path to a ma file inside the include_paths, returns the
176 new include_paths associated to that file *)
177 let read_include_paths ~include_paths file =
179 let root, _buri, _fname, _tgt =
180 Librarian.baseuri_of_script ~include_paths:[] file in
183 Str.split (Str.regexp " ")
184 (List.assoc "include_paths" (Librarian.load_root_file (root^"/root")))
187 let rc = root :: includes in
188 List.iter (HLog.debug) rc; rc
189 with Librarian.NoRootFor _ | Librarian.FileNotFound _ ->
193 let rec get_ast status ~compiling ~asserted ~include_paths strm =
194 match GrafiteParser.parse_statement status strm with
195 (GrafiteAst.Executable
196 (_,GrafiteAst.NCommand (_,GrafiteAst.Include (_,_,mafilename)))) as cmd
198 let already_included = NCicLibrary.get_transitively_included status in
200 assert_ng ~already_included ~compiling ~asserted ~include_paths
204 | cmd -> asserted,cmd
206 and eval_from_stream ~compiling ~asserted ~include_paths ?do_heavy_checks status str cb =
207 let matita_debug = Helm_registry.get_bool "matita.debug" in
208 let rec loop asserted status str =
209 let asserted,stop,status,str =
212 try Some (get_ast status ~compiling ~asserted ~include_paths str)
213 with End_of_file -> None in
215 | None -> asserted, true, status, str
216 | Some (asserted,ast) ->
219 eval_ast ~include_paths ?do_heavy_checks status ("",0,ast) in
221 match new_statuses with
223 | _::(_,Some (_,value))::_ ->
224 raise (TryingToAdd (lazy (GrafiteAstPp.pp_alias value)))
225 | _ -> assert false in
226 (* CSC: complex patch to re-build the lexer since the tokens may
227 have changed. Note: this way we loose look-ahead tokens.
228 Hence the "include" command must be terminated (no look-ahead) *)
231 (GrafiteAst.Executable
232 (_,GrafiteAst.NCommand
233 (_,(GrafiteAst.Include _ | GrafiteAst.Notation _)))) ->
234 GrafiteParser.parsable_statement status
235 (GrafiteParser.strm_of_parsable str)
238 asserted, false, status, str
239 with exn when not matita_debug ->
240 raise (EnrichedWithStatus (exn, status))
242 if stop then asserted,status else loop asserted status str
244 loop asserted status str
246 and compile ~compiling ~asserted ~include_paths fname =
247 if List.mem fname compiling then raise (CircularDependency fname);
248 let compiling = fname::compiling in
249 let matita_debug = Helm_registry.get_bool "matita.debug" in
250 let root,baseuri,fname,_tgt =
251 Librarian.baseuri_of_script ~include_paths fname in
252 if Http_getter_storage.is_read_only baseuri then assert false;
253 activate_extraction baseuri fname ;
254 (* MATITA 1.0: debbo fare time_travel sulla ng_library? *)
255 let status = new status baseuri in
256 let big_bang = Unix.gettimeofday () in
257 let { Unix.tms_utime = big_bang_u ; Unix.tms_stime = big_bang_s} =
260 let time = Unix.time () in
262 let rex = Str.regexp ".*opt$" in
263 if Str.string_match rex Sys.argv.(0) 0 then "matitac.opt"
265 let s = Printf.sprintf "%s %s" cc (cut (root^"/") fname) in
267 (* cleanup of previously compiled objects *)
268 if (not (Http_getter_storage.is_empty ~local:true baseuri))
270 HLog.message ("baseuri " ^ baseuri ^ " is not empty");
271 HLog.message ("cleaning baseuri " ^ baseuri);
272 LibraryClean.clean_baseuris [baseuri];
274 HLog.message ("compiling " ^ Filename.basename fname ^ " in " ^ baseuri);
275 if not (Helm_registry.get_bool "matita.verbose") then
276 (print_string true (s ^ "\n"); flush stdout);
277 (* we dalay this error check until we print 'matitac file ' *)
278 assert (Http_getter_storage.is_empty ~local:true baseuri);
279 (* create dir for XML files *)
280 if not (Helm_registry.get_opt_default Helm_registry.bool "matita.nodisk"
285 (Http_getter.filename ~local:true ~writable:true (baseuri ^
288 GrafiteParser.parsable_statement status
289 (Ulexing.from_utf8_channel (open_in fname))
292 if not (Helm_registry.get_bool "matita.verbose") then (fun _ _ -> ())
293 else pp_ast_statement
295 let asserted, status =
296 eval_from_stream ~compiling ~asserted ~include_paths status buf print_cb in
297 let elapsed = Unix.time () -. time in
298 (if Helm_registry.get_bool "matita.moo" then begin
299 GrafiteTypes.Serializer.serialize ~baseuri:(NUri.uri_of_string baseuri)
302 let tm = Unix.gmtime elapsed in
303 let sec = string_of_int tm.Unix.tm_sec ^ "''" in
305 if tm.Unix.tm_min > 0 then (string_of_int tm.Unix.tm_min^"' ") else ""
308 if tm.Unix.tm_hour > 0 then (string_of_int tm.Unix.tm_hour^"h ") else ""
311 (sprintf "execution of %s completed in %s." fname (hou^min^sec));
312 pp_times s fname true big_bang big_bang_u big_bang_s;
314 (* MATITA 1.0: debbo fare time_travel sulla ng_library?
315 LexiconSync.time_travel
316 ~present:lexicon_status ~past:initial_lexicon_status;
319 (* all exceptions should be wrapped to allow lexicon-undo (LS.time_travel) *)
320 | exn when not matita_debug ->
321 (* MATITA 1.0: debbo fare time_travel sulla ng_library?
322 LexiconSync.time_travel ~present:lexicon ~past:initial_lexicon_status;
324 pp_times s fname false big_bang big_bang_u big_bang_s;
325 clean_exit baseuri exn
327 and assert_ng ~already_included ~compiling ~asserted ~include_paths mapath =
328 let root,baseuri,fullmapath,_ =
329 Librarian.baseuri_of_script ~include_paths mapath in
330 if List.mem fullmapath asserted then asserted,false
336 Str.split (Str.regexp " ")
337 (List.assoc "include_paths" (Librarian.load_root_file (root^"/root")))
341 Helm_registry.get_list Helm_registry.string "matita.includes" in
342 let baseuri = NUri.uri_of_string baseuri in
343 let ngtime_of baseuri =
344 let ngpath = NCicLibrary.ng_path_of_baseuri baseuri in
346 Some (Unix.stat ngpath).Unix.st_mtime
347 with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = ngpath -> None in
349 try (Unix.stat fullmapath).Unix.st_mtime
350 with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = fullmapath -> assert false
352 let ngtime = ngtime_of baseuri in
353 let asserted,to_be_compiled =
356 let preamble = GrafiteTypes.Serializer.dependencies_of baseuri in
357 let asserted,children_bad =
359 (fun (asserted,b) mapath ->
361 assert_ng ~already_included ~compiling ~asserted ~include_paths
365 || let _,baseuri,_,_ =
366 (*CSC: bug here? include_paths should be empty and
367 mapath should be absolute *)
368 Librarian.baseuri_of_script ~include_paths mapath in
369 let baseuri = NUri.uri_of_string baseuri in
370 (match ngtime_of baseuri with
371 Some child_ngtime -> child_ngtime > ngtime
372 | None -> assert false)
373 ) (asserted,false) preamble
375 asserted, children_bad || matime > ngtime
376 | None -> asserted,true
378 if not to_be_compiled then fullmapath::asserted,false
380 if List.mem baseuri already_included then
381 (* maybe recompiling it I would get the same... *)
382 raise (AlreadyLoaded (lazy mapath))
384 let asserted = compile ~compiling ~asserted ~include_paths fullmapath in
385 fullmapath::asserted,true
389 let assert_ng ~include_paths mapath =
390 snd (assert_ng ~include_paths ~already_included:[] ~compiling:[] ~asserted:[]
392 let get_ast status ~include_paths strm =
393 snd (get_ast status ~compiling:[] ~asserted:[] ~include_paths strm)