]> matita.cs.unibo.it Git - helm.git/blob - helm/software/matita/matitaInit.ml
...
[helm.git] / helm / software / matita / matitaInit.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 type thingsToInitialize = 
29   ConfigurationFile | Db | Environment | Getter | CmdLine | Registry
30   
31 exception FailedToInitialize of thingsToInitialize
32
33 let wants s l = 
34   List.iter (
35     fun item -> 
36       if not (List.exists (fun x -> x = item) l) then
37         raise (FailedToInitialize item)) 
38   s
39
40 let already_configured s l =
41   List.for_all (fun item -> List.exists (fun x -> x = item) l) s
42   
43 let conffile = ref BuildTimeConf.matita_conf
44
45 let registry_defaults = [
46   "matita.debug",                "false";
47   "matita.debug_menu",           "false";
48   "matita.external_editor",      "gvim -f -c 'go %p' %f";
49   "matita.profile",              "true";
50   "matita.system",               "false";
51   "matita.verbose",              "false";
52   "matita.paste_unicode_as_tex", "false";
53   "matita.noinnertypes",         "false";
54   "matita.do_heavy_checks",      "true";
55   "matita.moo",                  "true";
56   "matita.extract",              "false";
57   "matita.execcomments",         "false";
58 ]
59
60 let set_registry_values =
61   List.iter 
62     (fun key, value -> 
63        if not (Helm_registry.has key) then Helm_registry.set ~key ~value)
64
65 let fill_registry init_status =
66   if not (already_configured [ Registry ] init_status) then begin
67     set_registry_values registry_defaults;
68     Registry :: init_status
69   end else
70     init_status
71
72 let load_configuration init_status =
73   if not (already_configured [ConfigurationFile] init_status) then
74     begin
75       Helm_registry.load_from !conffile;
76       if not (Helm_registry.has "user.name") then begin
77         let login = (Unix.getpwuid (Unix.getuid ())).Unix.pw_name in
78         Helm_registry.set "user.name" login
79       end;
80       let home = Helm_registry.get_string "matita.basedir" in
81       let user_conf_file = home ^ "/matita.conf.xml" in
82       if HExtlib.is_regular user_conf_file then
83         begin
84           HLog.message ("Loading additional conf file from " ^ user_conf_file);
85           try
86             Helm_registry.load_from user_conf_file
87           with exn -> 
88             HLog.error
89               ("While loading conf file: " ^ snd (MatitaExcPp.to_string exn))
90         end;
91       ConfigurationFile::init_status 
92     end
93   else
94     init_status
95
96 let initialize_db init_status = 
97   wants [ ConfigurationFile; CmdLine ] init_status;
98   if not (already_configured [ Db ] init_status) then
99     begin
100       if not (Helm_registry.get_bool "matita.system") then
101         MetadataTypes.ownerize_tables (Helm_registry.get "matita.owner");
102       LibraryDb.create_owner_environment ();
103       Db::init_status
104     end
105   else
106     init_status
107
108 let initialize_environment init_status = 
109   wants [CmdLine] init_status;
110   if not (already_configured [Getter;Environment] init_status) then
111     begin
112       Http_getter.init ();
113       if Helm_registry.get_bool "matita.system" then
114         Http_getter_storage.activate_system_mode ();
115       CicEnvironment.set_trust (* environment trust *)
116         (let trust =
117           Helm_registry.get_opt_default Helm_registry.get_bool
118             ~default:true "matita.environment_trust" in
119          fun _ -> trust);
120       Getter::Environment::init_status
121     end
122   else
123     init_status 
124   
125 let status = ref []
126
127 let usages = Hashtbl.create 11 (** app name (e.g. "matitac") -> usage string *)
128 let _ =
129   List.iter
130     (fun (name, s) -> Hashtbl.replace usages name s)
131     [ "matitac", 
132         Printf.sprintf "Matita batch compiler v%s
133 Usage: matitac [ OPTION ... ] FILE
134 Options:"
135           BuildTimeConf.version;
136         "matitaprover",
137         Printf.sprintf "Matita (TPTP) prover v%s
138 Usage: matitaprover [ -tptppath ] FILE.p
139 Options:"
140           BuildTimeConf.version;
141       "matita",
142         Printf.sprintf "Matita interactive theorem prover v%s
143 Usage: matita [ OPTION ... ] [ FILE ]
144 Options:"
145           BuildTimeConf.version;
146       "matitadep",
147         Printf.sprintf "Matita depency file generator v%s
148 Usage: matitadep [ OPTION ... ] 
149 Options:"
150           BuildTimeConf.version;
151       "matitaclean",
152         Printf.sprintf "MatitaClean v%s
153 Usage: matitaclean all
154        matitaclean ( FILE | URI )
155 Options:"
156           BuildTimeConf.version;
157     ]
158 let default_usage =
159   Printf.sprintf 
160     "Matita v%s\nUsage: matita [ ARG ]\nOptions:" BuildTimeConf.version
161
162 let usage () =
163   let basename = Filename.basename Sys.argv.(0) in
164   let usage_key =
165     try Filename.chop_extension basename with Invalid_argument  _ -> basename
166   in
167   try Hashtbl.find usages usage_key with Not_found -> default_usage
168 ;;
169
170 let extra_cmdline_specs = ref []
171 let add_cmdline_spec l = extra_cmdline_specs := l @ !extra_cmdline_specs
172
173 let parse_cmdline init_status =
174   if not (already_configured [CmdLine] init_status) then begin
175     wants [Registry] init_status;
176     let includes = ref [] in
177     let default_includes = [ 
178       BuildTimeConf.stdlib_dir_devel;
179       BuildTimeConf.stdlib_dir_installed ; 
180       BuildTimeConf.new_stdlib_dir_devel;
181       BuildTimeConf.new_stdlib_dir_installed ; 
182     ] 
183     in
184     let absolutize s =
185       if Pcre.pmatch ~pat:"^/" s then s else Sys.getcwd () ^"/"^s
186     in
187     let args = ref [] in
188     let add_l l = fun s -> l := s :: !l in
189     let print_version () =
190             Printf.printf "%s\n" BuildTimeConf.version;exit 0 in
191     let no_innertypes () =
192       Helm_registry.set_bool "matita.noinnertypes" true in
193     let set_baseuri s =
194       match Str.split (Str.regexp "::") s with
195       | [path; uri] -> Helm_registry.set "matita.baseuri"
196           (HExtlib.normalize_path (absolutize path)^" "^uri)
197       | _ -> raise (Failure "bad baseuri, use -b 'path::uri'")
198     in
199     let no_default_includes = ref false in
200     let execcomments = ref false in
201     let arg_spec =
202       let std_arg_spec = [
203         "-b", Arg.String set_baseuri, "<path::uri> forces the baseuri of path";
204         "-I", Arg.String (add_l includes),
205           ("<path> Adds path to the list of searched paths for the "
206            ^ "include command");
207         "-conffile", Arg.Set_string conffile,
208           (Printf.sprintf ("<filename> Read configuration from filename"
209              ^^ "\n    Default: %s")
210             BuildTimeConf.matita_conf);
211         "-force",
212             Arg.Unit (fun () -> Helm_registry.set_bool "matita.force" true),
213             ("Force actions that would not be executed per default");
214         "-noprofile", 
215           Arg.Unit (fun () -> Helm_registry.set_bool "matita.profile" false),
216           "Turns off profiling printings";
217         "-noinnertypes", Arg.Unit no_innertypes, 
218           "Turns off inner types generation while publishing";
219         "-profile-only",
220           Arg.String (fun rex -> Helm_registry.set "matita.profile_only" rex),
221           "Activates only profiler with label matching the provided regex";
222         "-system", Arg.Unit (fun () ->
223               Helm_registry.set_bool "matita.system" true),
224             ("Act on the system library instead of the user one"
225              ^ "\n    WARNING: not for the casual user");
226         "-no-default-includes", Arg.Set no_default_includes,
227           "Do not include the default searched paths for the include command"; 
228         "-execcomments", Arg.Set execcomments,
229           "Execute the content of (** ... *) comments";
230         "-v", 
231           Arg.Unit (fun () -> Helm_registry.set_bool "matita.verbose" true), 
232           "Verbose mode";
233         "--version", Arg.Unit print_version, "Prints version"
234       ] in
235       let debug_arg_spec =
236         if BuildTimeConf.debug then
237           [ "-debug",
238             Arg.Unit (fun () -> Helm_registry.set_bool "matita.debug" true),
239               ("Do not catch top-level exception "
240               ^ "(useful for backtrace inspection)");
241             "-onepass",
242             Arg.Unit (fun () -> MultiPassDisambiguator.only_one_pass := true),
243             "Enable only one disambiguation pass";    
244           ]
245         else []
246       in
247       std_arg_spec @ debug_arg_spec @ !extra_cmdline_specs
248     in
249     let set_list ~key l =
250       Helm_registry.set_list Helm_registry.of_string ~key ~value:l
251     in
252     Arg.parse arg_spec (add_l args) (usage ());
253     Helm_registry.set_bool ~key:"matita.execcomments" ~value:!execcomments;
254     let default_includes = if !no_default_includes then [] else default_includes in
255     let includes = 
256       List.map (fun x -> HExtlib.normalize_path (absolutize x)) 
257        ((List.rev !includes) @ default_includes) 
258     in
259     set_list ~key:"matita.includes" includes;
260     let args = List.rev (List.filter (fun x -> x <> "") !args) in
261     set_list ~key:"matita.args" args;
262     HExtlib.set_profiling_printings 
263       (fun s -> 
264         Helm_registry.get_bool "matita.profile" && 
265         Pcre.pmatch 
266           ~pat:(Helm_registry.get_opt_default 
267                   Helm_registry.string ~default:".*" "matita.profile_only") 
268           s);
269     CmdLine :: init_status
270   end else
271     init_status
272
273 let die_usage () =
274   print_endline (usage ());
275   exit 1
276
277 let conf_components = 
278   [ load_configuration; fill_registry; parse_cmdline]
279
280 let other_components =
281   [ initialize_db; initialize_environment ]
282
283 let initialize_all () =
284   status := 
285     List.fold_left (fun s f -> f s) !status
286     (conf_components @ other_components);
287   NCicLibrary.init ()
288
289 let parse_cmdline_and_configuration_file () =
290   status := List.fold_left (fun s f -> f s) !status conf_components
291
292 let initialize_environment () =
293   status := initialize_environment !status
294
295 let _ =
296   CicFix.init ();
297   Inversion_principle.init ();
298   CicRecord.init ();
299   CicElim.init ()
300 ;;