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