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