]> matita.cs.unibo.it Git - helm.git/blob - matita/matita/matitaInit.ml
the theory of substitution is started ...
[helm.git] / matita / 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       Db::init_status
101     end
102   else
103     init_status
104
105 let initialize_environment init_status = 
106   wants [CmdLine] init_status;
107   if not (already_configured [Getter;Environment] init_status) then
108     begin
109       Http_getter.init ();
110       if Helm_registry.get_bool "matita.system" then
111         Http_getter_storage.activate_system_mode ();
112       Getter::Environment::init_status
113     end
114   else
115     init_status 
116   
117 let status = ref []
118
119 let usages = Hashtbl.create 11 (** app name (e.g. "matitac") -> usage string *)
120 let _ =
121   List.iter
122     (fun (name, s) -> Hashtbl.replace usages name s)
123     [ "matitac", 
124         Printf.sprintf "Matita batch compiler v%s
125 Usage: matitac [ OPTION ... ] FILE
126 Options:"
127           BuildTimeConf.version;
128         "matitaprover",
129         Printf.sprintf "Matita (TPTP) prover v%s
130 Usage: matitaprover [ -tptppath ] FILE.p
131 Options:"
132           BuildTimeConf.version;
133       "matita",
134         Printf.sprintf "Matita interactive theorem prover v%s
135 Usage: matita [ OPTION ... ] [ FILE ]
136 Options:"
137           BuildTimeConf.version;
138       "matitadep",
139         Printf.sprintf "Matita depency file generator v%s
140 Usage: matitadep [ OPTION ... ] 
141 Options:"
142           BuildTimeConf.version;
143       "matitaclean",
144         Printf.sprintf "MatitaClean v%s
145 Usage: matitaclean all
146        matitaclean ( FILE | URI )
147 Options:"
148           BuildTimeConf.version;
149     ]
150 let default_usage =
151   Printf.sprintf 
152     "Matita v%s\nUsage: matita [ ARG ]\nOptions:" BuildTimeConf.version
153
154 let usage () =
155   let basename = Filename.basename Sys.argv.(0) in
156   let usage_key =
157     try Filename.chop_extension basename with Invalid_argument  _ -> basename
158   in
159   try Hashtbl.find usages usage_key with Not_found -> default_usage
160 ;;
161
162 let extra_cmdline_specs = ref []
163 let add_cmdline_spec l = extra_cmdline_specs := l @ !extra_cmdline_specs
164
165 let parse_cmdline init_status =
166   if not (already_configured [CmdLine] init_status) then begin
167     wants [Registry] init_status;
168     let includes = ref [] in
169     let default_includes = [ 
170       BuildTimeConf.new_stdlib_dir_devel;
171     (* CSC: no installed standard library!
172       BuildTimeConf.new_stdlib_dir_installed ; *)
173     ] 
174     in
175     let absolutize s =
176       if Pcre.pmatch ~pat:"^/" s then s else Sys.getcwd () ^"/"^s
177     in
178     let args = ref [] in
179     let add_l l = fun s -> l := s :: !l in
180     let print_version () =
181             Printf.printf "%s\n" BuildTimeConf.version;exit 0 in
182     let no_innertypes () =
183       Helm_registry.set_bool "matita.noinnertypes" true in
184     let set_baseuri s =
185       match Str.split (Str.regexp "::") s with
186       | [path; uri] -> Helm_registry.set "matita.baseuri"
187           (HExtlib.normalize_path (absolutize path)^" "^uri)
188       | _ -> raise (Failure "bad baseuri, use -b 'path::uri'")
189     in
190     let no_default_includes = ref false in
191     let execcomments = ref false in
192     let arg_spec =
193       let std_arg_spec = [
194         "-b", Arg.String set_baseuri, "<path::uri> forces the baseuri of path";
195         "-I", Arg.String (add_l includes),
196           ("<path> Adds path to the list of searched paths for the "
197            ^ "include command");
198         "-conffile", Arg.Set_string conffile,
199           (Printf.sprintf ("<filename> Read configuration from filename"
200              ^^ "\n    Default: %s")
201             BuildTimeConf.matita_conf);
202         "-force",
203             Arg.Unit (fun () -> Helm_registry.set_bool "matita.force" true),
204             ("Force actions that would not be executed per default");
205         "-noprofile", 
206           Arg.Unit (fun () -> Helm_registry.set_bool "matita.profile" false),
207           "Turns off profiling printings";
208         "-noinnertypes", Arg.Unit no_innertypes, 
209           "Turns off inner types generation while publishing";
210         "-profile-only",
211           Arg.String (fun rex -> Helm_registry.set "matita.profile_only" rex),
212           "Activates only profiler with label matching the provided regex";
213         "-system", Arg.Unit (fun () ->
214               Helm_registry.set_bool "matita.system" true),
215             ("Act on the system library instead of the user one"
216              ^ "\n    WARNING: not for the casual user");
217         "-no-default-includes", Arg.Set no_default_includes,
218           "Do not include the default searched paths for the include command"; 
219         "-execcomments", Arg.Set execcomments,
220           "Execute the content of (** ... *) comments";
221         "-v", 
222           Arg.Unit (fun () -> Helm_registry.set_bool "matita.verbose" true), 
223           "Verbose mode";
224         "--version", Arg.Unit print_version, "Prints version"
225       ] in
226       let debug_arg_spec =
227         if BuildTimeConf.debug then
228           [ "-debug",
229             Arg.Unit (fun () -> Helm_registry.set_bool "matita.debug" true),
230               ("Do not catch top-level exception "
231               ^ "(useful for backtrace inspection)");
232             "-onepass",
233             Arg.Unit (fun () -> MultiPassDisambiguator.only_one_pass := true),
234             "Enable only one disambiguation pass";    
235           ]
236         else []
237       in
238       std_arg_spec @ debug_arg_spec @ !extra_cmdline_specs
239     in
240     let set_list ~key l =
241       Helm_registry.set_list Helm_registry.of_string ~key ~value:l
242     in
243     Arg.parse arg_spec (add_l args) (usage ());
244     Helm_registry.set_bool ~key:"matita.execcomments" ~value:!execcomments;
245     let default_includes = if !no_default_includes then [] else default_includes in
246     let includes = 
247       List.map (fun x -> HExtlib.normalize_path (absolutize x)) 
248        ((List.rev !includes) @ default_includes) 
249     in
250     set_list ~key:"matita.includes" includes;
251     let args = List.rev (List.filter (fun x -> x <> "") !args) in
252     set_list ~key:"matita.args" args;
253     HExtlib.set_profiling_printings 
254       (fun s -> 
255         Helm_registry.get_bool "matita.profile" && 
256         Pcre.pmatch 
257           ~pat:(Helm_registry.get_opt_default 
258                   Helm_registry.string ~default:".*" "matita.profile_only") 
259           s);
260     CmdLine :: init_status
261   end else
262     init_status
263
264 let die_usage () =
265   print_endline (usage ());
266   exit 1
267
268 let conf_components = 
269   [ load_configuration; fill_registry; parse_cmdline]
270
271 let other_components =
272   [ initialize_db; initialize_environment ]
273
274 let initialize_all () =
275   status := 
276     List.fold_left (fun s f -> f s) !status
277     (conf_components @ other_components);
278   NCicLibrary.init ()
279
280 let parse_cmdline_and_configuration_file () =
281   status := List.fold_left (fun s f -> f s) !status conf_components
282
283 let initialize_environment () =
284   status := initialize_environment !status