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