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       BuildTimeConf.new_stdlib_dir_installed ;
 172     ]
 173     in
 174     let absolutize s =
 175       if Pcre.pmatch ~pat:"^/" s then s else Sys.getcwd () ^"/"^s
 176     in
 177     let args = ref [] in
 178     let add_l l = fun s -> l := s :: !l in
 179     let print_version () =
 180             Printf.printf "%s\n" BuildTimeConf.version;exit 0 in
 181     let no_innertypes () =
 182       Helm_registry.set_bool "matita.noinnertypes" true in
 183     let set_baseuri s =
 184       match Str.split (Str.regexp "::") s with
 185       | [path; uri] -> Helm_registry.set "matita.baseuri"
 186           (HExtlib.normalize_path (absolutize path)^" "^uri)
 187       | _ -> raise (Failure "bad baseuri, use -b 'path::uri'")
 188     in
 189     let no_default_includes = ref false in
 190     let execcomments = ref false in
 191     let arg_spec =
 192       let std_arg_spec = [
 193         "-b", Arg.String set_baseuri, "<path::uri> forces the baseuri of path";
 194         "-I", Arg.String (add_l includes),
 195           ("<path> Adds path to the list of searched paths for the "
 196            ^ "include command");
 197         "-conffile", Arg.Set_string conffile,
 198           (Printf.sprintf ("<filename> Read configuration from filename"
 199              ^^ "\n    Default: %s")
 200             BuildTimeConf.matita_conf);
 201         "-force",
 202             Arg.Unit (fun () -> Helm_registry.set_bool "matita.force" true),
 203             ("Force actions that would not be executed per default");
 204         "-noprofile",
 205           Arg.Unit (fun () -> Helm_registry.set_bool "matita.profile" false),
 206           "Turns off profiling printings";
 207         "-noinnertypes", Arg.Unit no_innertypes,
 208           "Turns off inner types generation while publishing";
 209         "-profile-only",
 210           Arg.String (fun rex -> Helm_registry.set "matita.profile_only" rex),
 211           "Activates only profiler with label matching the provided regex";
 212         "-system", Arg.Unit (fun () ->
 213               Helm_registry.set_bool "matita.system" true),
 214             ("Act on the system library instead of the user one"
 215              ^ "\n    WARNING: not for the casual user");
 216         "-no-default-includes", Arg.Set no_default_includes,
 217           "Do not include the default searched paths for the include command";
 218         "-execcomments", Arg.Set execcomments,
 219           "Execute the content of (** ... *) comments";
 220         "-v",
 221           Arg.Unit (fun () -> Helm_registry.set_bool "matita.verbose" true),
 222           "Verbose mode";
 223         "--version", Arg.Unit print_version, "Prints version"
 224       ] in
 225       let debug_arg_spec =
 226         if BuildTimeConf.debug then
 227           [ "-debug",
 228             Arg.Unit (fun () -> Helm_registry.set_bool "matita.debug" true),
 229               ("Do not catch top-level exception "
 230               ^ "(useful for backtrace inspection)");
 231             "-onepass",
 232             Arg.Unit (fun () -> MultiPassDisambiguator.only_one_pass := true),
 233             "Enable only one disambiguation pass";
 234           ]
 235         else []
 236       in
 237       std_arg_spec @ debug_arg_spec @ !extra_cmdline_specs
 238     in
 239     let set_list ~key l =
 240       Helm_registry.set_list Helm_registry.of_string ~key ~value:l
 241     in
 242     Arg.parse arg_spec (add_l args) (usage ());
 243     Helm_registry.set_bool ~key:"matita.execcomments" ~value:!execcomments;
 244     let default_includes = if !no_default_includes then [] else default_includes in
 245     let includes =
 246       List.map (fun x -> HExtlib.normalize_path (absolutize x))
 247        ((List.rev !includes) @ default_includes)
 248     in
 249     set_list ~key:"matita.includes" includes;
 250     let args = List.rev (List.filter (fun x -> x <> "") !args) in
 251     set_list ~key:"matita.args" args;
 252     HExtlib.set_profiling_printings
 253       (fun s ->
 254         Helm_registry.get_bool "matita.profile" &&
 255         Pcre.pmatch
 256           ~pat:(Helm_registry.get_opt_default
 257                   Helm_registry.string ~default:".*" "matita.profile_only")
 258           s);
 259     CmdLine :: init_status
 260   end else
 261     init_status
 262
 263 let die_usage () =
 264   print_endline (usage ());
 265   exit 1
 266
 267 let conf_components =
 268   [ load_configuration; fill_registry; parse_cmdline]
 269
 270 let other_components =
 271   [ initialize_db; initialize_environment ]
 272
 273 let initialize_all () =
 274   status :=
 275     List.fold_left (fun s f -> f s) !status
 276     (conf_components @ other_components);
 277   NCicLibrary.init ()
 278
 279 let parse_cmdline_and_configuration_file () =
 280   status := List.fold_left (fun s f -> f s) !status conf_components
 281
 282 let initialize_environment () =
 283   status := initialize_environment !status