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 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.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 ]
  58
  59 let set_registry_values =
  60   List.iter
  61     (fun key, value ->
  62        if not (Helm_registry.has key) then Helm_registry.set ~key ~value)
  63
  64 let fill_registry init_status =
  65   if not (already_configured [ Registry ] init_status) then begin
  66     set_registry_values registry_defaults;
  67     Registry :: init_status
  68   end else
  69     init_status
  70
  71 let load_configuration 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       let home = Helm_registry.get_string "matita.basedir" in
  80       let user_conf_file = home ^ "/matita.conf.xml" in
  81       if HExtlib.is_regular user_conf_file then
  82         begin
  83           HLog.message ("Loading additional conf file from " ^ user_conf_file);
  84           try
  85             Helm_registry.load_from user_conf_file
  86           with exn ->
  87             HLog.error
  88               ("While loading conf file: " ^ snd (MatitaExcPp.to_string exn))
  89         end;
  90       ConfigurationFile::init_status
  91     end
  92   else
  93     init_status
  94
  95 let initialize_db init_status =
  96   wants [ ConfigurationFile; CmdLine ] init_status;
  97   if not (already_configured [ Db ] init_status) then
  98     begin
  99       if not (Helm_registry.get_bool "matita.system") then
 100         MetadataTypes.ownerize_tables (Helm_registry.get "matita.owner");
 101       LibraryDb.create_owner_environment ();
 102       Db::init_status
 103     end
 104   else
 105     init_status
 106
 107 let initialize_environment init_status =
 108   wants [CmdLine] init_status;
 109   if not (already_configured [Getter;Environment] init_status) then
 110     begin
 111       Http_getter.init ();
 112       if Helm_registry.get_bool "matita.system" then
 113         Http_getter_storage.activate_system_mode ();
 114       CicEnvironment.set_trust (* environment trust *)
 115         (let trust =
 116           Helm_registry.get_opt_default Helm_registry.get_bool
 117             ~default:true "matita.environment_trust" in
 118          fun _ -> trust);
 119       Getter::Environment::init_status
 120     end
 121   else
 122     init_status
 123
 124 let status = ref []
 125
 126 let usages = Hashtbl.create 11 (** app name (e.g. "matitac") -> usage string *)
 127 let _ =
 128   List.iter
 129     (fun (name, s) -> Hashtbl.replace usages name s)
 130     [ "matitac",
 131         Printf.sprintf "Matita batch compiler v%s
 132 Usage: matitac [ OPTION ... ] FILE
 133 Options:"
 134           BuildTimeConf.version;
 135         "matitaprover",
 136         Printf.sprintf "Matita (TPTP) prover v%s
 137 Usage: matitaprover [ -tptppath ] FILE.p
 138 Options:"
 139           BuildTimeConf.version;
 140       "matita",
 141         Printf.sprintf "Matita interactive theorem prover v%s
 142 Usage: matita [ OPTION ... ] [ FILE ]
 143 Options:"
 144           BuildTimeConf.version;
 145       "matitadep",
 146         Printf.sprintf "Matita depency file generator v%s
 147 Usage: matitadep [ OPTION ... ]
 148 Options:"
 149           BuildTimeConf.version;
 150       "matitaclean",
 151         Printf.sprintf "MatitaClean v%s
 152 Usage: matitaclean all
 153        matitaclean ( FILE | URI )
 154 Options:"
 155           BuildTimeConf.version;
 156     ]
 157 let default_usage =
 158   Printf.sprintf
 159     "Matita v%s\nUsage: matita [ ARG ]\nOptions:" BuildTimeConf.version
 160
 161 let usage () =
 162   let basename = Filename.basename Sys.argv.(0) in
 163   let usage_key =
 164     try Filename.chop_extension basename with Invalid_argument  _ -> basename
 165   in
 166   try Hashtbl.find usages usage_key with Not_found -> default_usage
 167 ;;
 168
 169 let dump f =
 170    let module G = GrafiteAst in
 171    let module L = LexiconAst in
 172    let module H = HExtlib in
 173    Helm_registry.set_bool "matita.moo" false;
 174    let floc = H.dummy_floc in
 175    let nl_ast = G.Comment (floc, G.Note (floc, "")) in
 176    let och = open_out f in
 177    let atexit () = close_out och in
 178    let out_comment och s =
 179       let s = if s <> "" && s.[0] = '*' then "#" ^ s else s in
 180       Printf.fprintf och "%s%s%s\n\n" "(*" s "*)"
 181    in
 182    let out_line_comment och s =
 183       let l = 70 - String.length s in
 184       let s = Printf.sprintf " %s %s" s (String.make l '*') in
 185       out_comment och s
 186    in
 187    let out_preamble och (path, lines) =
 188       let ich = open_in path in
 189       let rec print i =
 190          if i > 0 then
 191             let s = input_line ich in
 192             begin Printf.fprintf och "%s\n" s; print (pred i) end
 193       in
 194       print lines;
 195       out_line_comment och "This file was automatically generated: do not edit"
 196    in
 197    let pp_ast_statement st =
 198      GrafiteAstPp.pp_statement ~term_pp:CicNotationPp.pp_term
 199        ~map_unicode_to_tex:(Helm_registry.get_bool
 200          "matita.paste_unicode_as_tex")
 201        ~lazy_term_pp:CicNotationPp.pp_term
 202        ~obj_pp:(CicNotationPp.pp_obj CicNotationPp.pp_term) st
 203    in
 204    let nl () =  output_string och (pp_ast_statement nl_ast) in
 205    let rt_base_dir = Filename.dirname Sys.argv.(0) in
 206    let path = Filename.concat rt_base_dir "matita.ma.templ" in
 207    let lines = 14 in
 208    out_preamble och (path, lines);
 209    let grafite_parser_cb fname =
 210       let ast = G.Executable
 211         (floc, G.Command (floc, G.Include (floc, fname))) in
 212       output_string och (pp_ast_statement ast); nl (); nl ()
 213    in
 214    let matita_engine_cb = function
 215       | G.Executable (_, G.Macro (_, G.Inline _))
 216       | G.Executable (_, G.Command (_, G.Include _)) -> ()
 217       | ast                                          ->
 218          output_string och (pp_ast_statement ast); nl (); nl ()
 219    in
 220    let matitac_lib_cb = output_string och in
 221    GrafiteParser.set_callback grafite_parser_cb;
 222    MatitaEngine.set_callback matita_engine_cb;
 223    MatitacLib.set_callback matitac_lib_cb;
 224    at_exit atexit
 225 ;;
 226
 227 let extra_cmdline_specs = ref []
 228 let add_cmdline_spec l = extra_cmdline_specs := l @ !extra_cmdline_specs
 229
 230 let parse_cmdline init_status =
 231   if not (already_configured [CmdLine] init_status) then begin
 232     wants [Registry] init_status;
 233     let includes = ref [] in
 234     let default_includes = [
 235       BuildTimeConf.stdlib_dir_devel;
 236       BuildTimeConf.stdlib_dir_installed ; ]
 237     in
 238     let absolutize s =
 239       if Pcre.pmatch ~pat:"^/" s then s else Sys.getcwd () ^"/"^s
 240     in
 241     let args = ref [] in
 242     let add_l l = fun s -> l := s :: !l in
 243     let print_version () =
 244             Printf.printf "%s\n" BuildTimeConf.version;exit 0 in
 245     let no_innertypes () =
 246       Helm_registry.set_bool "matita.noinnertypes" true in
 247     let set_baseuri s =
 248       match Str.split (Str.regexp "::") s with
 249       | [path; uri] -> Helm_registry.set "matita.baseuri"
 250           (HExtlib.normalize_path (absolutize path)^" "^uri)
 251       | _ -> raise (Failure "bad baseuri, use -b 'path::uri'")
 252     in
 253     let arg_spec =
 254       let std_arg_spec = [
 255         "-b", Arg.String set_baseuri, "<path::uri> forces the baseuri of path";
 256         "-I", Arg.String (add_l includes),
 257           ("<path> Adds path to the list of searched paths for the "
 258            ^ "include command");
 259         "-conffile", Arg.Set_string conffile,
 260           (Printf.sprintf ("<filename> Read configuration from filename"
 261              ^^ "\n    Default: %s")
 262             BuildTimeConf.matita_conf);
 263         "-force",
 264             Arg.Unit (fun () -> Helm_registry.set_bool "matita.force" true),
 265             ("Force actions that would not be executed per default");
 266         "-noprofile",
 267           Arg.Unit (fun () -> Helm_registry.set_bool "matita.profile" false),
 268           "Turns off profiling printings";
 269         "-noinnertypes", Arg.Unit no_innertypes,
 270           "Turns off inner types generation while publishing";
 271         "-profile-only",
 272           Arg.String (fun rex -> Helm_registry.set "matita.profile_only" rex),
 273           "Activates only profiler with label matching the provided regex";
 274         "-system", Arg.Unit (fun () ->
 275               Helm_registry.set_bool "matita.system" true),
 276             ("Act on the system library instead of the user one"
 277              ^ "\n    WARNING: not for the casual user");
 278         "-dump", Arg.String dump,
 279           "<filename> Dump with expanded macros to <filename>";
 280         "-v",
 281           Arg.Unit (fun () -> Helm_registry.set_bool "matita.verbose" true),
 282           "Verbose mode";
 283         "--version", Arg.Unit print_version, "Prints version";
 284       ] in
 285       let debug_arg_spec =
 286         if BuildTimeConf.debug then
 287           [ "-debug",
 288             Arg.Unit (fun () -> Helm_registry.set_bool "matita.debug" true),
 289               ("Do not catch top-level exception "
 290               ^ "(useful for backtrace inspection)");
 291             "-onepass",
 292             Arg.Unit (fun () -> GrafiteDisambiguator.only_one_pass := true),
 293             "Enable only one disambiguation pass";
 294           ]
 295         else []
 296       in
 297       std_arg_spec @ debug_arg_spec @ !extra_cmdline_specs
 298     in
 299     let set_list ~key l =
 300       Helm_registry.set_list Helm_registry.of_string ~key ~value:l
 301     in
 302     Arg.parse arg_spec (add_l args) (usage ());
 303     let includes =
 304       List.map (fun x -> HExtlib.normalize_path (absolutize x))
 305        ((List.rev !includes) @ default_includes)
 306     in
 307     set_list ~key:"matita.includes" includes;
 308     let args = List.rev (List.filter (fun x -> x <> "") !args) in
 309     set_list ~key:"matita.args" args;
 310     HExtlib.set_profiling_printings
 311       (fun s ->
 312         Helm_registry.get_bool "matita.profile" &&
 313         Pcre.pmatch
 314           ~pat:(Helm_registry.get_opt_default
 315                   Helm_registry.string ~default:".*" "matita.profile_only")
 316           s);
 317     CmdLine :: init_status
 318   end else
 319     init_status
 320
 321 let die_usage () =
 322   print_endline (usage ());
 323   exit 1
 324
 325 let conf_components =
 326   [ load_configuration; fill_registry; parse_cmdline]
 327
 328 let other_components =
 329   [ initialize_db; initialize_environment ]
 330
 331 let initialize_all () =
 332   status :=
 333     List.fold_left (fun s f -> f s) !status
 334     (conf_components @ other_components)
 335
 336 let parse_cmdline_and_configuration_file () =
 337   status := List.fold_left (fun s f -> f s) !status conf_components
 338
 339 let initialize_environment () =
 340   status := initialize_environment !status
 341
 342 let _ =
 343   Inversion_principle.init ()