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 (* FG: old function left for reference *)
  45 let exclude excluded_files files =
  46    let map file = not (List.mem (fix_name file) excluded_files) in
  47    List.filter map files
  48
  49 let main () =
  50 (*  let _ = print_times "inizio" in *)
  51   let include_paths = 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   (* helpers *)
  61   let rec baseuri_of_script s =
  62      try Hashtbl.find baseuri_of s
  63      with Not_found ->
  64        let _,b,_,_ =
  65          Librarian.baseuri_of_script ~include_paths:!include_paths s
  66        in
  67        Hashtbl.add baseuri_of s b;
  68        Hashtbl.add baseuri_of_inv b s;
  69        let _ =
  70           if Filename.check_suffix s ".mma" then
  71              let generated = Filename.chop_suffix s ".mma" ^ ".ma" in
  72              ignore (baseuri_of_script generated)
  73        in
  74        b
  75   in
  76   let script_of_baseuri ma b =
  77     try Some (Hashtbl.find baseuri_of_inv b)
  78     with Not_found ->
  79       HLog.error ("Skipping dependency of '"^ma^"' over '"^b^"'");
  80       HLog.error ("Please include the file defining such baseuri, or fix");
  81       HLog.error ("possibly incorrect verbatim URIs in the .ma file.");
  82       None
  83   in
  84   let buri alias = U.buri_of_uri (U.uri_of_string alias) in
  85   let resolve alias current_buri =
  86     let buri = buri alias in
  87     if buri <> current_buri then Some buri else None
  88   in
  89   (* initialization *)
  90   MatitaInit.add_cmdline_spec
  91     ["-dot", Arg.Unit set_dot_file,
  92         "Save dependency graph in dot format and generate a png";
  93      "-stdout", Arg.Set use_stdout,
  94         "Print dependences on stdout"
  95     ];
  96   MatitaInit.parse_cmdline_and_configuration_file ();
  97   MatitaInit.initialize_environment ();
  98   if not (Helm_registry.get_bool "matita.verbose") then MatitaMisc.shutup ();
  99   let cmdline_args = HR.get_list HR.string "matita.args" in
 100   let test x =
 101      Filename.check_suffix x ".ma" || Filename.check_suffix x ".mma"
 102   in
 103   let files = fun () -> match cmdline_args with
 104      | [] -> HExtlib.find ~test "."
 105      | _  -> cmdline_args
 106   in
 107   let args =
 108       let roots = Librarian.find_roots_in_dir (Sys.getcwd ()) in
 109       match roots with
 110       | [] ->
 111          prerr_endline ("No roots found in " ^ Sys.getcwd ());
 112          exit 1
 113       | [x] ->
 114          Sys.chdir (Filename.dirname x);
 115          let opts = Librarian.load_root_file "root" in
 116          include_paths :=
 117            (try Str.split (Str.regexp " ") (List.assoc "include_paths" opts)
 118            with Not_found -> []) @
 119            (HR.get_list HR.string "matita.includes");
 120          files ()
 121       | _ ->
 122          let roots = List.map (HExtlib.chop_prefix (Sys.getcwd()^"/")) roots in
 123          prerr_endline ("Too many roots found:\n\t"^String.concat "\n\t" roots);
 124          prerr_endline ("\nEnter one of these directories and retry");
 125          exit 1
 126   in
 127   let ma_files = args in
 128   (* here we go *)
 129   (* fills:
 130               Hashtbl.add include_deps     ma_file ma_file
 131               Hashtbl.add include_deps_dot ma_file baseuri
 132   *)
 133 (*  let _ = print_times "prima di iter1" in *)
 134   List.iter (fun ma_file -> ignore (baseuri_of_script ma_file)) ma_files;
 135 (*  let _ = print_times "in mezzo alle due iter" in *)
 136   let map s _ l = s :: l in
 137   let ma_files = Hashtbl.fold map baseuri_of [] in
 138   List.iter
 139    (fun ma_file ->
 140       let _ = if Filename.check_suffix ma_file ".mma" then
 141          let generated = Filename.chop_suffix ma_file ".mma" ^ ".ma" in
 142          Hashtbl.add include_deps generated ma_file;
 143       in
 144       let ma_baseuri = baseuri_of_script ma_file in
 145       let dependencies =
 146          try DependenciesParser.deps_of_file ma_file
 147          with Sys_error _ -> []
 148       in
 149       let handle_uri uri =
 150          if not (Http_getter_storage.is_legacy uri) then
 151          let dep = resolve uri ma_baseuri in
 152          match dep with
 153             | None   -> ()
 154             | Some u ->
 155                  match script_of_baseuri ma_file u with
 156                       | Some d -> Hashtbl.add include_deps ma_file d
 157                       | None   -> ()
 158       in
 159       let handle_script path =
 160          ignore (baseuri_of_script path);
 161          Hashtbl.add include_deps ma_file path
 162       in
 163       List.iter
 164        (function
 165          | DependenciesParser.UriDep uri      ->
 166             let uri = UriManager.string_of_uri uri in
 167             handle_uri uri
 168          | DependenciesParser.InlineDep path  ->
 169             if Librarian.is_uri path
 170             then handle_uri path else handle_script path
 171          | DependenciesParser.IncludeDep path ->
 172             handle_script path)
 173        dependencies)
 174    ma_files;
 175   (* generate regular depend output *)
 176 (*  let _ = print_times "dopo di iter2" in *)
 177   let deps =
 178     List.fold_left
 179      (fun acc ma_file ->
 180       let deps = Hashtbl.find_all include_deps ma_file in
 181       let deps = List.fast_sort Pervasives.compare deps in
 182       let deps = HExtlib.list_uniq deps in
 183       let deps = List.map fix_name deps in
 184       (fix_name ma_file, deps) :: acc)
 185      [] ma_files
 186   in
 187   let extern =
 188     List.fold_left
 189       (fun acc (_,d) ->
 190         List.fold_left
 191           (fun a x ->
 192              if List.exists (fun (t,_) -> x=t) deps then a
 193              else x::a)
 194           acc d)
 195       [] deps
 196   in
 197   let where = if !use_stdout then None else Some (Sys.getcwd()) in
 198   Librarian.write_deps_file where
 199    (deps@HExtlib.list_uniq (List.sort Pervasives.compare (List.map (fun x ->
 200            x,[]) extern)));
 201   (* dot generation *)
 202   if !dot_file <> "" then
 203     begin
 204       let oc = open_out !dot_file in
 205       let fmt = Format.formatter_of_out_channel oc in
 206       GraphvizPp.Dot.header fmt;
 207       List.iter
 208        (fun (ma_file,deps) ->
 209         GraphvizPp.Dot.node ma_file fmt;
 210         List.iter (fun dep -> GraphvizPp.Dot.edge ma_file dep fmt) deps)
 211        deps;
 212       List.iter
 213         (fun x -> GraphvizPp.Dot.node ~attrs:["style","dashed"] x fmt)
 214         extern;
 215       GraphvizPp.Dot.trailer fmt;
 216       close_out oc;
 217       ignore(Sys.command ("tred "^ !dot_file^"| dot -Tpng -o"^dot_name^".png"));
 218       HLog.message ("Type 'eog "^dot_name^".png' to view the graph");
 219     end;
 220 (*    let _ = print_times "fine" in () *)