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