src/Pure/library.ML
author wenzelm
Tue Jun 19 23:15:54 2007 +0200 (2007-06-19)
changeset 23424 d0580634f128
parent 23251 471b576aad25
child 23718 8ff68cb5860c
permissions -rw-r--r--
moved balanced tree operations to General/balanced_tree.ML;
wenzelm@41
     1
(*  Title:      Pure/library.ML
clasohm@0
     2
    ID:         $Id$
wenzelm@233
     3
    Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
wenzelm@16188
     4
    Author:     Markus Wenzel, TU Muenchen
clasohm@0
     5
wenzelm@233
     6
Basic library: functions, options, pairs, booleans, lists, integers,
wenzelm@23424
     7
strings, lists as sets, orders, current directory, misc.
wenzelm@21395
     8
wenzelm@21395
     9
See also General/basics.ML for the most fundamental concepts.
clasohm@0
    10
*)
clasohm@0
    11
wenzelm@21395
    12
infix 1 |>>>
wenzelm@21395
    13
infix 2 ?
wenzelm@21395
    14
infix 3 o oo ooo oooo
wenzelm@21395
    15
infix 4 ~~ upto downto
haftmann@20854
    16
infix orf andf \ \\ mem mem_int mem_string union union_int
wenzelm@21395
    17
  union_string inter inter_int inter_string subset subset_int subset_string
wenzelm@5893
    18
wenzelm@15745
    19
signature BASIC_LIBRARY =
wenzelm@4621
    20
sig
wenzelm@4621
    21
  (*functions*)
wenzelm@16842
    22
  val I: 'a -> 'a
wenzelm@16842
    23
  val K: 'a -> 'b -> 'a
wenzelm@23220
    24
  val flip: ('a -> 'b -> 'c) -> 'b -> 'a -> 'c
wenzelm@4621
    25
  val curry: ('a * 'b -> 'c) -> 'a -> 'b -> 'c
wenzelm@4621
    26
  val uncurry: ('a -> 'b -> 'c) -> 'a * 'b -> 'c
haftmann@21335
    27
  val |>>> : ('a * 'c) * ('a -> 'b * 'd) -> 'b * ('c * 'd)
wenzelm@21565
    28
  val ? : bool * ('a -> 'a) -> 'a -> 'a
wenzelm@16721
    29
  val oo: ('a -> 'b) * ('c -> 'd -> 'a) -> 'c -> 'd -> 'b
wenzelm@16721
    30
  val ooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'a) -> 'c -> 'd -> 'e -> 'b
wenzelm@16721
    31
  val oooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'f -> 'a) -> 'c -> 'd -> 'e -> 'f -> 'b
wenzelm@16842
    32
  val funpow: int -> ('a -> 'a) -> 'a -> 'a
clasohm@1364
    33
wenzelm@18681
    34
  (*exceptions*)
wenzelm@18681
    35
  exception EXCEPTION of exn * string
wenzelm@18681
    36
  val do_transform_failure: bool ref
wenzelm@18681
    37
  val transform_failure: (exn -> exn) -> ('a -> 'b) -> 'a -> 'b
wenzelm@14868
    38
  datatype 'a result = Result of 'a | Exn of exn
wenzelm@14868
    39
  val capture: ('a -> 'b) -> 'a -> 'b result
wenzelm@14868
    40
  val release: 'a result -> 'a
wenzelm@14868
    41
  val get_result: 'a result -> 'a option
wenzelm@14868
    42
  val get_exn: 'a result -> exn option
wenzelm@4621
    43
wenzelm@18681
    44
  (*errors*)
wenzelm@19542
    45
  exception SYS_ERROR of string
wenzelm@19542
    46
  val sys_error: string -> 'a
wenzelm@18681
    47
  exception ERROR of string
wenzelm@18681
    48
  val error: string -> 'a
wenzelm@18681
    49
  val cat_error: string -> string -> 'a
wenzelm@18681
    50
  val assert_all: ('a -> bool) -> 'a list -> ('a -> string) -> unit
wenzelm@18681
    51
wenzelm@4621
    52
  (*pairs*)
wenzelm@4621
    53
  val pair: 'a -> 'b -> 'a * 'b
wenzelm@4621
    54
  val rpair: 'a -> 'b -> 'b * 'a
wenzelm@4621
    55
  val fst: 'a * 'b -> 'a
wenzelm@4621
    56
  val snd: 'a * 'b -> 'b
haftmann@17498
    57
  val eq_fst: ('a * 'c -> bool) -> ('a * 'b) * ('c * 'd) -> bool
haftmann@17498
    58
  val eq_snd: ('b * 'd -> bool) -> ('a * 'b) * ('c * 'd) -> bool
haftmann@19454
    59
  val eq_pair: ('a * 'c -> bool) -> ('b * 'd -> bool) -> ('a * 'b) * ('c * 'd) -> bool
wenzelm@4621
    60
  val swap: 'a * 'b -> 'b * 'a
wenzelm@4621
    61
  val apfst: ('a -> 'b) -> 'a * 'c -> 'b * 'c
wenzelm@4621
    62
  val apsnd: ('a -> 'b) -> 'c * 'a -> 'c * 'b
wenzelm@4621
    63
  val pairself: ('a -> 'b) -> 'a * 'a -> 'b * 'b
wenzelm@4621
    64
wenzelm@4621
    65
  (*booleans*)
wenzelm@4621
    66
  val equal: ''a -> ''a -> bool
wenzelm@4621
    67
  val not_equal: ''a -> ''a -> bool
wenzelm@4621
    68
  val orf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    69
  val andf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    70
  val exists: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    71
  val forall: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    72
  val set: bool ref -> bool
wenzelm@4621
    73
  val reset: bool ref -> bool
wenzelm@4621
    74
  val toggle: bool ref -> bool
wenzelm@9118
    75
  val change: 'a ref -> ('a -> 'a) -> unit
wenzelm@4621
    76
  val setmp: 'a ref -> 'a -> ('b -> 'c) -> 'b -> 'c
wenzelm@4621
    77
wenzelm@4621
    78
  (*lists*)
skalberg@15570
    79
  exception UnequalLengths
wenzelm@5285
    80
  val single: 'a -> 'a list
wenzelm@20882
    81
  val the_single: 'a list -> 'a
wenzelm@19273
    82
  val singleton: ('a list -> 'b list) -> 'a -> 'b
wenzelm@5904
    83
  val apply: ('a -> 'a) list -> 'a -> 'a
wenzelm@15760
    84
  val foldr1: ('a * 'a -> 'a) -> 'a list -> 'a
haftmann@18278
    85
  val foldl_map: ('a * 'b -> 'a * 'c) -> 'a * 'b list -> 'a * 'c list
wenzelm@19461
    86
  val flat: 'a list list -> 'a list
wenzelm@19424
    87
  val unflat: 'a list list -> 'b list -> 'b list list
haftmann@18441
    88
  val burrow: ('a list -> 'b list) -> 'a list list -> 'b list list
haftmann@18549
    89
  val fold_burrow: ('a list -> 'c -> 'b list * 'd) -> 'a list list -> 'c -> 'b list list * 'd
wenzelm@21395
    90
  val maps: ('a -> 'b list) -> 'a list -> 'b list
wenzelm@19011
    91
  val chop: int -> 'a list -> 'a list * 'a list
nipkow@4713
    92
  val dropwhile: ('a -> bool) -> 'a list -> 'a list
haftmann@18278
    93
  val nth: 'a list -> int -> 'a
haftmann@18011
    94
  val nth_map: int -> ('a -> 'a) -> 'a list -> 'a list
wenzelm@18286
    95
  val nth_list: 'a list list -> int -> 'a list
haftmann@18514
    96
  val map_index: (int * 'a -> 'b) -> 'a list -> 'b list
haftmann@18514
    97
  val fold_index: (int * 'a -> 'b -> 'b) -> 'a list -> 'b -> 'b
wenzelm@4621
    98
  val split_last: 'a list -> 'a list * 'a
wenzelm@4621
    99
  val find_index: ('a -> bool) -> 'a list -> int
wenzelm@4621
   100
  val find_index_eq: ''a -> ''a list -> int
wenzelm@4621
   101
  val find_first: ('a -> bool) -> 'a list -> 'a option
haftmann@19233
   102
  val get_index: ('a -> 'b option) -> 'a list -> (int * 'b) option
wenzelm@4916
   103
  val get_first: ('a -> 'b option) -> 'a list -> 'b option
haftmann@19454
   104
  val eq_list: ('a * 'b -> bool) -> 'a list * 'b list -> bool
haftmann@18330
   105
  val map2: ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
haftmann@18330
   106
  val fold2: ('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'c
wenzelm@19799
   107
  val zip_options: 'a list -> 'b option list -> ('a * 'b) list
haftmann@18330
   108
  val ~~ : 'a list * 'b list -> ('a * 'b) list
haftmann@18330
   109
  val split_list: ('a * 'b) list -> 'a list * 'b list
wenzelm@4621
   110
  val separate: 'a -> 'a list -> 'a list
wenzelm@4621
   111
  val replicate: int -> 'a -> 'a list
wenzelm@18148
   112
  val multiply: 'a list -> 'a list list -> 'a list list
wenzelm@14792
   113
  val product: 'a list -> 'b list -> ('a * 'b) list
wenzelm@16129
   114
  val filter: ('a -> bool) -> 'a list -> 'a list
wenzelm@4621
   115
  val filter_out: ('a -> bool) -> 'a list -> 'a list
wenzelm@19483
   116
  val map_filter: ('a -> 'b option) -> 'a list -> 'b list
haftmann@18441
   117
  val is_prefix: ('a * 'a -> bool) -> 'a list -> 'a list -> bool
wenzelm@4621
   118
  val take_prefix: ('a -> bool) -> 'a list -> 'a list * 'a list
haftmann@20108
   119
  val chop_prefix: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list * ('a list * 'b list)
wenzelm@4621
   120
  val take_suffix: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@12249
   121
  val prefixes1: 'a list -> 'a list list
wenzelm@19011
   122
  val prefixes: 'a list -> 'a list list
wenzelm@12249
   123
  val suffixes1: 'a list -> 'a list list
wenzelm@19011
   124
  val suffixes: 'a list -> 'a list list
wenzelm@4621
   125
wenzelm@4621
   126
  (*integers*)
wenzelm@4621
   127
  val inc: int ref -> int
wenzelm@4621
   128
  val dec: int ref -> int
wenzelm@4621
   129
  val upto: int * int -> int list
wenzelm@4621
   130
  val downto: int * int -> int list
wenzelm@4621
   131
  val radixpand: int * int -> int list
wenzelm@4621
   132
  val radixstring: int * string * int -> string
wenzelm@4621
   133
  val string_of_int: int -> string
wenzelm@21942
   134
  val signed_string_of_int: int -> string
wenzelm@4621
   135
  val string_of_indexname: string * int -> string
wenzelm@20095
   136
  val read_intinf: int -> string list -> IntInf.int * string list
wenzelm@14826
   137
  val read_int: string list -> int * string list
wenzelm@14826
   138
  val oct_char: string -> string
wenzelm@4621
   139
wenzelm@4621
   140
  (*strings*)
haftmann@18011
   141
  val nth_string: string -> int -> string
wenzelm@16188
   142
  val fold_string: (string -> 'a -> 'a) -> string -> 'a -> 'a
wenzelm@6312
   143
  val exists_string: (string -> bool) -> string -> bool
wenzelm@16188
   144
  val forall_string: (string -> bool) -> string -> bool
wenzelm@4621
   145
  val enclose: string -> string -> string -> string
wenzelm@6642
   146
  val unenclose: string -> string
wenzelm@4621
   147
  val quote: string -> string
wenzelm@4621
   148
  val space_implode: string -> string list -> string
wenzelm@4621
   149
  val commas: string list -> string
wenzelm@4621
   150
  val commas_quote: string list -> string
wenzelm@4621
   151
  val cat_lines: string list -> string
wenzelm@4621
   152
  val space_explode: string -> string -> string list
wenzelm@14826
   153
  val split_lines: string -> string list
wenzelm@5942
   154
  val prefix_lines: string -> string -> string
wenzelm@7712
   155
  val untabify: string list -> string list
wenzelm@18681
   156
  val prefix: string -> string -> string
wenzelm@5285
   157
  val suffix: string -> string -> string
wenzelm@18681
   158
  val unprefix: string -> string -> string
wenzelm@5285
   159
  val unsuffix: string -> string -> string
wenzelm@10951
   160
  val replicate_string: int -> string -> string
wenzelm@14926
   161
  val translate_string: (string -> string) -> string -> string
wenzelm@4621
   162
wenzelm@16492
   163
  (*lists as sets -- see also Pure/General/ord_list.ML*)
wenzelm@18923
   164
  val member: ('b * 'a -> bool) -> 'a list -> 'b -> bool
wenzelm@18923
   165
  val insert: ('a * 'a -> bool) -> 'a -> 'a list -> 'a list
wenzelm@18923
   166
  val remove: ('b * 'a -> bool) -> 'b -> 'a list -> 'a list
wenzelm@19301
   167
  val subtract: ('b * 'a -> bool) -> 'b list -> 'a list -> 'a list
wenzelm@18923
   168
  val merge: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
wenzelm@4621
   169
  val mem: ''a * ''a list -> bool
wenzelm@4621
   170
  val mem_int: int * int list -> bool
wenzelm@4621
   171
  val mem_string: string * string list -> bool
wenzelm@4621
   172
  val union: ''a list * ''a list -> ''a list
wenzelm@4621
   173
  val union_int: int list * int list -> int list
wenzelm@4621
   174
  val union_string: string list * string list -> string list
wenzelm@4621
   175
  val gen_union: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
paulson@7090
   176
  val gen_inter: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list
wenzelm@4621
   177
  val inter: ''a list * ''a list -> ''a list
wenzelm@4621
   178
  val inter_int: int list * int list -> int list
wenzelm@4621
   179
  val inter_string: string list * string list -> string list
wenzelm@4621
   180
  val subset: ''a list * ''a list -> bool
wenzelm@4621
   181
  val subset_int: int list * int list -> bool
wenzelm@4621
   182
  val subset_string: string list * string list -> bool
wenzelm@4621
   183
  val eq_set: ''a list * ''a list -> bool
wenzelm@4621
   184
  val eq_set_string: string list * string list -> bool
wenzelm@4621
   185
  val gen_subset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@19301
   186
  val gen_eq_set: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   187
  val \ : ''a list * ''a -> ''a list
wenzelm@4621
   188
  val \\ : ''a list * ''a list -> ''a list
wenzelm@19046
   189
  val distinct: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@18966
   190
  val duplicates: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@16878
   191
  val has_duplicates: ('a * 'a -> bool) -> 'a list -> bool
wenzelm@4621
   192
wenzelm@23220
   193
  (*lists as multisets*)
nipkow@22142
   194
  val remove1: ('b * 'a -> bool) -> 'b -> 'a list -> 'a list
wenzelm@23220
   195
  val submultiset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   196
wenzelm@4621
   197
  (*orders*)
wenzelm@18966
   198
  val is_equal: order -> bool
wenzelm@4621
   199
  val rev_order: order -> order
wenzelm@4621
   200
  val make_ord: ('a * 'a -> bool) -> 'a * 'a -> order
wenzelm@4621
   201
  val int_ord: int * int -> order
wenzelm@4621
   202
  val string_ord: string * string -> order
wenzelm@16676
   203
  val fast_string_ord: string * string -> order
wenzelm@16492
   204
  val option_ord: ('a * 'b -> order) -> 'a option * 'b option -> order
wenzelm@4621
   205
  val prod_ord: ('a * 'b -> order) -> ('c * 'd -> order) -> ('a * 'c) * ('b * 'd) -> order
wenzelm@4621
   206
  val dict_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   207
  val list_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   208
  val sort: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@18427
   209
  val sort_distinct: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@4621
   210
  val sort_strings: string list -> string list
wenzelm@4621
   211
  val sort_wrt: ('a -> string) -> 'a list -> 'a list
wenzelm@4621
   212
berghofe@14106
   213
  (*random numbers*)
berghofe@14106
   214
  exception RANDOM
berghofe@14106
   215
  val random: unit -> real
berghofe@14106
   216
  val random_range: int -> int -> int
berghofe@14106
   217
  val one_of: 'a list -> 'a
berghofe@14106
   218
  val frequency: (int * 'a) list -> 'a
berghofe@14106
   219
wenzelm@14826
   220
  (*current directory*)
wenzelm@4621
   221
  val cd: string -> unit
wenzelm@4621
   222
  val pwd: unit -> string
wenzelm@4621
   223
wenzelm@4621
   224
  (*misc*)
wenzelm@19644
   225
  val divide_and_conquer: ('a -> 'a list * ('b list -> 'b)) -> 'a -> 'b
wenzelm@4621
   226
  val partition_eq: ('a * 'a -> bool) -> 'a list -> 'a list list
wenzelm@4621
   227
  val partition_list: (int -> 'a -> bool) -> int -> int -> 'a list -> 'a list list
wenzelm@4621
   228
  val gensym: string -> string
wenzelm@16439
   229
  type stamp
wenzelm@16439
   230
  val stamp: unit -> stamp
wenzelm@16439
   231
  type serial
wenzelm@16439
   232
  val serial: unit -> serial
wenzelm@19512
   233
  val serial_string: unit -> string
wenzelm@16535
   234
  structure Object: sig type T end
wenzelm@4621
   235
end;
wenzelm@4621
   236
wenzelm@15745
   237
signature LIBRARY =
skalberg@15570
   238
sig
wenzelm@15745
   239
  include BASIC_LIBRARY
skalberg@15570
   240
  val foldl: ('a * 'b -> 'a) -> 'a * 'b list -> 'a
skalberg@15570
   241
  val foldr: ('a * 'b -> 'b) -> 'a list * 'b -> 'b
skalberg@15570
   242
  val take: int * 'a list -> 'a list
skalberg@15570
   243
  val drop: int * 'a list -> 'a list
skalberg@15570
   244
  val last_elem: 'a list -> 'a
skalberg@15570
   245
end;
skalberg@15570
   246
wenzelm@15745
   247
structure Library: LIBRARY =
clasohm@1364
   248
struct
clasohm@0
   249
wenzelm@21395
   250
(* functions *)
clasohm@0
   251
wenzelm@16842
   252
fun I x = x;
wenzelm@16842
   253
fun K x = fn _ => x;
wenzelm@23220
   254
fun flip f x y = f y x;
wenzelm@233
   255
fun curry f x y = f (x, y);
wenzelm@233
   256
fun uncurry f (x, y) = f x y;
clasohm@0
   257
wenzelm@21395
   258
(*application and structured results -- old version*)
wenzelm@16705
   259
fun (x, y) |>>> f = let val (x', z) = f x in (x', (y, z)) end;
wenzelm@16842
   260
haftmann@17141
   261
(*conditional application*)
wenzelm@21565
   262
fun b ? f = fn x => if b then f x else x;
haftmann@17141
   263
wenzelm@16721
   264
(*composition with multiple args*)
wenzelm@16721
   265
fun (f oo g) x y = f (g x y);
wenzelm@16721
   266
fun (f ooo g) x y z = f (g x y z);
wenzelm@16721
   267
fun (f oooo g) x y z w = f (g x y z w);
wenzelm@16721
   268
wenzelm@233
   269
(*function exponentiation: f(...(f x)...) with n applications of f*)
wenzelm@233
   270
fun funpow n f x =
wenzelm@233
   271
  let fun rep (0, x) = x
wenzelm@233
   272
        | rep (n, x) = rep (n - 1, f x)
wenzelm@233
   273
  in rep (n, x) end;
wenzelm@160
   274
wenzelm@160
   275
wenzelm@17341
   276
(* exceptions *)
wenzelm@17341
   277
wenzelm@18681
   278
val do_transform_failure = ref true;
wenzelm@18681
   279
wenzelm@18681
   280
fun transform_failure exn f x =
wenzelm@18681
   281
  if ! do_transform_failure then
wenzelm@18681
   282
    f x handle Interrupt => raise Interrupt | e => raise exn e
wenzelm@18681
   283
  else f x;
wenzelm@18681
   284
wenzelm@17341
   285
exception EXCEPTION of exn * string;
wenzelm@6959
   286
wenzelm@14868
   287
datatype 'a result =
wenzelm@14868
   288
  Result of 'a |
wenzelm@14868
   289
  Exn of exn;
wenzelm@14868
   290
wenzelm@14868
   291
fun capture f x = Result (f x) handle e => Exn e;
wenzelm@14868
   292
wenzelm@14868
   293
fun release (Result y) = y
wenzelm@14868
   294
  | release (Exn e) = raise e;
wenzelm@14868
   295
skalberg@15531
   296
fun get_result (Result x) = SOME x
skalberg@15531
   297
  | get_result _ = NONE;
wenzelm@14868
   298
skalberg@15531
   299
fun get_exn (Exn exn) = SOME exn
skalberg@15531
   300
  | get_exn _ = NONE;
wenzelm@14868
   301
wenzelm@14868
   302
wenzelm@18681
   303
(* errors *)
wenzelm@18681
   304
wenzelm@19542
   305
exception SYS_ERROR of string;
wenzelm@19542
   306
fun sys_error msg = raise SYS_ERROR msg;
wenzelm@19542
   307
wenzelm@18681
   308
exception ERROR of string;
wenzelm@18681
   309
fun error msg = raise ERROR msg;
wenzelm@18681
   310
wenzelm@18681
   311
fun cat_error "" msg = error msg
wenzelm@18681
   312
  | cat_error msg1 msg2 = error (msg1 ^ "\n" ^ msg2);
wenzelm@18681
   313
wenzelm@18681
   314
fun assert_all pred list msg =
wenzelm@18681
   315
  let
wenzelm@18681
   316
    fun ass [] = ()
wenzelm@18681
   317
      | ass (x :: xs) = if pred x then ass xs else error (msg x);
wenzelm@18681
   318
  in ass list end;
wenzelm@18681
   319
wenzelm@18681
   320
wenzelm@21395
   321
(* pairs *)
wenzelm@233
   322
wenzelm@233
   323
fun pair x y = (x, y);
wenzelm@233
   324
fun rpair x y = (y, x);
wenzelm@233
   325
wenzelm@233
   326
fun fst (x, y) = x;
wenzelm@233
   327
fun snd (x, y) = y;
wenzelm@233
   328
haftmann@17498
   329
fun eq_fst eq ((x1, _), (x2, _)) = eq (x1, x2);
haftmann@17498
   330
fun eq_snd eq ((_, y1), (_, y2)) = eq (y1, y2);
haftmann@19454
   331
fun eq_pair eqx eqy ((x1, y1), (x2, y2)) = eqx (x1, x2) andalso eqy (y1, y2);
wenzelm@233
   332
wenzelm@233
   333
fun swap (x, y) = (y, x);
wenzelm@233
   334
wenzelm@233
   335
fun apfst f (x, y) = (f x, y);
wenzelm@233
   336
fun apsnd f (x, y) = (x, f y);
wenzelm@4212
   337
fun pairself f (x, y) = (f x, f y);
wenzelm@233
   338
wenzelm@233
   339
wenzelm@21395
   340
(* booleans *)
wenzelm@233
   341
wenzelm@21395
   342
(*polymorphic equality*)
wenzelm@233
   343
fun equal x y = x = y;
wenzelm@233
   344
fun not_equal x y = x <> y;
wenzelm@233
   345
wenzelm@21395
   346
(*combining predicates*)
wenzelm@16721
   347
fun p orf q = fn x => p x orelse q x;
wenzelm@16721
   348
fun p andf q = fn x => p x andalso q x;
wenzelm@233
   349
wenzelm@233
   350
(*exists pred [x1, ..., xn] ===> pred x1 orelse ... orelse pred xn*)
wenzelm@233
   351
fun exists (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   352
  let fun boolf [] = false
wenzelm@233
   353
        | boolf (x :: xs) = pred x orelse boolf xs
wenzelm@233
   354
  in boolf end;
wenzelm@233
   355
wenzelm@233
   356
(*forall pred [x1, ..., xn] ===> pred x1 andalso ... andalso pred xn*)
wenzelm@233
   357
fun forall (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   358
  let fun boolf [] = true
wenzelm@233
   359
        | boolf (x :: xs) = pred x andalso boolf xs
wenzelm@233
   360
  in boolf end;
clasohm@0
   361
wenzelm@19644
   362
wenzelm@380
   363
(* flags *)
wenzelm@380
   364
wenzelm@380
   365
fun set flag = (flag := true; true);
wenzelm@380
   366
fun reset flag = (flag := false; false);
wenzelm@380
   367
fun toggle flag = (flag := not (! flag); ! flag);
wenzelm@380
   368
wenzelm@9118
   369
fun change r f = r := f (! r);
wenzelm@9118
   370
wenzelm@18712
   371
(*temporarily set flag during execution*)
wenzelm@2978
   372
fun setmp flag value f x =
wenzelm@2958
   373
  let
wenzelm@2958
   374
    val orig_value = ! flag;
wenzelm@18712
   375
    val _ = flag := value;
wenzelm@18712
   376
    val result = capture f x;
wenzelm@18712
   377
    val _ = flag := orig_value;
wenzelm@18712
   378
  in release result end;
wenzelm@2958
   379
wenzelm@19644
   380
wenzelm@21395
   381
wenzelm@233
   382
(** lists **)
wenzelm@233
   383
skalberg@15570
   384
exception UnequalLengths;
wenzelm@233
   385
wenzelm@5285
   386
fun single x = [x];
wenzelm@233
   387
wenzelm@20882
   388
fun the_single [x] = x
wenzelm@20882
   389
  | the_single _ = raise Empty;
wenzelm@20882
   390
wenzelm@20882
   391
fun singleton f x = the_single (f [x]);
wenzelm@19273
   392
wenzelm@5904
   393
fun apply [] x = x
wenzelm@5904
   394
  | apply (f :: fs) x = apply fs (f x);
wenzelm@5904
   395
wenzelm@233
   396
wenzelm@21395
   397
(* fold -- old versions *)
haftmann@16691
   398
wenzelm@233
   399
(*the following versions of fold are designed to fit nicely with infixes*)
clasohm@0
   400
wenzelm@233
   401
(*  (op @) (e, [x1, ..., xn])  ===>  ((e @ x1) @ x2) ... @ xn
wenzelm@233
   402
    for operators that associate to the left (TAIL RECURSIVE)*)
wenzelm@233
   403
fun foldl (f: 'a * 'b -> 'a) : 'a * 'b list -> 'a =
wenzelm@233
   404
  let fun itl (e, [])  = e
wenzelm@233
   405
        | itl (e, a::l) = itl (f(e, a), l)
wenzelm@233
   406
  in  itl end;
wenzelm@233
   407
wenzelm@233
   408
(*  (op @) ([x1, ..., xn], e)  ===>   x1 @ (x2 ... @ (xn @ e))
wenzelm@233
   409
    for operators that associate to the right (not tail recursive)*)
wenzelm@233
   410
fun foldr f (l, e) =
wenzelm@233
   411
  let fun itr [] = e
wenzelm@233
   412
        | itr (a::l) = f(a, itr l)
wenzelm@233
   413
  in  itr l  end;
wenzelm@233
   414
wenzelm@233
   415
(*  (op @) [x1, ..., xn]  ===>   x1 @ (x2 ... @ (x[n-1] @ xn))
wenzelm@233
   416
    for n > 0, operators that associate to the right (not tail recursive)*)
paulson@20443
   417
fun foldr1 f [] = raise Empty
wenzelm@20510
   418
  | foldr1 f l =
paulson@20443
   419
      let fun itr [x] = x
wenzelm@20510
   420
            | itr (x::l) = f(x, itr l)
paulson@20443
   421
      in  itr l  end;
wenzelm@233
   422
wenzelm@16705
   423
fun foldl_map f =
wenzelm@16705
   424
  let
wenzelm@16705
   425
    fun fold_aux (x, []) = (x, [])
wenzelm@16705
   426
      | fold_aux (x, y :: ys) =
wenzelm@16705
   427
          let
wenzelm@16705
   428
            val (x', y') = f (x, y);
wenzelm@16705
   429
            val (x'', ys') = fold_aux (x', ys);
wenzelm@16705
   430
          in (x'', y' :: ys') end;
wenzelm@16705
   431
  in fold_aux end;
wenzelm@16705
   432
wenzelm@233
   433
wenzelm@233
   434
(* basic list functions *)
wenzelm@233
   435
wenzelm@20510
   436
fun eq_list eq (list1, list2) =
haftmann@20348
   437
  let
wenzelm@20510
   438
    fun eq_lst (x :: xs, y :: ys) = eq (x, y) andalso eq_lst (xs, ys)
wenzelm@20510
   439
      | eq_lst _ = true;
wenzelm@20510
   440
  in length list1 = length list2 andalso eq_lst (list1, list2) end;
haftmann@20348
   441
wenzelm@19483
   442
fun maps f [] = []
wenzelm@19483
   443
  | maps f (x :: xs) = f x @ maps f xs;
wenzelm@19483
   444
wenzelm@23220
   445
fun chop 0 xs = ([], xs)
wenzelm@23220
   446
  | chop _ [] = ([], [])
wenzelm@23220
   447
  | chop n (x :: xs) = chop (n - 1) xs |>> cons x;
wenzelm@19011
   448
wenzelm@233
   449
(*take the first n elements from a list*)
wenzelm@233
   450
fun take (n, []) = []
wenzelm@233
   451
  | take (n, x :: xs) =
wenzelm@233
   452
      if n > 0 then x :: take (n - 1, xs) else [];
wenzelm@233
   453
wenzelm@233
   454
(*drop the first n elements from a list*)
wenzelm@233
   455
fun drop (n, []) = []
wenzelm@233
   456
  | drop (n, x :: xs) =
wenzelm@233
   457
      if n > 0 then drop (n - 1, xs) else x :: xs;
clasohm@0
   458
nipkow@4713
   459
fun dropwhile P [] = []
nipkow@4713
   460
  | dropwhile P (ys as x::xs) = if P x then dropwhile P xs else ys;
nipkow@4713
   461
wenzelm@233
   462
(*return nth element of a list, where 0 designates the first element;
wenzelm@18461
   463
  raise Subscript if list too short*)
haftmann@18011
   464
fun nth xs i = List.nth (xs, i);
wenzelm@233
   465
wenzelm@18461
   466
fun nth_list xss i = nth xss i handle Subscript => [];
wenzelm@18461
   467
haftmann@18011
   468
fun nth_map 0 f (x :: xs) = f x :: xs
haftmann@18011
   469
  | nth_map n f (x :: xs) = x :: nth_map (n - 1) f xs
haftmann@18011
   470
  | nth_map _ _ [] = raise Subscript;
wenzelm@11773
   471
haftmann@18514
   472
fun map_index f =
haftmann@18514
   473
  let
haftmann@18514
   474
    fun mapp _ [] = []
haftmann@18514
   475
      | mapp i (x :: xs) = f (i, x) :: mapp (i+1) xs
haftmann@18514
   476
  in mapp 0 end;
haftmann@18514
   477
haftmann@21118
   478
fun fold_index f =
haftmann@21118
   479
  let
haftmann@21118
   480
    fun fold_aux _ [] y = y
haftmann@21118
   481
      | fold_aux i (x :: xs) y = fold_aux (i+1) xs (f (i, x) y);
haftmann@21118
   482
  in fold_aux 0 end;
haftmann@21118
   483
skalberg@15570
   484
val last_elem = List.last;
wenzelm@233
   485
wenzelm@3762
   486
(*rear decomposition*)
skalberg@15570
   487
fun split_last [] = raise Empty
wenzelm@3762
   488
  | split_last [x] = ([], x)
wenzelm@3762
   489
  | split_last (x :: xs) = apfst (cons x) (split_last xs);
wenzelm@3762
   490
wenzelm@4212
   491
(*find the position of an element in a list*)
wenzelm@4212
   492
fun find_index pred =
wenzelm@4212
   493
  let fun find _ [] = ~1
wenzelm@4212
   494
        | find n (x :: xs) = if pred x then n else find (n + 1) xs;
wenzelm@4212
   495
  in find 0 end;
wenzelm@3762
   496
wenzelm@4224
   497
fun find_index_eq x = find_index (equal x);
wenzelm@4212
   498
wenzelm@4212
   499
(*find first element satisfying predicate*)
paulson@22593
   500
val find_first = List.find;
wenzelm@233
   501
wenzelm@4916
   502
(*get first element by lookup function*)
skalberg@15531
   503
fun get_first _ [] = NONE
wenzelm@4916
   504
  | get_first f (x :: xs) =
wenzelm@4916
   505
      (case f x of
skalberg@15531
   506
        NONE => get_first f xs
wenzelm@4916
   507
      | some => some);
wenzelm@4916
   508
haftmann@19233
   509
fun get_index f =
haftmann@19233
   510
  let
haftmann@19233
   511
    fun get _ [] = NONE
wenzelm@19461
   512
      | get i (x :: xs) =
haftmann@19233
   513
          case f x
wenzelm@19461
   514
           of NONE => get (i + 1) xs
haftmann@19233
   515
            | SOME y => SOME (i, y)
haftmann@19233
   516
  in get 0 end;
haftmann@19233
   517
skalberg@15531
   518
val flat = List.concat;
wenzelm@233
   519
wenzelm@12136
   520
fun unflat (xs :: xss) ys =
wenzelm@19424
   521
      let val (ps, qs) = chop (length xs) ys
nipkow@13629
   522
      in ps :: unflat xss qs end
wenzelm@12136
   523
  | unflat [] [] = []
skalberg@15570
   524
  | unflat _ _ = raise UnequalLengths;
wenzelm@12136
   525
wenzelm@21479
   526
fun burrow f xss = unflat xss (f (flat xss));
haftmann@18359
   527
haftmann@18549
   528
fun fold_burrow f xss s =
haftmann@18549
   529
  apfst (unflat xss) (f (flat xss) s);
haftmann@18359
   530
wenzelm@233
   531
(*separate s [x1, x2, ..., xn]  ===>  [x1, s, x2, s, ..., s, xn]*)
wenzelm@233
   532
fun separate s (x :: (xs as _ :: _)) = x :: s :: separate s xs
wenzelm@233
   533
  | separate _ xs = xs;
wenzelm@233
   534
wenzelm@233
   535
(*make the list [x, x, ..., x] of length n*)
wenzelm@233
   536
fun replicate n (x: 'a) : 'a list =
wenzelm@233
   537
  let fun rep (0, xs) = xs
wenzelm@233
   538
        | rep (n, xs) = rep (n - 1, x :: xs)
wenzelm@233
   539
  in
skalberg@15570
   540
    if n < 0 then raise Subscript
wenzelm@233
   541
    else rep (n, [])
wenzelm@233
   542
  end;
wenzelm@233
   543
wenzelm@14926
   544
fun translate_string f = String.translate (f o String.str);
wenzelm@14926
   545
wenzelm@4248
   546
(*multiply [a, b, c, ...] * [xs, ys, zs, ...]*)
wenzelm@18148
   547
fun multiply [] _ = []
wenzelm@18148
   548
  | multiply (x :: xs) yss = map (cons x) yss @ multiply xs yss;
wenzelm@4248
   549
wenzelm@14792
   550
(*direct product*)
wenzelm@14792
   551
fun product _ [] = []
wenzelm@14792
   552
  | product [] _ = []
wenzelm@14792
   553
  | product (x :: xs) ys = map (pair x) ys @ product xs ys;
wenzelm@14792
   554
wenzelm@233
   555
wenzelm@233
   556
(* filter *)
wenzelm@233
   557
wenzelm@233
   558
(*copy the list preserving elements that satisfy the predicate*)
skalberg@15531
   559
val filter = List.filter;
clasohm@0
   560
fun filter_out f = filter (not o f);
wenzelm@19483
   561
val map_filter = List.mapPartial;
wenzelm@233
   562
wenzelm@233
   563
wenzelm@233
   564
(* lists of pairs *)
wenzelm@233
   565
skalberg@15570
   566
exception UnequalLengths;
skalberg@15570
   567
haftmann@18330
   568
fun map2 _ [] [] = []
haftmann@18330
   569
  | map2 f (x :: xs) (y :: ys) = f x y :: map2 f xs ys
haftmann@18330
   570
  | map2 _ _ _ = raise UnequalLengths;
wenzelm@380
   571
wenzelm@23220
   572
fun fold2 f [] [] z = z
wenzelm@23220
   573
  | fold2 f (x :: xs) (y :: ys) z = fold2 f xs ys (f x y z)
wenzelm@23220
   574
  | fold2 f _ _ _ = raise UnequalLengths;
wenzelm@380
   575
wenzelm@19799
   576
fun zip_options (x :: xs) (SOME y :: ys) = (x, y) :: zip_options xs ys
wenzelm@19799
   577
  | zip_options (_ :: xs) (NONE :: ys) = zip_options xs ys
wenzelm@19799
   578
  | zip_options _ [] = []
wenzelm@19799
   579
  | zip_options [] _ = raise UnequalLengths;
wenzelm@4956
   580
wenzelm@233
   581
(*combine two lists forming a list of pairs:
wenzelm@233
   582
  [x1, ..., xn] ~~ [y1, ..., yn]  ===>  [(x1, y1), ..., (xn, yn)]*)
wenzelm@233
   583
fun [] ~~ [] = []
wenzelm@233
   584
  | (x :: xs) ~~ (y :: ys) = (x, y) :: (xs ~~ ys)
skalberg@15570
   585
  | _ ~~ _ = raise UnequalLengths;
wenzelm@233
   586
wenzelm@233
   587
(*inverse of ~~; the old 'split':
wenzelm@233
   588
  [(x1, y1), ..., (xn, yn)]  ===>  ([x1, ..., xn], [y1, ..., yn])*)
skalberg@15570
   589
val split_list = ListPair.unzip;
wenzelm@233
   590
wenzelm@233
   591
wenzelm@233
   592
(* prefixes, suffixes *)
wenzelm@233
   593
haftmann@18441
   594
fun is_prefix _ [] _ = true
haftmann@18441
   595
  | is_prefix eq (x :: xs) (y :: ys) = eq (x, y) andalso is_prefix eq xs ys
haftmann@18441
   596
  | is_prefix eq _ _ = false;
wenzelm@233
   597
wenzelm@233
   598
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., x(i-1)], [xi, ..., xn])
wenzelm@233
   599
   where xi is the first element that does not satisfy the predicate*)
wenzelm@233
   600
fun take_prefix (pred : 'a -> bool)  (xs: 'a list) : 'a list * 'a list =
wenzelm@233
   601
  let fun take (rxs, []) = (rev rxs, [])
wenzelm@255
   602
        | take (rxs, x :: xs) =
wenzelm@255
   603
            if  pred x  then  take(x :: rxs, xs)  else  (rev rxs, x :: xs)
wenzelm@233
   604
  in  take([], xs)  end;
wenzelm@233
   605
haftmann@20108
   606
fun chop_prefix eq ([], ys) = ([], ([], ys))
haftmann@20108
   607
  | chop_prefix eq (xs, []) = ([], (xs, []))
wenzelm@23220
   608
  | chop_prefix eq (xs as x :: xs', ys as y :: ys') =
haftmann@20108
   609
      if eq (x, y) then
haftmann@20108
   610
        let val (ps', xys'') = chop_prefix eq (xs', ys')
wenzelm@23220
   611
        in (x :: ps', xys'') end
haftmann@20108
   612
      else ([], (xs, ys));
haftmann@20108
   613
wenzelm@233
   614
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., xi], [x(i+1), ..., xn])
wenzelm@233
   615
   where xi is the last element that does not satisfy the predicate*)
wenzelm@233
   616
fun take_suffix _ [] = ([], [])
wenzelm@233
   617
  | take_suffix pred (x :: xs) =
wenzelm@233
   618
      (case take_suffix pred xs of
wenzelm@233
   619
        ([], sffx) => if pred x then ([], x :: sffx) else ([x], sffx)
wenzelm@233
   620
      | (prfx, sffx) => (x :: prfx, sffx));
wenzelm@233
   621
wenzelm@12249
   622
fun prefixes1 [] = []
wenzelm@12249
   623
  | prefixes1 (x :: xs) = map (cons x) ([] :: prefixes1 xs);
wenzelm@12249
   624
wenzelm@19011
   625
fun prefixes xs = [] :: prefixes1 xs;
wenzelm@19011
   626
wenzelm@12249
   627
fun suffixes1 xs = map rev (prefixes1 (rev xs));
wenzelm@19011
   628
fun suffixes xs = [] :: suffixes1 xs;
wenzelm@233
   629
wenzelm@23220
   630
wenzelm@23220
   631
wenzelm@233
   632
(** integers **)
wenzelm@233
   633
wenzelm@2958
   634
fun inc i = (i := ! i + 1; ! i);
wenzelm@2958
   635
fun dec i = (i := ! i - 1; ! i);
wenzelm@233
   636
wenzelm@233
   637
wenzelm@233
   638
(* lists of integers *)
wenzelm@233
   639
wenzelm@233
   640
(*make the list [from, from + 1, ..., to]*)
wenzelm@21859
   641
fun (i upto j) =
wenzelm@21859
   642
  if i > j then [] else i :: (i + 1 upto j);
wenzelm@233
   643
wenzelm@233
   644
(*make the list [from, from - 1, ..., to]*)
wenzelm@21859
   645
fun (i downto j) =
wenzelm@21859
   646
  if i < j then [] else i :: (i - 1 downto j);
wenzelm@233
   647
wenzelm@233
   648
wenzelm@233
   649
(* convert integers to strings *)
wenzelm@233
   650
wenzelm@233
   651
(*expand the number in the given base;
wenzelm@233
   652
  example: radixpand (2, 8) gives [1, 0, 0, 0]*)
wenzelm@233
   653
fun radixpand (base, num) : int list =
wenzelm@233
   654
  let
wenzelm@233
   655
    fun radix (n, tail) =
wenzelm@233
   656
      if n < base then n :: tail
wenzelm@233
   657
      else radix (n div base, (n mod base) :: tail)
wenzelm@233
   658
  in radix (num, []) end;
wenzelm@233
   659
wenzelm@233
   660
(*expands a number into a string of characters starting from "zerochar";
wenzelm@233
   661
  example: radixstring (2, "0", 8) gives "1000"*)
wenzelm@233
   662
fun radixstring (base, zerochar, num) =
wenzelm@233
   663
  let val offset = ord zerochar;
wenzelm@233
   664
      fun chrof n = chr (offset + n)
wenzelm@233
   665
  in implode (map chrof (radixpand (base, num))) end;
wenzelm@233
   666
wenzelm@233
   667
paulson@3407
   668
val string_of_int = Int.toString;
wenzelm@233
   669
wenzelm@21942
   670
fun signed_string_of_int i =
wenzelm@21942
   671
  if i < 0 then "-" ^ string_of_int (~ i) else string_of_int i;
wenzelm@21942
   672
wenzelm@23220
   673
fun string_of_indexname (a, 0) = a
wenzelm@23220
   674
  | string_of_indexname (a, i) = a ^ "_" ^ string_of_int i;
wenzelm@233
   675
wenzelm@233
   676
wenzelm@14826
   677
(* read integers *)
wenzelm@14826
   678
wenzelm@20095
   679
fun read_intinf radix cs =
wenzelm@20095
   680
  let
wenzelm@20095
   681
    val zero = ord "0";
wenzelm@20095
   682
    val limit = zero + radix;
wenzelm@20095
   683
    fun scan (num, []) = (num, [])
wenzelm@20095
   684
      | scan (num, c :: cs) =
wenzelm@20095
   685
        if zero <= ord c andalso ord c < limit then
wenzelm@20095
   686
          scan (IntInf.fromInt radix * num + IntInf.fromInt (ord c - zero), cs)
wenzelm@20095
   687
        else (num, c :: cs);
wenzelm@21859
   688
  in scan (IntInf.fromInt 0, cs) end;
wenzelm@14826
   689
wenzelm@20095
   690
fun read_int cs = apfst IntInf.toInt (read_intinf 10 cs);
wenzelm@14826
   691
wenzelm@20095
   692
fun oct_char s = chr (IntInf.toInt (#1 (read_intinf 8 (explode s))));
wenzelm@14826
   693
wenzelm@14826
   694
wenzelm@14826
   695
wenzelm@233
   696
(** strings **)
wenzelm@233
   697
wenzelm@16188
   698
(* functions tuned for strings, avoiding explode *)
wenzelm@6312
   699
haftmann@18011
   700
fun nth_string str i =
wenzelm@6959
   701
  (case try String.substring (str, i, 1) of
skalberg@15531
   702
    SOME s => s
skalberg@15570
   703
  | NONE => raise Subscript);
wenzelm@6312
   704
wenzelm@16188
   705
fun fold_string f str x0 =
wenzelm@6282
   706
  let
wenzelm@6282
   707
    val n = size str;
wenzelm@16188
   708
    fun iter (x, i) =
wenzelm@16188
   709
      if i < n then iter (f (String.substring (str, i, 1)) x, i + 1) else x;
wenzelm@16188
   710
  in iter (x0, 0) end;
wenzelm@6282
   711
wenzelm@14968
   712
fun exists_string pred str =
wenzelm@14968
   713
  let
wenzelm@14968
   714
    val n = size str;
wenzelm@14968
   715
    fun ex i = i < n andalso (pred (String.substring (str, i, 1)) orelse ex (i + 1));
wenzelm@14968
   716
  in ex 0 end;
wenzelm@6312
   717
wenzelm@16188
   718
fun forall_string pred = not o exists_string (not o pred);
wenzelm@16188
   719
lcp@512
   720
(*enclose in brackets*)
lcp@512
   721
fun enclose lpar rpar str = lpar ^ str ^ rpar;
wenzelm@6642
   722
fun unenclose str = String.substring (str, 1, size str - 2);
wenzelm@255
   723
wenzelm@233
   724
(*simple quoting (does not escape special chars)*)
lcp@512
   725
val quote = enclose "\"" "\"";
wenzelm@233
   726
wenzelm@4212
   727
(*space_implode "..." (explode "hello") = "h...e...l...l...o"*)
wenzelm@233
   728
fun space_implode a bs = implode (separate a bs);
wenzelm@233
   729
wenzelm@255
   730
val commas = space_implode ", ";
wenzelm@380
   731
val commas_quote = commas o map quote;
wenzelm@255
   732
wenzelm@233
   733
(*concatenate messages, one per line, into a string*)
wenzelm@255
   734
val cat_lines = space_implode "\n";
wenzelm@233
   735
wenzelm@4212
   736
(*space_explode "." "h.e..l.lo" = ["h", "e", "", "l", "lo"]*)
wenzelm@3832
   737
fun space_explode _ "" = []
paulson@21899
   738
  | space_explode sep s = String.fields (fn c => str c = sep) s;
wenzelm@3832
   739
wenzelm@3832
   740
val split_lines = space_explode "\n";
wenzelm@3832
   741
wenzelm@14826
   742
fun prefix_lines "" txt = txt
wenzelm@14826
   743
  | prefix_lines prfx txt = txt |> split_lines |> map (fn s => prfx ^ s) |> cat_lines;
wenzelm@14826
   744
wenzelm@7712
   745
fun untabify chs =
wenzelm@7712
   746
  let
wenzelm@7712
   747
    val tab_width = 8;
wenzelm@7712
   748
wenzelm@22582
   749
    fun untab pos [] ys = rev ys
berghofe@22256
   750
      | untab pos ("\n" :: xs) ys = untab 0 xs ("\n" :: ys)
berghofe@22256
   751
      | untab pos ("\t" :: xs) ys =
wenzelm@22582
   752
          let val d = tab_width - (pos mod tab_width)
wenzelm@22582
   753
          in untab (pos + d) xs (replicate d " " @ ys) end
berghofe@22256
   754
      | untab pos (c :: xs) ys = untab (pos + 1) xs (c :: ys);
wenzelm@7712
   755
  in
wenzelm@19301
   756
    if not (exists (fn c => c = "\t") chs) then chs
berghofe@22256
   757
    else untab 0 chs []
wenzelm@7712
   758
  end;
wenzelm@7712
   759
wenzelm@18681
   760
fun prefix prfx s = prfx ^ s;
wenzelm@16188
   761
fun suffix sffx s = s ^ sffx;
wenzelm@5285
   762
wenzelm@18681
   763
fun unprefix prfx s =
wenzelm@18681
   764
  if String.isPrefix prfx s then String.substring (s, size prfx, size s - size prfx)
wenzelm@18681
   765
  else raise Fail "unprefix";
wenzelm@18681
   766
wenzelm@16188
   767
fun unsuffix sffx s =
wenzelm@17061
   768
  if String.isSuffix sffx s then String.substring (s, 0, size s - size sffx)
wenzelm@17061
   769
  else raise Fail "unsuffix";
wenzelm@5285
   770
wenzelm@10951
   771
fun replicate_string 0 _ = ""
wenzelm@10951
   772
  | replicate_string 1 a = a
wenzelm@10951
   773
  | replicate_string k a =
wenzelm@10951
   774
      if k mod 2 = 0 then replicate_string (k div 2) (a ^ a)
wenzelm@10951
   775
      else replicate_string (k div 2) (a ^ a) ^ a;
wenzelm@10951
   776
wenzelm@233
   777
wenzelm@23220
   778
wenzelm@16492
   779
(** lists as sets -- see also Pure/General/ord_list.ML **)
wenzelm@233
   780
wenzelm@18923
   781
(*canonical member, insert, remove*)
wenzelm@18923
   782
fun member eq list x =
wenzelm@18923
   783
  let
wenzelm@18923
   784
    fun memb [] = false
wenzelm@18923
   785
      | memb (y :: ys) = eq (x, y) orelse memb ys;
wenzelm@18923
   786
  in memb list end;
berghofe@1576
   787
wenzelm@18923
   788
fun insert eq x xs = if member eq xs x then xs else x :: xs;
wenzelm@18923
   789
fun remove eq x xs = if member eq xs x then filter_out (fn y => eq (x, y)) xs else xs;
wenzelm@233
   790
wenzelm@19301
   791
fun subtract eq = fold (remove eq);
wenzelm@19301
   792
wenzelm@18923
   793
fun merge _ ([], ys) = ys
wenzelm@18923
   794
  | merge eq (xs, ys) = fold_rev (insert eq) ys xs;
clasohm@0
   795
wenzelm@18923
   796
(*old-style infixes*)
wenzelm@18923
   797
fun x mem xs = member (op =) xs x;
wenzelm@18923
   798
fun (x: int) mem_int xs = member (op =) xs x;
wenzelm@18923
   799
fun (x: string) mem_string xs = member (op =) xs x;
berghofe@1576
   800
wenzelm@233
   801
wenzelm@233
   802
(*union of sets represented as lists: no repetitions*)
wenzelm@233
   803
fun xs union [] = xs
wenzelm@233
   804
  | [] union ys = ys
haftmann@20854
   805
  | (x :: xs) union ys = xs union (insert (op =) x ys);
clasohm@0
   806
paulson@2175
   807
(*union of sets, optimized version for ints*)
berghofe@1576
   808
fun (xs:int list) union_int [] = xs
berghofe@1576
   809
  | [] union_int ys = ys
haftmann@20854
   810
  | (x :: xs) union_int ys = xs union_int (insert (op =) x ys);
berghofe@1576
   811
paulson@2175
   812
(*union of sets, optimized version for strings*)
berghofe@1576
   813
fun (xs:string list) union_string [] = xs
berghofe@1576
   814
  | [] union_string ys = ys
haftmann@20854
   815
  | (x :: xs) union_string ys = xs union_string (insert (op =) x ys);
berghofe@1576
   816
clasohm@0
   817
(*generalized union*)
wenzelm@233
   818
fun gen_union eq (xs, []) = xs
wenzelm@233
   819
  | gen_union eq ([], ys) = ys
wenzelm@18923
   820
  | gen_union eq (x :: xs, ys) = gen_union eq (xs, insert eq x ys);
wenzelm@233
   821
wenzelm@233
   822
wenzelm@233
   823
(*intersection*)
wenzelm@233
   824
fun [] inter ys = []
wenzelm@233
   825
  | (x :: xs) inter ys =
wenzelm@233
   826
      if x mem ys then x :: (xs inter ys) else xs inter ys;
wenzelm@233
   827
paulson@2175
   828
(*intersection, optimized version for ints*)
berghofe@1576
   829
fun ([]:int list) inter_int ys = []
berghofe@1576
   830
  | (x :: xs) inter_int ys =
berghofe@1576
   831
      if x mem_int ys then x :: (xs inter_int ys) else xs inter_int ys;
berghofe@1576
   832
paulson@2175
   833
(*intersection, optimized version for strings *)
berghofe@1576
   834
fun ([]:string list) inter_string ys = []
berghofe@1576
   835
  | (x :: xs) inter_string ys =
berghofe@1576
   836
      if x mem_string ys then x :: (xs inter_string ys) else xs inter_string ys;
berghofe@1576
   837
paulson@7090
   838
(*generalized intersection*)
paulson@7090
   839
fun gen_inter eq ([], ys) = []
wenzelm@12284
   840
  | gen_inter eq (x::xs, ys) =
wenzelm@18923
   841
      if member eq ys x then x :: gen_inter eq (xs, ys)
wenzelm@18923
   842
      else gen_inter eq (xs, ys);
paulson@7090
   843
wenzelm@233
   844
wenzelm@233
   845
(*subset*)
wenzelm@233
   846
fun [] subset ys = true
wenzelm@233
   847
  | (x :: xs) subset ys = x mem ys andalso xs subset ys;
wenzelm@233
   848
paulson@2175
   849
(*subset, optimized version for ints*)
wenzelm@16439
   850
fun ([]: int list) subset_int ys = true
berghofe@1576
   851
  | (x :: xs) subset_int ys = x mem_int ys andalso xs subset_int ys;
berghofe@1576
   852
paulson@2175
   853
(*subset, optimized version for strings*)
wenzelm@16439
   854
fun ([]: string list) subset_string ys = true
berghofe@1576
   855
  | (x :: xs) subset_string ys = x mem_string ys andalso xs subset_string ys;
berghofe@1576
   856
wenzelm@4363
   857
(*set equality*)
wenzelm@4363
   858
fun eq_set (xs, ys) =
wenzelm@4363
   859
  xs = ys orelse (xs subset ys andalso ys subset xs);
wenzelm@4363
   860
paulson@2182
   861
(*set equality for strings*)
wenzelm@16439
   862
fun eq_set_string ((xs: string list), ys) =
berghofe@1576
   863
  xs = ys orelse (xs subset_string ys andalso ys subset_string xs);
berghofe@1576
   864
wenzelm@18923
   865
fun gen_subset eq (xs, ys) = forall (member eq ys) xs;
paulson@2182
   866
wenzelm@19301
   867
fun gen_eq_set eq (xs, ys) =
haftmann@20348
   868
  eq_list eq (xs, ys) orelse
wenzelm@19301
   869
    (gen_subset eq (xs, ys) andalso gen_subset (eq o swap) (ys, xs));
wenzelm@19301
   870
wenzelm@265
   871
wenzelm@233
   872
(*removing an element from a list WITHOUT duplicates*)
wenzelm@233
   873
fun (y :: ys) \ x = if x = y then ys else y :: (ys \ x)
wenzelm@233
   874
  | [] \ x = [];
paulson@2243
   875
fun ys \\ xs = foldl (op \) (ys,xs);
clasohm@0
   876
wenzelm@233
   877
wenzelm@233
   878
(*makes a list of the distinct members of the input; preserves order, takes
wenzelm@233
   879
  first of equal elements*)
wenzelm@19046
   880
fun distinct eq lst =
wenzelm@233
   881
  let
wenzelm@233
   882
    fun dist (rev_seen, []) = rev rev_seen
wenzelm@233
   883
      | dist (rev_seen, x :: xs) =
wenzelm@18923
   884
          if member eq rev_seen x then dist (rev_seen, xs)
wenzelm@233
   885
          else dist (x :: rev_seen, xs);
wenzelm@19046
   886
  in dist ([], lst) end;
wenzelm@233
   887
wenzelm@255
   888
(*returns a list containing all repeated elements exactly once; preserves
wenzelm@255
   889
  order, takes first of equal elements*)
wenzelm@18966
   890
fun duplicates eq lst =
wenzelm@255
   891
  let
wenzelm@255
   892
    fun dups (rev_dups, []) = rev rev_dups
wenzelm@255
   893
      | dups (rev_dups, x :: xs) =
wenzelm@18923
   894
          if member eq rev_dups x orelse not (member eq xs x) then
wenzelm@255
   895
            dups (rev_dups, xs)
wenzelm@255
   896
          else dups (x :: rev_dups, xs);
wenzelm@18966
   897
  in dups ([], lst) end;
wenzelm@255
   898
wenzelm@16878
   899
fun has_duplicates eq =
wenzelm@16878
   900
  let
wenzelm@16878
   901
    fun dups [] = false
wenzelm@16878
   902
      | dups (x :: xs) = member eq xs x orelse dups xs;
wenzelm@16878
   903
  in dups end;
wenzelm@16878
   904
wenzelm@255
   905
wenzelm@23220
   906
nipkow@22142
   907
(** lists as multisets **)
nipkow@22142
   908
nipkow@22142
   909
fun remove1 _ _ [] = raise Empty
wenzelm@23220
   910
  | remove1 eq y (x::xs) = if eq (y, x) then xs else x :: remove1 eq y xs;
nipkow@22142
   911
wenzelm@23220
   912
fun submultiset _ ([], _)  = true
wenzelm@23220
   913
  | submultiset eq (x :: xs, ys) = member eq ys x andalso submultiset eq (xs, remove1 eq x ys);
wenzelm@233
   914
clasohm@0
   915
clasohm@0
   916
wenzelm@2506
   917
(** orders **)
wenzelm@2506
   918
wenzelm@18966
   919
fun is_equal EQUAL = true
wenzelm@18966
   920
  | is_equal _ = false;
wenzelm@18966
   921
wenzelm@4445
   922
fun rev_order LESS = GREATER
wenzelm@4445
   923
  | rev_order EQUAL = EQUAL
wenzelm@4445
   924
  | rev_order GREATER = LESS;
wenzelm@4445
   925
wenzelm@4479
   926
(*assume rel is a linear strict order*)
wenzelm@4445
   927
fun make_ord rel (x, y) =
wenzelm@4445
   928
  if rel (x, y) then LESS
wenzelm@4445
   929
  else if rel (y, x) then GREATER
wenzelm@4445
   930
  else EQUAL;
wenzelm@4445
   931
wenzelm@15051
   932
val int_ord = Int.compare;
wenzelm@15051
   933
val string_ord = String.compare;
wenzelm@2506
   934
wenzelm@16676
   935
fun fast_string_ord (s1, s2) =
wenzelm@16676
   936
  (case int_ord (size s1, size s2) of EQUAL => string_ord (s1, s2) | ord => ord);
wenzelm@16676
   937
wenzelm@16492
   938
fun option_ord ord (SOME x, SOME y) = ord (x, y)
wenzelm@16492
   939
  | option_ord _ (NONE, NONE) = EQUAL
wenzelm@16492
   940
  | option_ord _ (NONE, SOME _) = LESS
wenzelm@16492
   941
  | option_ord _ (SOME _, NONE) = GREATER;
wenzelm@16492
   942
wenzelm@4343
   943
(*lexicographic product*)
wenzelm@4343
   944
fun prod_ord a_ord b_ord ((x, y), (x', y')) =
wenzelm@4343
   945
  (case a_ord (x, x') of EQUAL => b_ord (y, y') | ord => ord);
wenzelm@4343
   946
wenzelm@4343
   947
(*dictionary order -- in general NOT well-founded!*)
wenzelm@16984
   948
fun dict_ord elem_ord (x :: xs, y :: ys) =
wenzelm@16984
   949
      (case elem_ord (x, y) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord)
wenzelm@16984
   950
  | dict_ord _ ([], []) = EQUAL
wenzelm@4343
   951
  | dict_ord _ ([], _ :: _) = LESS
wenzelm@16984
   952
  | dict_ord _ (_ :: _, []) = GREATER;
wenzelm@4343
   953
wenzelm@4343
   954
(*lexicographic product of lists*)
wenzelm@4343
   955
fun list_ord elem_ord (xs, ys) =
wenzelm@16676
   956
  (case int_ord (length xs, length ys) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord);
wenzelm@4343
   957
wenzelm@2506
   958
wenzelm@4621
   959
(* sorting *)
wenzelm@4621
   960
wenzelm@18427
   961
(*quicksort -- stable, i.e. does not reorder equal elements*)
wenzelm@18427
   962
fun quicksort unique ord =
wenzelm@4621
   963
  let
wenzelm@16878
   964
    fun qsort [] = []
wenzelm@16878
   965
      | qsort (xs as [_]) = xs
wenzelm@18427
   966
      | qsort (xs as [x, y]) =
wenzelm@18427
   967
          (case ord (x, y) of
wenzelm@18427
   968
            LESS => xs
wenzelm@18427
   969
          | EQUAL => if unique then [x] else xs
wenzelm@18427
   970
          | GREATER => [y, x])
wenzelm@16878
   971
      | qsort xs =
haftmann@18011
   972
          let val (lts, eqs, gts) = part (nth xs (length xs div 2)) xs
wenzelm@16878
   973
          in qsort lts @ eqs @ qsort gts end
wenzelm@4621
   974
    and part _ [] = ([], [], [])
wenzelm@4621
   975
      | part pivot (x :: xs) = add (ord (x, pivot)) x (part pivot xs)
wenzelm@4621
   976
    and add LESS x (lts, eqs, gts) = (x :: lts, eqs, gts)
wenzelm@18427
   977
      | add EQUAL x (lts, [], gts) = (lts, [x], gts)
wenzelm@18427
   978
      | add EQUAL x (res as (lts, eqs, gts)) = if unique then res else (lts, x :: eqs, gts)
wenzelm@4621
   979
      | add GREATER x (lts, eqs, gts) = (lts, eqs, x :: gts);
wenzelm@4621
   980
  in qsort end;
wenzelm@4621
   981
wenzelm@18427
   982
fun sort ord = quicksort false ord;
wenzelm@18427
   983
fun sort_distinct ord = quicksort true ord;
wenzelm@18427
   984
wenzelm@4621
   985
val sort_strings = sort string_ord;
wenzelm@4621
   986
fun sort_wrt sel xs = sort (string_ord o pairself sel) xs;
wenzelm@4621
   987
wenzelm@4621
   988
wenzelm@2506
   989
berghofe@14106
   990
(** random numbers **)
berghofe@14106
   991
berghofe@14106
   992
exception RANDOM;
berghofe@14106
   993
berghofe@14618
   994
fun rmod x y = x - y * Real.realFloor (x / y);
berghofe@14106
   995
berghofe@14106
   996
local
berghofe@14106
   997
  val a = 16807.0;
berghofe@14106
   998
  val m = 2147483647.0;
berghofe@14106
   999
  val random_seed = ref 1.0;
berghofe@14106
  1000
in
berghofe@14106
  1001
berghofe@14106
  1002
fun random () =
berghofe@14106
  1003
  let val r = rmod (a * !random_seed) m
berghofe@14106
  1004
  in (random_seed := r; r) end;
berghofe@14106
  1005
berghofe@14106
  1006
end;
berghofe@14106
  1007
berghofe@14106
  1008
fun random_range l h =
berghofe@14106
  1009
  if h < l orelse l < 0 then raise RANDOM
berghofe@14106
  1010
  else l + Real.floor (rmod (random ()) (real (h - l + 1)));
berghofe@14106
  1011
haftmann@18011
  1012
fun one_of xs = nth xs (random_range 0 (length xs - 1));
berghofe@14106
  1013
berghofe@14106
  1014
fun frequency xs =
berghofe@14106
  1015
  let
berghofe@14106
  1016
    val sum = foldl op + (0, map fst xs);
wenzelm@17756
  1017
    fun pick n ((k: int, x) :: xs) =
berghofe@14106
  1018
      if n <= k then x else pick (n - k) xs
berghofe@14106
  1019
  in pick (random_range 1 sum) xs end;
berghofe@14106
  1020
berghofe@14106
  1021
wenzelm@23220
  1022
wenzelm@14826
  1023
(** current directory **)
wenzelm@233
  1024
paulson@2243
  1025
val cd = OS.FileSys.chDir;
wenzelm@2317
  1026
val pwd = OS.FileSys.getDir;
paulson@2243
  1027
berghofe@3606
  1028
wenzelm@19644
  1029
wenzelm@4621
  1030
(** misc **)
wenzelm@233
  1031
wenzelm@19644
  1032
fun divide_and_conquer decomp x =
wenzelm@19644
  1033
  let val (ys, recomb) = decomp x
wenzelm@19644
  1034
  in recomb (map (divide_and_conquer decomp) ys) end;
wenzelm@19644
  1035
clasohm@0
  1036
wenzelm@233
  1037
(*Partition a list into buckets  [ bi, b(i+1), ..., bj ]
clasohm@0
  1038
   putting x in bk if p(k)(x) holds.  Preserve order of elements if possible.*)
clasohm@0
  1039
fun partition_list p i j =
wenzelm@233
  1040
  let fun part k xs =
wenzelm@233
  1041
            if k>j then
clasohm@0
  1042
              (case xs of [] => []
skalberg@15570
  1043
                         | _ => raise Fail "partition_list")
clasohm@0
  1044
            else
wenzelm@19691
  1045
            let val (ns, rest) = List.partition (p k) xs;
wenzelm@233
  1046
            in  ns :: part(k+1)rest  end
clasohm@0
  1047
  in  part i end;
clasohm@0
  1048
wenzelm@19691
  1049
fun partition_eq (eq:'a * 'a -> bool) =
wenzelm@19691
  1050
  let
wenzelm@19691
  1051
    fun part [] = []
wenzelm@19691
  1052
      | part (x :: ys) =
wenzelm@19691
  1053
          let val (xs, xs') = List.partition (fn y => eq (x, y)) ys
wenzelm@19691
  1054
          in (x::xs)::(part xs') end
wenzelm@19691
  1055
  in part end;
wenzelm@19691
  1056
wenzelm@19691
  1057
clasohm@0
  1058
wenzelm@233
  1059
(* generating identifiers *)
clasohm@0
  1060
paulson@4063
  1061
(** Freshly generated identifiers; supplied prefix MUST start with a letter **)
wenzelm@22369
  1062
local
wenzelm@22369
  1063
(*Maps 0-61 to A-Z, a-z, 0-9; exclude _ or ' to avoid clash with internal/unusual indentifiers*)
wenzelm@22582
  1064
fun gensym_char i =
paulson@22368
  1065
  if i<26 then chr (ord "A" + i)
paulson@22368
  1066
  else if i<52 then chr (ord "a" + i - 26)
wenzelm@22369
  1067
  else chr (ord "0" + i - 52);
paulson@4063
  1068
wenzelm@22369
  1069
val char_vec = Vector.tabulate (62, gensym_char);
wenzelm@22369
  1070
fun newid n = implode (map (fn i => Vector.sub (char_vec, i)) (radixpand (62, n)));
wenzelm@4284
  1071
paulson@22368
  1072
val gensym_seed = ref 0;
paulson@2003
  1073
wenzelm@22369
  1074
in
wenzelm@22369
  1075
  fun gensym pre = pre ^ newid (inc gensym_seed);
wenzelm@22369
  1076
end;
paulson@4063
  1077
paulson@4063
  1078
wenzelm@16439
  1079
(* stamps and serial numbers *)
wenzelm@16439
  1080
wenzelm@16439
  1081
type stamp = unit ref;
wenzelm@16439
  1082
val stamp: unit -> stamp = ref;
wenzelm@16439
  1083
wenzelm@16439
  1084
type serial = int;
wenzelm@16439
  1085
local val count = ref 0
wenzelm@16439
  1086
in fun serial () = inc count end;
wenzelm@16439
  1087
wenzelm@19512
  1088
val serial_string = string_of_int o serial;
wenzelm@19512
  1089
wenzelm@16535
  1090
wenzelm@16535
  1091
(* generic objects *)
wenzelm@16535
  1092
wenzelm@16535
  1093
(*note that the builtin exception datatype may be extended by new
wenzelm@16535
  1094
  constructors at any time*)
wenzelm@16535
  1095
structure Object = struct type T = exn end;
wenzelm@16535
  1096
clasohm@1364
  1097
end;
clasohm@1364
  1098
wenzelm@15745
  1099
structure BasicLibrary: BASIC_LIBRARY = Library;
wenzelm@15745
  1100
open BasicLibrary;