src/Pure/System/isabelle_system.ML
author wenzelm
Tue, 18 Aug 2015 16:08:47 +0200
changeset 60970 e08d868ceca9
parent 60263 2a5dbad75355
child 62549 9498623b27f0
permissions -rw-r--r--
clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations); avoid patching of SML basis library;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     1
(*  Title:      Pure/System/isabelle_system.ML
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     3
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     4
Isabelle system support.
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     5
*)
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     6
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     7
signature ISABELLE_SYSTEM =
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     8
sig
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
     9
  val isabelle_tool: string -> string -> int
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    10
  val mkdirs: Path.T -> unit
40745
1dabcda202c3 more basic Isabelle_System.mkdir;
wenzelm
parents: 40743
diff changeset
    11
  val mkdir: Path.T -> unit
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    12
  val copy_dir: Path.T -> Path.T -> unit
56533
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    13
  val copy_file: Path.T -> Path.T -> unit
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    14
  val copy_file_base: Path.T * Path.T -> Path.T -> unit
42127
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
    15
  val create_tmp_path: string -> string -> Path.T
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
    16
  val with_tmp_file: string -> string -> (Path.T -> 'a) -> 'a
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
    17
  val with_tmp_dir: string -> (Path.T -> 'a) -> 'a
43850
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    18
  val bash_output: string -> string * int
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    19
  val bash: string -> int
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    20
end;
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    21
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    22
structure Isabelle_System: ISABELLE_SYSTEM =
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    23
struct
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    24
43850
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    25
(* bash *)
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    26
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    27
fun bash_output s =
47499
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    28
  let
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    29
    val {out, err, rc, ...} = Bash.process s;
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    30
    val _ = warning (trim_line err);
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    31
  in (out, rc) end;
43850
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    32
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    33
fun bash s =
47499
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    34
  let
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    35
    val (out, rc) = bash_output s;
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    36
    val _ = writeln (trim_line out);
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    37
  in rc end;
43850
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    38
7f2cbc713344 moved bash operations to Isabelle_System (cf. Scala version);
wenzelm
parents: 43849
diff changeset
    39
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    40
(* system commands *)
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    41
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    42
fun isabelle_tool name args =
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    43
  (case space_explode ":" (getenv "ISABELLE_TOOLS") |> get_first (fn dir =>
60970
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    44
      let
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    45
        val path = Path.append (Path.explode dir) (Path.basic name);
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    46
        val platform_path = File.platform_path path;
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    47
      in
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    48
        if can OS.FileSys.modTime platform_path andalso
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    49
          not (OS.FileSys.isDir platform_path) andalso
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    50
          OS.FileSys.access (platform_path, [OS.FileSys.A_READ, OS.FileSys.A_EXEC])
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    51
        then SOME path
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    52
        else NONE
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    53
      end handle OS.SysErr _ => NONE) of
60970
e08d868ceca9 clarified File.standard_path vs. File.platform_path (like Isabelle/Scala operations);
wenzelm
parents: 60263
diff changeset
    54
    SOME path => bash (File.shell_path path ^ " " ^ args)
47499
4b0daca2bf88 redirect bash stderr to Isabelle warning as appropriate -- avoid raw process error output which may either get ignored or overload PIDE syslog in extreme cases;
wenzelm
parents: 46502
diff changeset
    55
  | NONE => (warning ("Unknown Isabelle tool: " ^ name); 2));
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    56
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    57
fun system_command cmd =
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    58
  if bash cmd <> 0 then error ("System command failed: " ^ cmd)
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    59
  else ();
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    60
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    61
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    62
(* directory operations *)
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    63
60013
42d34eeb283c more uniform Isabelle_System.mkdirs in ML/Scala;
wenzelm
parents: 59351
diff changeset
    64
fun mkdirs path =
60263
2a5dbad75355 more portable mkdirs via perl, e.g. relevant for Windows UNC paths (network shares);
wenzelm
parents: 60028
diff changeset
    65
  if File.is_dir path then ()
2a5dbad75355 more portable mkdirs via perl, e.g. relevant for Windows UNC paths (network shares);
wenzelm
parents: 60028
diff changeset
    66
  else
2a5dbad75355 more portable mkdirs via perl, e.g. relevant for Windows UNC paths (network shares);
wenzelm
parents: 60028
diff changeset
    67
   (bash ("perl -e \"use File::Path make_path; make_path(" ^ File.shell_path path ^ ");\"");
2a5dbad75355 more portable mkdirs via perl, e.g. relevant for Windows UNC paths (network shares);
wenzelm
parents: 60028
diff changeset
    68
    if File.is_dir path then () else error ("Failed to create directory: " ^ Path.print path));
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    69
40785
c755df0f7062 more permissive Isabelle_System.mkdir;
wenzelm
parents: 40745
diff changeset
    70
fun mkdir path =
c755df0f7062 more permissive Isabelle_System.mkdir;
wenzelm
parents: 40745
diff changeset
    71
  if File.is_dir path then () else OS.FileSys.mkDir (File.platform_path path);
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    72
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    73
fun copy_dir src dst =
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    74
  if File.eq (src, dst) then ()
46502
3d43d4d4d071 more uniform / portable representation of the idea of "copy_dir" (NB: cp -f dereferences symlinks on GNU/Linux, but does not on old-school Unixen including BSD/Mac OS X);
wenzelm
parents: 45199
diff changeset
    75
  else (system_command ("cp -p -R -f " ^ File.shell_path src ^ "/. " ^ File.shell_path dst); ());
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
    76
56533
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    77
fun copy_file src0 dst0 =
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    78
  let
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    79
    val src = Path.expand src0;
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    80
    val dst = Path.expand dst0;
57085
cb212f52c2a3 clarified copy_file: allow to rename base name, e.g. relevant for 'display_drafts';
wenzelm
parents: 56533
diff changeset
    81
    val target = if File.is_dir dst then Path.append dst (Path.base src) else dst;
56533
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    82
  in
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    83
    if File.eq (src, target) then ()
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    84
    else
57085
cb212f52c2a3 clarified copy_file: allow to rename base name, e.g. relevant for 'display_drafts';
wenzelm
parents: 56533
diff changeset
    85
      ignore (system_command ("cp -p -f " ^ File.shell_path src ^ " " ^ File.shell_path target))
56533
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    86
  end;
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    87
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    88
fun copy_file_base (base_dir, src0) target_dir =
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    89
  let
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    90
    val src = Path.expand src0;
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    91
    val src_dir = Path.dir src;
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    92
    val _ =
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    93
      if Path.starts_basic src then ()
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    94
      else error ("Illegal path specification " ^ Path.print src ^ " beyond base directory");
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    95
    val _ = mkdirs (Path.append target_dir src_dir);
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    96
  in copy_file (Path.append base_dir src) (Path.append target_dir src) end;
cd8b6d849b6a explicit 'document_files' in session ROOT specifications;
wenzelm
parents: 56498
diff changeset
    97
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
    98
56498
6437c989a744 tuned comments (see Scala version);
wenzelm
parents: 50843
diff changeset
    99
(* tmp files *)
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   100
42127
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
   101
fun create_tmp_path name ext =
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   102
  let
42127
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
   103
    val path = File.tmp_path (Path.basic (name ^ serial_string ()) |> Path.ext ext);
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   104
    val _ = File.exists path andalso
41944
b97091ae583a Path.print is the official way to show file-system paths to users -- note that Path.implode often indicates violation of the abstract datatype;
wenzelm
parents: 41352
diff changeset
   105
      raise Fail ("Temporary file already exists: " ^ Path.print path);
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   106
  in path end;
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   107
42127
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
   108
fun with_tmp_file name ext f =
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
   109
  let val path = create_tmp_path name ext
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
   110
  in Exn.release (Exn.capture f path before ignore (try File.rm path)) end;
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   111
56498
6437c989a744 tuned comments (see Scala version);
wenzelm
parents: 50843
diff changeset
   112
6437c989a744 tuned comments (see Scala version);
wenzelm
parents: 50843
diff changeset
   113
(* tmp dirs *)
6437c989a744 tuned comments (see Scala version);
wenzelm
parents: 50843
diff changeset
   114
42127
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
   115
fun rm_tree path = system_command ("rm -r -f " ^ File.shell_path path);
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   116
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   117
fun with_tmp_dir name f =
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   118
  let
42127
8223e7f4b0da Isabelle_System.create_tmp_path/with_tmp_file: optional extension;
wenzelm
parents: 41944
diff changeset
   119
    val path = create_tmp_path name "";
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   120
    val _ = mkdirs path;
41352
87adb55fb0fb make SML/NJ and Poly/ML agree on the type of "before";
wenzelm
parents: 41307
diff changeset
   121
  in Exn.release (Exn.capture f path before ignore (try rm_tree path)) end;
41307
bb8468ae414e slightly more standard Isabelle_System.with_tmp_file/with_tmp_dir (cf. Scala version);
wenzelm
parents: 40785
diff changeset
   122
40743
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
   123
end;
b07a0dbc8a38 more explicit Isabelle_System operations;
wenzelm
parents:
diff changeset
   124