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