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