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