src/Pure/General/path.ML
author skalberg
Thu, 03 Mar 2005 12:43:01 +0100
changeset 15570 8d8c70b41bab
parent 15531 08c8dad8e399
child 17827 b32fad049413
permissions -rw-r--r--
Move towards standard functions.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6118
caa439435666 fixed titles;
wenzelm
parents: 5011
diff changeset
     1
(*  Title:      Pure/General/path.ML
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
     2
    ID:         $Id$
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
     3
    Author:     Markus Wenzel, TU Muenchen
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
     4
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
     5
Abstract algebra of file paths (external encoding Unix-style).
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
     6
*)
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
     7
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
     8
signature PATH =
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
     9
sig
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    10
  datatype elem = Root | Parent | Basic of string | Variable of string
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    11
  eqtype T
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    12
  val rep: T -> elem list
6460
cb8c85435228 added is_current;
wenzelm
parents: 6319
diff changeset
    13
  val is_current: T -> bool
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    14
  val current: T
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    15
  val root: T
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    16
  val parent: T
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    17
  val basic: string -> T
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    18
  val variable: string -> T
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    19
  val is_absolute: T -> bool
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    20
  val is_basic: T -> bool
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    21
  val append: T -> T -> T
6270
c905fe5994a2 val appends: T list -> T;
wenzelm
parents: 6223
diff changeset
    22
  val appends: T list -> T
6319
80173cb8691c added make, dir;
wenzelm
parents: 6270
diff changeset
    23
  val make: string list -> T
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    24
  val pack: T -> string
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    25
  val unpack: string -> T
14912
88b9d9165452 added split_ext; removed drop_ext;
wenzelm
parents: 8806
diff changeset
    26
  val dir: T -> T
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    27
  val base: T -> T
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    28
  val ext: string -> T -> T
14912
88b9d9165452 added split_ext; removed drop_ext;
wenzelm
parents: 8806
diff changeset
    29
  val split_ext: T -> T * string
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    30
  val expand: T -> T
7714
e6aa4fca983e added position;
wenzelm
parents: 6460
diff changeset
    31
  val position: T -> Position.T
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    32
end;
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    33
6187
c6c4626ef693 enabled sig;
wenzelm
parents: 6183
diff changeset
    34
structure Path: PATH =
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    35
struct
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    36
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    37
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    38
(* path elements *)
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    39
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    40
datatype elem = Root | Parent | Basic of string | Variable of string;
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    41
6223
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    42
fun err_elem msg chs = error (msg ^ " path element specification: " ^ quote (implode chs));
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    43
6319
80173cb8691c added make, dir;
wenzelm
parents: 6270
diff changeset
    44
fun check_elem (chs as []) = err_elem "Illegal" chs
80173cb8691c added make, dir;
wenzelm
parents: 6270
diff changeset
    45
  | check_elem (chs as ["~"]) = err_elem "Illegal" chs
6223
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    46
  | check_elem (chs as ["~", "~"]) = err_elem "Illegal" chs
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    47
  | check_elem chs =
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    48
      (case ["/", "\\", "$", ":"] inter_string chs of
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    49
        [] => chs
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    50
      | bads => err_elem ("Illegal character(s) " ^ commas_quote bads ^ " in") chs);
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    51
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    52
val basic_elem = Basic o implode o check_elem;
e8807883e3e3 check_elem: allow ~, except for '~' and '~~';
wenzelm
parents: 6187
diff changeset
    53
val variable_elem = Variable o implode o check_elem;
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    54
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    55
fun is_var (Variable _) = true
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    56
  | is_var _ = false;
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    57
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    58
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    59
(* type path *)
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    60
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    61
datatype T = Path of elem list;
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    62
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    63
fun rep (Path xs) = xs;
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    64
6460
cb8c85435228 added is_current;
wenzelm
parents: 6319
diff changeset
    65
fun is_current (Path []) = true
cb8c85435228 added is_current;
wenzelm
parents: 6319
diff changeset
    66
  | is_current _ = false;
cb8c85435228 added is_current;
wenzelm
parents: 6319
diff changeset
    67
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    68
val current = Path [];
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    69
val root = Path [Root];
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    70
val parent = Path [Parent];
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    71
fun basic s = Path [basic_elem (explode s)];
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    72
fun variable s = Path [variable_elem (explode s)];
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    73
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    74
fun is_absolute (Path (Root :: _)) = true
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    75
  | is_absolute _ = false;
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    76
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    77
fun is_basic (Path [Basic _]) = true
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    78
  | is_basic _ = false;
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    79
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    80
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    81
(* append and norm *)
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    82
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    83
(*append non-normal path (2n arg) to reversed normal one, result is normal*)
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    84
fun rev_app xs [] = rev xs
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    85
  | rev_app _ (Root :: ys) = rev_app [Root] ys
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    86
  | rev_app (x :: xs) (Parent :: ys) =
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    87
      if x = Parent orelse is_var x then rev_app (Parent :: x :: xs) ys
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    88
      else if x = Root then rev_app (x :: xs) ys
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    89
      else rev_app xs ys
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    90
  | rev_app xs (y :: ys) = rev_app (y :: xs) ys;
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    91
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    92
fun append (Path xs) (Path ys) = Path (rev_app (rev xs) ys);
15570
8d8c70b41bab Move towards standard functions.
skalberg
parents: 15531
diff changeset
    93
fun appends paths = Library.foldl (uncurry append) (current, paths);
6319
80173cb8691c added make, dir;
wenzelm
parents: 6270
diff changeset
    94
val make = appends o map basic;
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    95
fun norm path = rev_app [] path;
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    96
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    97
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
    98
(* pack *)
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
    99
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   100
fun pack_elem Root = ""
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   101
  | pack_elem Parent = ".."
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   102
  | pack_elem (Basic s) = s
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   103
  | pack_elem (Variable s) = "$" ^ s;
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   104
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   105
fun pack (Path []) = "."
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   106
  | pack (Path (Root :: xs)) = "/" ^ space_implode "/" (map pack_elem xs)
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   107
  | pack (Path xs) = space_implode "/" (map pack_elem xs);
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   108
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   109
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   110
(* unpack *)
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   111
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   112
fun unpack_elem "" = Root
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   113
  | unpack_elem ".." = Parent
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   114
  | unpack_elem "~" = Variable "HOME"
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   115
  | unpack_elem "~~" = Variable "ISABELLE_HOME"
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   116
  | unpack_elem s =
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   117
      (case explode s of
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   118
        "$" :: cs => variable_elem cs
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   119
      | cs => basic_elem cs);
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   120
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   121
val unpack_elems = map unpack_elem o filter_out (equal "" orf equal ".");
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   122
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   123
fun unpack str = Path (norm
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   124
  (case space_explode "/" str of
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   125
    "" :: ss => Root :: unpack_elems ss
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   126
  | ss => unpack_elems ss));
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   127
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   128
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   129
(* base element *)
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   130
7929
2010ae0393ca added drop_ext;
wenzelm
parents: 7714
diff changeset
   131
fun split_path f (path as Path xs) =
2010ae0393ca added drop_ext;
wenzelm
parents: 7714
diff changeset
   132
  (case try split_last xs of
15531
08c8dad8e399 Deleted Library.option type.
skalberg
parents: 14981
diff changeset
   133
    SOME (prfx, Basic s) => f (prfx, s)
7929
2010ae0393ca added drop_ext;
wenzelm
parents: 7714
diff changeset
   134
  | _ => error ("Cannot split path into dir/base: " ^ quote (pack path)));
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   135
14912
88b9d9165452 added split_ext; removed drop_ext;
wenzelm
parents: 8806
diff changeset
   136
val dir = split_path (fn (prfx, _) => Path prfx);
7929
2010ae0393ca added drop_ext;
wenzelm
parents: 7714
diff changeset
   137
val base = split_path (fn (_, s) => Path [Basic s]);
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   138
7929
2010ae0393ca added drop_ext;
wenzelm
parents: 7714
diff changeset
   139
fun ext "" path = path
2010ae0393ca added drop_ext;
wenzelm
parents: 7714
diff changeset
   140
  | ext e path = split_path (fn (prfx, s) => append (Path prfx) (basic (s ^ "." ^ e))) path;
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   141
14912
88b9d9165452 added split_ext; removed drop_ext;
wenzelm
parents: 8806
diff changeset
   142
val split_ext = split_path (fn (prfx, s) => apfst (append (Path prfx))
7929
2010ae0393ca added drop_ext;
wenzelm
parents: 7714
diff changeset
   143
  (case take_suffix (not_equal ".") (explode s) of
14912
88b9d9165452 added split_ext; removed drop_ext;
wenzelm
parents: 8806
diff changeset
   144
    ([], _) => (Path [Basic s], "")
15570
8d8c70b41bab Move towards standard functions.
skalberg
parents: 15531
diff changeset
   145
  | (cs, e) => (Path [Basic (implode (Library.take (length cs - 1, cs)))], implode e)));
6319
80173cb8691c added make, dir;
wenzelm
parents: 6270
diff changeset
   146
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   147
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   148
(* evaluate variables *)
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   149
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   150
fun eval env (Variable s) = rep (env s)
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   151
  | eval _ x = [x];
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   152
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   153
fun evaluate env (Path xs) =
15570
8d8c70b41bab Move towards standard functions.
skalberg
parents: 15531
diff changeset
   154
  Path (norm (List.concat (map (eval env) xs)));
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   155
6183
ca3ff2fee318 more abstract implementation;
wenzelm
parents: 6118
diff changeset
   156
val expand = evaluate (unpack o getenv);
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   157
7714
e6aa4fca983e added position;
wenzelm
parents: 6460
diff changeset
   158
val position = Position.line_name 1 o quote o pack o expand;
e6aa4fca983e added position;
wenzelm
parents: 6460
diff changeset
   159
5011
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   160
37c253fd3dc6 moved Thy/path.ML to General/path.ML;
wenzelm
parents:
diff changeset
   161
end;