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