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 open Printf
  29
  30 type thingsToInitilaize =
  31   ConfigurationFile | Db | Environment | Getter | Makelib | CmdLine | Registry
  32
  33 exception FailedToInitialize of thingsToInitilaize
  34
  35 let wants s l =
  36   List.iter (
  37     fun item ->
  38       if not (List.exists (fun x -> x = item) l) then
  39         raise (FailedToInitialize item))
  40   s
  41
  42 let already_configured s l =
  43   List.for_all (fun item -> List.exists (fun x -> x = item) l) s
  44
  45 let conffile = ref BuildTimeConf.matita_conf
  46
  47 let registry_defaults = [
  48   "db.nodb",                  "false";
  49   "matita.debug",             "false";
  50   "matita.external_editor",   "gvim -f -c 'go %p' %f";
  51   "matita.preserve",          "false";
  52   "matita.profile",           "true";
  53   "matita.system",            "false";
  54   "matita.verbosity",         "1";
  55     (** verbosity level: 1 is the default, 0 is intuitively "quiet", > 1 is
  56      * intuitively verbose *)
  57 ]
  58
  59 let set_registry_values =
  60   List.iter (fun key, value -> 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   wants [ Registry ] init_status;
  71   if not (already_configured [ConfigurationFile] init_status) then
  72     begin
  73       Helm_registry.load_from !conffile;
  74       if not (Helm_registry.has "user.name") then begin
  75         let login = (Unix.getpwuid (Unix.getuid ())).Unix.pw_name in
  76         Helm_registry.set "user.name" login
  77       end;
  78       ConfigurationFile::init_status
  79     end
  80   else
  81     init_status
  82
  83 let initialize_db init_status =
  84   wants [ ConfigurationFile; CmdLine ] init_status;
  85   if not (already_configured [ Db ] init_status) then
  86     begin
  87       if not (Helm_registry.get_bool "matita.system") then
  88         MetadataTypes.ownerize_tables (Helm_registry.get "matita.owner");
  89       LibraryDb.create_owner_environment ();
  90       Db::init_status
  91     end
  92   else
  93     init_status
  94
  95 let initialize_makelib init_status =
  96   wants [ConfigurationFile] init_status;
  97   if not (already_configured [Makelib] init_status) then
  98     begin
  99       MatitamakeLib.initialize ();
 100       Makelib::init_status
 101     end
 102   else
 103     init_status
 104
 105 let initialize_environment init_status =
 106   wants [ConfigurationFile] init_status;
 107   if not (already_configured [Getter;Environment] init_status) then
 108     begin
 109       Http_getter.init ();
 110       CicEnvironment.set_trust (* environment trust *)
 111         (let trust =
 112           Helm_registry.get_opt_default Helm_registry.get_bool
 113             ~default:true "matita.environment_trust" in
 114          fun _ -> trust);
 115       Getter::Environment::init_status
 116     end
 117   else
 118     init_status
 119
 120 let status = ref []
 121
 122 let usages = Hashtbl.create 11 (** app name (e.g. "matitac") -> usage string *)
 123 let _ =
 124   List.iter
 125     (fun (name, s) -> Hashtbl.replace usages name s)
 126     [ "matitac",
 127         sprintf "MatitaC v%s
 128 Usage: matitac [ OPTION ... ] FILE
 129 Options:"
 130           BuildTimeConf.version;
 131       "gragrep",
 132         sprintf "Grafite Grep v%s
 133 Usage: gragrep [ -r ] PATH
 134 Options:"
 135           BuildTimeConf.version;
 136       "matita",
 137         sprintf "Matita v%s
 138 Usage: matita [ OPTION ... ] [ FILE ... ]
 139 Options:"
 140           BuildTimeConf.version;
 141       "cicbrowser",
 142         sprintf
 143           "CIC Browser v%s
 144 Usage: cicbrowser [ URL | WHELP QUERY ]
 145 Options:"
 146           BuildTimeConf.version;
 147       "matitadep",
 148         sprintf "MatitaDep v%s
 149 Usage: matitadep [ OPTION ... ] FILE ...
 150 Options:"
 151           BuildTimeConf.version;
 152       "matitaclean",
 153         sprintf "MatitaClean v%s
 154 Usage: matitaclean all
 155        matitaclean [ (FILE | URI) ... ]
 156 Options:"
 157           BuildTimeConf.version;
 158       "matitamake",
 159         sprintf "MatitaMake v%s
 160 Usage: matitamake [ OPTION ... ] (init | clean | list | destroy | build)
 161   init
 162     Parameters: name (the name of the development, required)
 163     Description: tells matitamake that a new development radicated
 164       in the current working directory should be handled.
 165   clean
 166     Parameters: name (the name of the development to destroy, optional)
 167       If omitted the development that holds the current working
 168       directory is used (if any).
 169     Description: clean the develpoment.
 170   list
 171     Parameters:
 172     Description: lists the known developments and their roots.
 173   destroy
 174     Parameters: name (the name of the development to destroy, required)
 175     Description: deletes a development (only from matitamake metadat, no
 176       .ma files will be deleted).
 177   build
 178     Parameters: name (the name of the development to build, required)
 179     Description: completely builds the develpoment.
 180 Notes:
 181   If target is omitted an 'all' will be used as the default.
 182   With -build you can build a development wherever it is.
 183   If you specify a target it implicitly refers to the development that
 184   holds the current working directory (if any).
 185 Options:"
 186           BuildTimeConf.version;
 187     ]
 188 let default_usage =
 189   sprintf "Matita v%s\nUsage: matita [ ARG ]\nOptions:" BuildTimeConf.version
 190
 191 let usage () =
 192   let basename = Filename.basename Sys.argv.(0) in
 193   let usage_key =
 194     try Filename.chop_extension basename with Invalid_argument  _ -> basename
 195   in
 196   try Hashtbl.find usages usage_key with Not_found -> default_usage
 197
 198 let extra_cmdline_specs = ref []
 199 let add_cmdline_spec l = extra_cmdline_specs := l @ !extra_cmdline_specs
 200
 201 let parse_cmdline init_status =
 202   if not (already_configured [CmdLine] init_status) then begin
 203     let includes = ref [ BuildTimeConf.stdlib_dir ] in
 204     let args = ref [] in
 205     let add_l l = fun s -> l := s :: !l in
 206     let reduce_verbosity () =
 207       Helm_registry.set_int "matita.verbosity"
 208         (Helm_registry.get_int "matita.verbosity" - 1) in
 209     let increase_verbosity () =
 210       Helm_registry.set_int "matita.verbosity"
 211         (Helm_registry.get_int "matita.verbosity" + 1) in
 212     let arg_spec =
 213       let std_arg_spec = [
 214         "-I", Arg.String (add_l includes),
 215           ("<path> Adds path to the list of searched paths for the "
 216            ^ "include command");
 217         "-conffile", Arg.Set_string conffile,
 218           (Printf.sprintf ("<filename> Read configuration from filename"
 219              ^^ "\n    Default: %s")
 220             BuildTimeConf.matita_conf);
 221         "-force",
 222             Arg.Unit (fun () -> Helm_registry.set_bool "matita.force" true),
 223             ("Force actions that would not be executed per default");
 224         "-nodb", Arg.Unit (fun () -> Helm_registry.set_bool "db.nodb" true),
 225             ("Avoid using external database connection"
 226              ^ "\n    WARNING: disable many features");
 227         "-noprofile",
 228           Arg.Unit (fun () -> Helm_registry.set_bool "matita.profile" false),
 229           "Turns off profiling printings";
 230         "-preserve",
 231           Arg.Unit (fun () -> Helm_registry.set_bool "matita.preserve" true),
 232           "Turns off automatic baseuri cleaning";
 233         "-q", Arg.Unit reduce_verbosity, "Reduce verbosity";
 234         "-system", Arg.Unit (fun () ->
 235               Helm_registry.set_bool "matita.system" true),
 236             ("Act on the system library instead of the user one"
 237              ^ "\n    WARNING: not for the casual user");
 238         "-v", Arg.Unit increase_verbosity, "Increase verbosity";
 239       ] in
 240       let debug_arg_spec =
 241         if BuildTimeConf.debug then
 242           [ "-debug",
 243             Arg.Unit (fun () -> Helm_registry.set_bool "matita.debug" true),
 244               ("Do not catch top-level exception "
 245               ^ "(useful for backtrace inspection)");
 246           ]
 247         else []
 248       in
 249       std_arg_spec @ debug_arg_spec @ !extra_cmdline_specs
 250     in
 251     let set_list ~key l =
 252       Helm_registry.set_list Helm_registry.of_string ~key ~value:(List.rev !l)
 253     in
 254     Arg.parse arg_spec (add_l args) (usage ());
 255     set_list ~key:"matita.includes" includes;
 256     set_list ~key:"matita.args" args;
 257     HExtlib.set_profiling_printings
 258       (fun () -> Helm_registry.get_bool "matita.profile");
 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 initialize_all () =
 268   status :=
 269     List.fold_left (fun s f -> f s) !status
 270     [ fill_registry; parse_cmdline; load_configuration; initialize_makelib;
 271       initialize_db; initialize_environment ]
 272 (*     initialize_notation
 273       (initialize_environment
 274         (initialize_db
 275           (initialize_makelib
 276             (load_configuration
 277               (parse_cmdline !status))))) *)
 278
 279 let load_configuration_file () =
 280   status := load_configuration !status
 281
 282 let parse_cmdline () =
 283   status := parse_cmdline !status
 284
 285 let fill_registry () =
 286   status := fill_registry !status
 287