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 thingsToInitilaize =
  29   ConfigurationFile | Db | Environment | Getter | CmdLine | Registry
  30
  31 exception FailedToInitialize of thingsToInitilaize
  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.external_editor",      "gvim -f -c 'go %p' %f";
  48   "matita.profile",              "true";
  49   "matita.system",               "false";
  50   "matita.verbose",              "false";
  51   "matita.paste_unicode_as_tex", "false";
  52   "matita.noinnertypes",         "false";
  53   "matita.do_heavy_checks",      "true";
  54   "matita.moo",                  "true";
  55 ]
  56
  57 let set_registry_values =
  58   List.iter
  59     (fun key, value ->
  60        if not (Helm_registry.has key) then Helm_registry.set ~key ~value)
  61
  62 let fill_registry init_status =
  63   if not (already_configured [ Registry ] init_status) then begin
  64     set_registry_values registry_defaults;
  65     Registry :: init_status
  66   end else
  67     init_status
  68
  69 let load_configuration init_status =
  70   if not (already_configured [ConfigurationFile] init_status) then
  71     begin
  72       Helm_registry.load_from !conffile;
  73       if not (Helm_registry.has "user.name") then begin
  74         let login = (Unix.getpwuid (Unix.getuid ())).Unix.pw_name in
  75         Helm_registry.set "user.name" login
  76       end;
  77       let home = Helm_registry.get_string "matita.basedir" in
  78       let user_conf_file = home ^ "/matita.conf.xml" in
  79       if HExtlib.is_regular user_conf_file then
  80         begin
  81           HLog.message ("Loading additional conf file from " ^ user_conf_file);
  82           try
  83             Helm_registry.load_from user_conf_file
  84           with exn ->
  85             HLog.error
  86               ("While loading conf file: " ^ snd (MatitaExcPp.to_string exn))
  87         end;
  88       ConfigurationFile::init_status
  89     end
  90   else
  91     init_status
  92
  93 let initialize_db init_status =
  94   wants [ ConfigurationFile; CmdLine ] init_status;
  95   if not (already_configured [ Db ] init_status) then
  96     begin
  97       if not (Helm_registry.get_bool "matita.system") then
  98         MetadataTypes.ownerize_tables (Helm_registry.get "matita.owner");
  99       LibraryDb.create_owner_environment ();
 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       CicEnvironment.set_trust (* environment trust *)
 113         (let trust =
 114           Helm_registry.get_opt_default Helm_registry.get_bool
 115             ~default:true "matita.environment_trust" in
 116          fun _ -> trust);
 117       Getter::Environment::init_status
 118     end
 119   else
 120     init_status
 121
 122 let status = ref []
 123
 124 let usages = Hashtbl.create 11 (** app name (e.g. "matitac") -> usage string *)
 125 let _ =
 126   List.iter
 127     (fun (name, s) -> Hashtbl.replace usages name s)
 128     [ "matitac",
 129         Printf.sprintf "Matita batch compiler v%s
 130 Usage: matitac [ OPTION ... ] FILE
 131 Options:"
 132           BuildTimeConf.version;
 133         "matitaprover",
 134         Printf.sprintf "Matita (TPTP) prover v%s
 135 Usage: matitaprover [ -tptppath ] FILE.p
 136 Options:"
 137           BuildTimeConf.version;
 138       "matita",
 139         Printf.sprintf "Matita interactive theorem prover v%s
 140 Usage: matita [ OPTION ... ] [ FILE ]
 141 Options:"
 142           BuildTimeConf.version;
 143       "matitadep",
 144         Printf.sprintf "Matita depency file generator v%s
 145 Usage: matitadep [ OPTION ... ]
 146 Options:"
 147           BuildTimeConf.version;
 148       "matitaclean",
 149         Printf.sprintf "MatitaClean v%s
 150 Usage: matitaclean all
 151        matitaclean ( FILE | URI )
 152 Options:"
 153           BuildTimeConf.version;
 154     ]
 155 let default_usage =
 156   Printf.sprintf
 157     "Matita v%s\nUsage: matita [ ARG ]\nOptions:" BuildTimeConf.version
 158
 159 let usage () =
 160   let basename = Filename.basename Sys.argv.(0) in
 161   let usage_key =
 162     try Filename.chop_extension basename with Invalid_argument  _ -> basename
 163   in
 164   try Hashtbl.find usages usage_key with Not_found -> default_usage
 165
 166 let extra_cmdline_specs = ref []
 167 let add_cmdline_spec l = extra_cmdline_specs := l @ !extra_cmdline_specs
 168
 169 let parse_cmdline init_status =
 170   if not (already_configured [CmdLine] init_status) then begin
 171     wants [Registry] init_status;
 172     let includes = ref [] in
 173     let default_includes = [
 174       BuildTimeConf.stdlib_dir_devel;
 175       BuildTimeConf.stdlib_dir_installed ; ]
 176     in
 177     let absolutize s =
 178       if Pcre.pmatch ~pat:"^/" s then s else Sys.getcwd () ^"/"^s
 179     in
 180     let args = ref [] in
 181     let add_l l = fun s -> l := s :: !l in
 182     let print_version () =
 183             Printf.printf "%s\n" BuildTimeConf.version;exit 0 in
 184     let no_innertypes () =
 185       Helm_registry.set_bool "matita.noinnertypes" true in
 186     let set_baseuri s =
 187       match Str.split (Str.regexp "::") s with
 188       | [path; uri] -> Helm_registry.set "matita.baseuri"
 189           (HExtlib.normalize_path (absolutize path)^" "^uri)
 190       | _ -> raise (Failure "bad baseuri, use -b 'path::uri'")
 191     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         "-v",
 218           Arg.Unit (fun () -> Helm_registry.set_bool "matita.verbose" true),
 219           "Verbose mode";
 220         "--version", Arg.Unit print_version, "Prints version";
 221       ] in
 222       let debug_arg_spec =
 223         if BuildTimeConf.debug then
 224           [ "-debug",
 225             Arg.Unit (fun () -> Helm_registry.set_bool "matita.debug" true),
 226               ("Do not catch top-level exception "
 227               ^ "(useful for backtrace inspection)");
 228             "-onepass",
 229             Arg.Unit (fun () -> GrafiteDisambiguator.only_one_pass := true),
 230             "Enable only one disambiguation pass";
 231           ]
 232         else []
 233       in
 234       std_arg_spec @ debug_arg_spec @ !extra_cmdline_specs
 235     in
 236     let set_list ~key l =
 237       Helm_registry.set_list Helm_registry.of_string ~key ~value:l
 238     in
 239     Arg.parse arg_spec (add_l args) (usage ());
 240     let includes =
 241       List.map (fun x -> HExtlib.normalize_path (absolutize x))
 242        ((List.rev !includes) @ default_includes)
 243     in
 244     set_list ~key:"matita.includes" includes;
 245     let args = List.rev (List.filter (fun x -> x <> "") !args) in
 246     set_list ~key:"matita.args" args;
 247     HExtlib.set_profiling_printings
 248       (fun s ->
 249         Helm_registry.get_bool "matita.profile" &&
 250         Pcre.pmatch
 251           ~pat:(Helm_registry.get_opt_default
 252                   Helm_registry.string ~default:".*" "matita.profile_only")
 253           s);
 254     CmdLine :: init_status
 255   end else
 256     init_status
 257
 258 let die_usage () =
 259   print_endline (usage ());
 260   exit 1
 261
 262 let conf_components =
 263   [ load_configuration; fill_registry; parse_cmdline]
 264
 265 let other_components =
 266   [ initialize_db; initialize_environment ]
 267
 268 let initialize_all () =
 269   status :=
 270     List.fold_left (fun s f -> f s) !status
 271     (conf_components @ other_components)
 272
 273 let parse_cmdline_and_configuration_file () =
 274   status := List.fold_left (fun s f -> f s) !status conf_components
 275
 276 let initialize_environment () =
 277   status := initialize_environment !status
 278
 279 let _ =
 280   Inversion_principle.init ()