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