src/Pure/library.ML
author wenzelm
Fri Oct 10 15:50:46 1997 +0200 (1997-10-10)
changeset 3832 17a20a2af8f5
parent 3762 f20b071a429a
child 3874 552ce5ad6a2e
permissions -rw-r--r--
fixed space_explode, old one retained as BAD_space_explode;
added split_lines;
wenzelm@41
     1
(*  Title:      Pure/library.ML
clasohm@0
     2
    ID:         $Id$
wenzelm@233
     3
    Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
clasohm@0
     4
    Copyright   1992  University of Cambridge
clasohm@0
     5
wenzelm@233
     6
Basic library: functions, options, pairs, booleans, lists, integers,
wenzelm@233
     7
strings, lists as sets, association lists, generic tables, balanced trees,
wenzelm@2506
     8
orders, input / output, timing, filenames, misc functions.
clasohm@0
     9
*)
clasohm@0
    10
berghofe@1576
    11
infix |> ~~ \ \\ orelf ins ins_string ins_int orf andf prefix upto downto
paulson@2175
    12
      mem mem_int mem_string union union_int union_string  
paulson@2175
    13
      inter inter_int inter_string subset subset_int subset_string subdir_of;
clasohm@1364
    14
clasohm@1364
    15
clasohm@1364
    16
structure Library =
clasohm@1364
    17
struct
clasohm@0
    18
wenzelm@233
    19
(** functions **)
clasohm@0
    20
wenzelm@233
    21
(*handy combinators*)
wenzelm@233
    22
fun curry f x y = f (x, y);
wenzelm@233
    23
fun uncurry f (x, y) = f x y;
wenzelm@233
    24
fun I x = x;
wenzelm@233
    25
fun K x y = x;
clasohm@0
    26
wenzelm@380
    27
(*reverse apply*)
wenzelm@410
    28
fun (x |> f) = f x;
wenzelm@380
    29
wenzelm@233
    30
(*combine two functions forming the union of their domains*)
paulson@2175
    31
fun (f orelf g) = fn x => f x handle Match => g x;
clasohm@0
    32
wenzelm@233
    33
(*application of (infix) operator to its left or right argument*)
wenzelm@233
    34
fun apl (x, f) y = f (x, y);
wenzelm@233
    35
fun apr (f, y) x = f (x, y);
clasohm@0
    36
wenzelm@233
    37
(*functional for pairs*)
wenzelm@233
    38
fun pairself f (x, y) = (f x, f y);
clasohm@0
    39
wenzelm@233
    40
(*function exponentiation: f(...(f x)...) with n applications of f*)
wenzelm@233
    41
fun funpow n f x =
wenzelm@233
    42
  let fun rep (0, x) = x
wenzelm@233
    43
        | rep (n, x) = rep (n - 1, f x)
wenzelm@233
    44
  in rep (n, x) end;
wenzelm@160
    45
wenzelm@160
    46
wenzelm@160
    47
wenzelm@2471
    48
(** stamps **)
wenzelm@2471
    49
wenzelm@2471
    50
type stamp = unit ref;
wenzelm@2471
    51
val stamp: unit -> stamp = ref;
wenzelm@2471
    52
wenzelm@2471
    53
wenzelm@2471
    54
wenzelm@233
    55
(** options **)
clasohm@0
    56
clasohm@0
    57
datatype 'a option = None | Some of 'a;
clasohm@0
    58
clasohm@0
    59
exception OPTION of string;
clasohm@0
    60
clasohm@0
    61
fun the (Some x) = x
clasohm@0
    62
  | the None = raise OPTION "the";
clasohm@0
    63
wenzelm@255
    64
fun if_none None y = y
wenzelm@255
    65
  | if_none (Some x) _ = x;
wenzelm@255
    66
clasohm@0
    67
fun is_some (Some _) = true
clasohm@0
    68
  | is_some None = false;
clasohm@0
    69
clasohm@0
    70
fun is_none (Some _) = false
clasohm@0
    71
  | is_none None = true;
clasohm@0
    72
wenzelm@233
    73
fun apsome f (Some x) = Some (f x)
wenzelm@233
    74
  | apsome _ None = None;
clasohm@0
    75
wenzelm@233
    76
wenzelm@233
    77
wenzelm@233
    78
(** pairs **)
wenzelm@233
    79
wenzelm@233
    80
fun pair x y = (x, y);
wenzelm@233
    81
fun rpair x y = (y, x);
wenzelm@233
    82
wenzelm@233
    83
fun fst (x, y) = x;
wenzelm@233
    84
fun snd (x, y) = y;
wenzelm@233
    85
wenzelm@233
    86
fun eq_fst ((x1, _), (x2, _)) = x1 = x2;
wenzelm@233
    87
fun eq_snd ((_, y1), (_, y2)) = y1 = y2;
wenzelm@233
    88
wenzelm@233
    89
fun swap (x, y) = (y, x);
wenzelm@233
    90
wenzelm@233
    91
(*apply the function to a component of a pair*)
wenzelm@233
    92
fun apfst f (x, y) = (f x, y);
wenzelm@233
    93
fun apsnd f (x, y) = (x, f y);
wenzelm@233
    94
wenzelm@233
    95
wenzelm@233
    96
wenzelm@233
    97
(** booleans **)
wenzelm@233
    98
wenzelm@233
    99
(* equality *)
wenzelm@233
   100
wenzelm@233
   101
fun equal x y = x = y;
wenzelm@233
   102
fun not_equal x y = x <> y;
wenzelm@233
   103
wenzelm@233
   104
wenzelm@233
   105
(* operators for combining predicates *)
wenzelm@233
   106
paulson@2175
   107
fun (p orf q) = fn x => p x orelse q x;
wenzelm@233
   108
paulson@2175
   109
fun (p andf q) = fn x => p x andalso q x;
wenzelm@233
   110
wenzelm@233
   111
fun notf p x = not (p x);
clasohm@0
   112
wenzelm@233
   113
wenzelm@233
   114
(* predicates on lists *)
wenzelm@233
   115
wenzelm@233
   116
fun orl [] = false
wenzelm@233
   117
  | orl (x :: xs) = x orelse orl xs;
wenzelm@233
   118
wenzelm@233
   119
fun andl [] = true
wenzelm@233
   120
  | andl (x :: xs) = x andalso andl xs;
wenzelm@233
   121
paulson@3246
   122
(*Several object-logics declare theories named List or Option, hiding the
paulson@3246
   123
  eponymous basis library structures.*)
paulson@3246
   124
structure List_ = List
paulson@3246
   125
and       Option_ = Option;
paulson@2271
   126
wenzelm@233
   127
(*exists pred [x1, ..., xn] ===> pred x1 orelse ... orelse pred xn*)
wenzelm@233
   128
fun exists (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   129
  let fun boolf [] = false
wenzelm@233
   130
        | boolf (x :: xs) = pred x orelse boolf xs
wenzelm@233
   131
  in boolf end;
wenzelm@233
   132
wenzelm@233
   133
(*forall pred [x1, ..., xn] ===> pred x1 andalso ... andalso pred xn*)
wenzelm@233
   134
fun forall (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   135
  let fun boolf [] = true
wenzelm@233
   136
        | boolf (x :: xs) = pred x andalso boolf xs
wenzelm@233
   137
  in boolf end;
clasohm@0
   138
wenzelm@233
   139
wenzelm@380
   140
(* flags *)
wenzelm@380
   141
wenzelm@380
   142
fun set flag = (flag := true; true);
wenzelm@380
   143
fun reset flag = (flag := false; false);
wenzelm@380
   144
fun toggle flag = (flag := not (! flag); ! flag);
wenzelm@380
   145
wenzelm@2978
   146
fun setmp flag value f x =
wenzelm@2958
   147
  let
wenzelm@2958
   148
    val orig_value = ! flag;
wenzelm@2958
   149
    fun return y = (flag := orig_value; y);
wenzelm@2958
   150
  in
wenzelm@2958
   151
    flag := value;
wenzelm@2958
   152
    return (f x handle exn => (return (); raise exn))
wenzelm@2958
   153
  end;
wenzelm@2958
   154
wenzelm@380
   155
wenzelm@233
   156
wenzelm@233
   157
(** lists **)
wenzelm@233
   158
wenzelm@233
   159
exception LIST of string;
wenzelm@233
   160
wenzelm@233
   161
fun null [] = true
wenzelm@233
   162
  | null (_ :: _) = false;
wenzelm@233
   163
wenzelm@233
   164
fun hd [] = raise LIST "hd"
wenzelm@233
   165
  | hd (x :: _) = x;
wenzelm@233
   166
wenzelm@233
   167
fun tl [] = raise LIST "tl"
wenzelm@233
   168
  | tl (_ :: xs) = xs;
wenzelm@233
   169
wenzelm@233
   170
fun cons x xs = x :: xs;
wenzelm@233
   171
wenzelm@233
   172
wenzelm@233
   173
(* fold *)
wenzelm@233
   174
wenzelm@233
   175
(*the following versions of fold are designed to fit nicely with infixes*)
clasohm@0
   176
wenzelm@233
   177
(*  (op @) (e, [x1, ..., xn])  ===>  ((e @ x1) @ x2) ... @ xn
wenzelm@233
   178
    for operators that associate to the left (TAIL RECURSIVE)*)
wenzelm@233
   179
fun foldl (f: 'a * 'b -> 'a) : 'a * 'b list -> 'a =
wenzelm@233
   180
  let fun itl (e, [])  = e
wenzelm@233
   181
        | itl (e, a::l) = itl (f(e, a), l)
wenzelm@233
   182
  in  itl end;
wenzelm@233
   183
wenzelm@233
   184
(*  (op @) ([x1, ..., xn], e)  ===>   x1 @ (x2 ... @ (xn @ e))
wenzelm@233
   185
    for operators that associate to the right (not tail recursive)*)
wenzelm@233
   186
fun foldr f (l, e) =
wenzelm@233
   187
  let fun itr [] = e
wenzelm@233
   188
        | itr (a::l) = f(a, itr l)
wenzelm@233
   189
  in  itr l  end;
wenzelm@233
   190
wenzelm@233
   191
(*  (op @) [x1, ..., xn]  ===>   x1 @ (x2 ... @ (x[n-1] @ xn))
wenzelm@233
   192
    for n > 0, operators that associate to the right (not tail recursive)*)
wenzelm@233
   193
fun foldr1 f l =
wenzelm@233
   194
  let fun itr [x] = x                       (* FIXME [] case: elim warn (?) *)
wenzelm@233
   195
        | itr (x::l) = f(x, itr l)
wenzelm@233
   196
  in  itr l  end;
wenzelm@233
   197
wenzelm@233
   198
wenzelm@233
   199
(* basic list functions *)
wenzelm@233
   200
wenzelm@233
   201
(*length of a list, should unquestionably be a standard function*)
wenzelm@233
   202
local fun length1 (n, [])  = n   (*TAIL RECURSIVE*)
wenzelm@233
   203
        | length1 (n, x :: xs) = length1 (n + 1, xs)
wenzelm@233
   204
in  fun length l = length1 (0, l) end;
wenzelm@233
   205
wenzelm@233
   206
(*take the first n elements from a list*)
wenzelm@233
   207
fun take (n, []) = []
wenzelm@233
   208
  | take (n, x :: xs) =
wenzelm@233
   209
      if n > 0 then x :: take (n - 1, xs) else [];
wenzelm@233
   210
wenzelm@233
   211
(*drop the first n elements from a list*)
wenzelm@233
   212
fun drop (n, []) = []
wenzelm@233
   213
  | drop (n, x :: xs) =
wenzelm@233
   214
      if n > 0 then drop (n - 1, xs) else x :: xs;
clasohm@0
   215
wenzelm@233
   216
(*return nth element of a list, where 0 designates the first element;
wenzelm@233
   217
  raise EXCEPTION if list too short*)
wenzelm@233
   218
fun nth_elem NL =
wenzelm@233
   219
  (case drop NL of
wenzelm@233
   220
    [] => raise LIST "nth_elem"
wenzelm@233
   221
  | x :: _ => x);
wenzelm@233
   222
wenzelm@233
   223
(*last element of a list*)
wenzelm@233
   224
fun last_elem [] = raise LIST "last_elem"
wenzelm@233
   225
  | last_elem [x] = x
wenzelm@233
   226
  | last_elem (_ :: xs) = last_elem xs;
wenzelm@233
   227
wenzelm@3762
   228
(*rear decomposition*)
wenzelm@3762
   229
fun split_last [] = raise LIST "split_last"
wenzelm@3762
   230
  | split_last [x] = ([], x)
wenzelm@3762
   231
  | split_last (x :: xs) = apfst (cons x) (split_last xs);
wenzelm@3762
   232
wenzelm@3762
   233
wenzelm@233
   234
(*find the position of an element in a list*)
wenzelm@233
   235
fun find (x, ys) =
wenzelm@233
   236
  let fun f (y :: ys, i) = if x = y then i else f (ys, i + 1)
wenzelm@233
   237
        | f (_, _) = raise LIST "find"
wenzelm@233
   238
  in f (ys, 0) end;
wenzelm@233
   239
wenzelm@233
   240
(*flatten a list of lists to a list*)
wenzelm@233
   241
fun flat (ls: 'c list list) : 'c list = foldr (op @) (ls, []);
wenzelm@233
   242
wenzelm@233
   243
wenzelm@233
   244
(*like Lisp's MAPC -- seq proc [x1, ..., xn] evaluates
wenzelm@233
   245
  (proc x1; ...; proc xn) for side effects*)
wenzelm@233
   246
fun seq (proc: 'a -> unit) : 'a list -> unit =
wenzelm@233
   247
  let fun seqf [] = ()
wenzelm@233
   248
        | seqf (x :: xs) = (proc x; seqf xs)
wenzelm@233
   249
  in seqf end;
wenzelm@233
   250
wenzelm@233
   251
wenzelm@233
   252
(*separate s [x1, x2, ..., xn]  ===>  [x1, s, x2, s, ..., s, xn]*)
wenzelm@233
   253
fun separate s (x :: (xs as _ :: _)) = x :: s :: separate s xs
wenzelm@233
   254
  | separate _ xs = xs;
wenzelm@233
   255
wenzelm@233
   256
(*make the list [x, x, ..., x] of length n*)
wenzelm@233
   257
fun replicate n (x: 'a) : 'a list =
wenzelm@233
   258
  let fun rep (0, xs) = xs
wenzelm@233
   259
        | rep (n, xs) = rep (n - 1, x :: xs)
wenzelm@233
   260
  in
wenzelm@233
   261
    if n < 0 then raise LIST "replicate"
wenzelm@233
   262
    else rep (n, [])
wenzelm@233
   263
  end;
wenzelm@233
   264
wenzelm@233
   265
wenzelm@233
   266
(* filter *)
wenzelm@233
   267
wenzelm@233
   268
(*copy the list preserving elements that satisfy the predicate*)
wenzelm@233
   269
fun filter (pred: 'a->bool) : 'a list -> 'a list =
clasohm@0
   270
  let fun filt [] = []
wenzelm@233
   271
        | filt (x :: xs) = if pred x then x :: filt xs else filt xs
wenzelm@233
   272
  in filt end;
clasohm@0
   273
clasohm@0
   274
fun filter_out f = filter (not o f);
clasohm@0
   275
clasohm@0
   276
wenzelm@233
   277
fun mapfilter (f: 'a -> 'b option) ([]: 'a list) = [] : 'b list
wenzelm@233
   278
  | mapfilter f (x :: xs) =
wenzelm@233
   279
      (case f x of
wenzelm@233
   280
        None => mapfilter f xs
wenzelm@233
   281
      | Some y => y :: mapfilter f xs);
wenzelm@233
   282
wenzelm@233
   283
wenzelm@380
   284
fun find_first _ [] = None
wenzelm@380
   285
  | find_first pred (x :: xs) =
wenzelm@380
   286
      if pred x then Some x else find_first pred xs;
wenzelm@380
   287
wenzelm@380
   288
wenzelm@233
   289
(* lists of pairs *)
wenzelm@233
   290
wenzelm@380
   291
fun map2 _ ([], []) = []
wenzelm@380
   292
  | map2 f (x :: xs, y :: ys) = (f (x, y) :: map2 f (xs, ys))
wenzelm@380
   293
  | map2 _ _ = raise LIST "map2";
wenzelm@380
   294
wenzelm@380
   295
fun exists2 _ ([], []) = false
wenzelm@380
   296
  | exists2 pred (x :: xs, y :: ys) = pred (x, y) orelse exists2 pred (xs, ys)
wenzelm@380
   297
  | exists2 _ _ = raise LIST "exists2";
wenzelm@380
   298
wenzelm@380
   299
fun forall2 _ ([], []) = true
wenzelm@380
   300
  | forall2 pred (x :: xs, y :: ys) = pred (x, y) andalso forall2 pred (xs, ys)
wenzelm@380
   301
  | forall2 _ _ = raise LIST "forall2";
wenzelm@380
   302
wenzelm@233
   303
(*combine two lists forming a list of pairs:
wenzelm@233
   304
  [x1, ..., xn] ~~ [y1, ..., yn]  ===>  [(x1, y1), ..., (xn, yn)]*)
wenzelm@233
   305
fun [] ~~ [] = []
wenzelm@233
   306
  | (x :: xs) ~~ (y :: ys) = (x, y) :: (xs ~~ ys)
wenzelm@233
   307
  | _ ~~ _ = raise LIST "~~";
wenzelm@233
   308
wenzelm@233
   309
wenzelm@233
   310
(*inverse of ~~; the old 'split':
wenzelm@233
   311
  [(x1, y1), ..., (xn, yn)]  ===>  ([x1, ..., xn], [y1, ..., yn])*)
wenzelm@233
   312
fun split_list (l: ('a * 'b) list) = (map #1 l, map #2 l);
wenzelm@233
   313
wenzelm@233
   314
wenzelm@233
   315
(* prefixes, suffixes *)
wenzelm@233
   316
wenzelm@233
   317
fun [] prefix _ = true
wenzelm@233
   318
  | (x :: xs) prefix (y :: ys) = x = y andalso (xs prefix ys)
wenzelm@233
   319
  | _ prefix _ = false;
wenzelm@233
   320
wenzelm@233
   321
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., x(i-1)], [xi, ..., xn])
wenzelm@233
   322
   where xi is the first element that does not satisfy the predicate*)
wenzelm@233
   323
fun take_prefix (pred : 'a -> bool)  (xs: 'a list) : 'a list * 'a list =
wenzelm@233
   324
  let fun take (rxs, []) = (rev rxs, [])
wenzelm@255
   325
        | take (rxs, x :: xs) =
wenzelm@255
   326
            if  pred x  then  take(x :: rxs, xs)  else  (rev rxs, x :: xs)
wenzelm@233
   327
  in  take([], xs)  end;
wenzelm@233
   328
wenzelm@233
   329
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., xi], [x(i+1), ..., xn])
wenzelm@233
   330
   where xi is the last element that does not satisfy the predicate*)
wenzelm@233
   331
fun take_suffix _ [] = ([], [])
wenzelm@233
   332
  | take_suffix pred (x :: xs) =
wenzelm@233
   333
      (case take_suffix pred xs of
wenzelm@233
   334
        ([], sffx) => if pred x then ([], x :: sffx) else ([x], sffx)
wenzelm@233
   335
      | (prfx, sffx) => (x :: prfx, sffx));
wenzelm@233
   336
wenzelm@233
   337
wenzelm@233
   338
wenzelm@233
   339
(** integers **)
wenzelm@233
   340
wenzelm@2958
   341
fun inc i = (i := ! i + 1; ! i);
wenzelm@2958
   342
fun dec i = (i := ! i - 1; ! i);
wenzelm@233
   343
wenzelm@233
   344
wenzelm@233
   345
(* lists of integers *)
wenzelm@233
   346
wenzelm@233
   347
(*make the list [from, from + 1, ..., to]*)
paulson@2175
   348
fun (from upto to) =
wenzelm@233
   349
  if from > to then [] else from :: ((from + 1) upto to);
wenzelm@233
   350
wenzelm@233
   351
(*make the list [from, from - 1, ..., to]*)
paulson@2175
   352
fun (from downto to) =
wenzelm@233
   353
  if from < to then [] else from :: ((from - 1) downto to);
wenzelm@233
   354
wenzelm@233
   355
(*predicate: downto0 (is, n) <=> is = [n, n - 1, ..., 0]*)
wenzelm@233
   356
fun downto0 (i :: is, n) = i = n andalso downto0 (is, n - 1)
wenzelm@233
   357
  | downto0 ([], n) = n = ~1;
wenzelm@233
   358
wenzelm@233
   359
wenzelm@233
   360
(* convert integers to strings *)
wenzelm@233
   361
wenzelm@233
   362
(*expand the number in the given base;
wenzelm@233
   363
  example: radixpand (2, 8) gives [1, 0, 0, 0]*)
wenzelm@233
   364
fun radixpand (base, num) : int list =
wenzelm@233
   365
  let
wenzelm@233
   366
    fun radix (n, tail) =
wenzelm@233
   367
      if n < base then n :: tail
wenzelm@233
   368
      else radix (n div base, (n mod base) :: tail)
wenzelm@233
   369
  in radix (num, []) end;
wenzelm@233
   370
wenzelm@233
   371
(*expands a number into a string of characters starting from "zerochar";
wenzelm@233
   372
  example: radixstring (2, "0", 8) gives "1000"*)
wenzelm@233
   373
fun radixstring (base, zerochar, num) =
wenzelm@233
   374
  let val offset = ord zerochar;
wenzelm@233
   375
      fun chrof n = chr (offset + n)
wenzelm@233
   376
  in implode (map chrof (radixpand (base, num))) end;
wenzelm@233
   377
wenzelm@233
   378
paulson@3407
   379
val string_of_int = Int.toString;
wenzelm@233
   380
paulson@3407
   381
fun string_of_indexname (a,0) = a
paulson@3407
   382
  | string_of_indexname (a,i) = a ^ "_" ^ Int.toString i;
wenzelm@233
   383
wenzelm@233
   384
wenzelm@233
   385
(** strings **)
wenzelm@233
   386
wenzelm@233
   387
fun is_letter ch =
wenzelm@233
   388
  ord "A" <= ord ch andalso ord ch <= ord "Z" orelse
wenzelm@233
   389
  ord "a" <= ord ch andalso ord ch <= ord "z";
wenzelm@233
   390
wenzelm@233
   391
fun is_digit ch =
wenzelm@233
   392
  ord "0" <= ord ch andalso ord ch <= ord "9";
wenzelm@233
   393
wenzelm@233
   394
(*letter or _ or prime (')*)
wenzelm@233
   395
fun is_quasi_letter "_" = true
wenzelm@233
   396
  | is_quasi_letter "'" = true
wenzelm@233
   397
  | is_quasi_letter ch = is_letter ch;
wenzelm@233
   398
lcp@512
   399
(*white space: blanks, tabs, newlines, formfeeds*)
wenzelm@233
   400
val is_blank : string -> bool =
wenzelm@3393
   401
  fn " " => true | "\t" => true | "\n" => true | "\^L" => true | "\160" => true
wenzelm@3063
   402
    | _ => false;
wenzelm@233
   403
wenzelm@233
   404
val is_letdig = is_quasi_letter orf is_digit;
wenzelm@233
   405
wenzelm@2196
   406
(*printable chars*)
wenzelm@2196
   407
fun is_printable c = ord c > ord " " andalso ord c <= ord "~";
wenzelm@2196
   408
wenzelm@233
   409
wenzelm@233
   410
(*lower all chars of string*)
wenzelm@233
   411
val to_lower =
wenzelm@233
   412
  let
wenzelm@233
   413
    fun lower ch =
wenzelm@233
   414
      if ch >= "A" andalso ch <= "Z" then
wenzelm@233
   415
        chr (ord ch - ord "A" + ord "a")
wenzelm@233
   416
      else ch;
wenzelm@233
   417
  in implode o (map lower) o explode end;
wenzelm@233
   418
wenzelm@233
   419
lcp@512
   420
(*enclose in brackets*)
lcp@512
   421
fun enclose lpar rpar str = lpar ^ str ^ rpar;
wenzelm@255
   422
wenzelm@233
   423
(*simple quoting (does not escape special chars)*)
lcp@512
   424
val quote = enclose "\"" "\"";
wenzelm@233
   425
wenzelm@233
   426
(*space_implode "..." (explode "hello"); gives "h...e...l...l...o"*)
wenzelm@233
   427
fun space_implode a bs = implode (separate a bs);
wenzelm@233
   428
wenzelm@255
   429
val commas = space_implode ", ";
wenzelm@380
   430
val commas_quote = commas o map quote;
wenzelm@255
   431
wenzelm@233
   432
(*concatenate messages, one per line, into a string*)
wenzelm@255
   433
val cat_lines = space_implode "\n";
wenzelm@233
   434
wenzelm@3832
   435
(*BAD_space_explode "." "h.e..l.lo"; gives ["h", "e", "l", "lo"]*)
wenzelm@3832
   436
fun BAD_space_explode sep s =
clasohm@1290
   437
  let fun divide [] "" = []
clasohm@1290
   438
        | divide [] part = [part]
clasohm@1290
   439
        | divide (c::s) part =
clasohm@1290
   440
            if c = sep then
clasohm@1290
   441
              (if part = "" then divide s "" else part :: divide s "")
clasohm@1290
   442
            else divide s (part ^ c)
clasohm@1290
   443
  in divide (explode s) "" end;
wenzelm@233
   444
wenzelm@3832
   445
(*space_explode "." "h.e..l.lo"; gives ["h", "e", "", "l", "lo"]*)
wenzelm@3832
   446
fun space_explode _ "" = []
wenzelm@3832
   447
  | space_explode sep str =
wenzelm@3832
   448
      let
wenzelm@3832
   449
        fun expl chs =
wenzelm@3832
   450
          (case take_prefix (not_equal sep) chs of
wenzelm@3832
   451
            (cs, []) => [implode cs]
wenzelm@3832
   452
          | (cs, _ :: cs') => implode cs :: expl cs');
wenzelm@3832
   453
      in expl (explode str) end;
wenzelm@3832
   454
wenzelm@3832
   455
val split_lines = space_explode "\n";
wenzelm@3832
   456
wenzelm@3832
   457
wenzelm@233
   458
wenzelm@233
   459
(** lists as sets **)
wenzelm@233
   460
wenzelm@233
   461
(*membership in a list*)
wenzelm@233
   462
fun x mem [] = false
wenzelm@233
   463
  | x mem (y :: ys) = x = y orelse x mem ys;
clasohm@0
   464
paulson@2175
   465
(*membership in a list, optimized version for ints*)
berghofe@1576
   466
fun (x:int) mem_int [] = false
berghofe@1576
   467
  | x mem_int (y :: ys) = x = y orelse x mem_int ys;
berghofe@1576
   468
paulson@2175
   469
(*membership in a list, optimized version for strings*)
berghofe@1576
   470
fun (x:string) mem_string [] = false
berghofe@1576
   471
  | x mem_string (y :: ys) = x = y orelse x mem_string ys;
berghofe@1576
   472
clasohm@0
   473
(*generalized membership test*)
wenzelm@233
   474
fun gen_mem eq (x, []) = false
wenzelm@233
   475
  | gen_mem eq (x, y :: ys) = eq (x, y) orelse gen_mem eq (x, ys);
wenzelm@233
   476
wenzelm@233
   477
wenzelm@233
   478
(*insertion into list if not already there*)
paulson@2175
   479
fun (x ins xs) = if x mem xs then xs else x :: xs;
clasohm@0
   480
paulson@2175
   481
(*insertion into list, optimized version for ints*)
paulson@2175
   482
fun (x ins_int xs) = if x mem_int xs then xs else x :: xs;
berghofe@1576
   483
paulson@2175
   484
(*insertion into list, optimized version for strings*)
paulson@2175
   485
fun (x ins_string xs) = if x mem_string xs then xs else x :: xs;
berghofe@1576
   486
clasohm@0
   487
(*generalized insertion*)
wenzelm@233
   488
fun gen_ins eq (x, xs) = if gen_mem eq (x, xs) then xs else x :: xs;
wenzelm@233
   489
wenzelm@233
   490
wenzelm@233
   491
(*union of sets represented as lists: no repetitions*)
wenzelm@233
   492
fun xs union [] = xs
wenzelm@233
   493
  | [] union ys = ys
wenzelm@233
   494
  | (x :: xs) union ys = xs union (x ins ys);
clasohm@0
   495
paulson@2175
   496
(*union of sets, optimized version for ints*)
berghofe@1576
   497
fun (xs:int list) union_int [] = xs
berghofe@1576
   498
  | [] union_int ys = ys
berghofe@1576
   499
  | (x :: xs) union_int ys = xs union_int (x ins_int ys);
berghofe@1576
   500
paulson@2175
   501
(*union of sets, optimized version for strings*)
berghofe@1576
   502
fun (xs:string list) union_string [] = xs
berghofe@1576
   503
  | [] union_string ys = ys
berghofe@1576
   504
  | (x :: xs) union_string ys = xs union_string (x ins_string ys);
berghofe@1576
   505
clasohm@0
   506
(*generalized union*)
wenzelm@233
   507
fun gen_union eq (xs, []) = xs
wenzelm@233
   508
  | gen_union eq ([], ys) = ys
wenzelm@233
   509
  | gen_union eq (x :: xs, ys) = gen_union eq (xs, gen_ins eq (x, ys));
wenzelm@233
   510
wenzelm@233
   511
wenzelm@233
   512
(*intersection*)
wenzelm@233
   513
fun [] inter ys = []
wenzelm@233
   514
  | (x :: xs) inter ys =
wenzelm@233
   515
      if x mem ys then x :: (xs inter ys) else xs inter ys;
wenzelm@233
   516
paulson@2175
   517
(*intersection, optimized version for ints*)
berghofe@1576
   518
fun ([]:int list) inter_int ys = []
berghofe@1576
   519
  | (x :: xs) inter_int ys =
berghofe@1576
   520
      if x mem_int ys then x :: (xs inter_int ys) else xs inter_int ys;
berghofe@1576
   521
paulson@2175
   522
(*intersection, optimized version for strings *)
berghofe@1576
   523
fun ([]:string list) inter_string ys = []
berghofe@1576
   524
  | (x :: xs) inter_string ys =
berghofe@1576
   525
      if x mem_string ys then x :: (xs inter_string ys) else xs inter_string ys;
berghofe@1576
   526
wenzelm@233
   527
wenzelm@233
   528
(*subset*)
wenzelm@233
   529
fun [] subset ys = true
wenzelm@233
   530
  | (x :: xs) subset ys = x mem ys andalso xs subset ys;
wenzelm@233
   531
paulson@2175
   532
(*subset, optimized version for ints*)
berghofe@1576
   533
fun ([]:int list) subset_int ys = true
berghofe@1576
   534
  | (x :: xs) subset_int ys = x mem_int ys andalso xs subset_int ys;
berghofe@1576
   535
paulson@2175
   536
(*subset, optimized version for strings*)
berghofe@1576
   537
fun ([]:string list) subset_string ys = true
berghofe@1576
   538
  | (x :: xs) subset_string ys = x mem_string ys andalso xs subset_string ys;
berghofe@1576
   539
paulson@2182
   540
(*set equality for strings*)
berghofe@1576
   541
fun eq_set_string ((xs:string list), ys) =
berghofe@1576
   542
  xs = ys orelse (xs subset_string ys andalso ys subset_string xs);
berghofe@1576
   543
paulson@2182
   544
fun gen_subset eq (xs, ys) = forall (fn x => gen_mem eq (x, ys)) xs;
paulson@2182
   545
wenzelm@265
   546
wenzelm@233
   547
(*removing an element from a list WITHOUT duplicates*)
wenzelm@233
   548
fun (y :: ys) \ x = if x = y then ys else y :: (ys \ x)
wenzelm@233
   549
  | [] \ x = [];
wenzelm@233
   550
paulson@2243
   551
fun ys \\ xs = foldl (op \) (ys,xs);
clasohm@0
   552
wenzelm@233
   553
(*removing an element from a list -- possibly WITH duplicates*)
wenzelm@233
   554
fun gen_rem eq (xs, y) = filter_out (fn x => eq (x, y)) xs;
wenzelm@233
   555
paulson@2243
   556
fun gen_rems eq = foldl (gen_rem eq);
wenzelm@233
   557
wenzelm@233
   558
wenzelm@233
   559
(*makes a list of the distinct members of the input; preserves order, takes
wenzelm@233
   560
  first of equal elements*)
wenzelm@233
   561
fun gen_distinct eq lst =
wenzelm@233
   562
  let
wenzelm@233
   563
    val memb = gen_mem eq;
clasohm@0
   564
wenzelm@233
   565
    fun dist (rev_seen, []) = rev rev_seen
wenzelm@233
   566
      | dist (rev_seen, x :: xs) =
wenzelm@233
   567
          if memb (x, rev_seen) then dist (rev_seen, xs)
wenzelm@233
   568
          else dist (x :: rev_seen, xs);
wenzelm@233
   569
  in
wenzelm@233
   570
    dist ([], lst)
wenzelm@233
   571
  end;
wenzelm@233
   572
paulson@2243
   573
fun distinct l = gen_distinct (op =) l;
wenzelm@233
   574
wenzelm@233
   575
wenzelm@233
   576
(*returns the tail beginning with the first repeated element, or []*)
wenzelm@233
   577
fun findrep [] = []
wenzelm@233
   578
  | findrep (x :: xs) = if x mem xs then x :: xs else findrep xs;
wenzelm@233
   579
wenzelm@233
   580
wenzelm@255
   581
(*returns a list containing all repeated elements exactly once; preserves
wenzelm@255
   582
  order, takes first of equal elements*)
wenzelm@255
   583
fun gen_duplicates eq lst =
wenzelm@255
   584
  let
wenzelm@255
   585
    val memb = gen_mem eq;
wenzelm@255
   586
wenzelm@255
   587
    fun dups (rev_dups, []) = rev rev_dups
wenzelm@255
   588
      | dups (rev_dups, x :: xs) =
wenzelm@255
   589
          if memb (x, rev_dups) orelse not (memb (x, xs)) then
wenzelm@255
   590
            dups (rev_dups, xs)
wenzelm@255
   591
          else dups (x :: rev_dups, xs);
wenzelm@255
   592
  in
wenzelm@255
   593
    dups ([], lst)
wenzelm@255
   594
  end;
wenzelm@255
   595
paulson@2243
   596
fun duplicates l = gen_duplicates (op =) l;
wenzelm@255
   597
wenzelm@255
   598
wenzelm@233
   599
wenzelm@233
   600
(** association lists **)
clasohm@0
   601
wenzelm@233
   602
(*association list lookup*)
wenzelm@233
   603
fun assoc ([], key) = None
wenzelm@233
   604
  | assoc ((keyi, xi) :: pairs, key) =
wenzelm@233
   605
      if key = keyi then Some xi else assoc (pairs, key);
wenzelm@233
   606
paulson@2175
   607
(*association list lookup, optimized version for ints*)
berghofe@1576
   608
fun assoc_int ([], (key:int)) = None
berghofe@1576
   609
  | assoc_int ((keyi, xi) :: pairs, key) =
berghofe@1576
   610
      if key = keyi then Some xi else assoc_int (pairs, key);
berghofe@1576
   611
paulson@2175
   612
(*association list lookup, optimized version for strings*)
berghofe@1576
   613
fun assoc_string ([], (key:string)) = None
berghofe@1576
   614
  | assoc_string ((keyi, xi) :: pairs, key) =
berghofe@1576
   615
      if key = keyi then Some xi else assoc_string (pairs, key);
berghofe@1576
   616
paulson@2175
   617
(*association list lookup, optimized version for string*ints*)
berghofe@1576
   618
fun assoc_string_int ([], (key:string*int)) = None
berghofe@1576
   619
  | assoc_string_int ((keyi, xi) :: pairs, key) =
berghofe@1576
   620
      if key = keyi then Some xi else assoc_string_int (pairs, key);
berghofe@1576
   621
wenzelm@233
   622
fun assocs ps x =
wenzelm@233
   623
  (case assoc (ps, x) of
wenzelm@233
   624
    None => []
wenzelm@233
   625
  | Some ys => ys);
wenzelm@233
   626
wenzelm@255
   627
(*two-fold association list lookup*)
wenzelm@255
   628
fun assoc2 (aal, (key1, key2)) =
wenzelm@255
   629
  (case assoc (aal, key1) of
wenzelm@255
   630
    Some al => assoc (al, key2)
wenzelm@255
   631
  | None => None);
wenzelm@255
   632
wenzelm@233
   633
(*generalized association list lookup*)
wenzelm@233
   634
fun gen_assoc eq ([], key) = None
wenzelm@233
   635
  | gen_assoc eq ((keyi, xi) :: pairs, key) =
wenzelm@233
   636
      if eq (key, keyi) then Some xi else gen_assoc eq (pairs, key);
wenzelm@233
   637
wenzelm@233
   638
(*association list update*)
wenzelm@233
   639
fun overwrite (al, p as (key, _)) =
wenzelm@233
   640
  let fun over ((q as (keyi, _)) :: pairs) =
wenzelm@233
   641
            if keyi = key then p :: pairs else q :: (over pairs)
wenzelm@233
   642
        | over [] = [p]
wenzelm@233
   643
  in over al end;
wenzelm@233
   644
wenzelm@2522
   645
fun gen_overwrite eq (al, p as (key, _)) =
wenzelm@2522
   646
  let fun over ((q as (keyi, _)) :: pairs) =
wenzelm@2522
   647
            if eq (keyi, key) then p :: pairs else q :: (over pairs)
wenzelm@2522
   648
        | over [] = [p]
wenzelm@2522
   649
  in over al end;
wenzelm@2522
   650
wenzelm@233
   651
wenzelm@233
   652
wenzelm@233
   653
(** generic tables **)
clasohm@0
   654
wenzelm@233
   655
(*Tables are supposed to be 'efficient' encodings of lists of elements distinct
wenzelm@233
   656
  wrt. an equality "eq". The extend and merge operations below are optimized
wenzelm@233
   657
  for long-term space efficiency.*)
wenzelm@233
   658
wenzelm@233
   659
(*append (new) elements to a table*)
wenzelm@233
   660
fun generic_extend _ _ _ tab [] = tab
wenzelm@233
   661
  | generic_extend eq dest_tab mk_tab tab1 lst2 =
wenzelm@233
   662
      let
wenzelm@233
   663
        val lst1 = dest_tab tab1;
wenzelm@233
   664
        val new_lst2 = gen_rems eq (lst2, lst1);
wenzelm@233
   665
      in
wenzelm@233
   666
        if null new_lst2 then tab1
wenzelm@233
   667
        else mk_tab (lst1 @ new_lst2)
wenzelm@233
   668
      end;
clasohm@0
   669
wenzelm@233
   670
(*append (new) elements of 2nd table to 1st table*)
wenzelm@233
   671
fun generic_merge eq dest_tab mk_tab tab1 tab2 =
wenzelm@233
   672
  let
wenzelm@233
   673
    val lst1 = dest_tab tab1;
wenzelm@233
   674
    val lst2 = dest_tab tab2;
wenzelm@233
   675
    val new_lst2 = gen_rems eq (lst2, lst1);
wenzelm@233
   676
  in
wenzelm@233
   677
    if null new_lst2 then tab1
wenzelm@233
   678
    else if gen_subset eq (lst1, lst2) then tab2
wenzelm@233
   679
    else mk_tab (lst1 @ new_lst2)
wenzelm@233
   680
  end;
clasohm@0
   681
wenzelm@233
   682
wenzelm@233
   683
(*lists as tables*)
paulson@2243
   684
fun extend_list tab = generic_extend (op =) I I tab;
paulson@2243
   685
fun merge_lists tab = generic_merge (op =) I I tab;
wenzelm@233
   686
wenzelm@380
   687
fun merge_rev_lists xs [] = xs
wenzelm@380
   688
  | merge_rev_lists [] ys = ys
wenzelm@380
   689
  | merge_rev_lists xs (y :: ys) =
wenzelm@380
   690
      (if y mem xs then I else cons y) (merge_rev_lists xs ys);
wenzelm@380
   691
clasohm@0
   692
clasohm@0
   693
wenzelm@233
   694
(** balanced trees **)
wenzelm@233
   695
wenzelm@233
   696
exception Balance;      (*indicates non-positive argument to balancing fun*)
wenzelm@233
   697
wenzelm@233
   698
(*balanced folding; avoids deep nesting*)
wenzelm@233
   699
fun fold_bal f [x] = x
wenzelm@233
   700
  | fold_bal f [] = raise Balance
wenzelm@233
   701
  | fold_bal f xs =
wenzelm@233
   702
      let val k = length xs div 2
wenzelm@233
   703
      in  f (fold_bal f (take(k, xs)),
wenzelm@233
   704
             fold_bal f (drop(k, xs)))
wenzelm@233
   705
      end;
wenzelm@233
   706
wenzelm@233
   707
(*construct something of the form f(...g(...(x)...)) for balanced access*)
wenzelm@233
   708
fun access_bal (f, g, x) n i =
wenzelm@233
   709
  let fun acc n i =     (*1<=i<=n*)
wenzelm@233
   710
          if n=1 then x else
wenzelm@233
   711
          let val n2 = n div 2
wenzelm@233
   712
          in  if i<=n2 then f (acc n2 i)
wenzelm@233
   713
                       else g (acc (n-n2) (i-n2))
wenzelm@233
   714
          end
wenzelm@233
   715
  in  if 1<=i andalso i<=n then acc n i else raise Balance  end;
wenzelm@233
   716
wenzelm@233
   717
(*construct ALL such accesses; could try harder to share recursive calls!*)
wenzelm@233
   718
fun accesses_bal (f, g, x) n =
wenzelm@233
   719
  let fun acc n =
wenzelm@233
   720
          if n=1 then [x] else
wenzelm@233
   721
          let val n2 = n div 2
wenzelm@233
   722
              val acc2 = acc n2
wenzelm@233
   723
          in  if n-n2=n2 then map f acc2 @ map g acc2
wenzelm@233
   724
                         else map f acc2 @ map g (acc (n-n2)) end
wenzelm@233
   725
  in  if 1<=n then acc n else raise Balance  end;
wenzelm@233
   726
wenzelm@233
   727
wenzelm@233
   728
wenzelm@2506
   729
(** orders **)
wenzelm@2506
   730
wenzelm@2506
   731
datatype order = LESS | EQUAL | GREATER;
wenzelm@2506
   732
wenzelm@2506
   733
fun intord (i, j: int) =
wenzelm@2506
   734
  if i < j then LESS
wenzelm@2506
   735
  else if i = j then EQUAL
wenzelm@2506
   736
  else GREATER;
wenzelm@2506
   737
wenzelm@2506
   738
fun stringord (a, b: string) =
wenzelm@2506
   739
  if a < b then LESS
wenzelm@2506
   740
  else if a = b then EQUAL
wenzelm@2506
   741
  else GREATER;
wenzelm@2506
   742
wenzelm@2506
   743
wenzelm@2506
   744
wenzelm@3525
   745
(** input / output and diagnostics **)
wenzelm@233
   746
paulson@2243
   747
val cd = OS.FileSys.chDir;
wenzelm@2317
   748
val pwd = OS.FileSys.getDir;
paulson@2243
   749
wenzelm@3525
   750
wenzelm@3525
   751
local
wenzelm@3525
   752
  fun out s =
wenzelm@3525
   753
    (TextIO.output (TextIO.stdOut, s); TextIO.flushOut TextIO.stdOut);
wenzelm@3525
   754
wenzelm@3525
   755
  fun prefix_lines prfx txt =
wenzelm@3832
   756
    txt |> split_lines |> map (fn s => prfx ^ s ^ "\n") |> implode;
wenzelm@3525
   757
in
wenzelm@3525
   758
wenzelm@3525
   759
(*hooks for output channels: normal, warning, error*)
wenzelm@3525
   760
val prs_fn = ref (fn s => out s);
wenzelm@3525
   761
val warning_fn = ref (fn s => out (prefix_lines "### " s));
wenzelm@3525
   762
val error_fn = ref (fn s => out (prefix_lines "*** " s));
wenzelm@3525
   763
wenzelm@3525
   764
end;
berghofe@1580
   765
berghofe@1580
   766
fun prs s = !prs_fn s;
wenzelm@233
   767
fun writeln s = prs (s ^ "\n");
wenzelm@233
   768
wenzelm@3525
   769
fun warning s = !warning_fn s;
wenzelm@233
   770
wenzelm@233
   771
(*print error message and abort to top level*)
wenzelm@233
   772
exception ERROR;
wenzelm@3553
   773
fun error_msg s = !error_fn s;
wenzelm@3553
   774
fun error s = (error_msg s; raise ERROR);
wenzelm@3553
   775
fun sys_error msg = (error_msg " !! SYSTEM ERROR !!\n"; error msg);
wenzelm@233
   776
wenzelm@233
   777
fun assert p msg = if p then () else error msg;
wenzelm@233
   778
fun deny p msg = if p then error msg else ();
wenzelm@233
   779
lcp@544
   780
(*Assert pred for every member of l, generating a message if pred fails*)
lcp@544
   781
fun assert_all pred l msg_fn = 
lcp@544
   782
  let fun asl [] = ()
paulson@2243
   783
        | asl (x::xs) = if pred x then asl xs
paulson@2243
   784
                        else error (msg_fn x)
lcp@544
   785
  in  asl l  end;
wenzelm@233
   786
wenzelm@3624
   787
wenzelm@3699
   788
(* handle errors (capturing messages) *)
wenzelm@3699
   789
wenzelm@3699
   790
datatype 'a error =
wenzelm@3699
   791
  Error of string |
wenzelm@3699
   792
  OK of 'a;
wenzelm@3699
   793
wenzelm@3699
   794
fun handle_error f x =
wenzelm@3699
   795
  let
wenzelm@3699
   796
    val buffer = ref "";
wenzelm@3699
   797
    fun capture s = buffer := ! buffer ^ s ^ "\n";
wenzelm@3699
   798
    val result = Some (setmp error_fn capture f x) handle ERROR => None;
wenzelm@3699
   799
  in
wenzelm@3699
   800
    case result of
wenzelm@3699
   801
      None => Error (! buffer)
wenzelm@3699
   802
    | Some y => OK y
wenzelm@3699
   803
  end;
wenzelm@3699
   804
wenzelm@3699
   805
wenzelm@3624
   806
(* read / write files *)
wenzelm@3624
   807
wenzelm@3624
   808
fun read_file name =
wenzelm@3624
   809
  let
wenzelm@3624
   810
    val instream  = TextIO.openIn name;
wenzelm@3624
   811
    val intext = TextIO.inputAll instream;
wenzelm@3624
   812
  in
wenzelm@3624
   813
    TextIO.closeIn instream;
wenzelm@3624
   814
    intext
wenzelm@3624
   815
  end;
wenzelm@3624
   816
wenzelm@3624
   817
fun write_file name txt =
wenzelm@3645
   818
  let val outstream = TextIO.openOut name in
wenzelm@3645
   819
    TextIO.output (outstream, txt);
wenzelm@3645
   820
    TextIO.closeOut outstream
wenzelm@3645
   821
  end;
wenzelm@3645
   822
wenzelm@3645
   823
fun append_file name txt =
wenzelm@3645
   824
  let val outstream = TextIO.openAppend name in
wenzelm@3624
   825
    TextIO.output (outstream, txt);
wenzelm@3624
   826
    TextIO.closeOut outstream
wenzelm@3624
   827
  end;
wenzelm@3624
   828
wenzelm@3624
   829
wenzelm@3624
   830
(*for the "test" target in IsaMakefiles -- signifies successful termination*)
wenzelm@233
   831
fun maketest msg =
wenzelm@3624
   832
  (writeln msg; write_file "test" "Test examples ran successfully\n");
wenzelm@233
   833
wenzelm@233
   834
wenzelm@233
   835
(*print a list surrounded by the brackets lpar and rpar, with comma separator
wenzelm@233
   836
  print nothing for empty list*)
wenzelm@233
   837
fun print_list (lpar, rpar, pre: 'a -> unit) (l : 'a list) =
wenzelm@233
   838
  let fun prec x = (prs ","; pre x)
wenzelm@233
   839
  in
wenzelm@233
   840
    (case l of
wenzelm@233
   841
      [] => ()
wenzelm@233
   842
    | x::l => (prs lpar; pre x; seq prec l; prs rpar))
wenzelm@233
   843
  end;
wenzelm@233
   844
wenzelm@233
   845
(*print a list of items separated by newlines*)
wenzelm@233
   846
fun print_list_ln (pre: 'a -> unit) : 'a list -> unit =
wenzelm@233
   847
  seq (fn x => (pre x; writeln ""));
wenzelm@233
   848
wenzelm@233
   849
wenzelm@233
   850
val print_int = prs o string_of_int;
wenzelm@233
   851
wenzelm@233
   852
wenzelm@3525
   853
(* output to LaTeX / xdvi *)
wenzelm@3525
   854
fun latex s =
wenzelm@3525
   855
  execute ("( cd /tmp ; echo \"" ^ s ^
wenzelm@3525
   856
    "\" | isa2latex -s > $$.tex ; latex $$.tex ; xdvi $$.dvi ; rm $$.* ) > /dev/null &");
wenzelm@3525
   857
wenzelm@233
   858
wenzelm@233
   859
(** timing **)
wenzelm@233
   860
wenzelm@233
   861
(*unconditional timing function*)
paulson@2243
   862
fun timeit x = cond_timeit true x;
wenzelm@233
   863
wenzelm@233
   864
(*timed application function*)
wenzelm@233
   865
fun timeap f x = timeit (fn () => f x);
wenzelm@233
   866
wenzelm@233
   867
(*timed "use" function, printing filenames*)
wenzelm@233
   868
fun time_use fname = timeit (fn () =>
wenzelm@233
   869
  (writeln ("\n**** Starting " ^ fname ^ " ****"); use fname;
wenzelm@233
   870
   writeln ("\n**** Finished " ^ fname ^ " ****")));
wenzelm@233
   871
wenzelm@3624
   872
(*use the file, but exit with error code if errors found.*)
lcp@955
   873
fun exit_use fname = use fname handle _ => exit 1;
wenzelm@233
   874
wenzelm@233
   875
clasohm@1407
   876
(** filenames and paths **)
wenzelm@233
   877
clasohm@1290
   878
(*Convert UNIX filename of the form "path/file" to "path/" and "file";
wenzelm@233
   879
  if filename contains no slash, then it returns "" and "file"*)
wenzelm@233
   880
val split_filename =
wenzelm@233
   881
  (pairself implode) o take_suffix (not_equal "/") o explode;
wenzelm@233
   882
wenzelm@233
   883
val base_name = #2 o split_filename;
wenzelm@233
   884
clasohm@1290
   885
(*Merge splitted filename (path and file);
wenzelm@233
   886
  if path does not end with one a slash is appended*)
wenzelm@233
   887
fun tack_on "" name = name
wenzelm@233
   888
  | tack_on path name =
wenzelm@233
   889
      if last_elem (explode path) = "/" then path ^ name
wenzelm@233
   890
      else path ^ "/" ^ name;
wenzelm@233
   891
clasohm@1290
   892
(*Remove the extension of a filename, i.e. the part after the last '.'*)
wenzelm@233
   893
val remove_ext = implode o #1 o take_suffix (not_equal ".") o explode;
wenzelm@233
   894
clasohm@1290
   895
(*Make relative path to reach an absolute location from a different one*)
clasohm@1290
   896
fun relative_path cur_path dest_path =
clasohm@1290
   897
  let (*Remove common beginning of both paths and make relative path*)
clasohm@1290
   898
      fun mk_relative [] [] = []
clasohm@1290
   899
        | mk_relative [] ds = ds
clasohm@1290
   900
        | mk_relative cs [] = map (fn _ => "..") cs
clasohm@1290
   901
        | mk_relative (c::cs) (d::ds) =
clasohm@1290
   902
            if c = d then mk_relative cs ds
clasohm@1290
   903
            else ".." :: map (fn _ => "..") cs @ (d::ds);
clasohm@1290
   904
  in if cur_path = "" orelse hd (explode cur_path) <> "/" orelse
clasohm@1290
   905
        dest_path = "" orelse hd (explode dest_path) <> "/" then
clasohm@1290
   906
       error "Relative or empty path passed to relative_path"
clasohm@1290
   907
     else ();
wenzelm@3832
   908
     space_implode "/" (mk_relative (BAD_space_explode "/" cur_path)
wenzelm@3832
   909
                                    (BAD_space_explode "/" dest_path))
clasohm@1290
   910
  end;
wenzelm@233
   911
clasohm@1407
   912
(*Determine if absolute path1 is a subdirectory of absolute path2*)
clasohm@1407
   913
fun path1 subdir_of path2 =
clasohm@1407
   914
  if hd (explode path1) <> "/" orelse hd (explode path2) <> "/" then
clasohm@1407
   915
    error "Relative or empty path passed to subdir_of"
wenzelm@3832
   916
  else (BAD_space_explode "/" path2) prefix (BAD_space_explode "/" path1);
clasohm@1407
   917
clasohm@1456
   918
fun absolute_path cwd file =
clasohm@1456
   919
  let fun rm_points [] result = rev result
clasohm@1456
   920
        | rm_points (".."::ds) result = rm_points ds (tl result)
clasohm@1456
   921
        | rm_points ("."::ds) result = rm_points ds result
clasohm@1456
   922
        | rm_points (d::ds) result = rm_points ds (d::result);
clasohm@1456
   923
  in if file = "" then ""
clasohm@1456
   924
     else if hd (explode file) = "/" then file
clasohm@1456
   925
     else "/" ^ space_implode "/"
wenzelm@3832
   926
                  (rm_points (BAD_space_explode "/" (tack_on cwd file)) [])
clasohm@1456
   927
  end;
clasohm@1456
   928
berghofe@3606
   929
fun file_exists file = (file_info file <> "");
berghofe@3606
   930
wenzelm@233
   931
wenzelm@233
   932
(** misc functions **)
wenzelm@233
   933
wenzelm@233
   934
(*use the keyfun to make a list of (x, key) pairs*)
clasohm@0
   935
fun make_keylist (keyfun: 'a->'b) : 'a list -> ('a * 'b) list =
wenzelm@233
   936
  let fun keypair x = (x, keyfun x)
wenzelm@233
   937
  in map keypair end;
clasohm@0
   938
wenzelm@233
   939
(*given a list of (x, key) pairs and a searchkey
clasohm@0
   940
  return the list of xs from each pair whose key equals searchkey*)
clasohm@0
   941
fun keyfilter [] searchkey = []
wenzelm@233
   942
  | keyfilter ((x, key) :: pairs) searchkey =
wenzelm@233
   943
      if key = searchkey then x :: keyfilter pairs searchkey
wenzelm@233
   944
      else keyfilter pairs searchkey;
clasohm@0
   945
clasohm@0
   946
clasohm@0
   947
(*Partition list into elements that satisfy predicate and those that don't.
wenzelm@233
   948
  Preserves order of elements in both lists.*)
clasohm@0
   949
fun partition (pred: 'a->bool) (ys: 'a list) : ('a list * 'a list) =
clasohm@0
   950
    let fun part ([], answer) = answer
wenzelm@233
   951
          | part (x::xs, (ys, ns)) = if pred(x)
wenzelm@233
   952
            then  part (xs, (x::ys, ns))
wenzelm@233
   953
            else  part (xs, (ys, x::ns))
wenzelm@233
   954
    in  part (rev ys, ([], []))  end;
clasohm@0
   955
clasohm@0
   956
clasohm@0
   957
fun partition_eq (eq:'a * 'a -> bool) =
clasohm@0
   958
    let fun part [] = []
wenzelm@233
   959
          | part (x::ys) = let val (xs, xs') = partition (apl(x, eq)) ys
wenzelm@233
   960
                           in (x::xs)::(part xs') end
clasohm@0
   961
    in part end;
clasohm@0
   962
clasohm@0
   963
wenzelm@233
   964
(*Partition a list into buckets  [ bi, b(i+1), ..., bj ]
clasohm@0
   965
   putting x in bk if p(k)(x) holds.  Preserve order of elements if possible.*)
clasohm@0
   966
fun partition_list p i j =
wenzelm@233
   967
  let fun part k xs =
wenzelm@233
   968
            if k>j then
clasohm@0
   969
              (case xs of [] => []
clasohm@0
   970
                         | _ => raise LIST "partition_list")
clasohm@0
   971
            else
wenzelm@233
   972
            let val (ns, rest) = partition (p k) xs;
wenzelm@233
   973
            in  ns :: part(k+1)rest  end
clasohm@0
   974
  in  part i end;
clasohm@0
   975
clasohm@0
   976
wenzelm@233
   977
(* sorting *)
wenzelm@233
   978
wenzelm@233
   979
(*insertion sort; stable (does not reorder equal elements)
wenzelm@233
   980
  'less' is less-than test on type 'a*)
wenzelm@233
   981
fun sort (less: 'a*'a -> bool) =
clasohm@0
   982
  let fun insert (x, []) = [x]
wenzelm@233
   983
        | insert (x, y::ys) =
wenzelm@233
   984
              if less(y, x) then y :: insert (x, ys) else x::y::ys;
clasohm@0
   985
      fun sort1 [] = []
clasohm@0
   986
        | sort1 (x::xs) = insert (x, sort1 xs)
clasohm@0
   987
  in  sort1  end;
clasohm@0
   988
wenzelm@41
   989
(*sort strings*)
wenzelm@41
   990
val sort_strings = sort (op <= : string * string -> bool);
wenzelm@41
   991
wenzelm@41
   992
wenzelm@233
   993
(* transitive closure (not Warshall's algorithm) *)
clasohm@0
   994
wenzelm@233
   995
fun transitive_closure [] = []
wenzelm@233
   996
  | transitive_closure ((x, ys)::ps) =
wenzelm@233
   997
      let val qs = transitive_closure ps
paulson@2182
   998
          val zs = foldl (fn (zs, y) => assocs qs y union_string zs) (ys, ys)
paulson@2182
   999
          fun step(u, us) = (u, if x mem_string us then zs union_string us 
paulson@2243
  1000
                                else us)
wenzelm@233
  1001
      in (x, zs) :: map step qs end;
clasohm@0
  1002
clasohm@0
  1003
wenzelm@233
  1004
(* generating identifiers *)
clasohm@0
  1005
clasohm@0
  1006
local
wenzelm@233
  1007
  val a = ord "a" and z = ord "z" and A = ord "A" and Z = ord "Z"
wenzelm@233
  1008
  and k0 = ord "0" and k9 = ord "9"
paulson@2003
  1009
paulson@2806
  1010
  val seedr = ref 0;
clasohm@0
  1011
in
clasohm@0
  1012
paulson@2003
  1013
(*Maps 0-63 to A-Z, a-z, 0-9 or _ or ' for generating random identifiers*)
paulson@2003
  1014
fun newid n = 
paulson@2003
  1015
  let fun char i =
paulson@2003
  1016
               if i<26 then chr (A+i)
paulson@2003
  1017
          else if i<52 then chr (a+i-26)
paulson@2003
  1018
          else if i<62 then chr (k0+i-52)
paulson@2003
  1019
          else if i=62 then "_"
paulson@2003
  1020
          else  (*i=63*)    "'"
paulson@2003
  1021
  in  implode (map char (radixpand (64,n)))  end;
paulson@2003
  1022
paulson@2806
  1023
(*Freshly generated identifiers with given prefix; MUST start with a letter*)
paulson@2003
  1024
fun gensym pre = pre ^ 
paulson@2806
  1025
                 (#1(newid (!seedr), 
paulson@2806
  1026
                     seedr := 1+ !seedr))
paulson@2003
  1027
clasohm@0
  1028
(*Increment a list of letters like a reversed base 26 number.
wenzelm@233
  1029
  If head is "z", bumps chars in tail.
clasohm@0
  1030
  Digits are incremented as if they were integers.
clasohm@0
  1031
  "_" and "'" are not changed.
wenzelm@233
  1032
  For making variants of identifiers.*)
clasohm@0
  1033
clasohm@0
  1034
fun bump_int_list(c::cs) = if c="9" then "0" :: bump_int_list cs else
wenzelm@233
  1035
        if k0 <= ord(c) andalso ord(c) < k9 then chr(ord(c)+1) :: cs
wenzelm@233
  1036
        else "1" :: c :: cs
clasohm@0
  1037
  | bump_int_list([]) = error("bump_int_list: not an identifier");
clasohm@0
  1038
wenzelm@233
  1039
fun bump_list([], d) = [d]
wenzelm@233
  1040
  | bump_list(["'"], d) = [d, "'"]
wenzelm@233
  1041
  | bump_list("z"::cs, _) = "a" :: bump_list(cs, "a")
wenzelm@233
  1042
  | bump_list("Z"::cs, _) = "A" :: bump_list(cs, "A")
wenzelm@233
  1043
  | bump_list("9"::cs, _) = "0" :: bump_int_list cs
wenzelm@233
  1044
  | bump_list(c::cs, _) = let val k = ord(c)
wenzelm@233
  1045
        in if (a <= k andalso k < z) orelse (A <= k andalso k < Z) orelse
wenzelm@233
  1046
              (k0 <= k andalso k < k9) then chr(k+1) :: cs else
wenzelm@233
  1047
           if c="'" orelse c="_" then c :: bump_list(cs, "") else
wenzelm@233
  1048
                error("bump_list: not legal in identifier: " ^
wenzelm@233
  1049
                        implode(rev(c::cs)))
wenzelm@233
  1050
        end;
clasohm@0
  1051
clasohm@0
  1052
end;
clasohm@0
  1053
wenzelm@233
  1054
fun bump_string s : string = implode (rev (bump_list(rev(explode s), "")));
wenzelm@41
  1055
wenzelm@41
  1056
wenzelm@233
  1057
(* lexical scanning *)
clasohm@0
  1058
wenzelm@233
  1059
(*scan a list of characters into "words" composed of "letters" (recognized by
wenzelm@233
  1060
  is_let) and separated by any number of non-"letters"*)
wenzelm@233
  1061
fun scanwords is_let cs =
clasohm@0
  1062
  let fun scan1 [] = []
wenzelm@233
  1063
        | scan1 cs =
wenzelm@233
  1064
            let val (lets, rest) = take_prefix is_let cs
wenzelm@233
  1065
            in implode lets :: scanwords is_let rest end;
wenzelm@233
  1066
  in scan1 (#2 (take_prefix (not o is_let) cs)) end;
clasohm@24
  1067
clasohm@1364
  1068
end;
clasohm@1364
  1069
paulson@1592
  1070
(*Variable-branching trees: for proof terms*)
paulson@1592
  1071
datatype 'a mtree = Join of 'a * 'a mtree list;
paulson@1592
  1072
clasohm@1364
  1073
open Library;