src/Pure/General/file.ML
author wenzelm
Thu, 04 Feb 1999 18:14:27 +0100
changeset 6224 0c08846be6f3
parent 6218 3e9d6edc99a8
child 6318 4a423e8a0b54
permissions -rw-r--r--
fail_safe close; added sys_unpack hook; added pwd; removed join_info;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6118
caa439435666 fixed titles;
wenzelm
parents: 5009
diff changeset
     1
(*  Title:      Pure/General/file.ML
5009
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     2
    ID:         $Id$
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     3
    Author:     Markus Wenzel, TU Muenchen
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     4
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     5
File system operations.
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     6
*)
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     7
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     8
signature FILE =
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
     9
sig
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    10
  val sys_pack_fn: (Path.T -> string) ref
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    11
  val sys_unpack_fn: (string -> Path.T) ref
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    12
  val use: Path.T -> unit
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    13
  val rm: Path.T -> unit
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    14
  val cd: Path.T -> unit
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    15
  val pwd: unit -> Path.T
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    16
  val full_path: Path.T -> Path.T
6182
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    17
  val tmp_path: Path.T -> Path.T
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    18
  val read: Path.T -> string
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    19
  val write: Path.T -> string -> unit
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    20
  val append: Path.T -> string -> unit
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    21
  val copy: Path.T -> Path.T -> unit
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    22
  eqtype info
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    23
  val info: Path.T -> info option
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    24
  val exists: Path.T -> bool
5009
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    25
end;
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    26
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    27
structure File: FILE =
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    28
struct
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    29
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    30
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    31
(* system path representations (default: Unix) *)
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    32
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    33
val sys_pack_fn = ref Path.pack;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    34
val sys_unpack_fn = ref Path.unpack;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    35
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    36
fun sysify path = ! sys_pack_fn (Path.expand path);
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    37
fun unsysify s = ! sys_unpack_fn s;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    38
6182
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    39
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    40
val use = use o sysify;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    41
val rm = OS.FileSys.remove o sysify;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    42
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    43
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    44
(* current path *)
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    45
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    46
val cd = Library.cd o sysify;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    47
val pwd = unsysify o Library.pwd;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    48
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    49
fun full_path path =
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    50
  if Path.is_absolute path then path
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    51
  else Path.append (pwd ()) path;
5009
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    52
6182
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    53
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    54
(* tmp_path *)
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    55
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    56
fun tmp_path path =
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    57
  Path.append (Path.variable "ISABELLE_TMP") (Path.base path);
5009
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    58
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    59
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    60
(* read / write files *)
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    61
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    62
fun fail_safe f g x =
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    63
  let val y = f x handle exn => (g x; raise exn)
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    64
  in g x; y end;
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    65
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    66
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    67
fun output txt stream = TextIO.output (stream, txt);
6182
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    68
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    69
fun read path = fail_safe TextIO.inputAll TextIO.closeIn (TextIO.openIn (sysify path));
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    70
fun write path txt = fail_safe (output txt) TextIO.closeOut (TextIO.openOut (sysify path));
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    71
fun append path txt = fail_safe (output txt) TextIO.closeOut (TextIO.openAppend (sysify path));
6218
3e9d6edc99a8 added join_info;
wenzelm
parents: 6182
diff changeset
    72
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    73
fun copy inpath outpath = write outpath (read inpath);
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    74
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    75
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    76
(* file info *)
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    77
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    78
datatype info = Info of string;
5009
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    79
6182
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    80
fun info path =
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    81
  let val name = sysify path in
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    82
    (case file_info name of
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    83
      "" => None
6224
0c08846be6f3 fail_safe close;
wenzelm
parents: 6218
diff changeset
    84
    | s => Some (Info s))
6182
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    85
  end;
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    86
4a07dfe3583f use Path.T;
wenzelm
parents: 6118
diff changeset
    87
val exists = is_some o info;
5009
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    88
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    89
05b152a41922 moved Thy/file.ML to General/file.ML;
wenzelm
parents:
diff changeset
    90
end;