helm/software/matita/matitadep.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 module S = Set.Make (String)
  29
  30 module GA = GrafiteAst
  31 module U = UriManager
  32 module HR = Helm_registry
  33
  34 let print_times msg =
  35    let times = Unix.times () in
  36    let stamp = times.Unix.tms_utime +. times.Unix.tms_utime in
  37    Printf.printf "TIME STAMP: %s: %f\n" msg stamp; flush stdout; stamp
  38
  39 let fix_name f =
  40    let f =
  41       if Pcre.pmatch ~pat:"^\\./" f then String.sub f 2 (String.length f - 2)
  42       else f
  43    in
  44    HExtlib.normalize_path f
  45
  46 (* FG: old function left for reference *)
  47 let exclude excluded_files files =
  48    let map file = not (List.mem (fix_name file) excluded_files) in
  49    List.filter map files
  50
  51 let generate_theory theory_file deps =
  52    if theory_file = "" then deps else
  53    let map (files, deps) (t, d) =
  54       if t = theory_file then files, deps else
  55       S.add t files, List.fold_left (fun deps dep -> S.add dep deps) deps d
  56    in
  57    let out_include och dep =
  58       Printf.fprintf och "include \"%s\".\n\n" dep
  59    in
  60    let fileset, depset = List.fold_left map (S.empty, S.empty) deps in
  61    let top_depset = S.diff fileset depset in
  62    let och = open_out theory_file in
  63    begin
  64       MatitaMisc.out_preamble och;
  65       S.iter (out_include och) top_depset;
  66       close_out och;
  67       (theory_file, S.elements top_depset) :: deps
  68    end
  69
  70 let main () =
  71 (*  let _ = print_times "inizio" in *)
  72   let include_paths = ref [] in
  73   let use_stdout = ref false in
  74   let theory_file = ref "" in
  75   (* all are maps from "file" to "something" *)
  76   let include_deps = Hashtbl.create 13 in
  77   let baseuri_of = Hashtbl.create 13 in
  78   let baseuri_of_inv = Hashtbl.create 13 in
  79   let dot_name = "depends" in
  80   let dot_file = ref "" in
  81   let set_dot_file () = dot_file := dot_name^".dot" in
  82   let set_theory_file s = theory_file := s ^ ".ma" in
  83   (* helpers *)
  84   let rec baseuri_of_script s =
  85      try Hashtbl.find baseuri_of s
  86      with Not_found ->
  87        let _,b,_,_ =
  88          Librarian.baseuri_of_script ~include_paths:!include_paths s
  89        in
  90        Hashtbl.add baseuri_of s b;
  91        Hashtbl.add baseuri_of_inv b s;
  92        let _ =
  93           if Filename.check_suffix s ".mma" then
  94              let generated = Filename.chop_suffix s ".mma" ^ ".ma" in
  95              ignore (baseuri_of_script generated)
  96        in
  97        b
  98   in
  99   let script_of_baseuri ma b =
 100     try Some (Hashtbl.find baseuri_of_inv b)
 101     with Not_found ->
 102       HLog.error ("Skipping dependency of '"^ma^"' over '"^b^"'");
 103       HLog.error ("Please include the file defining such baseuri, or fix");
 104       HLog.error ("possibly incorrect verbatim URIs in the .ma file.");
 105       None
 106   in
 107   let buri alias = U.buri_of_uri (U.uri_of_string alias) in
 108   let resolve alias current_buri =
 109     let buri = buri alias in
 110     if buri <> current_buri then Some buri else None
 111   in
 112   (* initialization *)
 113   MatitaInit.add_cmdline_spec
 114     ["-dot", Arg.Unit set_dot_file,
 115         "Save dependency graph in dot format and generate a png";
 116      "-stdout", Arg.Set use_stdout,
 117         "Print dependences on stdout";
 118      "-theory <name>", Arg.String set_theory_file,
 119         "generate a theory file <name>.ma (it includes all other files)"
 120     ];
 121   MatitaInit.parse_cmdline_and_configuration_file ();
 122   MatitaInit.initialize_environment ();
 123   if not (Helm_registry.get_bool "matita.verbose") then MatitaMisc.shutup ();
 124   let cmdline_args = HR.get_list HR.string "matita.args" in
 125   let test x =
 126      Filename.check_suffix x ".ma" || Filename.check_suffix x ".mma"
 127   in
 128   let files = fun () -> match cmdline_args with
 129      | [] -> HExtlib.find ~test "."
 130      | _  -> cmdline_args
 131   in
 132   let args =
 133       let roots = Librarian.find_roots_in_dir (Sys.getcwd ()) in
 134       match roots with
 135       | [] ->
 136          prerr_endline ("No roots found in " ^ Sys.getcwd ());
 137          exit 1
 138       | [x] ->
 139          Sys.chdir (Filename.dirname x);
 140          let opts = Librarian.load_root_file "root" in
 141          include_paths :=
 142            (try Str.split (Str.regexp " ") (List.assoc "include_paths" opts)
 143            with Not_found -> []) @
 144            (HR.get_list HR.string "matita.includes");
 145          files ()
 146       | _ ->
 147          let roots = List.map (HExtlib.chop_prefix (Sys.getcwd()^"/")) roots in
 148          prerr_endline ("Too many roots found:\n\t"^String.concat "\n\t" roots);
 149          prerr_endline ("\nEnter one of these directories and retry");
 150          exit 1
 151   in
 152   let ma_files = args in
 153   (* here we go *)
 154   (* fills:
 155               Hashtbl.add include_deps     ma_file ma_file
 156               Hashtbl.add include_deps_dot ma_file baseuri
 157   *)
 158 (*  let _ = print_times "prima di iter1" in *)
 159   List.iter (fun ma_file -> ignore (baseuri_of_script ma_file)) ma_files;
 160 (*  let _ = print_times "in mezzo alle due iter" in *)
 161   let map s _ l = s :: l in
 162   let ma_files = Hashtbl.fold map baseuri_of [] in
 163   List.iter
 164    (fun ma_file ->
 165       let _ = if Filename.check_suffix ma_file ".mma" then
 166          let generated = Filename.chop_suffix ma_file ".mma" ^ ".ma" in
 167          Hashtbl.add include_deps generated ma_file;
 168       in
 169       let ma_baseuri = baseuri_of_script ma_file in
 170       let dependencies =
 171          try DependenciesParser.deps_of_file ma_file
 172          with Sys_error _ -> []
 173       in
 174       let handle_uri uri =
 175          if not (Http_getter_storage.is_legacy uri) then
 176          let dep = resolve uri ma_baseuri in
 177          match dep with
 178             | None   -> ()
 179             | Some u ->
 180                  match script_of_baseuri ma_file u with
 181                       | Some d -> Hashtbl.add include_deps ma_file d
 182                       | None   -> ()
 183       in
 184       let handle_script path =
 185          ignore (baseuri_of_script path);
 186          Hashtbl.add include_deps ma_file path
 187       in
 188       List.iter
 189        (function
 190          | DependenciesParser.UriDep uri      ->
 191             let uri = UriManager.string_of_uri uri in
 192             handle_uri uri
 193          | DependenciesParser.InlineDep path  ->
 194             if Librarian.is_uri path
 195             then handle_uri path else handle_script path
 196          | DependenciesParser.IncludeDep path ->
 197             handle_script path)
 198        dependencies)
 199    ma_files;
 200   (* generate regular depend output *)
 201 (*  let _ = print_times "dopo di iter2" in *)
 202   let deps =
 203     List.fold_left
 204      (fun acc ma_file ->
 205       let deps = Hashtbl.find_all include_deps ma_file in
 206       let deps = List.fast_sort Pervasives.compare deps in
 207       let deps = HExtlib.list_uniq deps in
 208       let deps = List.map fix_name deps in
 209       (fix_name ma_file, deps) :: acc)
 210      [] ma_files
 211   in
 212   let extern =
 213     List.fold_left
 214       (fun acc (_,d) ->
 215         List.fold_left
 216           (fun a x ->
 217              if List.exists (fun (t,_) -> x=t) deps then a
 218              else x::a)
 219           acc d)
 220       [] deps
 221   in
 222   let where = if !use_stdout then None else Some (Sys.getcwd()) in
 223   let all_deps =
 224      deps @
 225      HExtlib.list_uniq (List.sort Pervasives.compare (List.map (fun x -> x,[]) extern))
 226   in
 227   (* theory generation *)
 228   let all_deps_and_theory = generate_theory !theory_file all_deps in
 229   (* matita depend file generation *)
 230   Librarian.write_deps_file where all_deps_and_theory;
 231   (* dot generation *)
 232   if !dot_file <> "" then
 233     begin
 234       let oc = open_out !dot_file in
 235       let fmt = Format.formatter_of_out_channel oc in
 236       GraphvizPp.Dot.header fmt;
 237       List.iter
 238        (fun (ma_file,deps) ->
 239         GraphvizPp.Dot.node ma_file fmt;
 240         List.iter (fun dep -> GraphvizPp.Dot.edge ma_file dep fmt) deps)
 241        deps;
 242       List.iter
 243         (fun x -> GraphvizPp.Dot.node ~attrs:["style","dashed"] x fmt)
 244         extern;
 245       GraphvizPp.Dot.trailer fmt;
 246       close_out oc;
 247       ignore(Sys.command ("tred "^ !dot_file^"| dot -Tpng -o"^dot_name^".png"));
 248       HLog.message ("Type 'eog "^dot_name^".png' to view the graph");
 249     end;
 250 (*    let _ = print_times "fine" in () *)