helm/matita/matitamakeLib.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 let logger = fun mark ->
  27   match mark with
  28   | `Error -> HLog.error
  29   | `Warning -> HLog.warn
  30   | `Debug -> HLog.debug
  31   | `Message -> HLog.message
  32 ;;
  33
  34 type development =
  35   { root: string ; name: string }
  36
  37 let developments = ref []
  38
  39 let pool () = Helm_registry.get "matita.basedir" ^ "/matitamake/" ;;
  40 let rootfile = "/root" ;;
  41
  42 let ls_dir dir =
  43   try
  44     let d = Unix.opendir dir in
  45     let content = ref [] in
  46     try
  47       while true do
  48         let name = Unix.readdir d in
  49         if name <> "." && name <> ".." then
  50           content := name :: !content
  51       done;
  52       Some []
  53     with End_of_file -> Unix.closedir d; Some !content
  54   with Unix.Unix_error _ -> None
  55
  56 let initialize () =
  57   (* create a base env if none *)
  58   HExtlib.mkdir (pool ());
  59   (* load developments *)
  60   match ls_dir (pool ()) with
  61   | None -> logger `Error ("Unable to list directory " ^ pool ())
  62   | Some l ->
  63       List.iter
  64         (fun name ->
  65           let root =
  66             try
  67               Some (HExtlib.input_file (pool () ^ name ^ rootfile))
  68             with Unix.Unix_error _ ->
  69               logger `Warning ("Malformed development " ^ name);
  70               None
  71           in
  72           match root with
  73           | None -> ()
  74           | Some root ->
  75               developments := {root = root ; name = name} :: !developments)
  76       l
  77
  78 (* finds the makefile path for development devel *)
  79 let makefile_for_development devel =
  80   let develdir = pool () ^ devel.name in
  81   develdir ^ "/makefile"
  82 ;;
  83
  84 (* given a dir finds a development that is radicated in it or below *)
  85 let development_for_dir dir =
  86   let is_prefix_of d1 d2 =
  87     let len1 = String.length d1 in
  88     let len2 = String.length d2 in
  89     if len2 < len1 then
  90       false
  91     else
  92       let pref = String.sub d2 0 len1 in
  93       pref = d1
  94   in
  95   (* it must be unique *)
  96   try
  97     Some (List.find (fun d -> is_prefix_of d.root dir) !developments)
  98   with Not_found -> None
  99 ;;
 100
 101 let development_for_name name =
 102   try
 103     Some (List.find (fun d -> d.name = name) !developments)
 104   with Not_found -> None
 105
 106 (* dumps the deveopment to disk *)
 107 let dump_development devel =
 108   let devel_dir = pool () ^ devel.name in
 109   HExtlib.mkdir devel_dir;
 110   HExtlib.output_file ~filename:(devel_dir ^ rootfile) ~text:devel.root
 111 ;;
 112
 113 let list_known_developments () =
 114   List.map (fun r -> r.name,r.root) !developments
 115
 116 let am_i_opt () =
 117   if Pcre.pmatch ~pat:"\\.opt$" Sys.argv.(0) then ".opt" else ""
 118
 119 let rebuild_makefile development =
 120   let makefilepath = makefile_for_development development in
 121   let template =
 122     HExtlib.input_file BuildTimeConf.matitamake_makefile_template
 123   in
 124   let cc = BuildTimeConf.runtime_base_dir ^ "/matitac" ^ am_i_opt () in
 125   let rm = BuildTimeConf.runtime_base_dir ^ "/matitaclean" ^ am_i_opt () in
 126   let mm = BuildTimeConf.runtime_base_dir ^ "/matitadep" ^ am_i_opt () in
 127   let df = pool () ^ development.name ^ "/depend" in
 128   let template = Pcre.replace ~pat:"@ROOT@" ~templ:development.root template in
 129   let template = Pcre.replace ~pat:"@CC@" ~templ:cc template in
 130   let template = Pcre.replace ~pat:"@DEP@" ~templ:mm template in
 131   let template = Pcre.replace ~pat:"@DEPFILE@" ~templ:df template in
 132   let template = Pcre.replace ~pat:"@CLEAN@" ~templ:rm template in
 133   HExtlib.output_file ~filename:makefilepath ~text:template
 134
 135 (* creates a new development if possible *)
 136 let initialize_development name dir =
 137   let name = Pcre.replace ~pat:" " ~templ:"_" name in
 138   let dev = {name = name ; root = dir} in
 139   match development_for_dir dir with
 140   | Some d ->
 141       logger `Error
 142         ("Directory " ^ dir ^ " is already handled by development " ^ d.name);
 143       logger `Error
 144         ("Development " ^ d.name ^ " is rooted in " ^ d.root);
 145       logger `Error
 146         (dir ^ " is a subdir of " ^ d.root);
 147       None
 148   | None ->
 149       dump_development dev;
 150       rebuild_makefile dev;
 151       developments := dev :: !developments;
 152       Some dev
 153
 154 let make chdir args =
 155   let old = Unix.getcwd () in
 156   try
 157     Unix.chdir chdir;
 158     let rc =
 159       Unix.system
 160         (String.concat " " ("make"::(List.map Filename.quote args)))
 161     in
 162     Unix.chdir old;
 163     match rc with
 164     | Unix.WEXITED 0 -> true
 165     | Unix.WEXITED i -> logger `Error ("make returned " ^ string_of_int i);false
 166     | _ -> logger `Error "make STOPPED or SIGNALED!";false
 167   with Unix.Unix_error (_,cmd,err) ->
 168     logger `Warning ("Unix Error: " ^ cmd ^ ": " ^ err);
 169     false
 170
 171 let call_make development target make =
 172   rebuild_makefile development;
 173   let makefile = makefile_for_development development in
 174   let nodb =
 175     Helm_registry.get_opt_default Helm_registry.bool ~default:false "db.nodb"
 176   in
 177   let flags = if nodb then ["NODB=true"] else [] in
 178   make development.root
 179     (["--no-print-directory"; "-s"; "-k"; "-f"; makefile; target]
 180     @ flags)
 181
 182 let build_development ?(target="all") development =
 183   call_make development target make
 184
 185 (* not really good vt100 *)
 186 let vt100 s =
 187   let rex = Pcre.regexp "\e\\[[0-9;]+m" in
 188   let rex_i = Pcre.regexp "^Info" in
 189   let rex_w = Pcre.regexp "^Warning" in
 190   let rex_e = Pcre.regexp "^Error" in
 191   let rex_d = Pcre.regexp "^Debug" in
 192   let rex_noendline = Pcre.regexp "\\n" in
 193   let s = Pcre.replace ~rex:rex_noendline s in
 194   let tokens = Pcre.split ~rex s in
 195   let logger = ref HLog.message in
 196   let rec aux =
 197     function
 198     | [] -> ()
 199     | s::tl ->
 200         (if Pcre.pmatch ~rex:rex_i s then
 201           logger := HLog.message
 202         else if Pcre.pmatch ~rex:rex_w s then
 203           logger := HLog.warn
 204         else if Pcre.pmatch ~rex:rex_e s then
 205           logger := HLog.error
 206         else if Pcre.pmatch ~rex:rex_d s then
 207           logger := HLog.debug
 208         else
 209           !logger s);
 210         aux tl
 211   in
 212   aux tokens
 213
 214
 215 let mk_maker refresh_cb =
 216   (fun chdir args ->
 217     let out_r,out_w = Unix.pipe () in
 218     let err_r,err_w = Unix.pipe () in
 219     let pid = ref ~-1 in
 220     ignore(Sys.signal Sys.sigchld (Sys.Signal_ignore));
 221     try
 222       let argv = Array.of_list ("make"::args) in
 223       pid := Unix.create_process "make" argv Unix.stdin out_w err_w;
 224       Unix.close out_w;
 225       Unix.close err_w;
 226       let buf = String.create 1024 in
 227       let rec aux = function
 228         | f::tl ->
 229             let len = Unix.read f buf 0 1024 in
 230             if len = 0 then
 231               raise
 232                 (Unix.Unix_error
 233                   (Unix.EPIPE,"read","len = 0 (matita internal)"));
 234             vt100 (String.sub buf 0 len);
 235             aux tl
 236         | _ -> ()
 237       in
 238       while true do
 239         let r,_,_ = Unix.select [out_r; err_r] [] [] (-. 1.) in
 240         aux r;
 241         refresh_cb ()
 242       done;
 243       true
 244     with
 245     | Unix.Unix_error (_,"read",_)
 246     | Unix.Unix_error (_,"select",_) -> true)
 247
 248 let build_development_in_bg ?(target="all") refresh_cb development =
 249   call_make development target (mk_maker refresh_cb)
 250 ;;
 251
 252 let clean_development development =
 253   call_make development "clean" make
 254
 255 let clean_development_in_bg refresh_cb development =
 256   call_make development "clean" (mk_maker refresh_cb)
 257
 258 let destroy_development_aux development clean_development =
 259   let delete_development development =
 260     let unlink file =
 261       try
 262         Unix.unlink file
 263       with Unix.Unix_error _ -> logger `Debug ("Unable to delete " ^ file)
 264     in
 265     let rmdir dir =
 266       try
 267         Unix.rmdir dir
 268       with Unix.Unix_error _ ->
 269         logger `Warning ("Unable to remove dir " ^ dir);
 270         match ls_dir dir with
 271         | None -> logger `Error ("Unable to list directory " ^ dir)
 272         | Some [] -> ()
 273         | Some l -> logger `Error ("The directory is not empty")
 274     in
 275     unlink (makefile_for_development development);
 276     unlink (pool () ^ development.name ^ rootfile);
 277     unlink (pool () ^ development.name ^ "/depend");
 278     rmdir (pool () ^ development.name);
 279     developments :=
 280       List.filter (fun d -> d.name <> development.name) !developments
 281   in
 282   if not(clean_development development) then
 283     begin
 284       logger `Warning "Unable to clean the development problerly.";
 285       logger `Warning "This may cause garbage."
 286     end;
 287   delete_development development
 288
 289 let destroy_development development =
 290   destroy_development_aux development clean_development
 291
 292 let destroy_development_in_bg refresh development =
 293   destroy_development_aux development (clean_development_in_bg refresh)
 294
 295 let root_for_development development = development.root
 296 let name_for_development development = development.name
 297