]> matita.cs.unibo.it Git - helm.git/blob - matita/matitacLib.ml
better documentation both with -h and with F1
[helm.git] / 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
33
34 let out = ref ignore 
35 let set_callback f = out := f
36
37 let slash_n_RE = Pcre.regexp "\\n" ;;
38
39 let pp_ast_statement grafite_status stm =
40   let stm = GrafiteAstPp.pp_statement
41     ~map_unicode_to_tex:(Helm_registry.get_bool "matita.paste_unicode_as_tex")
42     ~term_pp:CicNotationPp.pp_term
43     ~lazy_term_pp:CicNotationPp.pp_term ~obj_pp:(CicNotationPp.pp_obj
44     CicNotationPp.pp_term) stm
45   in
46   let stm = Pcre.replace ~rex:slash_n_RE stm in
47   let stm =
48       if String.length stm > 50 then String.sub stm 0 50 ^ " ..."
49       else stm
50   in
51     HLog.debug ("Executing: ``" ^ stm ^ "''")
52 ;;
53
54 let clean_exit baseuri rc =
55   LibraryClean.clean_baseuris ~verbose:false [baseuri]; rc
56 ;;
57
58 let get_macro_context = function
59    | Some {GrafiteTypes.proof_status = GrafiteTypes.No_proof} -> []
60    | Some status                ->
61       let stack = GrafiteTypes.get_stack status in
62       let goal = Continuationals.Stack.find_goal stack in
63       GrafiteTypes.get_proof_context status goal
64    | None                       -> assert false
65 ;;
66    
67 let pp_times fname rc big_bang = 
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 extra = try Sys.getenv "BENCH_EXTRA_TEXT" with Not_found -> "" in
72     let rc,rcascii = 
73       if rc then "\e[0;32mOK\e[0m","Ok" else "\e[0;31mFAIL\e[0m","Fail" in
74     let times = 
75       let fmt t = 
76         let seconds = int_of_float t in
77         let cents = int_of_float ((t -. floor t) *. 100.0) in
78         let minutes = seconds / 60 in
79         let seconds = seconds mod 60 in
80         Printf.sprintf "%dm%02d.%02ds" minutes seconds cents
81       in
82       Printf.sprintf "%s %s %s" (fmt r) (fmt u) (fmt s)
83     in
84     let s = Printf.sprintf "%-4s %s %s" rc times extra in
85     print_endline s;
86     flush stdout;
87     HLog.message ("Compilation of "^Filename.basename fname^": "^rc)
88 ;;
89
90 let cut prefix s = 
91   let lenp = String.length prefix in
92   let lens = String.length s in
93   assert (lens > lenp);
94   assert (String.sub s 0 lenp = prefix);
95   String.sub s lenp (lens-lenp)
96 ;;
97
98 let get_include_paths options =
99   let include_paths = 
100     try List.assoc "include_paths" options with Not_found -> "" 
101   in
102   let include_paths = Str.split (Str.regexp " ") include_paths in
103   let include_paths = 
104     include_paths @ 
105     Helm_registry.get_list Helm_registry.string "matita.includes" 
106   in
107     include_paths
108 ;;
109
110 let rec compile options fname =
111   (* initialization, MOVE OUTSIDE *)
112   let matita_debug = Helm_registry.get_bool "matita.debug" in
113   (* sanity checks *)
114   let include_paths = get_include_paths options in
115   let root,baseuri,fname,_tgt = Librarian.baseuri_of_script ~include_paths fname in
116   let moo_fname = 
117    LibraryMisc.obj_file_of_baseuri ~must_exist:false ~baseuri ~writable:true
118   in
119   let lexicon_fname= 
120    LibraryMisc.lexicon_file_of_baseuri ~must_exist:false ~baseuri ~writable:true
121   in
122   if Http_getter_storage.is_read_only baseuri then 
123     HLog.error 
124       (Printf.sprintf "uri %s belongs to a read-only repository" baseuri);
125   (* cleanup of previously compiled objects *)
126   if (not (Http_getter_storage.is_empty ~local:true baseuri) ||
127       LibraryClean.db_uris_of_baseuri baseuri <> []) 
128     then begin
129     HLog.message ("baseuri " ^ baseuri ^ " is not empty");
130     HLog.message ("cleaning baseuri " ^ baseuri);
131     LibraryClean.clean_baseuris [baseuri];
132     assert (Http_getter_storage.is_empty ~local:true baseuri);
133   end;
134   (* create dir for XML files *)
135   if not (Helm_registry.get_opt_default Helm_registry.bool "matita.nodisk"
136             ~default:false) 
137   then
138     HExtlib.mkdir 
139       (Filename.dirname 
140         (Http_getter.filename ~local:true ~writable:true (baseuri ^
141         "foo.con")));
142   (* begin of compilation *)
143   let grafite_status = GrafiteSync.init baseuri in
144   let lexicon_status = 
145     CicNotation2.load_notation ~include_paths:[]
146       BuildTimeConf.core_notation_script 
147   in
148   let big_bang = Unix.gettimeofday () in
149   let time = Unix.time () in
150   HLog.message ("compiling " ^ Filename.basename fname ^ " in " ^ baseuri);
151   if not (Helm_registry.get_bool "matita.verbose") then
152     (let cc = 
153       if Str.string_match(Str.regexp ".*opt$") Sys.argv.(0) 0 then "matitac.opt"
154       else "matitac" 
155     in
156     let s = Printf.sprintf "%s %-35s " cc (cut (root^"/") fname) in
157     print_string s; flush stdout);
158   let buf = Ulexing.from_utf8_channel (open_in fname) in
159   let print_cb =
160     if not (Helm_registry.get_bool "matita.verbose") then (fun _ _ -> ())
161     else pp_ast_statement
162   in
163   try
164     let grafite_status, lexicon_status =
165       match
166        MatitaEngine.eval_from_stream ~first_statement_only:false ~include_paths
167         lexicon_status grafite_status buf print_cb
168       with
169       | [] -> raise End_of_file
170       | ((grafite,lexicon),None)::_ -> grafite, lexicon
171       | (s,Some _)::_ -> raise AttemptToInsertAnAlias
172     in
173     let elapsed = Unix.time () -. time in
174     let proof_status,moo_content_rev,lexicon_content_rev = 
175       grafite_status.proof_status, grafite_status.moo_content_rev, 
176        lexicon_status.LexiconEngine.lexicon_content_rev
177     in
178     if proof_status <> GrafiteTypes.No_proof then
179      (HLog.error
180       "there are still incomplete proofs at the end of the script"; 
181      pp_times fname false big_bang;
182      clean_exit baseuri false)
183     else
184      (if Helm_registry.get_bool "matita.moo" then begin
185         (* FG: we do not generate .moo when dumping .mma files *)
186         GrafiteMarshal.save_moo moo_fname moo_content_rev;
187         LexiconMarshal.save_lexicon lexicon_fname lexicon_content_rev;
188      end;
189      let tm = Unix.gmtime elapsed in
190      let sec = string_of_int tm.Unix.tm_sec ^ "''" in
191      let min = 
192        if tm.Unix.tm_min > 0 then (string_of_int tm.Unix.tm_min^"' ") else "" 
193      in
194      let hou = 
195        if tm.Unix.tm_hour > 0 then (string_of_int tm.Unix.tm_hour^"h ") else ""
196      in
197      HLog.message 
198        (sprintf "execution of %s completed in %s." fname (hou^min^sec));
199      pp_times fname true big_bang;
200      true)
201   with 
202   | End_of_file -> HLog.error "End_of_file?!"; clean_exit baseuri false
203   | Sys.Break as exn ->
204      if matita_debug then raise exn;
205      HLog.error "user break!";
206      pp_times fname false big_bang;
207      clean_exit baseuri false
208   | GrafiteEngine.Macro (floc, f) ->
209       (match f (get_macro_context (Some grafite_status)) with 
210       | _, GrafiteAst.Inline (_, style, suri, prefix) ->
211         let str =
212          ApplyTransformation.txt_of_inline_macro style suri prefix
213           ~map_unicode_to_tex:(Helm_registry.get_bool
214             "matita.paste_unicode_as_tex") in
215         !out str;
216         compile options fname 
217       | _ ->
218         let x, y = HExtlib.loc_of_floc floc in
219         HLog.error (sprintf "A macro has been found at %d-%d" x y);
220         pp_times fname false big_bang;
221         clean_exit baseuri false)
222   | HExtlib.Localized (floc,CicNotationParser.Parse_error err) ->
223       let (x, y) = HExtlib.loc_of_floc floc in
224       HLog.error (sprintf "Parse error at %d-%d: %s" x y err);
225       pp_times fname false big_bang;
226       clean_exit baseuri false
227   | exn ->
228        if matita_debug then raise exn;
229        HLog.error (snd (MatitaExcPp.to_string exn));
230        pp_times fname false big_bang;
231        clean_exit baseuri false
232 ;;
233
234 module F = 
235   struct 
236     type source_object = string
237     type target_object = string
238     let string_of_source_object s = s;;
239     let string_of_target_object s = s;;
240
241     let root_of opts s = 
242       try
243         let include_paths = get_include_paths opts in
244         let root,_,_,_ = Librarian.baseuri_of_script ~include_paths s in
245         Some root
246       with Librarian.NoRootFor x -> None
247     ;;
248
249     let target_of opts mafile = 
250       let include_paths = get_include_paths opts in
251       let _,baseuri,_,_ = Librarian.baseuri_of_script ~include_paths mafile in
252       LibraryMisc.obj_file_of_baseuri 
253         ~must_exist:false ~baseuri ~writable:true 
254     ;;
255
256     let mtime_of_source_object s =
257       try Some (Unix.stat s).Unix.st_mtime
258       with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = s -> 
259               None
260 (*         max_float *)
261 (*         raise (Failure ("Unable to stat a source file: " ^ s))  *)
262     ;;
263
264     let mtime_of_target_object s =
265       try Some (Unix.stat s).Unix.st_mtime
266       with Unix.Unix_error (Unix.ENOENT, "stat", f) when f = s -> None
267     ;;
268
269     let build = compile;;
270
271     let load_deps_file = Librarian.load_deps_file;;
272
273   end 
274
275 module Make = Librarian.Make(F) 
276