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