src/Pure/library.ML
author wenzelm
Mon Dec 03 21:01:37 2001 +0100 (2001-12-03)
changeset 12346 e7b1956f4eae
parent 12295 83f747db967c
child 12419 6a7ee57447aa
permissions -rw-r--r--
removed questionable init_gensym;
wenzelm@41
     1
(*  Title:      Pure/library.ML
clasohm@0
     2
    ID:         $Id$
wenzelm@233
     3
    Author:     Lawrence C Paulson, Cambridge University Computer Laboratory
wenzelm@12284
     4
    Author:     Markus Wenzel, TU Munich
wenzelm@8806
     5
    License:    GPL (GNU GENERAL PUBLIC LICENSE)
clasohm@0
     6
wenzelm@233
     7
Basic library: functions, options, pairs, booleans, lists, integers,
wenzelm@4212
     8
strings, lists as sets, association lists, generic tables, balanced
wenzelm@4621
     9
trees, orders, I/O and diagnostics, timing, misc.
clasohm@0
    10
*)
clasohm@0
    11
wenzelm@8418
    12
infix |> |>> |>>> ~~ \ \\ ins ins_string ins_int orf andf prefix upto downto
wenzelm@4212
    13
  mem mem_int mem_string union union_int union_string inter inter_int
wenzelm@4212
    14
  inter_string subset subset_int subset_string;
clasohm@1364
    15
wenzelm@6510
    16
infix 3 oo ooo oooo;
wenzelm@5893
    17
wenzelm@4621
    18
signature LIBRARY =
wenzelm@4621
    19
sig
wenzelm@4621
    20
  (*functions*)
wenzelm@4621
    21
  val curry: ('a * 'b -> 'c) -> 'a -> 'b -> 'c
wenzelm@4621
    22
  val uncurry: ('a -> 'b -> 'c) -> 'a * 'b -> 'c
wenzelm@4621
    23
  val I: 'a -> 'a
wenzelm@4621
    24
  val K: 'a -> 'b -> 'a
wenzelm@4621
    25
  val |> : 'a * ('a -> 'b) -> 'b
wenzelm@8418
    26
  val |>> : ('a * 'b) * ('a -> 'c) -> 'c * 'b
wenzelm@8418
    27
  val |>>> : ('a * 'b) * ('a -> 'c * 'd) -> 'c * ('b * 'd)
wenzelm@4621
    28
  val apl: 'a * ('a * 'b -> 'c) -> 'b -> 'c
wenzelm@4621
    29
  val apr: ('a * 'b -> 'c) * 'b -> 'a -> 'c
wenzelm@4621
    30
  val funpow: int -> ('a -> 'a) -> 'a -> 'a
wenzelm@5893
    31
  val oo: ('a -> 'b) * ('c -> 'd -> 'a) -> 'c -> 'd -> 'b
wenzelm@5893
    32
  val ooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'a) -> 'c -> 'd -> 'e -> 'b
wenzelm@6510
    33
  val oooo: ('a -> 'b) * ('c -> 'd -> 'e -> 'f -> 'a) -> 'c -> 'd -> 'e -> 'f -> 'b
clasohm@1364
    34
wenzelm@4621
    35
  (*stamps*)
wenzelm@4621
    36
  type stamp
wenzelm@4621
    37
  val stamp: unit -> stamp
wenzelm@4621
    38
wenzelm@4621
    39
  (*options*)
wenzelm@4621
    40
  datatype 'a option = None | Some of 'a
wenzelm@4621
    41
  exception OPTION
wenzelm@4621
    42
  val the: 'a option -> 'a
wenzelm@4621
    43
  val if_none: 'a option -> 'a -> 'a
wenzelm@4621
    44
  val is_some: 'a option -> bool
wenzelm@4621
    45
  val is_none: 'a option -> bool
wenzelm@4621
    46
  val apsome: ('a -> 'b) -> 'a option -> 'b option
wenzelm@6959
    47
  val try: ('a -> 'b) -> 'a -> 'b option
wenzelm@4621
    48
  val can: ('a -> 'b) -> 'a -> bool
wenzelm@4621
    49
wenzelm@4621
    50
  (*pairs*)
wenzelm@4621
    51
  val pair: 'a -> 'b -> 'a * 'b
wenzelm@4621
    52
  val rpair: 'a -> 'b -> 'b * 'a
wenzelm@4621
    53
  val fst: 'a * 'b -> 'a
wenzelm@4621
    54
  val snd: 'a * 'b -> 'b
wenzelm@4621
    55
  val eq_fst: (''a * 'b) * (''a * 'c) -> bool
wenzelm@4621
    56
  val eq_snd: ('a * ''b) * ('c * ''b) -> bool
wenzelm@4621
    57
  val swap: 'a * 'b -> 'b * 'a
wenzelm@4621
    58
  val apfst: ('a -> 'b) -> 'a * 'c -> 'b * 'c
wenzelm@4621
    59
  val apsnd: ('a -> 'b) -> 'c * 'a -> 'c * 'b
wenzelm@4621
    60
  val pairself: ('a -> 'b) -> 'a * 'a -> 'b * 'b
wenzelm@4621
    61
wenzelm@4621
    62
  (*booleans*)
wenzelm@4621
    63
  val equal: ''a -> ''a -> bool
wenzelm@4621
    64
  val not_equal: ''a -> ''a -> bool
wenzelm@4621
    65
  val orf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    66
  val andf: ('a -> bool) * ('a -> bool) -> 'a -> bool
wenzelm@4621
    67
  val exists: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    68
  val forall: ('a -> bool) -> 'a list -> bool
wenzelm@4621
    69
  val set: bool ref -> bool
wenzelm@4621
    70
  val reset: bool ref -> bool
wenzelm@4621
    71
  val toggle: bool ref -> bool
wenzelm@9118
    72
  val change: 'a ref -> ('a -> 'a) -> unit
wenzelm@4621
    73
  val setmp: 'a ref -> 'a -> ('b -> 'c) -> 'b -> 'c
wenzelm@11853
    74
  val conditional: bool -> (unit -> unit) -> unit
wenzelm@4621
    75
wenzelm@4621
    76
  (*lists*)
wenzelm@4621
    77
  exception LIST of string
wenzelm@4621
    78
  val null: 'a list -> bool
wenzelm@4621
    79
  val hd: 'a list -> 'a
wenzelm@4621
    80
  val tl: 'a list -> 'a list
wenzelm@4621
    81
  val cons: 'a -> 'a list -> 'a list
wenzelm@5285
    82
  val single: 'a -> 'a list
wenzelm@4629
    83
  val append: 'a list -> 'a list -> 'a list
wenzelm@5904
    84
  val apply: ('a -> 'a) list -> 'a -> 'a
wenzelm@4621
    85
  val foldl: ('a * 'b -> 'a) -> 'a * 'b list -> 'a
wenzelm@4621
    86
  val foldr: ('a * 'b -> 'b) -> 'a list * 'b -> 'b
wenzelm@4621
    87
  val foldr1: ('a * 'a -> 'a) -> 'a list -> 'a
wenzelm@4956
    88
  val foldl_map: ('a * 'b -> 'a * 'c) -> 'a * 'b list -> 'a * 'c list
oheimb@11002
    89
  val foldln: ('a * int -> 'b -> 'b) -> 'a list -> 'b -> 'b
wenzelm@4621
    90
  val length: 'a list -> int
wenzelm@4621
    91
  val take: int * 'a list -> 'a list
wenzelm@4621
    92
  val drop: int * 'a list -> 'a list
nipkow@4713
    93
  val dropwhile: ('a -> bool) -> 'a list -> 'a list
wenzelm@4621
    94
  val nth_elem: int * 'a list -> 'a
wenzelm@11773
    95
  val map_nth_elem: int -> ('a -> 'a) -> 'a list -> 'a list
wenzelm@4621
    96
  val last_elem: 'a list -> 'a
wenzelm@4621
    97
  val split_last: 'a list -> 'a list * 'a
wenzelm@4893
    98
  val nth_update: 'a -> int * 'a list -> 'a list
wenzelm@4621
    99
  val find_index: ('a -> bool) -> 'a list -> int
wenzelm@4621
   100
  val find_index_eq: ''a -> ''a list -> int
wenzelm@4621
   101
  val find_first: ('a -> bool) -> 'a list -> 'a option
wenzelm@4916
   102
  val get_first: ('a -> 'b option) -> 'a list -> 'b option
wenzelm@4621
   103
  val flat: 'a list list -> 'a list
wenzelm@12136
   104
  val unflat: 'a list list -> 'b list -> 'b list list
wenzelm@4621
   105
  val seq: ('a -> unit) -> 'a list -> unit
wenzelm@4621
   106
  val separate: 'a -> 'a list -> 'a list
wenzelm@4621
   107
  val replicate: int -> 'a -> 'a list
wenzelm@4621
   108
  val multiply: 'a list * 'a list list -> 'a list list
wenzelm@4621
   109
  val filter: ('a -> bool) -> 'a list -> 'a list
wenzelm@4621
   110
  val filter_out: ('a -> bool) -> 'a list -> 'a list
wenzelm@4621
   111
  val mapfilter: ('a -> 'b option) -> 'a list -> 'b list
wenzelm@4621
   112
  val map2: ('a * 'b -> 'c) -> 'a list * 'b list -> 'c list
wenzelm@4621
   113
  val exists2: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   114
  val forall2: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4956
   115
  val seq2: ('a * 'b -> unit) -> 'a list * 'b list -> unit
wenzelm@4621
   116
  val ~~ : 'a list * 'b list -> ('a * 'b) list
wenzelm@4621
   117
  val split_list: ('a * 'b) list -> 'a list * 'b list
wenzelm@7468
   118
  val equal_lists: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   119
  val prefix: ''a list * ''a list -> bool
wenzelm@4621
   120
  val take_prefix: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@4621
   121
  val take_suffix: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@12249
   122
  val prefixes1: 'a list -> 'a list list
wenzelm@12249
   123
  val suffixes1: 'a list -> 'a list list
wenzelm@4621
   124
wenzelm@4621
   125
  (*integers*)
nipkow@10692
   126
  val gcd: int * int -> int
nipkow@10692
   127
  val lcm: int * int -> int
wenzelm@4621
   128
  val inc: int ref -> int
wenzelm@4621
   129
  val dec: int ref -> int
wenzelm@4621
   130
  val upto: int * int -> int list
wenzelm@4621
   131
  val downto: int * int -> int list
wenzelm@4621
   132
  val downto0: int list * int -> bool
wenzelm@4621
   133
  val radixpand: int * int -> int list
wenzelm@4621
   134
  val radixstring: int * string * int -> string
wenzelm@4621
   135
  val string_of_int: int -> string
wenzelm@4621
   136
  val string_of_indexname: string * int -> string
wenzelm@4621
   137
nipkow@10692
   138
  (*rational numbers*)
nipkow@10692
   139
  type rat
nipkow@10692
   140
  val rep_rat: rat -> int * int
nipkow@10692
   141
  val ratadd: rat * rat -> rat
nipkow@10692
   142
  val ratmul: rat * rat -> rat
nipkow@10692
   143
  val ratinv: rat -> rat
nipkow@10692
   144
  val int_ratdiv: int * int -> rat
nipkow@10692
   145
  val ratneg: rat -> rat
nipkow@10692
   146
  val rat_of_int: int -> rat
nipkow@10692
   147
wenzelm@4621
   148
  (*strings*)
wenzelm@6312
   149
  val nth_elem_string: int * string -> string
wenzelm@6282
   150
  val foldl_string: ('a * string -> 'a) -> 'a * string -> 'a
wenzelm@6312
   151
  val exists_string: (string -> bool) -> string -> bool
wenzelm@4621
   152
  val enclose: string -> string -> string -> string
wenzelm@6642
   153
  val unenclose: string -> string
wenzelm@4621
   154
  val quote: string -> string
wenzelm@4621
   155
  val space_implode: string -> string list -> string
wenzelm@4621
   156
  val commas: string list -> string
wenzelm@4621
   157
  val commas_quote: string list -> string
wenzelm@4621
   158
  val cat_lines: string list -> string
wenzelm@4621
   159
  val space_explode: string -> string -> string list
wenzelm@5942
   160
  val std_output: string -> unit
wenzelm@11853
   161
  val std_error: string -> unit
wenzelm@5942
   162
  val prefix_lines: string -> string -> string
wenzelm@4621
   163
  val split_lines: string -> string list
wenzelm@7712
   164
  val untabify: string list -> string list
wenzelm@5285
   165
  val suffix: string -> string -> string
wenzelm@5285
   166
  val unsuffix: string -> string -> string
wenzelm@10951
   167
  val replicate_string: int -> string -> string
wenzelm@4621
   168
wenzelm@4621
   169
  (*lists as sets*)
wenzelm@4621
   170
  val mem: ''a * ''a list -> bool
wenzelm@4621
   171
  val mem_int: int * int list -> bool
wenzelm@4621
   172
  val mem_string: string * string list -> bool
wenzelm@4621
   173
  val gen_mem: ('a * 'b -> bool) -> 'a * 'b list -> bool
wenzelm@4621
   174
  val ins: ''a * ''a list -> ''a list
wenzelm@4621
   175
  val ins_int: int * int list -> int list
wenzelm@4621
   176
  val ins_string: string * string list -> string list
wenzelm@4621
   177
  val gen_ins: ('a * 'a -> bool) -> 'a * 'a list -> 'a list
wenzelm@4621
   178
  val union: ''a list * ''a list -> ''a list
wenzelm@4621
   179
  val union_int: int list * int list -> int list
wenzelm@4621
   180
  val union_string: string list * string list -> string list
wenzelm@4621
   181
  val gen_union: ('a * 'a -> bool) -> 'a list * 'a list -> 'a list
paulson@7090
   182
  val gen_inter: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list
wenzelm@4621
   183
  val inter: ''a list * ''a list -> ''a list
wenzelm@4621
   184
  val inter_int: int list * int list -> int list
wenzelm@4621
   185
  val inter_string: string list * string list -> string list
wenzelm@4621
   186
  val subset: ''a list * ''a list -> bool
wenzelm@4621
   187
  val subset_int: int list * int list -> bool
wenzelm@4621
   188
  val subset_string: string list * string list -> bool
wenzelm@4621
   189
  val eq_set: ''a list * ''a list -> bool
wenzelm@4621
   190
  val eq_set_string: string list * string list -> bool
wenzelm@4621
   191
  val gen_subset: ('a * 'b -> bool) -> 'a list * 'b list -> bool
wenzelm@4621
   192
  val \ : ''a list * ''a -> ''a list
wenzelm@4621
   193
  val \\ : ''a list * ''a list -> ''a list
wenzelm@4621
   194
  val gen_rem: ('a * 'b -> bool) -> 'a list * 'b -> 'a list
wenzelm@4621
   195
  val gen_rems: ('a * 'b -> bool) -> 'a list * 'b list -> 'a list
wenzelm@4621
   196
  val gen_distinct: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@4621
   197
  val distinct: ''a list -> ''a list
wenzelm@4621
   198
  val findrep: ''a list -> ''a list
wenzelm@4621
   199
  val gen_duplicates: ('a * 'a -> bool) -> 'a list -> 'a list
wenzelm@4621
   200
  val duplicates: ''a list -> ''a list
wenzelm@4621
   201
wenzelm@4621
   202
  (*association lists*)
wenzelm@4621
   203
  val assoc: (''a * 'b) list * ''a -> 'b option
wenzelm@4621
   204
  val assoc_int: (int * 'a) list * int -> 'a option
wenzelm@4621
   205
  val assoc_string: (string * 'a) list * string -> 'a option
wenzelm@4621
   206
  val assoc_string_int: ((string * int) * 'a) list * (string * int) -> 'a option
wenzelm@4621
   207
  val assocs: (''a * 'b list) list -> ''a -> 'b list
wenzelm@4621
   208
  val assoc2: (''a * (''b * 'c) list) list * (''a * ''b) -> 'c option
wenzelm@4621
   209
  val gen_assoc: ('a * 'b -> bool) -> ('b * 'c) list * 'a -> 'c option
wenzelm@4621
   210
  val overwrite: (''a * 'b) list * (''a * 'b) -> (''a * 'b) list
nipkow@9721
   211
  val overwrite_warn: (''a * 'b) list * (''a * 'b) -> string -> (''a * 'b) list
wenzelm@4621
   212
  val gen_overwrite: ('a * 'a -> bool) -> ('a * 'b) list * ('a * 'b) -> ('a * 'b) list
wenzelm@4621
   213
wenzelm@12284
   214
  (*lists as tables*)
wenzelm@12284
   215
  val gen_merge_lists: ('a * 'a -> bool) -> 'a list -> 'a list -> 'a list
wenzelm@12284
   216
  val gen_merge_lists': ('a * 'a -> bool) -> 'a list -> 'a list -> 'a list
wenzelm@4621
   217
  val merge_lists: ''a list -> ''a list -> ''a list
wenzelm@12284
   218
  val merge_lists': ''a list -> ''a list -> ''a list
wenzelm@4692
   219
  val merge_alists: (''a * 'b) list -> (''a * 'b) list -> (''a * 'b) list
wenzelm@4621
   220
wenzelm@4621
   221
  (*balanced trees*)
wenzelm@4621
   222
  exception Balance
wenzelm@4621
   223
  val fold_bal: ('a * 'a -> 'a) -> 'a list -> 'a
wenzelm@4621
   224
  val access_bal: ('a -> 'a) * ('a -> 'a) * 'a -> int -> int -> 'a
wenzelm@4621
   225
  val accesses_bal: ('a -> 'a) * ('a -> 'a) * 'a -> int -> 'a list
wenzelm@4621
   226
wenzelm@4621
   227
  (*orders*)
paulson@8043
   228
  datatype order = LESS | EQUAL | GREATER
wenzelm@4621
   229
  val rev_order: order -> order
wenzelm@4621
   230
  val make_ord: ('a * 'a -> bool) -> 'a * 'a -> order
wenzelm@4621
   231
  val int_ord: int * int -> order
wenzelm@4621
   232
  val string_ord: string * string -> order
wenzelm@4621
   233
  val prod_ord: ('a * 'b -> order) -> ('c * 'd -> order) -> ('a * 'c) * ('b * 'd) -> order
wenzelm@4621
   234
  val dict_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   235
  val list_ord: ('a * 'b -> order) -> 'a list * 'b list -> order
wenzelm@4621
   236
  val sort: ('a * 'a -> order) -> 'a list -> 'a list
wenzelm@4621
   237
  val sort_strings: string list -> string list
wenzelm@4621
   238
  val sort_wrt: ('a -> string) -> 'a list -> 'a list
berghofe@11514
   239
  val unique_strings: string list -> string list
wenzelm@4621
   240
wenzelm@4621
   241
  (*I/O and diagnostics*)
wenzelm@4621
   242
  val cd: string -> unit
wenzelm@4621
   243
  val pwd: unit -> string
wenzelm@5966
   244
  val writeln_fn: (string -> unit) ref
wenzelm@9774
   245
  val priority_fn: (string -> unit) ref
wenzelm@12260
   246
  val tracing_fn: (string -> unit) ref
wenzelm@4621
   247
  val warning_fn: (string -> unit) ref
wenzelm@4621
   248
  val error_fn: (string -> unit) ref
wenzelm@4621
   249
  val writeln: string -> unit
wenzelm@9774
   250
  val priority: string -> unit
wenzelm@12260
   251
  val tracing: string -> unit
wenzelm@4621
   252
  val warning: string -> unit
wenzelm@4621
   253
  exception ERROR
wenzelm@4621
   254
  val error_msg: string -> unit
wenzelm@4621
   255
  val error: string -> 'a
wenzelm@4621
   256
  val sys_error: string -> 'a
wenzelm@4621
   257
  val assert: bool -> string -> unit
wenzelm@4621
   258
  val deny: bool -> string -> unit
wenzelm@4621
   259
  val assert_all: ('a -> bool) -> 'a list -> ('a -> string) -> unit
wenzelm@4621
   260
  datatype 'a error = Error of string | OK of 'a
wenzelm@4621
   261
  val get_error: 'a error -> string option
wenzelm@4621
   262
  val get_ok: 'a error -> 'a option
wenzelm@4621
   263
  val handle_error: ('a -> 'b) -> 'a -> 'b error
wenzelm@4923
   264
  exception ERROR_MESSAGE of string
wenzelm@4923
   265
  val transform_error: ('a -> 'b) -> 'a -> 'b
wenzelm@5904
   266
  val transform_failure: (exn -> exn) -> ('a -> 'b) -> 'a -> 'b
wenzelm@4621
   267
wenzelm@4621
   268
  (*timing*)
wenzelm@4621
   269
  val cond_timeit: bool -> (unit -> 'a) -> 'a
wenzelm@4621
   270
  val timeit: (unit -> 'a) -> 'a
wenzelm@4621
   271
  val timeap: ('a -> 'b) -> 'a -> 'b
wenzelm@8999
   272
  val timing: bool ref
wenzelm@4621
   273
wenzelm@4621
   274
  (*misc*)
wenzelm@4621
   275
  val make_keylist: ('a -> 'b) -> 'a list -> ('a * 'b) list
wenzelm@4621
   276
  val keyfilter: ('a * ''b) list -> ''b -> 'a list
wenzelm@4621
   277
  val partition: ('a -> bool) -> 'a list -> 'a list * 'a list
wenzelm@4621
   278
  val partition_eq: ('a * 'a -> bool) -> 'a list -> 'a list list
wenzelm@4621
   279
  val partition_list: (int -> 'a -> bool) -> int -> int -> 'a list -> 'a list list
wenzelm@4621
   280
  val transitive_closure: (string * string list) list -> (string * string list) list
wenzelm@4621
   281
  val gensym: string -> string
wenzelm@4621
   282
  val bump_int_list: string list -> string list
wenzelm@4621
   283
  val bump_list: string list * string -> string list
wenzelm@4621
   284
  val bump_string: string -> string
wenzelm@4621
   285
  val scanwords: (string -> bool) -> string list -> string list
wenzelm@4621
   286
  datatype 'a mtree = Join of 'a * 'a mtree list
wenzelm@4621
   287
end;
wenzelm@4621
   288
wenzelm@4621
   289
structure Library: LIBRARY =
clasohm@1364
   290
struct
clasohm@0
   291
wenzelm@4995
   292
wenzelm@233
   293
(** functions **)
clasohm@0
   294
wenzelm@233
   295
(*handy combinators*)
wenzelm@233
   296
fun curry f x y = f (x, y);
wenzelm@233
   297
fun uncurry f (x, y) = f x y;
wenzelm@233
   298
fun I x = x;
wenzelm@233
   299
fun K x y = x;
clasohm@0
   300
wenzelm@380
   301
(*reverse apply*)
wenzelm@410
   302
fun (x |> f) = f x;
wenzelm@8418
   303
fun ((x, y) |>> f) = (f x, y);
wenzelm@8418
   304
fun ((x, y) |>>> f) = let val (x', z) = f x in (x', (y, z)) end;
wenzelm@380
   305
wenzelm@233
   306
(*application of (infix) operator to its left or right argument*)
wenzelm@233
   307
fun apl (x, f) y = f (x, y);
wenzelm@233
   308
fun apr (f, y) x = f (x, y);
clasohm@0
   309
wenzelm@233
   310
(*function exponentiation: f(...(f x)...) with n applications of f*)
wenzelm@233
   311
fun funpow n f x =
wenzelm@233
   312
  let fun rep (0, x) = x
wenzelm@233
   313
        | rep (n, x) = rep (n - 1, f x)
wenzelm@233
   314
  in rep (n, x) end;
wenzelm@160
   315
wenzelm@5893
   316
(*concatenation: 2 and 3 args*)
wenzelm@5893
   317
fun (f oo g) x y = f (g x y);
wenzelm@5893
   318
fun (f ooo g) x y z = f (g x y z);
wenzelm@6510
   319
fun (f oooo g) x y z w = f (g x y z w);
wenzelm@6510
   320
wenzelm@160
   321
wenzelm@160
   322
wenzelm@2471
   323
(** stamps **)
wenzelm@2471
   324
wenzelm@2471
   325
type stamp = unit ref;
wenzelm@2471
   326
val stamp: unit -> stamp = ref;
wenzelm@2471
   327
wenzelm@2471
   328
wenzelm@2471
   329
wenzelm@233
   330
(** options **)
clasohm@0
   331
clasohm@0
   332
datatype 'a option = None | Some of 'a;
clasohm@0
   333
wenzelm@4139
   334
exception OPTION;
clasohm@0
   335
clasohm@0
   336
fun the (Some x) = x
wenzelm@4139
   337
  | the None = raise OPTION;
clasohm@0
   338
wenzelm@4212
   339
(*strict!*)
wenzelm@255
   340
fun if_none None y = y
wenzelm@255
   341
  | if_none (Some x) _ = x;
wenzelm@255
   342
clasohm@0
   343
fun is_some (Some _) = true
clasohm@0
   344
  | is_some None = false;
clasohm@0
   345
clasohm@0
   346
fun is_none (Some _) = false
clasohm@0
   347
  | is_none None = true;
clasohm@0
   348
wenzelm@233
   349
fun apsome f (Some x) = Some (f x)
wenzelm@233
   350
  | apsome _ None = None;
clasohm@0
   351
wenzelm@6959
   352
wenzelm@6959
   353
(* exception handling *)
wenzelm@6959
   354
wenzelm@6959
   355
exception ERROR;
wenzelm@6959
   356
wenzelm@6959
   357
fun try f x = Some (f x)
wenzelm@6959
   358
  handle Interrupt => raise Interrupt | ERROR => raise ERROR | _ => None;
wenzelm@6959
   359
wenzelm@6959
   360
fun can f x = is_some (try f x);
wenzelm@4139
   361
wenzelm@4139
   362
wenzelm@4139
   363
wenzelm@233
   364
(** pairs **)
wenzelm@233
   365
wenzelm@233
   366
fun pair x y = (x, y);
wenzelm@233
   367
fun rpair x y = (y, x);
wenzelm@233
   368
wenzelm@233
   369
fun fst (x, y) = x;
wenzelm@233
   370
fun snd (x, y) = y;
wenzelm@233
   371
wenzelm@233
   372
fun eq_fst ((x1, _), (x2, _)) = x1 = x2;
wenzelm@233
   373
fun eq_snd ((_, y1), (_, y2)) = y1 = y2;
wenzelm@233
   374
wenzelm@233
   375
fun swap (x, y) = (y, x);
wenzelm@233
   376
wenzelm@4212
   377
(*apply function to components*)
wenzelm@233
   378
fun apfst f (x, y) = (f x, y);
wenzelm@233
   379
fun apsnd f (x, y) = (x, f y);
wenzelm@4212
   380
fun pairself f (x, y) = (f x, f y);
wenzelm@233
   381
wenzelm@233
   382
wenzelm@233
   383
wenzelm@233
   384
(** booleans **)
wenzelm@233
   385
wenzelm@233
   386
(* equality *)
wenzelm@233
   387
wenzelm@233
   388
fun equal x y = x = y;
wenzelm@233
   389
fun not_equal x y = x <> y;
wenzelm@233
   390
wenzelm@233
   391
wenzelm@233
   392
(* operators for combining predicates *)
wenzelm@233
   393
paulson@2175
   394
fun (p orf q) = fn x => p x orelse q x;
paulson@2175
   395
fun (p andf q) = fn x => p x andalso q x;
wenzelm@233
   396
wenzelm@233
   397
wenzelm@233
   398
(* predicates on lists *)
wenzelm@233
   399
wenzelm@233
   400
(*exists pred [x1, ..., xn] ===> pred x1 orelse ... orelse pred xn*)
wenzelm@233
   401
fun exists (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   402
  let fun boolf [] = false
wenzelm@233
   403
        | boolf (x :: xs) = pred x orelse boolf xs
wenzelm@233
   404
  in boolf end;
wenzelm@233
   405
wenzelm@233
   406
(*forall pred [x1, ..., xn] ===> pred x1 andalso ... andalso pred xn*)
wenzelm@233
   407
fun forall (pred: 'a -> bool) : 'a list -> bool =
wenzelm@233
   408
  let fun boolf [] = true
wenzelm@233
   409
        | boolf (x :: xs) = pred x andalso boolf xs
wenzelm@233
   410
  in boolf end;
clasohm@0
   411
wenzelm@233
   412
wenzelm@380
   413
(* flags *)
wenzelm@380
   414
wenzelm@380
   415
fun set flag = (flag := true; true);
wenzelm@380
   416
fun reset flag = (flag := false; false);
wenzelm@380
   417
fun toggle flag = (flag := not (! flag); ! flag);
wenzelm@380
   418
wenzelm@9118
   419
fun change r f = r := f (! r);
wenzelm@9118
   420
wenzelm@4212
   421
(*temporarily set flag, handling errors*)
wenzelm@2978
   422
fun setmp flag value f x =
wenzelm@2958
   423
  let
wenzelm@2958
   424
    val orig_value = ! flag;
wenzelm@2958
   425
    fun return y = (flag := orig_value; y);
wenzelm@2958
   426
  in
wenzelm@2958
   427
    flag := value;
wenzelm@2958
   428
    return (f x handle exn => (return (); raise exn))
wenzelm@2958
   429
  end;
wenzelm@2958
   430
wenzelm@380
   431
wenzelm@11853
   432
(* conditional execution *)
wenzelm@11853
   433
wenzelm@11853
   434
fun conditional b f = if b then f () else ();
wenzelm@11853
   435
wenzelm@11853
   436
wenzelm@233
   437
wenzelm@233
   438
(** lists **)
wenzelm@233
   439
wenzelm@233
   440
exception LIST of string;
wenzelm@233
   441
wenzelm@233
   442
fun null [] = true
wenzelm@233
   443
  | null (_ :: _) = false;
wenzelm@233
   444
wenzelm@233
   445
fun hd [] = raise LIST "hd"
wenzelm@233
   446
  | hd (x :: _) = x;
wenzelm@233
   447
wenzelm@233
   448
fun tl [] = raise LIST "tl"
wenzelm@233
   449
  | tl (_ :: xs) = xs;
wenzelm@233
   450
wenzelm@233
   451
fun cons x xs = x :: xs;
wenzelm@5285
   452
fun single x = [x];
wenzelm@233
   453
wenzelm@4629
   454
fun append xs ys = xs @ ys;
wenzelm@4629
   455
wenzelm@5904
   456
fun apply [] x = x
wenzelm@5904
   457
  | apply (f :: fs) x = apply fs (f x);
wenzelm@5904
   458
wenzelm@233
   459
wenzelm@233
   460
(* fold *)
wenzelm@233
   461
wenzelm@233
   462
(*the following versions of fold are designed to fit nicely with infixes*)
clasohm@0
   463
wenzelm@233
   464
(*  (op @) (e, [x1, ..., xn])  ===>  ((e @ x1) @ x2) ... @ xn
wenzelm@233
   465
    for operators that associate to the left (TAIL RECURSIVE)*)
wenzelm@233
   466
fun foldl (f: 'a * 'b -> 'a) : 'a * 'b list -> 'a =
wenzelm@233
   467
  let fun itl (e, [])  = e
wenzelm@233
   468
        | itl (e, a::l) = itl (f(e, a), l)
wenzelm@233
   469
  in  itl end;
wenzelm@233
   470
wenzelm@233
   471
(*  (op @) ([x1, ..., xn], e)  ===>   x1 @ (x2 ... @ (xn @ e))
wenzelm@233
   472
    for operators that associate to the right (not tail recursive)*)
wenzelm@233
   473
fun foldr f (l, e) =
wenzelm@233
   474
  let fun itr [] = e
wenzelm@233
   475
        | itr (a::l) = f(a, itr l)
wenzelm@233
   476
  in  itr l  end;
wenzelm@233
   477
wenzelm@233
   478
(*  (op @) [x1, ..., xn]  ===>   x1 @ (x2 ... @ (x[n-1] @ xn))
wenzelm@233
   479
    for n > 0, operators that associate to the right (not tail recursive)*)
wenzelm@233
   480
fun foldr1 f l =
wenzelm@4181
   481
  let fun itr [x] = x
wenzelm@233
   482
        | itr (x::l) = f(x, itr l)
wenzelm@233
   483
  in  itr l  end;
wenzelm@233
   484
wenzelm@4956
   485
fun foldl_map _ (x, []) = (x, [])
wenzelm@4956
   486
  | foldl_map f (x, y :: ys) =
wenzelm@4956
   487
      let
wenzelm@4956
   488
        val (x', y') = f (x, y);
wenzelm@4956
   489
        val (x'', ys') = foldl_map f (x', ys);
wenzelm@4956
   490
      in (x'', y' :: ys') end;
wenzelm@4956
   491
oheimb@11002
   492
fun foldln f xs e = fst (foldl (fn ((e,i), x) => (f (x,i) e, i+1)) ((e,1),xs));
wenzelm@233
   493
wenzelm@233
   494
(* basic list functions *)
wenzelm@233
   495
wenzelm@233
   496
(*length of a list, should unquestionably be a standard function*)
wenzelm@233
   497
local fun length1 (n, [])  = n   (*TAIL RECURSIVE*)
wenzelm@233
   498
        | length1 (n, x :: xs) = length1 (n + 1, xs)
wenzelm@233
   499
in  fun length l = length1 (0, l) end;
wenzelm@233
   500
wenzelm@233
   501
(*take the first n elements from a list*)
wenzelm@233
   502
fun take (n, []) = []
wenzelm@233
   503
  | take (n, x :: xs) =
wenzelm@233
   504
      if n > 0 then x :: take (n - 1, xs) else [];
wenzelm@233
   505
wenzelm@233
   506
(*drop the first n elements from a list*)
wenzelm@233
   507
fun drop (n, []) = []
wenzelm@233
   508
  | drop (n, x :: xs) =
wenzelm@233
   509
      if n > 0 then drop (n - 1, xs) else x :: xs;
clasohm@0
   510
nipkow@4713
   511
fun dropwhile P [] = []
nipkow@4713
   512
  | dropwhile P (ys as x::xs) = if P x then dropwhile P xs else ys;
nipkow@4713
   513
wenzelm@233
   514
(*return nth element of a list, where 0 designates the first element;
wenzelm@233
   515
  raise EXCEPTION if list too short*)
wenzelm@233
   516
fun nth_elem NL =
wenzelm@233
   517
  (case drop NL of
wenzelm@233
   518
    [] => raise LIST "nth_elem"
wenzelm@233
   519
  | x :: _ => x);
wenzelm@233
   520
wenzelm@11773
   521
fun map_nth_elem 0 f (x :: xs) = f x :: xs
wenzelm@11773
   522
  | map_nth_elem n f (x :: xs) = x :: map_nth_elem (n - 1) f xs
wenzelm@11773
   523
  | map_nth_elem _ _ [] = raise LIST "map_nth_elem";
wenzelm@11773
   524
wenzelm@233
   525
(*last element of a list*)
wenzelm@233
   526
fun last_elem [] = raise LIST "last_elem"
wenzelm@233
   527
  | last_elem [x] = x
wenzelm@233
   528
  | last_elem (_ :: xs) = last_elem xs;
wenzelm@233
   529
wenzelm@3762
   530
(*rear decomposition*)
wenzelm@3762
   531
fun split_last [] = raise LIST "split_last"
wenzelm@3762
   532
  | split_last [x] = ([], x)
wenzelm@3762
   533
  | split_last (x :: xs) = apfst (cons x) (split_last xs);
wenzelm@3762
   534
wenzelm@4893
   535
(*update nth element*)
wenzelm@4893
   536
fun nth_update x (n, xs) =
wenzelm@4893
   537
  let
wenzelm@4893
   538
    val prfx = take (n, xs);
wenzelm@4893
   539
    val sffx = drop (n, xs);
wenzelm@4893
   540
  in
wenzelm@4893
   541
    (case sffx of
wenzelm@4893
   542
      [] => raise LIST "nth_update"
wenzelm@4893
   543
    | _ :: sffx' => prfx @ (x :: sffx'))
wenzelm@4893
   544
  end;
wenzelm@4893
   545
wenzelm@4212
   546
(*find the position of an element in a list*)
wenzelm@4212
   547
fun find_index pred =
wenzelm@4212
   548
  let fun find _ [] = ~1
wenzelm@4212
   549
        | find n (x :: xs) = if pred x then n else find (n + 1) xs;
wenzelm@4212
   550
  in find 0 end;
wenzelm@3762
   551
wenzelm@4224
   552
fun find_index_eq x = find_index (equal x);
wenzelm@4212
   553
wenzelm@4212
   554
(*find first element satisfying predicate*)
wenzelm@4212
   555
fun find_first _ [] = None
wenzelm@4212
   556
  | find_first pred (x :: xs) =
wenzelm@4212
   557
      if pred x then Some x else find_first pred xs;
wenzelm@233
   558
wenzelm@4916
   559
(*get first element by lookup function*)
wenzelm@4916
   560
fun get_first _ [] = None
wenzelm@4916
   561
  | get_first f (x :: xs) =
wenzelm@4916
   562
      (case f x of
wenzelm@4916
   563
        None => get_first f xs
wenzelm@4916
   564
      | some => some);
wenzelm@4916
   565
wenzelm@233
   566
(*flatten a list of lists to a list*)
wenzelm@233
   567
fun flat (ls: 'c list list) : 'c list = foldr (op @) (ls, []);
wenzelm@233
   568
wenzelm@12136
   569
fun unflat (xs :: xss) ys =
wenzelm@12136
   570
      let val n = length xs in take (n, ys) :: unflat xss (drop (n, ys)) end
wenzelm@12136
   571
  | unflat [] [] = []
wenzelm@12136
   572
  | unflat _ _ = raise LIST "unflat";
wenzelm@12136
   573
wenzelm@233
   574
(*like Lisp's MAPC -- seq proc [x1, ..., xn] evaluates
wenzelm@233
   575
  (proc x1; ...; proc xn) for side effects*)
wenzelm@233
   576
fun seq (proc: 'a -> unit) : 'a list -> unit =
wenzelm@233
   577
  let fun seqf [] = ()
wenzelm@233
   578
        | seqf (x :: xs) = (proc x; seqf xs)
wenzelm@233
   579
  in seqf end;
wenzelm@233
   580
wenzelm@233
   581
(*separate s [x1, x2, ..., xn]  ===>  [x1, s, x2, s, ..., s, xn]*)
wenzelm@233
   582
fun separate s (x :: (xs as _ :: _)) = x :: s :: separate s xs
wenzelm@233
   583
  | separate _ xs = xs;
wenzelm@233
   584
wenzelm@233
   585
(*make the list [x, x, ..., x] of length n*)
wenzelm@233
   586
fun replicate n (x: 'a) : 'a list =
wenzelm@233
   587
  let fun rep (0, xs) = xs
wenzelm@233
   588
        | rep (n, xs) = rep (n - 1, x :: xs)
wenzelm@233
   589
  in
wenzelm@233
   590
    if n < 0 then raise LIST "replicate"
wenzelm@233
   591
    else rep (n, [])
wenzelm@233
   592
  end;
wenzelm@233
   593
wenzelm@4248
   594
(*multiply [a, b, c, ...] * [xs, ys, zs, ...]*)
wenzelm@4248
   595
fun multiply ([], _) = []
wenzelm@4248
   596
  | multiply (x :: xs, yss) = map (cons x) yss @ multiply (xs, yss);
wenzelm@4248
   597
wenzelm@233
   598
wenzelm@233
   599
(* filter *)
wenzelm@233
   600
wenzelm@233
   601
(*copy the list preserving elements that satisfy the predicate*)
wenzelm@233
   602
fun filter (pred: 'a->bool) : 'a list -> 'a list =
clasohm@0
   603
  let fun filt [] = []
wenzelm@233
   604
        | filt (x :: xs) = if pred x then x :: filt xs else filt xs
wenzelm@233
   605
  in filt end;
clasohm@0
   606
clasohm@0
   607
fun filter_out f = filter (not o f);
clasohm@0
   608
wenzelm@233
   609
fun mapfilter (f: 'a -> 'b option) ([]: 'a list) = [] : 'b list
wenzelm@233
   610
  | mapfilter f (x :: xs) =
wenzelm@233
   611
      (case f x of
wenzelm@233
   612
        None => mapfilter f xs
wenzelm@233
   613
      | Some y => y :: mapfilter f xs);
wenzelm@233
   614
wenzelm@233
   615
wenzelm@233
   616
(* lists of pairs *)
wenzelm@233
   617
wenzelm@380
   618
fun map2 _ ([], []) = []
wenzelm@380
   619
  | map2 f (x :: xs, y :: ys) = (f (x, y) :: map2 f (xs, ys))
wenzelm@380
   620
  | map2 _ _ = raise LIST "map2";
wenzelm@380
   621
wenzelm@380
   622
fun exists2 _ ([], []) = false
wenzelm@380
   623
  | exists2 pred (x :: xs, y :: ys) = pred (x, y) orelse exists2 pred (xs, ys)
wenzelm@380
   624
  | exists2 _ _ = raise LIST "exists2";
wenzelm@380
   625
wenzelm@380
   626
fun forall2 _ ([], []) = true
wenzelm@380
   627
  | forall2 pred (x :: xs, y :: ys) = pred (x, y) andalso forall2 pred (xs, ys)
wenzelm@380
   628
  | forall2 _ _ = raise LIST "forall2";
wenzelm@380
   629
wenzelm@4956
   630
fun seq2 _ ([], []) = ()
wenzelm@4956
   631
  | seq2 f (x :: xs, y :: ys) = (f (x, y); seq2 f (xs, ys))
wenzelm@4956
   632
  | seq2 _ _ = raise LIST "seq2";
wenzelm@4956
   633
wenzelm@233
   634
(*combine two lists forming a list of pairs:
wenzelm@233
   635
  [x1, ..., xn] ~~ [y1, ..., yn]  ===>  [(x1, y1), ..., (xn, yn)]*)
wenzelm@233
   636
fun [] ~~ [] = []
wenzelm@233
   637
  | (x :: xs) ~~ (y :: ys) = (x, y) :: (xs ~~ ys)
wenzelm@233
   638
  | _ ~~ _ = raise LIST "~~";
wenzelm@233
   639
wenzelm@233
   640
(*inverse of ~~; the old 'split':
wenzelm@233
   641
  [(x1, y1), ..., (xn, yn)]  ===>  ([x1, ..., xn], [y1, ..., yn])*)
wenzelm@233
   642
fun split_list (l: ('a * 'b) list) = (map #1 l, map #2 l);
wenzelm@233
   643
wenzelm@7468
   644
fun equal_lists eq (xs, ys) = length xs = length ys andalso forall2 eq (xs, ys);
wenzelm@7468
   645
wenzelm@233
   646
wenzelm@233
   647
(* prefixes, suffixes *)
wenzelm@233
   648
wenzelm@233
   649
fun [] prefix _ = true
wenzelm@233
   650
  | (x :: xs) prefix (y :: ys) = x = y andalso (xs prefix ys)
wenzelm@233
   651
  | _ prefix _ = false;
wenzelm@233
   652
wenzelm@233
   653
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., x(i-1)], [xi, ..., xn])
wenzelm@233
   654
   where xi is the first element that does not satisfy the predicate*)
wenzelm@233
   655
fun take_prefix (pred : 'a -> bool)  (xs: 'a list) : 'a list * 'a list =
wenzelm@233
   656
  let fun take (rxs, []) = (rev rxs, [])
wenzelm@255
   657
        | take (rxs, x :: xs) =
wenzelm@255
   658
            if  pred x  then  take(x :: rxs, xs)  else  (rev rxs, x :: xs)
wenzelm@233
   659
  in  take([], xs)  end;
wenzelm@233
   660
wenzelm@233
   661
(* [x1, ..., xi, ..., xn]  --->  ([x1, ..., xi], [x(i+1), ..., xn])
wenzelm@233
   662
   where xi is the last element that does not satisfy the predicate*)
wenzelm@233
   663
fun take_suffix _ [] = ([], [])
wenzelm@233
   664
  | take_suffix pred (x :: xs) =
wenzelm@233
   665
      (case take_suffix pred xs of
wenzelm@233
   666
        ([], sffx) => if pred x then ([], x :: sffx) else ([x], sffx)
wenzelm@233
   667
      | (prfx, sffx) => (x :: prfx, sffx));
wenzelm@233
   668
wenzelm@12249
   669
fun prefixes1 [] = []
wenzelm@12249
   670
  | prefixes1 (x :: xs) = map (cons x) ([] :: prefixes1 xs);
wenzelm@12249
   671
wenzelm@12249
   672
fun suffixes1 xs = map rev (prefixes1 (rev xs));
wenzelm@12249
   673
wenzelm@233
   674
wenzelm@233
   675
wenzelm@233
   676
(** integers **)
wenzelm@233
   677
nipkow@10692
   678
fun gcd(x,y) =
nipkow@10692
   679
  let fun gxd x y =
nipkow@10692
   680
    if y = 0 then x else gxd y (x mod y)
nipkow@10692
   681
  in if x < y then gxd y x else gxd x y end;
nipkow@10692
   682
nipkow@10692
   683
fun lcm(x,y) = (x * y) div gcd(x,y);
nipkow@10692
   684
wenzelm@2958
   685
fun inc i = (i := ! i + 1; ! i);
wenzelm@2958
   686
fun dec i = (i := ! i - 1; ! i);
wenzelm@233
   687
wenzelm@233
   688
wenzelm@233
   689
(* lists of integers *)
wenzelm@233
   690
wenzelm@233
   691
(*make the list [from, from + 1, ..., to]*)
paulson@2175
   692
fun (from upto to) =
wenzelm@233
   693
  if from > to then [] else from :: ((from + 1) upto to);
wenzelm@233
   694
wenzelm@233
   695
(*make the list [from, from - 1, ..., to]*)
paulson@2175
   696
fun (from downto to) =
wenzelm@233
   697
  if from < to then [] else from :: ((from - 1) downto to);
wenzelm@233
   698
wenzelm@233
   699
(*predicate: downto0 (is, n) <=> is = [n, n - 1, ..., 0]*)
wenzelm@233
   700
fun downto0 (i :: is, n) = i = n andalso downto0 (is, n - 1)
wenzelm@233
   701
  | downto0 ([], n) = n = ~1;
wenzelm@233
   702
wenzelm@233
   703
wenzelm@233
   704
(* convert integers to strings *)
wenzelm@233
   705
wenzelm@233
   706
(*expand the number in the given base;
wenzelm@233
   707
  example: radixpand (2, 8) gives [1, 0, 0, 0]*)
wenzelm@233
   708
fun radixpand (base, num) : int list =
wenzelm@233
   709
  let
wenzelm@233
   710
    fun radix (n, tail) =
wenzelm@233
   711
      if n < base then n :: tail
wenzelm@233
   712
      else radix (n div base, (n mod base) :: tail)
wenzelm@233
   713
  in radix (num, []) end;
wenzelm@233
   714
wenzelm@233
   715
(*expands a number into a string of characters starting from "zerochar";
wenzelm@233
   716
  example: radixstring (2, "0", 8) gives "1000"*)
wenzelm@233
   717
fun radixstring (base, zerochar, num) =
wenzelm@233
   718
  let val offset = ord zerochar;
wenzelm@233
   719
      fun chrof n = chr (offset + n)
wenzelm@233
   720
  in implode (map chrof (radixpand (base, num))) end;
wenzelm@233
   721
wenzelm@233
   722
paulson@3407
   723
val string_of_int = Int.toString;
wenzelm@233
   724
paulson@3407
   725
fun string_of_indexname (a,0) = a
paulson@3407
   726
  | string_of_indexname (a,i) = a ^ "_" ^ Int.toString i;
wenzelm@233
   727
wenzelm@233
   728
wenzelm@233
   729
(** strings **)
wenzelm@233
   730
wenzelm@6312
   731
(*functions tuned for strings, avoiding explode*)
wenzelm@6312
   732
wenzelm@6312
   733
fun nth_elem_string (i, str) =
wenzelm@6959
   734
  (case try String.substring (str, i, 1) of
wenzelm@6959
   735
    Some s => s
wenzelm@6959
   736
  | None => raise LIST "nth_elem_string");
wenzelm@6312
   737
wenzelm@6282
   738
fun foldl_string f (x0, str) =
wenzelm@6282
   739
  let
wenzelm@6282
   740
    val n = size str;
wenzelm@6282
   741
    fun fold (x, i) = if i < n then fold (f (x, String.substring (str, i, 1)), i + 1) else x
wenzelm@6282
   742
  in fold (x0, 0) end;
wenzelm@6282
   743
wenzelm@6312
   744
fun exists_string pred str = foldl_string (fn (b, s) => b orelse pred s) (false, str);
wenzelm@6312
   745
lcp@512
   746
(*enclose in brackets*)
lcp@512
   747
fun enclose lpar rpar str = lpar ^ str ^ rpar;
wenzelm@6642
   748
fun unenclose str = String.substring (str, 1, size str - 2);
wenzelm@255
   749
wenzelm@233
   750
(*simple quoting (does not escape special chars)*)
lcp@512
   751
val quote = enclose "\"" "\"";
wenzelm@233
   752
wenzelm@4212
   753
(*space_implode "..." (explode "hello") = "h...e...l...l...o"*)
wenzelm@233
   754
fun space_implode a bs = implode (separate a bs);
wenzelm@233
   755
wenzelm@255
   756
val commas = space_implode ", ";
wenzelm@380
   757
val commas_quote = commas o map quote;
wenzelm@255
   758
wenzelm@233
   759
(*concatenate messages, one per line, into a string*)
wenzelm@255
   760
val cat_lines = space_implode "\n";
wenzelm@233
   761
wenzelm@4212
   762
(*space_explode "." "h.e..l.lo" = ["h", "e", "", "l", "lo"]*)
wenzelm@3832
   763
fun space_explode _ "" = []
wenzelm@3832
   764
  | space_explode sep str =
wenzelm@3832
   765
      let
wenzelm@3832
   766
        fun expl chs =
wenzelm@3832
   767
          (case take_prefix (not_equal sep) chs of
wenzelm@3832
   768
            (cs, []) => [implode cs]
wenzelm@3832
   769
          | (cs, _ :: cs') => implode cs :: expl cs');
wenzelm@3832
   770
      in expl (explode str) end;
wenzelm@3832
   771
wenzelm@3832
   772
val split_lines = space_explode "\n";
wenzelm@3832
   773
wenzelm@7712
   774
(*untabify*)
wenzelm@7712
   775
fun untabify chs =
wenzelm@7712
   776
  let
wenzelm@7712
   777
    val tab_width = 8;
wenzelm@7712
   778
wenzelm@7712
   779
    fun untab (_, "\n") = (0, ["\n"])
wenzelm@9118
   780
      | untab (pos, "\t") =
wenzelm@9118
   781
          let val d = tab_width - (pos mod tab_width) in (pos + d, replicate d " ") end
wenzelm@7712
   782
      | untab (pos, c) = (pos + 1, [c]);
wenzelm@7712
   783
  in
wenzelm@7712
   784
    if not (exists (equal "\t") chs) then chs
wenzelm@7712
   785
    else flat (#2 (foldl_map untab (0, chs)))
wenzelm@7712
   786
  end;
wenzelm@7712
   787
wenzelm@5285
   788
(*append suffix*)
wenzelm@5285
   789
fun suffix sfx s = s ^ sfx;
wenzelm@5285
   790
wenzelm@5285
   791
(*remove suffix*)
wenzelm@5285
   792
fun unsuffix sfx s =
wenzelm@5285
   793
  let
wenzelm@5285
   794
    val cs = explode s;
wenzelm@5285
   795
    val prfx_len = size s - size sfx;
wenzelm@5285
   796
  in
wenzelm@5285
   797
    if prfx_len >= 0 andalso implode (drop (prfx_len, cs)) = sfx then
wenzelm@5285
   798
      implode (take (prfx_len, cs))
wenzelm@5285
   799
    else raise LIST "unsuffix"
wenzelm@5285
   800
  end;
wenzelm@5285
   801
wenzelm@10951
   802
fun replicate_string 0 _ = ""
wenzelm@10951
   803
  | replicate_string 1 a = a
wenzelm@10951
   804
  | replicate_string k a =
wenzelm@10951
   805
      if k mod 2 = 0 then replicate_string (k div 2) (a ^ a)
wenzelm@10951
   806
      else replicate_string (k div 2) (a ^ a) ^ a;
wenzelm@10951
   807
wenzelm@3832
   808
wenzelm@233
   809
wenzelm@233
   810
(** lists as sets **)
wenzelm@233
   811
wenzelm@233
   812
(*membership in a list*)
wenzelm@233
   813
fun x mem [] = false
wenzelm@233
   814
  | x mem (y :: ys) = x = y orelse x mem ys;
clasohm@0
   815
paulson@2175
   816
(*membership in a list, optimized version for ints*)
berghofe@1576
   817
fun (x:int) mem_int [] = false
berghofe@1576
   818
  | x mem_int (y :: ys) = x = y orelse x mem_int ys;
berghofe@1576
   819
paulson@2175
   820
(*membership in a list, optimized version for strings*)
berghofe@1576
   821
fun (x:string) mem_string [] = false
berghofe@1576
   822
  | x mem_string (y :: ys) = x = y orelse x mem_string ys;
berghofe@1576
   823
clasohm@0
   824
(*generalized membership test*)
wenzelm@233
   825
fun gen_mem eq (x, []) = false
wenzelm@233
   826
  | gen_mem eq (x, y :: ys) = eq (x, y) orelse gen_mem eq (x, ys);
wenzelm@233
   827
wenzelm@233
   828
wenzelm@233
   829
(*insertion into list if not already there*)
paulson@2175
   830
fun (x ins xs) = if x mem xs then xs else x :: xs;
clasohm@0
   831
paulson@2175
   832
(*insertion into list, optimized version for ints*)
paulson@2175
   833
fun (x ins_int xs) = if x mem_int xs then xs else x :: xs;
berghofe@1576
   834
paulson@2175
   835
(*insertion into list, optimized version for strings*)
paulson@2175
   836
fun (x ins_string xs) = if x mem_string xs then xs else x :: xs;
berghofe@1576
   837
clasohm@0
   838
(*generalized insertion*)
wenzelm@233
   839
fun gen_ins eq (x, xs) = if gen_mem eq (x, xs) then xs else x :: xs;
wenzelm@233
   840
wenzelm@233
   841
wenzelm@233
   842
(*union of sets represented as lists: no repetitions*)
wenzelm@233
   843
fun xs union [] = xs
wenzelm@233
   844
  | [] union ys = ys
wenzelm@233
   845
  | (x :: xs) union ys = xs union (x ins ys);
clasohm@0
   846
paulson@2175
   847
(*union of sets, optimized version for ints*)
berghofe@1576
   848
fun (xs:int list) union_int [] = xs
berghofe@1576
   849
  | [] union_int ys = ys
berghofe@1576
   850
  | (x :: xs) union_int ys = xs union_int (x ins_int ys);
berghofe@1576
   851
paulson@2175
   852
(*union of sets, optimized version for strings*)
berghofe@1576
   853
fun (xs:string list) union_string [] = xs
berghofe@1576
   854
  | [] union_string ys = ys
berghofe@1576
   855
  | (x :: xs) union_string ys = xs union_string (x ins_string ys);
berghofe@1576
   856
clasohm@0
   857
(*generalized union*)
wenzelm@233
   858
fun gen_union eq (xs, []) = xs
wenzelm@233
   859
  | gen_union eq ([], ys) = ys
wenzelm@233
   860
  | gen_union eq (x :: xs, ys) = gen_union eq (xs, gen_ins eq (x, ys));
wenzelm@233
   861
wenzelm@233
   862
wenzelm@233
   863
(*intersection*)
wenzelm@233
   864
fun [] inter ys = []
wenzelm@233
   865
  | (x :: xs) inter ys =
wenzelm@233
   866
      if x mem ys then x :: (xs inter ys) else xs inter ys;
wenzelm@233
   867
paulson@2175
   868
(*intersection, optimized version for ints*)
berghofe@1576
   869
fun ([]:int list) inter_int ys = []
berghofe@1576
   870
  | (x :: xs) inter_int ys =
berghofe@1576
   871
      if x mem_int ys then x :: (xs inter_int ys) else xs inter_int ys;
berghofe@1576
   872
paulson@2175
   873
(*intersection, optimized version for strings *)
berghofe@1576
   874
fun ([]:string list) inter_string ys = []
berghofe@1576
   875
  | (x :: xs) inter_string ys =
berghofe@1576
   876
      if x mem_string ys then x :: (xs inter_string ys) else xs inter_string ys;
berghofe@1576
   877
paulson@7090
   878
(*generalized intersection*)
paulson@7090
   879
fun gen_inter eq ([], ys) = []
wenzelm@12284
   880
  | gen_inter eq (x::xs, ys) =
paulson@7090
   881
      if gen_mem eq (x,ys) then x :: gen_inter eq (xs, ys)
wenzelm@12284
   882
                           else      gen_inter eq (xs, ys);
paulson@7090
   883
wenzelm@233
   884
wenzelm@233
   885
(*subset*)
wenzelm@233
   886
fun [] subset ys = true
wenzelm@233
   887
  | (x :: xs) subset ys = x mem ys andalso xs subset ys;
wenzelm@233
   888
paulson@2175
   889
(*subset, optimized version for ints*)
berghofe@1576
   890
fun ([]:int list) subset_int ys = true
berghofe@1576
   891
  | (x :: xs) subset_int ys = x mem_int ys andalso xs subset_int ys;
berghofe@1576
   892
paulson@2175
   893
(*subset, optimized version for strings*)
berghofe@1576
   894
fun ([]:string list) subset_string ys = true
berghofe@1576
   895
  | (x :: xs) subset_string ys = x mem_string ys andalso xs subset_string ys;
berghofe@1576
   896
wenzelm@4363
   897
(*set equality*)
wenzelm@4363
   898
fun eq_set (xs, ys) =
wenzelm@4363
   899
  xs = ys orelse (xs subset ys andalso ys subset xs);
wenzelm@4363
   900
paulson@2182
   901
(*set equality for strings*)
berghofe@1576
   902
fun eq_set_string ((xs:string list), ys) =
berghofe@1576
   903
  xs = ys orelse (xs subset_string ys andalso ys subset_string xs);
berghofe@1576
   904
paulson@2182
   905
fun gen_subset eq (xs, ys) = forall (fn x => gen_mem eq (x, ys)) xs;
paulson@2182
   906
wenzelm@265
   907
wenzelm@233
   908
(*removing an element from a list WITHOUT duplicates*)
wenzelm@233
   909
fun (y :: ys) \ x = if x = y then ys else y :: (ys \ x)
wenzelm@233
   910
  | [] \ x = [];
wenzelm@233
   911
paulson@2243
   912
fun ys \\ xs = foldl (op \) (ys,xs);
clasohm@0
   913
wenzelm@233
   914
(*removing an element from a list -- possibly WITH duplicates*)
wenzelm@233
   915
fun gen_rem eq (xs, y) = filter_out (fn x => eq (x, y)) xs;
wenzelm@12295
   916
fun gen_rems eq (xs, ys) = filter_out (fn x => gen_mem eq (x, ys)) xs;
wenzelm@233
   917
wenzelm@233
   918
wenzelm@233
   919
(*makes a list of the distinct members of the input; preserves order, takes
wenzelm@233
   920
  first of equal elements*)
wenzelm@233
   921
fun gen_distinct eq lst =
wenzelm@233
   922
  let
wenzelm@233
   923
    val memb = gen_mem eq;
clasohm@0
   924
wenzelm@233
   925
    fun dist (rev_seen, []) = rev rev_seen
wenzelm@233
   926
      | dist (rev_seen, x :: xs) =
wenzelm@233
   927
          if memb (x, rev_seen) then dist (rev_seen, xs)
wenzelm@233
   928
          else dist (x :: rev_seen, xs);
wenzelm@233
   929
  in
wenzelm@233
   930
    dist ([], lst)
wenzelm@233
   931
  end;
wenzelm@233
   932
paulson@2243
   933
fun distinct l = gen_distinct (op =) l;
wenzelm@233
   934
wenzelm@233
   935
wenzelm@233
   936
(*returns the tail beginning with the first repeated element, or []*)
wenzelm@233
   937
fun findrep [] = []
wenzelm@233
   938
  | findrep (x :: xs) = if x mem xs then x :: xs else findrep xs;
wenzelm@233
   939
wenzelm@233
   940
wenzelm@255
   941
(*returns a list containing all repeated elements exactly once; preserves
wenzelm@255
   942
  order, takes first of equal elements*)
wenzelm@255
   943
fun gen_duplicates eq lst =
wenzelm@255
   944
  let
wenzelm@255
   945
    val memb = gen_mem eq;
wenzelm@255
   946
wenzelm@255
   947
    fun dups (rev_dups, []) = rev rev_dups
wenzelm@255
   948
      | dups (rev_dups, x :: xs) =
wenzelm@255
   949
          if memb (x, rev_dups) orelse not (memb (x, xs)) then
wenzelm@255
   950
            dups (rev_dups, xs)
wenzelm@255
   951
          else dups (x :: rev_dups, xs);
wenzelm@255
   952
  in
wenzelm@255
   953
    dups ([], lst)
wenzelm@255
   954
  end;
wenzelm@255
   955
paulson@2243
   956
fun duplicates l = gen_duplicates (op =) l;
wenzelm@255
   957
wenzelm@255
   958
wenzelm@233
   959
wenzelm@233
   960
(** association lists **)
clasohm@0
   961
wenzelm@233
   962
(*association list lookup*)
wenzelm@233
   963
fun assoc ([], key) = None
wenzelm@233
   964
  | assoc ((keyi, xi) :: pairs, key) =
wenzelm@233
   965
      if key = keyi then Some xi else assoc (pairs, key);
wenzelm@233
   966
paulson@2175
   967
(*association list lookup, optimized version for ints*)
berghofe@1576
   968
fun assoc_int ([], (key:int)) = None
berghofe@1576
   969
  | assoc_int ((keyi, xi) :: pairs, key) =
berghofe@1576
   970
      if key = keyi then Some xi else assoc_int (pairs, key);
berghofe@1576
   971
paulson@2175
   972
(*association list lookup, optimized version for strings*)
berghofe@1576
   973
fun assoc_string ([], (key:string)) = None
berghofe@1576
   974
  | assoc_string ((keyi, xi) :: pairs, key) =
berghofe@1576
   975
      if key = keyi then Some xi else assoc_string (pairs, key);
berghofe@1576
   976
paulson@2175
   977
(*association list lookup, optimized version for string*ints*)
berghofe@1576
   978
fun assoc_string_int ([], (key:string*int)) = None
berghofe@1576
   979
  | assoc_string_int ((keyi, xi) :: pairs, key) =
berghofe@1576
   980
      if key = keyi then Some xi else assoc_string_int (pairs, key);
berghofe@1576
   981
wenzelm@233
   982
fun assocs ps x =
wenzelm@233
   983
  (case assoc (ps, x) of
wenzelm@233
   984
    None => []
wenzelm@233
   985
  | Some ys => ys);
wenzelm@233
   986
wenzelm@255
   987
(*two-fold association list lookup*)
wenzelm@255
   988
fun assoc2 (aal, (key1, key2)) =
wenzelm@255
   989
  (case assoc (aal, key1) of
wenzelm@255
   990
    Some al => assoc (al, key2)
wenzelm@255
   991
  | None => None);
wenzelm@255
   992
wenzelm@233
   993
(*generalized association list lookup*)
wenzelm@233
   994
fun gen_assoc eq ([], key) = None
wenzelm@233
   995
  | gen_assoc eq ((keyi, xi) :: pairs, key) =
wenzelm@233
   996
      if eq (key, keyi) then Some xi else gen_assoc eq (pairs, key);
wenzelm@233
   997
wenzelm@233
   998
(*association list update*)
wenzelm@233
   999
fun overwrite (al, p as (key, _)) =
wenzelm@233
  1000
  let fun over ((q as (keyi, _)) :: pairs) =
wenzelm@233
  1001
            if keyi = key then p :: pairs else q :: (over pairs)
wenzelm@233
  1002
        | over [] = [p]
wenzelm@233
  1003
  in over al end;
wenzelm@233
  1004
wenzelm@2522
  1005
fun gen_overwrite eq (al, p as (key, _)) =
wenzelm@2522
  1006
  let fun over ((q as (keyi, _)) :: pairs) =
wenzelm@2522
  1007
            if eq (keyi, key) then p :: pairs else q :: (over pairs)
wenzelm@2522
  1008
        | over [] = [p]
wenzelm@2522
  1009
  in over al end;
wenzelm@2522
  1010
wenzelm@233
  1011
wenzelm@12284
  1012
(* lists as tables *)
wenzelm@233
  1013
wenzelm@12284
  1014
fun gen_merge_lists _ xs [] = xs
wenzelm@12284
  1015
  | gen_merge_lists _ [] ys = ys
wenzelm@12284
  1016
  | gen_merge_lists eq xs ys = xs @ gen_rems eq (ys, xs);
clasohm@0
  1017
wenzelm@12284
  1018
fun gen_merge_lists' _ xs [] = xs
wenzelm@12284
  1019
  | gen_merge_lists' _ [] ys = ys
wenzelm@12295
  1020
  | gen_merge_lists' eq xs ys = gen_rems eq (ys, xs) @ xs;
clasohm@0
  1021
wenzelm@12284
  1022
fun merge_lists xs ys = gen_merge_lists (op =) xs ys;
wenzelm@12284
  1023
fun merge_lists' xs ys = gen_merge_lists' (op =) xs ys;
wenzelm@12284
  1024
fun merge_alists al = gen_merge_lists eq_fst al;
wenzelm@380
  1025
clasohm@0
  1026
clasohm@0
  1027
wenzelm@233
  1028
(** balanced trees **)
wenzelm@233
  1029
wenzelm@233
  1030
exception Balance;      (*indicates non-positive argument to balancing fun*)
wenzelm@233
  1031
wenzelm@233
  1032
(*balanced folding; avoids deep nesting*)
wenzelm@233
  1033
fun fold_bal f [x] = x
wenzelm@233
  1034
  | fold_bal f [] = raise Balance
wenzelm@233
  1035
  | fold_bal f xs =
wenzelm@233
  1036
      let val k = length xs div 2
wenzelm@233
  1037
      in  f (fold_bal f (take(k, xs)),
wenzelm@233
  1038
             fold_bal f (drop(k, xs)))
wenzelm@233
  1039
      end;
wenzelm@233
  1040
wenzelm@233
  1041
(*construct something of the form f(...g(...(x)...)) for balanced access*)
wenzelm@233
  1042
fun access_bal (f, g, x) n i =
wenzelm@233
  1043
  let fun acc n i =     (*1<=i<=n*)
wenzelm@233
  1044
          if n=1 then x else
wenzelm@233
  1045
          let val n2 = n div 2
wenzelm@233
  1046
          in  if i<=n2 then f (acc n2 i)
wenzelm@233
  1047
                       else g (acc (n-n2) (i-n2))
wenzelm@233
  1048
          end
wenzelm@233
  1049
  in  if 1<=i andalso i<=n then acc n i else raise Balance  end;
wenzelm@233
  1050
wenzelm@233
  1051
(*construct ALL such accesses; could try harder to share recursive calls!*)
wenzelm@233
  1052
fun accesses_bal (f, g, x) n =
wenzelm@233
  1053
  let fun acc n =
wenzelm@233
  1054
          if n=1 then [x] else
wenzelm@233
  1055
          let val n2 = n div 2
wenzelm@233
  1056
              val acc2 = acc n2
wenzelm@233
  1057
          in  if n-n2=n2 then map f acc2 @ map g acc2
wenzelm@233
  1058
                         else map f acc2 @ map g (acc (n-n2)) end
wenzelm@233
  1059
  in  if 1<=n then acc n else raise Balance  end;
wenzelm@233
  1060
wenzelm@233
  1061
wenzelm@233
  1062
wenzelm@2506
  1063
(** orders **)
wenzelm@2506
  1064
wenzelm@2506
  1065
datatype order = LESS | EQUAL | GREATER;
wenzelm@2506
  1066
wenzelm@4445
  1067
fun rev_order LESS = GREATER
wenzelm@4445
  1068
  | rev_order EQUAL = EQUAL
wenzelm@4445
  1069
  | rev_order GREATER = LESS;
wenzelm@4445
  1070
wenzelm@4479
  1071
(*assume rel is a linear strict order*)
wenzelm@4445
  1072
fun make_ord rel (x, y) =
wenzelm@4445
  1073
  if rel (x, y) then LESS
wenzelm@4445
  1074
  else if rel (y, x) then GREATER
wenzelm@4445
  1075
  else EQUAL;
wenzelm@4445
  1076
wenzelm@4343
  1077
fun int_ord (i, j: int) =
wenzelm@2506
  1078
  if i < j then LESS
wenzelm@2506
  1079
  else if i = j then EQUAL
wenzelm@2506
  1080
  else GREATER;
wenzelm@2506
  1081
wenzelm@4343
  1082
fun string_ord (a, b: string) =
wenzelm@2506
  1083
  if a < b then LESS
wenzelm@2506
  1084
  else if a = b then EQUAL
wenzelm@2506
  1085
  else GREATER;
wenzelm@2506
  1086
wenzelm@4343
  1087
(*lexicographic product*)
wenzelm@4343
  1088
fun prod_ord a_ord b_ord ((x, y), (x', y')) =
wenzelm@4343
  1089
  (case a_ord (x, x') of EQUAL => b_ord (y, y') | ord => ord);
wenzelm@4343
  1090
wenzelm@4343
  1091
(*dictionary order -- in general NOT well-founded!*)
wenzelm@4343
  1092
fun dict_ord _ ([], []) = EQUAL
wenzelm@4343
  1093
  | dict_ord _ ([], _ :: _) = LESS
wenzelm@4343
  1094
  | dict_ord _ (_ :: _, []) = GREATER
wenzelm@4343
  1095
  | dict_ord elem_ord (x :: xs, y :: ys) =
wenzelm@4343
  1096
      (case elem_ord (x, y) of EQUAL => dict_ord elem_ord (xs, ys) | ord => ord);
wenzelm@4343
  1097
wenzelm@4343
  1098
(*lexicographic product of lists*)
wenzelm@4343
  1099
fun list_ord elem_ord (xs, ys) =
wenzelm@4343
  1100
  prod_ord int_ord (dict_ord elem_ord) ((length xs, xs), (length ys, ys));
wenzelm@4343
  1101
wenzelm@2506
  1102
wenzelm@4621
  1103
(* sorting *)
wenzelm@4621
  1104
wenzelm@4621
  1105
(*quicksort (stable, i.e. does not reorder equal elements)*)
wenzelm@4621
  1106
fun sort ord =
wenzelm@4621
  1107
  let
wenzelm@4621
  1108
    fun qsort xs =
wenzelm@4621
  1109
      let val len = length xs in
wenzelm@4621
  1110
        if len <= 1 then xs
wenzelm@4621
  1111
        else
wenzelm@4621
  1112
          let val (lts, eqs, gts) = part (nth_elem (len div 2, xs)) xs in
wenzelm@4621
  1113
            qsort lts @ eqs @ qsort gts
wenzelm@4621
  1114
          end
wenzelm@4621
  1115
      end
wenzelm@4621
  1116
    and part _ [] = ([], [], [])
wenzelm@4621
  1117
      | part pivot (x :: xs) = add (ord (x, pivot)) x (part pivot xs)
wenzelm@4621
  1118
    and add LESS x (lts, eqs, gts) = (x :: lts, eqs, gts)
wenzelm@4621
  1119
      | add EQUAL x (lts, eqs, gts) = (lts, x :: eqs, gts)
wenzelm@4621
  1120
      | add GREATER x (lts, eqs, gts) = (lts, eqs, x :: gts);
wenzelm@4621
  1121
  in qsort end;
wenzelm@4621
  1122
wenzelm@4621
  1123
(*sort strings*)
wenzelm@4621
  1124
val sort_strings = sort string_ord;
wenzelm@4621
  1125
fun sort_wrt sel xs = sort (string_ord o pairself sel) xs;
wenzelm@4621
  1126
berghofe@11514
  1127
fun unique_strings ([]: string list) = []
berghofe@11514
  1128
  | unique_strings [x] = [x]
berghofe@11514
  1129
  | unique_strings (x :: y :: ys) =
berghofe@11514
  1130
      if x = y then unique_strings (y :: ys)
berghofe@11514
  1131
      else x :: unique_strings (y :: ys);
wenzelm@4621
  1132
wenzelm@2506
  1133
wenzelm@3525
  1134
(** input / output and diagnostics **)
wenzelm@233
  1135
paulson@2243
  1136
val cd = OS.FileSys.chDir;
wenzelm@2317
  1137
val pwd = OS.FileSys.getDir;
paulson@2243
  1138
wenzelm@11853
  1139
fun std_output s = (TextIO.output (TextIO.stdOut, s); TextIO.flushOut TextIO.stdOut);
wenzelm@11853
  1140
fun std_error s = (TextIO.output (TextIO.stdErr, s); TextIO.flushOut TextIO.stdErr);
wenzelm@3525
  1141
wenzelm@5942
  1142
fun prefix_lines prfx txt =
wenzelm@5949
  1143
  txt |> split_lines |> map (fn s => prfx ^ s) |> cat_lines;
wenzelm@3525
  1144
wenzelm@3525
  1145
(*hooks for output channels: normal, warning, error*)
wenzelm@5966
  1146
val writeln_fn = ref (std_output o suffix "\n");
wenzelm@9774
  1147
val priority_fn = ref (fn s => ! writeln_fn s);
wenzelm@12260
  1148
val tracing_fn = ref (fn s => ! writeln_fn s);
wenzelm@5949
  1149
val warning_fn = ref (std_output o suffix "\n" o prefix_lines "### ");
wenzelm@5949
  1150
val error_fn = ref (std_output o suffix "\n" o prefix_lines "*** ");
berghofe@1580
  1151
wenzelm@5966
  1152
fun writeln s = ! writeln_fn s;
wenzelm@9774
  1153
fun priority s = ! priority_fn s;
wenzelm@12260
  1154
fun tracing s = ! tracing_fn s;
wenzelm@5942
  1155
fun warning s = ! warning_fn s;
wenzelm@233
  1156
wenzelm@233
  1157
(*print error message and abort to top level*)
wenzelm@6959
  1158
wenzelm@5949
  1159
fun error_msg s = ! error_fn s;
wenzelm@3553
  1160
fun error s = (error_msg s; raise ERROR);
wenzelm@4849
  1161
fun sys_error msg = error ("## SYSTEM ERROR ##\n" ^ msg);
wenzelm@233
  1162
wenzelm@233
  1163
fun assert p msg = if p then () else error msg;
wenzelm@233
  1164
fun deny p msg = if p then error msg else ();
wenzelm@233
  1165
lcp@544
  1166
(*Assert pred for every member of l, generating a message if pred fails*)
wenzelm@4212
  1167
fun assert_all pred l msg_fn =
lcp@544
  1168
  let fun asl [] = ()
wenzelm@4212
  1169
        | asl (x::xs) = if pred x then asl xs else error (msg_fn x)
wenzelm@4212
  1170
  in asl l end;
wenzelm@233
  1171
wenzelm@3624
  1172
wenzelm@4212
  1173
(* handle errors capturing messages *)
wenzelm@3699
  1174
wenzelm@3699
  1175
datatype 'a error =
wenzelm@3699
  1176
  Error of string |
wenzelm@3699
  1177
  OK of 'a;
wenzelm@3699
  1178
wenzelm@4248
  1179
fun get_error (Error msg) = Some msg
wenzelm@4248
  1180
  | get_error _ = None;
wenzelm@4248
  1181
wenzelm@4248
  1182
fun get_ok (OK x) = Some x
wenzelm@4248
  1183
  | get_ok _ = None;
wenzelm@4248
  1184
wenzelm@5037
  1185
datatype 'a result =
wenzelm@5037
  1186
  Result of 'a |
wenzelm@5037
  1187
  Exn of exn;
wenzelm@5037
  1188
wenzelm@3699
  1189
fun handle_error f x =
wenzelm@3699
  1190
  let
wenzelm@4945
  1191
    val buffer = ref ([]: string list);
wenzelm@4945
  1192
    fun capture s = buffer := ! buffer @ [s];
wenzelm@5037
  1193
    fun err_msg () = if not (null (! buffer)) then error_msg (cat_lines (! buffer)) else ();
wenzelm@3699
  1194
  in
wenzelm@5037
  1195
    (case Result (setmp error_fn capture f x) handle exn => Exn exn of
wenzelm@5037
  1196
      Result y => (err_msg (); OK y)
wenzelm@5037
  1197
    | Exn ERROR => Error (cat_lines (! buffer))
wenzelm@5037
  1198
    | Exn exn => (err_msg (); raise exn))
wenzelm@3624
  1199
  end;
wenzelm@3624
  1200
wenzelm@3624
  1201
wenzelm@5037
  1202
(* transform ERROR into ERROR_MESSAGE *)
wenzelm@4923
  1203
wenzelm@4923
  1204
exception ERROR_MESSAGE of string;
wenzelm@4923
  1205
wenzelm@4923
  1206
fun transform_error f x =
wenzelm@4923
  1207
  (case handle_error f x of
wenzelm@4923
  1208
    OK y => y
wenzelm@4923
  1209
  | Error msg => raise ERROR_MESSAGE msg);
wenzelm@4923
  1210
wenzelm@4923
  1211
wenzelm@5904
  1212
(* transform any exception, including ERROR *)
wenzelm@5904
  1213
wenzelm@5904
  1214
fun transform_failure exn f x =
wenzelm@5904
  1215
  transform_error f x handle e => raise exn e;
wenzelm@5904
  1216
wenzelm@5904
  1217
wenzelm@233
  1218
wenzelm@233
  1219
(** timing **)
wenzelm@233
  1220
paulson@4326
  1221
(*a conditional timing function: applies f to () and, if the flag is true,
wenzelm@8999
  1222
  prints its runtime on warning channel*)
paulson@4326
  1223
fun cond_timeit flag f =
paulson@4326
  1224
  if flag then
paulson@4326
  1225
    let val start = startTiming()
paulson@4326
  1226
        val result = f ()
wenzelm@8999
  1227
    in warning (endTiming start);  result end
paulson@4326
  1228
  else f ();
paulson@4326
  1229
wenzelm@233
  1230
(*unconditional timing function*)
paulson@2243
  1231
fun timeit x = cond_timeit true x;
wenzelm@233
  1232
wenzelm@233
  1233
(*timed application function*)
wenzelm@233
  1234
fun timeap f x = timeit (fn () => f x);
wenzelm@233
  1235
wenzelm@8999
  1236
(*global timing mode*)
wenzelm@8999
  1237
val timing = ref false;
wenzelm@8999
  1238
berghofe@3606
  1239
wenzelm@233
  1240
nipkow@10692
  1241
(** rational numbers **)
nipkow@10692
  1242
nipkow@10692
  1243
datatype rat = Rat of bool * int * int
nipkow@10692
  1244
nipkow@10692
  1245
fun rep_rat(Rat(a,p,q)) = (if a then p else ~p,q)
nipkow@10692
  1246
nipkow@10692
  1247
fun ratnorm(a,p,q) = if p=0 then Rat(a,0,1) else
nipkow@10692
  1248
  let val absp = abs p
nipkow@10692
  1249
      val m = gcd(absp,q)
nipkow@10692
  1250
  in Rat(a = (0 <= p), absp div m, q div m) end;
nipkow@10692
  1251
nipkow@10692
  1252
fun ratadd(Rat(a,p,q),Rat(b,r,s)) =
nipkow@10692
  1253
  let val den = lcm(q,s)
nipkow@10692
  1254
      val p = p*(den div q) and r = r*(den div s)
nipkow@10692
  1255
      val num = (if a then p else ~p) + (if b then r else ~r)
nipkow@10692
  1256
  in ratnorm(true,num,den) end;
nipkow@10692
  1257
nipkow@10692
  1258
fun ratmul(Rat(a,p,q),Rat(b,r,s)) = ratnorm(a=b,p*r,q*s)
nipkow@10692
  1259
nipkow@10692
  1260
fun ratinv(Rat(a,p,q)) = if p=0 then error("ratinv") else Rat(a,q,p)
nipkow@10692
  1261
nipkow@10692
  1262
fun int_ratdiv(p,q) =
nipkow@10692
  1263
  if q=0 then error("int_ratdiv") else ratnorm(0<=q, p, abs q)
nipkow@10692
  1264
nipkow@10692
  1265
fun ratneg(Rat(b,p,q)) = Rat(not b,p,q);
nipkow@10692
  1266
nipkow@10692
  1267
fun rat_of_int i = if i < 0 then Rat(false,abs i,1) else Rat(true,i,1);
nipkow@10692
  1268
nipkow@10692
  1269
wenzelm@4621
  1270
(** misc **)
wenzelm@233
  1271
wenzelm@9830
  1272
fun overwrite_warn (args as (alist, (a, _))) msg =
wenzelm@9830
  1273
 (if is_none (assoc (alist, a)) then () else warning msg;
wenzelm@9830
  1274
  overwrite args);
nipkow@9721
  1275
wenzelm@233
  1276
(*use the keyfun to make a list of (x, key) pairs*)
clasohm@0
  1277
fun make_keylist (keyfun: 'a->'b) : 'a list -> ('a * 'b) list =
wenzelm@233
  1278
  let fun keypair x = (x, keyfun x)
wenzelm@233
  1279
  in map keypair end;
clasohm@0
  1280
wenzelm@233
  1281
(*given a list of (x, key) pairs and a searchkey
clasohm@0
  1282
  return the list of xs from each pair whose key equals searchkey*)
clasohm@0
  1283
fun keyfilter [] searchkey = []
wenzelm@233
  1284
  | keyfilter ((x, key) :: pairs) searchkey =
wenzelm@233
  1285
      if key = searchkey then x :: keyfilter pairs searchkey
wenzelm@233
  1286
      else keyfilter pairs searchkey;
clasohm@0
  1287
clasohm@0
  1288
clasohm@0
  1289
(*Partition list into elements that satisfy predicate and those that don't.
wenzelm@233
  1290
  Preserves order of elements in both lists.*)
clasohm@0
  1291
fun partition (pred: 'a->bool) (ys: 'a list) : ('a list * 'a list) =
clasohm@0
  1292
    let fun part ([], answer) = answer
wenzelm@233
  1293
          | part (x::xs, (ys, ns)) = if pred(x)
wenzelm@233
  1294
            then  part (xs, (x::ys, ns))
wenzelm@233
  1295
            else  part (xs, (ys, x::ns))
wenzelm@233
  1296
    in  part (rev ys, ([], []))  end;
clasohm@0
  1297
clasohm@0
  1298
clasohm@0
  1299
fun partition_eq (eq:'a * 'a -> bool) =
clasohm@0
  1300
    let fun part [] = []
wenzelm@233
  1301
          | part (x::ys) = let val (xs, xs') = partition (apl(x, eq)) ys
wenzelm@233
  1302
                           in (x::xs)::(part xs') end
clasohm@0
  1303
    in part end;
clasohm@0
  1304
clasohm@0
  1305
wenzelm@233
  1306
(*Partition a list into buckets  [ bi, b(i+1), ..., bj ]
clasohm@0
  1307
   putting x in bk if p(k)(x) holds.  Preserve order of elements if possible.*)
clasohm@0
  1308
fun partition_list p i j =
wenzelm@233
  1309
  let fun part k xs =
wenzelm@233
  1310
            if k>j then
clasohm@0
  1311
              (case xs of [] => []
clasohm@0
  1312
                         | _ => raise LIST "partition_list")
clasohm@0
  1313
            else
wenzelm@233
  1314
            let val (ns, rest) = partition (p k) xs;
wenzelm@233
  1315
            in  ns :: part(k+1)rest  end
clasohm@0
  1316
  in  part i end;
clasohm@0
  1317
clasohm@0
  1318
wenzelm@233
  1319
(* transitive closure (not Warshall's algorithm) *)
clasohm@0
  1320
wenzelm@233
  1321
fun transitive_closure [] = []
wenzelm@233
  1322
  | transitive_closure ((x, ys)::ps) =
wenzelm@233
  1323
      let val qs = transitive_closure ps
paulson@2182
  1324
          val zs = foldl (fn (zs, y) => assocs qs y union_string zs) (ys, ys)
wenzelm@5904
  1325
          fun step(u, us) = (u, if x mem_string us then zs union_string us
paulson@2243
  1326
                                else us)
wenzelm@233
  1327
      in (x, zs) :: map step qs end;
clasohm@0
  1328
clasohm@0
  1329
wenzelm@233
  1330
(* generating identifiers *)
clasohm@0
  1331
paulson@4063
  1332
(** Freshly generated identifiers; supplied prefix MUST start with a letter **)
clasohm@0
  1333
local
paulson@4063
  1334
(*Maps 0-63 to A-Z, a-z, 0-9 or _ or ' for generating random identifiers*)
paulson@4063
  1335
fun char i =      if i<26 then chr (ord "A" + i)
wenzelm@5904
  1336
             else if i<52 then chr (ord "a" + i - 26)
wenzelm@5904
  1337
             else if i<62 then chr (ord"0" + i - 52)
wenzelm@5904
  1338
             else if i=62 then "_"
wenzelm@5904
  1339
             else  (*i=63*)    "'";
paulson@4063
  1340
paulson@4063
  1341
val charVec = Vector.tabulate (64, char);
paulson@4063
  1342
wenzelm@5904
  1343
fun newid n =
wenzelm@5904
  1344
  let
wenzelm@4284
  1345
  in  implode (map (fn i => Vector.sub(charVec,i)) (radixpand (64,n)))  end;
paulson@2003
  1346
wenzelm@4284
  1347
val seedr = ref 0;
clasohm@0
  1348
paulson@4063
  1349
in
wenzelm@4284
  1350
wenzelm@12346
  1351
fun gensym pre = pre ^ (#1(newid (!seedr), inc seedr));
paulson@2003
  1352
paulson@4063
  1353
end;
paulson@4063
  1354
paulson@4063
  1355
paulson@4063
  1356
local
paulson@4063
  1357
(*Identifies those character codes legal in identifiers.
paulson@4063
  1358
  chould use Basis Library character functions if Poly/ML provided characters*)
wenzelm@5904
  1359
fun idCode k = (ord "a" <= k andalso k < ord "z") orelse
paulson@4063
  1360
               (ord "A" <= k andalso k < ord "Z") orelse
paulson@4063
  1361
               (ord "0" <= k andalso k < ord "9");
paulson@4063
  1362
paulson@4063
  1363
val idCodeVec = Vector.tabulate (256, idCode);
paulson@4063
  1364
paulson@4063
  1365
in
paulson@2003
  1366
clasohm@0
  1367
(*Increment a list of letters like a reversed base 26 number.
wenzelm@233
  1368
  If head is "z", bumps chars in tail.
clasohm@0
  1369
  Digits are incremented as if they were integers.
clasohm@0
  1370
  "_" and "'" are not changed.
wenzelm@233
  1371
  For making variants of identifiers.*)
clasohm@0
  1372
wenzelm@5904
  1373
fun bump_int_list(c::cs) =
wenzelm@5904
  1374
        if c="9" then "0" :: bump_int_list cs
wenzelm@5904
  1375
        else
paulson@4063
  1376
        if "0" <= c andalso c < "9" then chr(ord(c)+1) :: cs
wenzelm@233
  1377
        else "1" :: c :: cs
clasohm@0
  1378
  | bump_int_list([]) = error("bump_int_list: not an identifier");
clasohm@0
  1379
wenzelm@233
  1380
fun bump_list([], d) = [d]
wenzelm@233
  1381
  | bump_list(["'"], d) = [d, "'"]
wenzelm@233
  1382
  | bump_list("z"::cs, _) = "a" :: bump_list(cs, "a")
wenzelm@233
  1383
  | bump_list("Z"::cs, _) = "A" :: bump_list(cs, "A")
wenzelm@233
  1384
  | bump_list("9"::cs, _) = "0" :: bump_int_list cs
wenzelm@5904
  1385
  | bump_list(c::cs, _) =
paulson@4063
  1386
        let val k = ord(c)
wenzelm@5904
  1387
        in if Vector.sub(idCodeVec,k) then chr(k+1) :: cs
wenzelm@5904
  1388
           else
wenzelm@5904
  1389
           if c="'" orelse c="_" then c :: bump_list(cs, "")
wenzelm@5904
  1390
           else error("bump_list: not legal in identifier: " ^
wenzelm@5904
  1391
                      implode(rev(c::cs)))
wenzelm@233
  1392
        end;
clasohm@0
  1393
clasohm@0
  1394
end;
clasohm@0
  1395
wenzelm@233
  1396
fun bump_string s : string = implode (rev (bump_list(rev(explode s), "")));
wenzelm@41
  1397
wenzelm@41
  1398
wenzelm@233
  1399
(* lexical scanning *)
clasohm@0
  1400
wenzelm@233
  1401
(*scan a list of characters into "words" composed of "letters" (recognized by
wenzelm@233
  1402
  is_let) and separated by any number of non-"letters"*)
wenzelm@233
  1403
fun scanwords is_let cs =
clasohm@0
  1404
  let fun scan1 [] = []
wenzelm@233
  1405
        | scan1 cs =
wenzelm@233
  1406
            let val (lets, rest) = take_prefix is_let cs
wenzelm@233
  1407
            in implode lets :: scanwords is_let rest end;
wenzelm@233
  1408
  in scan1 (#2 (take_prefix (not o is_let) cs)) end;
clasohm@24
  1409
wenzelm@4212
  1410
wenzelm@4212
  1411
wenzelm@4212
  1412
(* Variable-branching trees: for proof terms etc. *)
wenzelm@4212
  1413
datatype 'a mtree = Join of 'a * 'a mtree list;
wenzelm@4212
  1414
wenzelm@4212
  1415
clasohm@1364
  1416
end;
clasohm@1364
  1417
clasohm@1364
  1418
open Library;