src/HOL/Tools/Nitpick/nitpick.ML
author blanchet
Mon Dec 07 13:40:45 2009 +0100 (2009-12-07 ago)
changeset 34038 a2736debeabd
parent 33982 1ae222745c4a
child 34039 1fba360b5443
permissions -rw-r--r--
make Nitpick output the message "Hint: Maybe you forgot a type constraint?" only for syntactic classes
blanchet@33982
     1
(*  Title:      HOL/Tools/Nitpick/nitpick.ML
blanchet@33192
     2
    Author:     Jasmin Blanchette, TU Muenchen
blanchet@33192
     3
    Copyright   2008, 2009
blanchet@33192
     4
blanchet@33192
     5
Finite model generation for HOL formulas using Kodkod.
blanchet@33192
     6
*)
blanchet@33192
     7
blanchet@33192
     8
signature NITPICK =
blanchet@33192
     9
sig
blanchet@33705
    10
  type styp = Nitpick_Util.styp
blanchet@33192
    11
  type params = {
blanchet@33192
    12
    cards_assigns: (typ option * int list) list,
blanchet@33192
    13
    maxes_assigns: (styp option * int list) list,
blanchet@33192
    14
    iters_assigns: (styp option * int list) list,
blanchet@33192
    15
    bisim_depths: int list,
blanchet@33192
    16
    boxes: (typ option * bool option) list,
blanchet@33192
    17
    monos: (typ option * bool option) list,
blanchet@33192
    18
    wfs: (styp option * bool option) list,
blanchet@33192
    19
    sat_solver: string,
blanchet@33192
    20
    blocking: bool,
blanchet@33192
    21
    falsify: bool,
blanchet@33192
    22
    debug: bool,
blanchet@33192
    23
    verbose: bool,
blanchet@33192
    24
    overlord: bool,
blanchet@33192
    25
    user_axioms: bool option,
blanchet@33192
    26
    assms: bool,
blanchet@33556
    27
    merge_type_vars: bool,
blanchet@33192
    28
    destroy_constrs: bool,
blanchet@33192
    29
    specialize: bool,
blanchet@33192
    30
    skolemize: bool,
blanchet@33192
    31
    star_linear_preds: bool,
blanchet@33192
    32
    uncurry: bool,
blanchet@33192
    33
    fast_descrs: bool,
blanchet@33192
    34
    peephole_optim: bool,
blanchet@33192
    35
    timeout: Time.time option,
blanchet@33192
    36
    tac_timeout: Time.time option,
blanchet@33192
    37
    sym_break: int,
blanchet@33192
    38
    sharing_depth: int,
blanchet@33192
    39
    flatten_props: bool,
blanchet@33192
    40
    max_threads: int,
blanchet@33192
    41
    show_skolems: bool,
blanchet@33192
    42
    show_datatypes: bool,
blanchet@33192
    43
    show_consts: bool,
blanchet@33192
    44
    evals: term list,
blanchet@33192
    45
    formats: (term option * int list) list,
blanchet@33192
    46
    max_potential: int,
blanchet@33192
    47
    max_genuine: int,
blanchet@33192
    48
    check_potential: bool,
blanchet@33192
    49
    check_genuine: bool,
blanchet@33192
    50
    batch_size: int,
blanchet@33192
    51
    expect: string}
blanchet@33192
    52
blanchet@33192
    53
  val register_frac_type : string -> (string * string) list -> theory -> theory
blanchet@33192
    54
  val unregister_frac_type : string -> theory -> theory
blanchet@33192
    55
  val register_codatatype : typ -> string -> styp list -> theory -> theory
blanchet@33192
    56
  val unregister_codatatype : typ -> theory -> theory
blanchet@33192
    57
  val pick_nits_in_term :
blanchet@33192
    58
    Proof.state -> params -> bool -> term list -> term -> string * Proof.state
blanchet@33192
    59
  val pick_nits_in_subgoal :
blanchet@33192
    60
    Proof.state -> params -> bool -> int -> string * Proof.state
blanchet@33192
    61
end;
blanchet@33192
    62
blanchet@33192
    63
structure Nitpick : NITPICK =
blanchet@33192
    64
struct
blanchet@33192
    65
blanchet@33232
    66
open Nitpick_Util
blanchet@33232
    67
open Nitpick_HOL
blanchet@33232
    68
open Nitpick_Mono
blanchet@33232
    69
open Nitpick_Scope
blanchet@33232
    70
open Nitpick_Peephole
blanchet@33232
    71
open Nitpick_Rep
blanchet@33232
    72
open Nitpick_Nut
blanchet@33232
    73
open Nitpick_Kodkod
blanchet@33232
    74
open Nitpick_Model
blanchet@33192
    75
blanchet@33192
    76
type params = {
blanchet@33192
    77
  cards_assigns: (typ option * int list) list,
blanchet@33192
    78
  maxes_assigns: (styp option * int list) list,
blanchet@33192
    79
  iters_assigns: (styp option * int list) list,
blanchet@33192
    80
  bisim_depths: int list,
blanchet@33192
    81
  boxes: (typ option * bool option) list,
blanchet@33192
    82
  monos: (typ option * bool option) list,
blanchet@33192
    83
  wfs: (styp option * bool option) list,
blanchet@33192
    84
  sat_solver: string,
blanchet@33192
    85
  blocking: bool,
blanchet@33192
    86
  falsify: bool,
blanchet@33192
    87
  debug: bool,
blanchet@33192
    88
  verbose: bool,
blanchet@33192
    89
  overlord: bool,
blanchet@33192
    90
  user_axioms: bool option,
blanchet@33192
    91
  assms: bool,
blanchet@33556
    92
  merge_type_vars: bool,
blanchet@33192
    93
  destroy_constrs: bool,
blanchet@33192
    94
  specialize: bool,
blanchet@33192
    95
  skolemize: bool,
blanchet@33192
    96
  star_linear_preds: bool,
blanchet@33192
    97
  uncurry: bool,
blanchet@33192
    98
  fast_descrs: bool,
blanchet@33192
    99
  peephole_optim: bool,
blanchet@33192
   100
  timeout: Time.time option,
blanchet@33192
   101
  tac_timeout: Time.time option,
blanchet@33192
   102
  sym_break: int,
blanchet@33192
   103
  sharing_depth: int,
blanchet@33192
   104
  flatten_props: bool,
blanchet@33192
   105
  max_threads: int,
blanchet@33192
   106
  show_skolems: bool,
blanchet@33192
   107
  show_datatypes: bool,
blanchet@33192
   108
  show_consts: bool,
blanchet@33192
   109
  evals: term list,
blanchet@33192
   110
  formats: (term option * int list) list,
blanchet@33192
   111
  max_potential: int,
blanchet@33192
   112
  max_genuine: int,
blanchet@33192
   113
  check_potential: bool,
blanchet@33192
   114
  check_genuine: bool,
blanchet@33192
   115
  batch_size: int,
blanchet@33192
   116
  expect: string}
blanchet@33192
   117
blanchet@33192
   118
type problem_extension = {
blanchet@33192
   119
  free_names: nut list,
blanchet@33192
   120
  sel_names: nut list,
blanchet@33192
   121
  nonsel_names: nut list,
blanchet@33192
   122
  rel_table: nut NameTable.table,
blanchet@33192
   123
  liberal: bool,
blanchet@33192
   124
  scope: scope,
blanchet@33192
   125
  core: Kodkod.formula,
blanchet@33192
   126
  defs: Kodkod.formula list}
blanchet@33192
   127
blanchet@33192
   128
type rich_problem = Kodkod.problem * problem_extension
blanchet@33192
   129
blanchet@33192
   130
(* Proof.context -> string -> term list -> Pretty.T list *)
blanchet@33192
   131
fun pretties_for_formulas _ _ [] = []
blanchet@33192
   132
  | pretties_for_formulas ctxt s ts =
blanchet@33192
   133
    [Pretty.str (s ^ plural_s_for_list ts ^ ":"),
blanchet@33192
   134
     Pretty.indent indent_size (Pretty.chunks
blanchet@33192
   135
         (map2 (fn j => fn t =>
blanchet@33192
   136
                   Pretty.block [t |> shorten_const_names_in_term
blanchet@33192
   137
                                   |> Syntax.pretty_term ctxt,
blanchet@33192
   138
                                 Pretty.str (if j = 1 then "." else ";")])
blanchet@33192
   139
               (length ts downto 1) ts))]
blanchet@33192
   140
blanchet@33568
   141
(* unit -> string *)
blanchet@33568
   142
fun install_kodkodi_message () =
blanchet@33568
   143
  "Nitpick requires the external Java program Kodkodi. To install it, download \
blanchet@33568
   144
  \the package from Isabelle's web page and add the \"kodkodi-x.y.z\" \
blanchet@33568
   145
  \directory's full path to \"" ^
blanchet@33568
   146
  Path.implode (Path.expand (Path.appends
blanchet@33568
   147
      (Path.variable "ISABELLE_HOME_USER" ::
blanchet@33568
   148
       map Path.basic ["etc", "components"]))) ^ "\"."
blanchet@33568
   149
blanchet@33192
   150
val max_liberal_delay_ms = 200
blanchet@33192
   151
val max_liberal_delay_percent = 2
blanchet@33192
   152
blanchet@33192
   153
(* Time.time option -> int *)
blanchet@33192
   154
fun liberal_delay_for_timeout NONE = max_liberal_delay_ms
blanchet@33192
   155
  | liberal_delay_for_timeout (SOME timeout) =
blanchet@33192
   156
    Int.max (0, Int.min (max_liberal_delay_ms,
blanchet@33192
   157
                         Time.toMilliseconds timeout
blanchet@33192
   158
                         * max_liberal_delay_percent div 100))
blanchet@33192
   159
blanchet@33192
   160
(* Time.time option -> bool *)
blanchet@33192
   161
fun passed_deadline NONE = false
blanchet@33192
   162
  | passed_deadline (SOME time) = Time.compare (Time.now (), time) <> LESS
blanchet@33192
   163
blanchet@33192
   164
(* ('a * bool option) list -> bool *)
blanchet@33192
   165
fun none_true asgns = forall (not_equal (SOME true) o snd) asgns
blanchet@33192
   166
blanchet@34038
   167
val syntactic_sorts =
blanchet@34038
   168
  @{sort "{default,zero,one,plus,minus,uminus,times,inverse,abs,sgn,ord,eq}"} @
blanchet@34038
   169
  @{sort number}
blanchet@34038
   170
(* typ -> bool *)
blanchet@34038
   171
fun has_tfree_syntactic_sort (TFree (_, S as _ :: _)) =
blanchet@34038
   172
    subset (op =) (S, syntactic_sorts)
blanchet@34038
   173
  | has_tfree_syntactic_sort _ = false
blanchet@34038
   174
(* term -> bool *)
blanchet@34038
   175
val has_syntactic_sorts = exists_type (exists_subtype has_tfree_syntactic_sort)
blanchet@33192
   176
blanchet@33568
   177
(* (unit -> string) -> Pretty.T *)
blanchet@33568
   178
fun plazy f = Pretty.blk (0, pstrs (f ()))
blanchet@33568
   179
blanchet@33192
   180
(* Time.time -> Proof.state -> params -> bool -> term -> string * Proof.state *)
blanchet@33192
   181
fun pick_them_nits_in_term deadline state (params : params) auto orig_assm_ts
blanchet@33192
   182
                           orig_t =
blanchet@33192
   183
  let
blanchet@33192
   184
    val timer = Timer.startRealTimer ()
blanchet@33192
   185
    val thy = Proof.theory_of state
blanchet@33192
   186
    val ctxt = Proof.context_of state
blanchet@33192
   187
    val {cards_assigns, maxes_assigns, iters_assigns, bisim_depths, boxes,
blanchet@33192
   188
         monos, wfs, sat_solver, blocking, falsify, debug, verbose, overlord,
blanchet@33556
   189
         user_axioms, assms, merge_type_vars, destroy_constrs, specialize,
blanchet@33192
   190
         skolemize, star_linear_preds, uncurry, fast_descrs, peephole_optim,
blanchet@33192
   191
         tac_timeout, sym_break, sharing_depth, flatten_props, max_threads,
blanchet@33192
   192
         show_skolems, show_datatypes, show_consts, evals, formats,
blanchet@33192
   193
         max_potential, max_genuine, check_potential, check_genuine, batch_size,
blanchet@33192
   194
         ...} =
blanchet@33192
   195
      params
blanchet@33192
   196
    val state_ref = Unsynchronized.ref state
blanchet@33192
   197
    (* Pretty.T -> unit *)
blanchet@33192
   198
    val pprint =
blanchet@33192
   199
      if auto then
blanchet@33192
   200
        Unsynchronized.change state_ref o Proof.goal_message o K
blanchet@33561
   201
        o Pretty.chunks o cons (Pretty.str "") o single
blanchet@33192
   202
        o Pretty.mark Markup.hilite
blanchet@33192
   203
      else
blanchet@33192
   204
        priority o Pretty.string_of
blanchet@33192
   205
    (* (unit -> Pretty.T) -> unit *)
blanchet@33192
   206
    fun pprint_m f = () |> not auto ? pprint o f
blanchet@33192
   207
    fun pprint_v f = () |> verbose ? pprint o f
blanchet@33192
   208
    fun pprint_d f = () |> debug ? pprint o f
blanchet@33192
   209
    (* string -> unit *)
blanchet@33192
   210
    val print = pprint o curry Pretty.blk 0 o pstrs
blanchet@33192
   211
    (* (unit -> string) -> unit *)
blanchet@33568
   212
    val print_m = pprint_m o K o plazy
blanchet@33568
   213
    val print_v = pprint_v o K o plazy
blanchet@33568
   214
    val print_d = pprint_d o K o plazy
blanchet@33192
   215
blanchet@33192
   216
    (* unit -> unit *)
blanchet@33192
   217
    fun check_deadline () =
blanchet@33192
   218
      if debug andalso passed_deadline deadline then raise TimeLimit.TimeOut
blanchet@33192
   219
      else ()
blanchet@33192
   220
    (* unit -> 'a *)
blanchet@33192
   221
    fun do_interrupted () =
blanchet@33192
   222
      if passed_deadline deadline then raise TimeLimit.TimeOut
blanchet@33192
   223
      else raise Interrupt
blanchet@33192
   224
blanchet@33192
   225
    val _ = print_m (K "Nitpicking...")
blanchet@33192
   226
    val neg_t = if falsify then Logic.mk_implies (orig_t, @{prop False})
blanchet@33192
   227
                else orig_t
blanchet@33192
   228
    val assms_t = if assms orelse auto then
blanchet@33192
   229
                    Logic.mk_conjunction_list (neg_t :: orig_assm_ts)
blanchet@33192
   230
                  else
blanchet@33192
   231
                    neg_t
blanchet@33192
   232
    val (assms_t, evals) =
blanchet@33705
   233
      assms_t :: evals |> merge_type_vars ? merge_type_vars_in_terms
blanchet@33705
   234
                       |> pairf hd tl
blanchet@33192
   235
    val original_max_potential = max_potential
blanchet@33192
   236
    val original_max_genuine = max_genuine
blanchet@33192
   237
(*
blanchet@33192
   238
    val _ = priority ("*** " ^ Syntax.string_of_term ctxt orig_t)
blanchet@33192
   239
    val _ = List.app (fn t => priority ("*** " ^ Syntax.string_of_term ctxt t))
blanchet@33192
   240
                     orig_assm_ts
blanchet@33192
   241
*)
blanchet@33192
   242
    val max_bisim_depth = fold Integer.max bisim_depths ~1
blanchet@33192
   243
    val case_names = case_const_names thy
blanchet@33192
   244
    val (defs, built_in_nondefs, user_nondefs) = all_axioms_of thy
blanchet@33192
   245
    val def_table = const_def_table ctxt defs
blanchet@33192
   246
    val nondef_table = const_nondef_table (built_in_nondefs @ user_nondefs)
blanchet@33192
   247
    val simp_table = Unsynchronized.ref (const_simp_table ctxt)
blanchet@33192
   248
    val psimp_table = const_psimp_table ctxt
blanchet@33192
   249
    val intro_table = inductive_intro_table ctxt def_table
blanchet@33192
   250
    val ground_thm_table = ground_theorem_table thy
blanchet@33192
   251
    val ersatz_table = ersatz_table thy
blanchet@33877
   252
    val (ext_ctxt as {wf_cache, ...}) =
blanchet@33192
   253
      {thy = thy, ctxt = ctxt, max_bisim_depth = max_bisim_depth, boxes = boxes,
blanchet@33192
   254
       user_axioms = user_axioms, debug = debug, wfs = wfs,
blanchet@33192
   255
       destroy_constrs = destroy_constrs, specialize = specialize,
blanchet@33192
   256
       skolemize = skolemize, star_linear_preds = star_linear_preds,
blanchet@33192
   257
       uncurry = uncurry, fast_descrs = fast_descrs, tac_timeout = tac_timeout,
blanchet@33192
   258
       evals = evals, case_names = case_names, def_table = def_table,
blanchet@33192
   259
       nondef_table = nondef_table, user_nondefs = user_nondefs,
blanchet@33192
   260
       simp_table = simp_table, psimp_table = psimp_table,
blanchet@33192
   261
       intro_table = intro_table, ground_thm_table = ground_thm_table,
blanchet@33192
   262
       ersatz_table = ersatz_table, skolems = Unsynchronized.ref [],
blanchet@33192
   263
       special_funs = Unsynchronized.ref [],
blanchet@33580
   264
       unrolled_preds = Unsynchronized.ref [], wf_cache = Unsynchronized.ref [],
blanchet@33580
   265
       constr_cache = Unsynchronized.ref []}
blanchet@33192
   266
    val frees = Term.add_frees assms_t []
blanchet@33192
   267
    val _ = null (Term.add_tvars assms_t [])
blanchet@33192
   268
            orelse raise NOT_SUPPORTED "schematic type variables"
blanchet@33192
   269
    val (((def_ts, nondef_ts), (got_all_mono_user_axioms, no_poly_user_axioms)),
blanchet@33192
   270
         core_t) = preprocess_term ext_ctxt assms_t
blanchet@33192
   271
    val got_all_user_axioms =
blanchet@33192
   272
      got_all_mono_user_axioms andalso no_poly_user_axioms
blanchet@33192
   273
blanchet@33192
   274
    (* styp * (bool * bool) -> unit *)
blanchet@33192
   275
    fun print_wf (x, (gfp, wf)) =
blanchet@33192
   276
      pprint (Pretty.blk (0,
blanchet@33192
   277
          pstrs ("The " ^ (if gfp then "co" else "") ^ "inductive predicate \"")
blanchet@33192
   278
          @ Syntax.pretty_term ctxt (Const x) ::
blanchet@33192
   279
          pstrs (if wf then
blanchet@33192
   280
                   "\" was proved well-founded. Nitpick can compute it \
blanchet@33192
   281
                   \efficiently."
blanchet@33192
   282
                 else
blanchet@33192
   283
                   "\" could not be proved well-founded. Nitpick might need to \
blanchet@33192
   284
                   \unroll it.")))
blanchet@33192
   285
    val _ = if verbose then List.app print_wf (!wf_cache) else ()
blanchet@33192
   286
    val _ =
blanchet@33192
   287
      pprint_d (fn () =>
blanchet@33192
   288
          Pretty.chunks
blanchet@33192
   289
              (pretties_for_formulas ctxt "Preprocessed formula" [core_t] @
blanchet@33192
   290
               pretties_for_formulas ctxt "Relevant definitional axiom" def_ts @
blanchet@33192
   291
               pretties_for_formulas ctxt "Relevant nondefinitional axiom"
blanchet@33192
   292
                                     nondef_ts))
blanchet@33192
   293
    val _ = List.app (ignore o Term.type_of) (core_t :: def_ts @ nondef_ts)
blanchet@33192
   294
            handle TYPE (_, Ts, ts) =>
blanchet@33192
   295
                   raise TYPE ("Nitpick.pick_them_nits_in_term", Ts, ts)
blanchet@33192
   296
blanchet@33877
   297
    val core_u = nut_from_term ext_ctxt Eq core_t
blanchet@33877
   298
    val def_us = map (nut_from_term ext_ctxt DefEq) def_ts
blanchet@33877
   299
    val nondef_us = map (nut_from_term ext_ctxt Eq) nondef_ts
blanchet@33558
   300
    val (free_names, const_names) =
blanchet@33558
   301
      fold add_free_and_const_names (core_u :: def_us @ nondef_us) ([], [])
blanchet@33558
   302
    val (sel_names, nonsel_names) =
blanchet@33558
   303
      List.partition (is_sel o nickname_of) const_names
blanchet@33558
   304
    val would_be_genuine = got_all_user_axioms andalso none_true wfs
blanchet@33558
   305
(*
blanchet@33558
   306
    val _ = List.app (priority o string_for_nut ctxt)
blanchet@33558
   307
                     (core_u :: def_us @ nondef_us)
blanchet@33558
   308
*)
blanchet@33558
   309
blanchet@33192
   310
    val unique_scope = forall (equal 1 o length o snd) cards_assigns
blanchet@33192
   311
    (* typ -> bool *)
blanchet@33192
   312
    fun is_free_type_monotonic T =
blanchet@33192
   313
      unique_scope orelse
blanchet@33192
   314
      case triple_lookup (type_match thy) monos T of
blanchet@33192
   315
        SOME (SOME b) => b
blanchet@33192
   316
      | _ => formulas_monotonic ext_ctxt T def_ts nondef_ts core_t
blanchet@33192
   317
    fun is_datatype_monotonic T =
blanchet@33192
   318
      unique_scope orelse
blanchet@33192
   319
      case triple_lookup (type_match thy) monos T of
blanchet@33192
   320
        SOME (SOME b) => b
blanchet@33192
   321
      | _ =>
blanchet@33192
   322
        not (is_pure_typedef thy T) orelse is_univ_typedef thy T
blanchet@33192
   323
        orelse is_number_type thy T
blanchet@33192
   324
        orelse formulas_monotonic ext_ctxt T def_ts nondef_ts core_t
blanchet@33558
   325
    fun is_datatype_shallow T =
blanchet@33558
   326
      not (exists (equal T o domain_type o type_of) sel_names)
blanchet@33192
   327
    val Ts = ground_types_in_terms ext_ctxt (core_t :: def_ts @ nondef_ts)
blanchet@33192
   328
             |> sort TermOrd.typ_ord
blanchet@33192
   329
    val (all_dataTs, all_free_Ts) =
blanchet@33192
   330
      List.partition (is_integer_type orf is_datatype thy) Ts
blanchet@33192
   331
    val (mono_dataTs, nonmono_dataTs) =
blanchet@33192
   332
      List.partition is_datatype_monotonic all_dataTs
blanchet@33192
   333
    val (mono_free_Ts, nonmono_free_Ts) =
blanchet@33192
   334
      List.partition is_free_type_monotonic all_free_Ts
blanchet@33192
   335
blanchet@33192
   336
    val _ =
blanchet@33192
   337
      if not unique_scope andalso not (null mono_free_Ts) then
blanchet@33192
   338
        print_v (fn () =>
blanchet@33192
   339
                    let
blanchet@33192
   340
                      val ss = map (quote o string_for_type ctxt) mono_free_Ts
blanchet@33192
   341
                    in
blanchet@33192
   342
                      "The type" ^ plural_s_for_list ss ^ " " ^
blanchet@33192
   343
                      space_implode " " (serial_commas "and" ss) ^ " " ^
blanchet@33192
   344
                      (if none_true monos then
blanchet@33192
   345
                         "passed the monotonicity test"
blanchet@33192
   346
                       else
blanchet@33192
   347
                         (if length ss = 1 then "is" else "are") ^
blanchet@33192
   348
                         " considered monotonic") ^
blanchet@33192
   349
                      ". Nitpick might be able to skip some scopes."
blanchet@33192
   350
                    end)
blanchet@33192
   351
      else
blanchet@33192
   352
        ()
blanchet@33192
   353
    val mono_Ts = mono_dataTs @ mono_free_Ts
blanchet@33192
   354
    val nonmono_Ts = nonmono_dataTs @ nonmono_free_Ts
blanchet@33558
   355
    val shallow_dataTs = filter is_datatype_shallow mono_dataTs
blanchet@33192
   356
(*
blanchet@33192
   357
    val _ = priority "Monotonic datatypes:"
blanchet@33192
   358
    val _ = List.app (priority o string_for_type ctxt) mono_dataTs
blanchet@33192
   359
    val _ = priority "Nonmonotonic datatypes:"
blanchet@33192
   360
    val _ = List.app (priority o string_for_type ctxt) nonmono_dataTs
blanchet@33192
   361
    val _ = priority "Monotonic free types:"
blanchet@33192
   362
    val _ = List.app (priority o string_for_type ctxt) mono_free_Ts
blanchet@33192
   363
    val _ = priority "Nonmonotonic free types:"
blanchet@33192
   364
    val _ = List.app (priority o string_for_type ctxt) nonmono_free_Ts
blanchet@33192
   365
*)
blanchet@33192
   366
blanchet@33192
   367
    val need_incremental = Int.max (max_potential, max_genuine) >= 2
blanchet@33192
   368
    val effective_sat_solver =
blanchet@33192
   369
      if sat_solver <> "smart" then
blanchet@33192
   370
        if need_incremental andalso
blanchet@33232
   371
           not (sat_solver mem Kodkod_SAT.configured_sat_solvers true) then
blanchet@33192
   372
          (print_m (K ("An incremental SAT solver is required: \"SAT4J\" will \
blanchet@33192
   373
                       \be used instead of " ^ quote sat_solver ^ "."));
blanchet@33192
   374
           "SAT4J")
blanchet@33192
   375
        else
blanchet@33192
   376
          sat_solver
blanchet@33192
   377
      else
blanchet@33232
   378
        Kodkod_SAT.smart_sat_solver_name need_incremental
blanchet@33192
   379
    val _ =
blanchet@33192
   380
      if sat_solver = "smart" then
blanchet@33192
   381
        print_v (fn () => "Using SAT solver " ^ quote effective_sat_solver ^
blanchet@33192
   382
                          ". The following" ^
blanchet@33192
   383
                          (if need_incremental then " incremental " else " ") ^
blanchet@33192
   384
                          "solvers are configured: " ^
blanchet@33232
   385
                          commas (map quote (Kodkod_SAT.configured_sat_solvers
blanchet@33192
   386
                                                       need_incremental)) ^ ".")
blanchet@33192
   387
      else
blanchet@33192
   388
        ()
blanchet@33192
   389
blanchet@33192
   390
    val too_big_scopes = Unsynchronized.ref []
blanchet@33192
   391
blanchet@33192
   392
    (* bool -> scope -> rich_problem option *)
blanchet@33192
   393
    fun problem_for_scope liberal
blanchet@33192
   394
            (scope as {card_assigns, bisim_depth, datatypes, ofs, ...}) =
blanchet@33192
   395
      let
blanchet@33192
   396
        val _ = not (exists (fn other => scope_less_eq other scope)
blanchet@33192
   397
                            (!too_big_scopes))
blanchet@33192
   398
                orelse raise LIMIT ("Nitpick.pick_them_nits_in_term.\
blanchet@33192
   399
                                    \problem_for_scope", "too big scope")
blanchet@33192
   400
(*
blanchet@33192
   401
        val _ = priority "Offsets:"
blanchet@33192
   402
        val _ = List.app (fn (T, j0) =>
blanchet@33192
   403
                             priority (string_for_type ctxt T ^ " = " ^
blanchet@33192
   404
                                       string_of_int j0))
blanchet@33192
   405
                         (Typtab.dest ofs)
blanchet@33192
   406
*)
blanchet@33192
   407
        val all_precise = forall (is_precise_type datatypes) Ts
blanchet@33192
   408
        (* nut list -> rep NameTable.table -> nut list * rep NameTable.table *)
blanchet@33192
   409
        val repify_consts = choose_reps_for_consts scope all_precise
blanchet@33192
   410
        val main_j0 = offset_of_type ofs bool_T
blanchet@33192
   411
        val (nat_card, nat_j0) = spec_of_type scope nat_T
blanchet@33192
   412
        val (int_card, int_j0) = spec_of_type scope int_T
blanchet@33192
   413
        val _ = forall (equal main_j0) [nat_j0, int_j0]
blanchet@33192
   414
                orelse raise BAD ("Nitpick.pick_them_nits_in_term.\
blanchet@33192
   415
                                  \problem_for_scope", "bad offsets")
blanchet@33192
   416
        val kk = kodkod_constrs peephole_optim nat_card int_card main_j0
blanchet@33192
   417
        val (free_names, rep_table) =
blanchet@33192
   418
          choose_reps_for_free_vars scope free_names NameTable.empty
blanchet@33192
   419
        val (sel_names, rep_table) = choose_reps_for_all_sels scope rep_table
blanchet@33192
   420
        val (nonsel_names, rep_table) = repify_consts nonsel_names rep_table
blanchet@33192
   421
        val min_highest_arity =
blanchet@33192
   422
          NameTable.fold (curry Int.max o arity_of_rep o snd) rep_table 1
blanchet@33192
   423
        val min_univ_card =
blanchet@33192
   424
          NameTable.fold (curry Int.max o min_univ_card_of_rep o snd) rep_table
blanchet@33192
   425
                         (univ_card nat_card int_card main_j0 [] Kodkod.True)
blanchet@33192
   426
        val _ = check_arity min_univ_card min_highest_arity
blanchet@33192
   427
blanchet@33192
   428
        val core_u = choose_reps_in_nut scope liberal rep_table false core_u
blanchet@33192
   429
        val def_us = map (choose_reps_in_nut scope liberal rep_table true)
blanchet@33192
   430
                         def_us
blanchet@33192
   431
        val nondef_us = map (choose_reps_in_nut scope liberal rep_table false)
blanchet@33192
   432
                            nondef_us
blanchet@33745
   433
(*
blanchet@33192
   434
        val _ = List.app (priority o string_for_nut ctxt)
blanchet@33192
   435
                         (free_names @ sel_names @ nonsel_names @
blanchet@33192
   436
                          core_u :: def_us @ nondef_us)
blanchet@33745
   437
*)
blanchet@33192
   438
        val (free_rels, pool, rel_table) =
blanchet@33192
   439
          rename_free_vars free_names initial_pool NameTable.empty
blanchet@33192
   440
        val (sel_rels, pool, rel_table) =
blanchet@33192
   441
          rename_free_vars sel_names pool rel_table
blanchet@33192
   442
        val (other_rels, pool, rel_table) =
blanchet@33192
   443
          rename_free_vars nonsel_names pool rel_table
blanchet@33192
   444
        val core_u = rename_vars_in_nut pool rel_table core_u
blanchet@33192
   445
        val def_us = map (rename_vars_in_nut pool rel_table) def_us
blanchet@33192
   446
        val nondef_us = map (rename_vars_in_nut pool rel_table) nondef_us
blanchet@33192
   447
        (* nut -> Kodkod.formula *)
blanchet@33192
   448
        val to_f = kodkod_formula_from_nut ofs liberal kk
blanchet@33192
   449
        val core_f = to_f core_u
blanchet@33192
   450
        val def_fs = map to_f def_us
blanchet@33192
   451
        val nondef_fs = map to_f nondef_us
blanchet@33192
   452
        val formula = fold (fold s_and) [def_fs, nondef_fs] core_f
blanchet@33192
   453
        val comment = (if liberal then "liberal" else "conservative") ^ "\n" ^
blanchet@33192
   454
                      PrintMode.setmp [] multiline_string_for_scope scope
blanchet@33232
   455
        val kodkod_sat_solver = Kodkod_SAT.sat_solver_spec effective_sat_solver
blanchet@33192
   456
                                |> snd
blanchet@33192
   457
        val delay = if liberal then
blanchet@33192
   458
                      Option.map (fn time => Time.- (time, Time.now ()))
blanchet@33192
   459
                                 deadline
blanchet@33192
   460
                      |> liberal_delay_for_timeout
blanchet@33192
   461
                    else
blanchet@33192
   462
                      0
blanchet@33192
   463
        val settings = [("solver", commas (map quote kodkod_sat_solver)),
blanchet@33192
   464
                        ("skolem_depth", "-1"),
blanchet@33192
   465
                        ("bit_width", "16"),
blanchet@33192
   466
                        ("symmetry_breaking", signed_string_of_int sym_break),
blanchet@33192
   467
                        ("sharing", signed_string_of_int sharing_depth),
blanchet@33192
   468
                        ("flatten", Bool.toString flatten_props),
blanchet@33192
   469
                        ("delay", signed_string_of_int delay)]
blanchet@33192
   470
        val plain_rels = free_rels @ other_rels
blanchet@33192
   471
        val plain_bounds = map (bound_for_plain_rel ctxt debug) plain_rels
blanchet@33192
   472
        val plain_axioms = map (declarative_axiom_for_plain_rel kk) plain_rels
blanchet@33192
   473
        val sel_bounds = map (bound_for_sel_rel ctxt debug datatypes) sel_rels
blanchet@33192
   474
        val dtype_axioms = declarative_axioms_for_datatypes ext_ctxt ofs kk
blanchet@33192
   475
                                                            rel_table datatypes
blanchet@33192
   476
        val declarative_axioms = plain_axioms @ dtype_axioms
blanchet@33192
   477
        val univ_card = univ_card nat_card int_card main_j0
blanchet@33192
   478
                                  (plain_bounds @ sel_bounds) formula
blanchet@33192
   479
        val built_in_bounds = bounds_for_built_in_rels_in_formula debug
blanchet@33192
   480
                                  univ_card nat_card int_card main_j0 formula
blanchet@33192
   481
        val bounds = built_in_bounds @ plain_bounds @ sel_bounds
blanchet@33192
   482
                     |> not debug ? merge_bounds
blanchet@33192
   483
        val highest_arity =
blanchet@33192
   484
          fold Integer.max (map (fst o fst) (maps fst bounds)) 0
blanchet@33192
   485
        val formula = fold_rev s_and declarative_axioms formula
blanchet@33192
   486
        val _ = if formula = Kodkod.False then ()
blanchet@33192
   487
                else check_arity univ_card highest_arity
blanchet@33192
   488
      in
blanchet@33192
   489
        SOME ({comment = comment, settings = settings, univ_card = univ_card,
blanchet@33192
   490
               tuple_assigns = [], bounds = bounds,
blanchet@33192
   491
               int_bounds = sequential_int_bounds univ_card,
blanchet@33192
   492
               expr_assigns = [], formula = formula},
blanchet@33192
   493
              {free_names = free_names, sel_names = sel_names,
blanchet@33192
   494
               nonsel_names = nonsel_names, rel_table = rel_table,
blanchet@33192
   495
               liberal = liberal, scope = scope, core = core_f,
blanchet@33192
   496
               defs = nondef_fs @ def_fs @ declarative_axioms})
blanchet@33192
   497
      end
blanchet@33192
   498
      handle LIMIT (loc, msg) =>
blanchet@33232
   499
             if loc = "Nitpick_Kodkod.check_arity"
blanchet@33192
   500
                andalso not (Typtab.is_empty ofs) then
blanchet@33192
   501
               problem_for_scope liberal
blanchet@33192
   502
                   {ext_ctxt = ext_ctxt, card_assigns = card_assigns,
blanchet@33192
   503
                    bisim_depth = bisim_depth, datatypes = datatypes,
blanchet@33192
   504
                    ofs = Typtab.empty}
blanchet@33192
   505
             else if loc = "Nitpick.pick_them_nits_in_term.\
blanchet@33192
   506
                           \problem_for_scope" then
blanchet@33192
   507
               NONE
blanchet@33192
   508
             else
blanchet@33192
   509
               (Unsynchronized.change too_big_scopes (cons scope);
blanchet@33192
   510
                print_v (fn () => ("Limit reached: " ^ msg ^
blanchet@33192
   511
                                   ". Dropping " ^ (if liberal then "potential"
blanchet@33192
   512
                                                    else "genuine") ^
blanchet@33192
   513
                                   " component of scope."));
blanchet@33192
   514
                NONE)
blanchet@33192
   515
blanchet@33192
   516
    (* int -> (''a * int list list) list -> ''a -> Kodkod.tuple_set *)
blanchet@33192
   517
    fun tuple_set_for_rel univ_card =
blanchet@33192
   518
      Kodkod.TupleSet o map (kk_tuple debug univ_card) o the
blanchet@33192
   519
      oo AList.lookup (op =)
blanchet@33192
   520
blanchet@33192
   521
    val word_model = if falsify then "counterexample" else "model"
blanchet@33192
   522
blanchet@33192
   523
    val scopes = Unsynchronized.ref []
blanchet@33192
   524
    val generated_scopes = Unsynchronized.ref []
blanchet@33192
   525
    val generated_problems = Unsynchronized.ref []
blanchet@33192
   526
    val checked_problems = Unsynchronized.ref (SOME [])
blanchet@33192
   527
    val met_potential = Unsynchronized.ref 0
blanchet@33192
   528
blanchet@33192
   529
    (* rich_problem list -> int list -> unit *)
blanchet@33192
   530
    fun update_checked_problems problems =
blanchet@33192
   531
      List.app (Unsynchronized.change checked_problems o Option.map o cons
blanchet@33192
   532
                o nth problems)
blanchet@33192
   533
blanchet@33192
   534
    (* bool -> Kodkod.raw_bound list -> problem_extension -> bool option *)
blanchet@33192
   535
    fun print_and_check_model genuine bounds
blanchet@33192
   536
            ({free_names, sel_names, nonsel_names, rel_table, scope, ...}
blanchet@33192
   537
             : problem_extension) =
blanchet@33192
   538
      let
blanchet@33192
   539
        val (reconstructed_model, codatatypes_ok) =
blanchet@33192
   540
          reconstruct_hol_model {show_skolems = show_skolems,
blanchet@33192
   541
                                 show_datatypes = show_datatypes,
blanchet@33192
   542
                                 show_consts = show_consts}
blanchet@33192
   543
              scope formats frees free_names sel_names nonsel_names rel_table
blanchet@33192
   544
              bounds
blanchet@33192
   545
        val would_be_genuine = would_be_genuine andalso codatatypes_ok
blanchet@33192
   546
      in
blanchet@33192
   547
        pprint (Pretty.chunks
blanchet@33192
   548
            [Pretty.blk (0,
blanchet@33192
   549
                 (pstrs ("Nitpick found a" ^
blanchet@33192
   550
                         (if not genuine then " potential "
blanchet@33192
   551
                          else if would_be_genuine then " "
blanchet@33192
   552
                          else " likely genuine ") ^ word_model) @
blanchet@33192
   553
                  (case pretties_for_scope scope verbose of
blanchet@33192
   554
                     [] => []
blanchet@33192
   555
                   | pretties => pstrs " for " @ pretties) @
blanchet@33192
   556
                  [Pretty.str ":\n"])),
blanchet@33192
   557
             Pretty.indent indent_size reconstructed_model]);
blanchet@33192
   558
        if genuine then
blanchet@33192
   559
          (if check_genuine then
blanchet@33192
   560
             (case prove_hol_model scope tac_timeout free_names sel_names
blanchet@33192
   561
                                   rel_table bounds assms_t of
blanchet@33192
   562
                SOME true => print ("Confirmation by \"auto\": The above " ^
blanchet@33192
   563
                                    word_model ^ " is really genuine.")
blanchet@33192
   564
              | SOME false =>
blanchet@33192
   565
                if would_be_genuine then
blanchet@33192
   566
                  error ("A supposedly genuine " ^ word_model ^ " was shown to\
blanchet@33192
   567
                         \be spurious by \"auto\".\nThis should never happen.\n\
blanchet@33192
   568
                         \Please send a bug report to blanchet\
blanchet@33192
   569
                         \te@in.tum.de.")
blanchet@33192
   570
                else
blanchet@33192
   571
                  print ("Refutation by \"auto\": The above " ^ word_model ^
blanchet@33192
   572
                         " is spurious.")
blanchet@33192
   573
              | NONE => print "No confirmation by \"auto\".")
blanchet@33192
   574
           else
blanchet@33192
   575
             ();
blanchet@34038
   576
           if has_syntactic_sorts orig_t then
blanchet@33192
   577
             print "Hint: Maybe you forgot a type constraint?"
blanchet@33192
   578
           else
blanchet@33192
   579
             ();
blanchet@33192
   580
           if not would_be_genuine then
blanchet@33192
   581
             if no_poly_user_axioms then
blanchet@33192
   582
               let
blanchet@33192
   583
                 val options =
blanchet@33192
   584
                   [] |> not got_all_mono_user_axioms
blanchet@33192
   585
                         ? cons ("user_axioms", "\"true\"")
blanchet@33192
   586
                      |> not (none_true wfs)
blanchet@33192
   587
                         ? cons ("wf", "\"smart\" or \"false\"")
blanchet@33192
   588
                      |> not codatatypes_ok
blanchet@33192
   589
                         ? cons ("bisim_depth", "a nonnegative value")
blanchet@33192
   590
                 val ss =
blanchet@33192
   591
                   map (fn (name, value) => quote name ^ " set to " ^ value)
blanchet@33192
   592
                       options
blanchet@33192
   593
               in
blanchet@33192
   594
                 print ("Try again with " ^
blanchet@33192
   595
                        space_implode " " (serial_commas "and" ss) ^
blanchet@33192
   596
                        " to confirm that the " ^ word_model ^ " is genuine.")
blanchet@33192
   597
               end
blanchet@33192
   598
             else
blanchet@33192
   599
               print ("Nitpick is unable to guarantee the authenticity of \
blanchet@33192
   600
                      \the " ^ word_model ^ " in the presence of polymorphic \
blanchet@33192
   601
                      \axioms.")
blanchet@33192
   602
           else
blanchet@33192
   603
             ();
blanchet@33192
   604
           NONE)
blanchet@33192
   605
        else
blanchet@33192
   606
          if not genuine then
blanchet@33192
   607
            (Unsynchronized.inc met_potential;
blanchet@33192
   608
             if check_potential then
blanchet@33192
   609
               let
blanchet@33192
   610
                 val status = prove_hol_model scope tac_timeout free_names
blanchet@33192
   611
                                              sel_names rel_table bounds assms_t
blanchet@33192
   612
               in
blanchet@33192
   613
                 (case status of
blanchet@33192
   614
                    SOME true => print ("Confirmation by \"auto\": The above " ^
blanchet@33192
   615
                                        word_model ^ " is genuine.")
blanchet@33192
   616
                  | SOME false => print ("Refutation by \"auto\": The above " ^
blanchet@33192
   617
                                         word_model ^ " is spurious.")
blanchet@33192
   618
                  | NONE => print "No confirmation by \"auto\".");
blanchet@33192
   619
                 status
blanchet@33192
   620
               end
blanchet@33192
   621
             else
blanchet@33192
   622
               NONE)
blanchet@33192
   623
          else
blanchet@33192
   624
            NONE
blanchet@33192
   625
      end
blanchet@33192
   626
    (* int -> int -> int -> bool -> rich_problem list -> int * int * int *)
blanchet@33192
   627
    fun solve_any_problem max_potential max_genuine donno first_time problems =
blanchet@33192
   628
      let
blanchet@33192
   629
        val max_potential = Int.max (0, max_potential)
blanchet@33192
   630
        val max_genuine = Int.max (0, max_genuine)
blanchet@33192
   631
        (* bool -> int * Kodkod.raw_bound list -> bool option *)
blanchet@33192
   632
        fun print_and_check genuine (j, bounds) =
blanchet@33192
   633
          print_and_check_model genuine bounds (snd (nth problems j))
blanchet@33192
   634
        val max_solutions = max_potential + max_genuine
blanchet@33192
   635
                            |> not need_incremental ? curry Int.min 1
blanchet@33192
   636
      in
blanchet@33192
   637
        if max_solutions <= 0 then
blanchet@33192
   638
          (0, 0, donno)
blanchet@33192
   639
        else
blanchet@33192
   640
          case Kodkod.solve_any_problem overlord deadline max_threads
blanchet@33192
   641
                                        max_solutions (map fst problems) of
blanchet@33233
   642
            Kodkod.NotInstalled =>
blanchet@33568
   643
            (print_m install_kodkodi_message;
blanchet@33233
   644
             (max_potential, max_genuine, donno + 1))
blanchet@33233
   645
          | Kodkod.Normal ([], unsat_js) =>
blanchet@33192
   646
            (update_checked_problems problems unsat_js;
blanchet@33192
   647
             (max_potential, max_genuine, donno))
blanchet@33192
   648
          | Kodkod.Normal (sat_ps, unsat_js) =>
blanchet@33192
   649
            let
blanchet@33192
   650
              val (lib_ps, con_ps) =
blanchet@33192
   651
                List.partition (#liberal o snd o nth problems o fst) sat_ps
blanchet@33192
   652
            in
blanchet@33192
   653
              update_checked_problems problems (unsat_js @ map fst lib_ps);
blanchet@33192
   654
              if null con_ps then
blanchet@33192
   655
                let
haftmann@33955
   656
                  val num_genuine = take max_potential lib_ps
blanchet@33192
   657
                                    |> map (print_and_check false)
blanchet@33192
   658
                                    |> filter (equal (SOME true)) |> length
blanchet@33192
   659
                  val max_genuine = max_genuine - num_genuine
blanchet@33192
   660
                  val max_potential = max_potential
blanchet@33192
   661
                                      - (length lib_ps - num_genuine)
blanchet@33192
   662
                in
blanchet@33192
   663
                  if max_genuine <= 0 then
blanchet@33192
   664
                    (0, 0, donno)
blanchet@33192
   665
                  else
blanchet@33192
   666
                    let
blanchet@33192
   667
                      (* "co_js" is the list of conservative problems whose
blanchet@33192
   668
                         liberal pendants couldn't be satisfied and hence that
blanchet@33192
   669
                         most probably can't be satisfied themselves. *)
blanchet@33192
   670
                      val co_js =
blanchet@33192
   671
                        map (fn j => j - 1) unsat_js
blanchet@33192
   672
                        |> filter (fn j =>
blanchet@33192
   673
                                      j >= 0 andalso
blanchet@33192
   674
                                      scopes_equivalent
blanchet@33192
   675
                                          (#scope (snd (nth problems j)))
blanchet@33192
   676
                                          (#scope (snd (nth problems (j + 1)))))
blanchet@33192
   677
                      val bye_js = sort_distinct int_ord (map fst sat_ps @
blanchet@33192
   678
                                                          unsat_js @ co_js)
blanchet@33192
   679
                      val problems =
blanchet@33192
   680
                        problems |> filter_out_indices bye_js
blanchet@33192
   681
                                 |> max_potential <= 0
blanchet@33192
   682
                                    ? filter_out (#liberal o snd)
blanchet@33192
   683
                    in
blanchet@33192
   684
                      solve_any_problem max_potential max_genuine donno false
blanchet@33192
   685
                                        problems
blanchet@33192
   686
                    end
blanchet@33192
   687
                end
blanchet@33192
   688
              else
blanchet@33192
   689
                let
haftmann@33955
   690
                  val _ = take max_genuine con_ps
blanchet@33192
   691
                          |> List.app (ignore o print_and_check true)
blanchet@33192
   692
                  val max_genuine = max_genuine - length con_ps
blanchet@33192
   693
                in
blanchet@33192
   694
                  if max_genuine <= 0 orelse not first_time then
blanchet@33192
   695
                    (0, max_genuine, donno)
blanchet@33192
   696
                  else
blanchet@33192
   697
                    let
blanchet@33192
   698
                      val bye_js = sort_distinct int_ord
blanchet@33192
   699
                                                 (map fst sat_ps @ unsat_js)
blanchet@33192
   700
                      val problems =
blanchet@33192
   701
                        problems |> filter_out_indices bye_js
blanchet@33192
   702
                                 |> filter_out (#liberal o snd)
blanchet@33192
   703
                    in solve_any_problem 0 max_genuine donno false problems end
blanchet@33192
   704
                end
blanchet@33192
   705
            end
blanchet@33192
   706
          | Kodkod.TimedOut unsat_js =>
blanchet@33192
   707
            (update_checked_problems problems unsat_js; raise TimeLimit.TimeOut)
blanchet@33192
   708
          | Kodkod.Interrupted NONE =>
blanchet@33192
   709
            (checked_problems := NONE; do_interrupted ())
blanchet@33192
   710
          | Kodkod.Interrupted (SOME unsat_js) =>
blanchet@33192
   711
            (update_checked_problems problems unsat_js; do_interrupted ())
blanchet@33192
   712
          | Kodkod.Error (s, unsat_js) =>
blanchet@33192
   713
            (update_checked_problems problems unsat_js;
blanchet@33192
   714
             print_v (K ("Kodkod error: " ^ s ^ "."));
blanchet@33192
   715
             (max_potential, max_genuine, donno + 1))
blanchet@33192
   716
      end
blanchet@33192
   717
blanchet@33192
   718
    (* int -> int -> scope list -> int * int * int -> int * int * int *)
blanchet@33192
   719
    fun run_batch j n scopes (max_potential, max_genuine, donno) =
blanchet@33192
   720
      let
blanchet@33192
   721
        val _ =
blanchet@33192
   722
          if null scopes then
blanchet@33192
   723
            print_m (K "The scope specification is inconsistent.")
blanchet@33192
   724
          else if verbose then
blanchet@33192
   725
            pprint (Pretty.chunks
blanchet@33192
   726
                [Pretty.blk (0,
blanchet@33192
   727
                     pstrs ((if n > 1 then
blanchet@33192
   728
                               "Batch " ^ string_of_int (j + 1) ^ " of " ^
blanchet@33192
   729
                               signed_string_of_int n ^ ": "
blanchet@33192
   730
                             else
blanchet@33192
   731
                               "") ^
blanchet@33192
   732
                            "Trying " ^ string_of_int (length scopes) ^
blanchet@33192
   733
                            " scope" ^ plural_s_for_list scopes ^ ":")),
blanchet@33192
   734
                 Pretty.indent indent_size
blanchet@33192
   735
                     (Pretty.chunks (map2
blanchet@33192
   736
                          (fn j => fn scope =>
blanchet@33192
   737
                              Pretty.block (
blanchet@33192
   738
                                  (case pretties_for_scope scope true of
blanchet@33192
   739
                                     [] => [Pretty.str "Empty"]
blanchet@33192
   740
                                   | pretties => pretties) @
blanchet@33192
   741
                                  [Pretty.str (if j = 1 then "." else ";")]))
blanchet@33192
   742
                          (length scopes downto 1) scopes))])
blanchet@33192
   743
          else
blanchet@33192
   744
            ()
blanchet@33192
   745
        (* scope * bool -> rich_problem list * bool
blanchet@33192
   746
           -> rich_problem list * bool *)
blanchet@33192
   747
        fun add_problem_for_scope (scope as {datatypes, ...}, liberal)
blanchet@33192
   748
                                  (problems, donno) =
blanchet@33192
   749
          (check_deadline ();
blanchet@33192
   750
           case problem_for_scope liberal scope of
blanchet@33192
   751
             SOME problem =>
blanchet@33192
   752
             (problems
blanchet@33192
   753
              |> (null problems orelse
blanchet@33192
   754
                  not (Kodkod.problems_equivalent (fst problem)
blanchet@33192
   755
                                                  (fst (hd problems))))
blanchet@33192
   756
                  ? cons problem, donno)
blanchet@33192
   757
           | NONE => (problems, donno + 1))
blanchet@33192
   758
        val (problems, donno) =
blanchet@33192
   759
          fold add_problem_for_scope
blanchet@33192
   760
               (map_product pair scopes
blanchet@33192
   761
                    ((if max_genuine > 0 then [false] else []) @
blanchet@33192
   762
                     (if max_potential > 0 then [true] else [])))
blanchet@33192
   763
               ([], donno)
blanchet@33192
   764
        val _ = Unsynchronized.change generated_problems (append problems)
blanchet@33192
   765
        val _ = Unsynchronized.change generated_scopes (append scopes)
blanchet@33192
   766
      in
blanchet@33192
   767
        solve_any_problem max_potential max_genuine donno true (rev problems)
blanchet@33192
   768
      end
blanchet@33192
   769
blanchet@33192
   770
    (* rich_problem list -> scope -> int *)
blanchet@33192
   771
    fun scope_count (problems : rich_problem list) scope =
blanchet@33192
   772
      length (filter (scopes_equivalent scope o #scope o snd) problems)
blanchet@33192
   773
    (* string -> string *)
blanchet@33192
   774
    fun excipit did_so_and_so =
blanchet@33192
   775
      let
blanchet@33192
   776
        (* rich_problem list -> rich_problem list *)
blanchet@33192
   777
        val do_filter =
blanchet@33192
   778
          if !met_potential = max_potential then filter_out (#liberal o snd)
blanchet@33192
   779
          else I
blanchet@33192
   780
        val total = length (!scopes)
blanchet@33192
   781
        val unsat =
blanchet@33192
   782
          fold (fn scope =>
blanchet@33192
   783
                   case scope_count (do_filter (!generated_problems)) scope of
blanchet@33192
   784
                     0 => I
blanchet@33192
   785
                   | n =>
blanchet@33556
   786
                     scope_count (do_filter (these (!checked_problems)))
blanchet@33556
   787
                                 scope = n
blanchet@33556
   788
                     ? Integer.add 1) (!generated_scopes) 0
blanchet@33192
   789
      in
blanchet@33192
   790
        "Nitpick " ^ did_so_and_so ^
blanchet@33192
   791
        (if is_some (!checked_problems) andalso total > 0 then
blanchet@33192
   792
           " after checking " ^
blanchet@33192
   793
           string_of_int (Int.min (total - 1, unsat)) ^ " of " ^
blanchet@33192
   794
           string_of_int total ^ " scope" ^ plural_s total
blanchet@33192
   795
         else
blanchet@33192
   796
           "") ^ "."
blanchet@33192
   797
      end
blanchet@33192
   798
blanchet@33192
   799
    (* int -> int -> scope list -> int * int * int -> Kodkod.outcome *)
blanchet@33192
   800
    fun run_batches _ _ [] (max_potential, max_genuine, donno) =
blanchet@33192
   801
        if donno > 0 andalso max_genuine > 0 then
blanchet@33233
   802
          (print_m (fn () => excipit "ran into difficulties"); "unknown")
blanchet@33192
   803
        else if max_genuine = original_max_genuine then
blanchet@33192
   804
          if max_potential = original_max_potential then
blanchet@33192
   805
            (print_m (K ("Nitpick found no " ^ word_model ^ ".")); "none")
blanchet@33192
   806
          else
blanchet@33192
   807
            (print_m (K ("Nitpick could not find " ^
blanchet@33192
   808
                         (if max_genuine = 1 then "a better " ^ word_model ^ "."
blanchet@33192
   809
                          else "any better " ^ word_model ^ "s.")));
blanchet@33192
   810
             "potential")
blanchet@33192
   811
        else
blanchet@33192
   812
          if would_be_genuine then "genuine" else "likely_genuine"
blanchet@33192
   813
      | run_batches j n (batch :: batches) z =
blanchet@33192
   814
        let val (z as (_, max_genuine, _)) = run_batch j n batch z in
blanchet@33192
   815
          run_batches (j + 1) n (if max_genuine > 0 then batches else []) z
blanchet@33192
   816
        end
blanchet@33192
   817
blanchet@33580
   818
    val (skipped, the_scopes) =
blanchet@33580
   819
      all_scopes ext_ctxt sym_break cards_assigns maxes_assigns iters_assigns
blanchet@33580
   820
                 bisim_depths mono_Ts nonmono_Ts shallow_dataTs
blanchet@33580
   821
    val _ = if skipped > 0 then
blanchet@33580
   822
              print_m (fn () => "Too many scopes. Dropping " ^
blanchet@33580
   823
                                string_of_int skipped ^ " scope" ^
blanchet@33580
   824
                                plural_s skipped ^
blanchet@33580
   825
                                ". (Consider using \"mono\" or \
blanchet@33580
   826
                                \\"merge_type_vars\" to prevent this.)")
blanchet@33580
   827
            else
blanchet@33580
   828
              ()
blanchet@33580
   829
    val _ = scopes := the_scopes
blanchet@33580
   830
blanchet@33192
   831
    val batches = batch_list batch_size (!scopes)
blanchet@33192
   832
    val outcome_code =
blanchet@33192
   833
      (run_batches 0 (length batches) batches (max_potential, max_genuine, 0)
blanchet@33192
   834
       handle Exn.Interrupt => do_interrupted ())
blanchet@33192
   835
      handle TimeLimit.TimeOut =>
blanchet@33192
   836
             (print_m (fn () => excipit "ran out of time");
blanchet@33192
   837
              if !met_potential > 0 then "potential" else "unknown")
blanchet@33192
   838
           | Exn.Interrupt => if auto orelse debug then raise Interrupt
blanchet@33192
   839
                              else error (excipit "was interrupted")
blanchet@33192
   840
    val _ = print_v (fn () => "Total time: " ^
blanchet@33192
   841
                              signed_string_of_int (Time.toMilliseconds
blanchet@33192
   842
                                    (Timer.checkRealTimer timer)) ^ " ms.")
blanchet@33192
   843
  in (outcome_code, !state_ref) end
blanchet@33192
   844
  handle Exn.Interrupt =>
blanchet@33192
   845
         if auto orelse #debug params then
blanchet@33192
   846
           raise Interrupt
blanchet@33192
   847
         else
blanchet@33192
   848
           if passed_deadline deadline then
blanchet@33192
   849
             (priority "Nitpick ran out of time."; ("unknown", state))
blanchet@33192
   850
           else
blanchet@33192
   851
             error "Nitpick was interrupted."
blanchet@33192
   852
blanchet@33192
   853
(* Proof.state -> params -> bool -> term -> string * Proof.state *)
blanchet@33192
   854
fun pick_nits_in_term state (params as {debug, timeout, expect, ...})
blanchet@33192
   855
                      auto orig_assm_ts orig_t =
blanchet@33568
   856
  if getenv "KODKODI" = "" then
blanchet@33568
   857
    (if auto then ()
blanchet@33568
   858
     else warning (Pretty.string_of (plazy install_kodkodi_message));
blanchet@33568
   859
     ("unknown", state))
blanchet@33568
   860
  else
blanchet@33568
   861
    let
blanchet@33568
   862
      val deadline = Option.map (curry Time.+ (Time.now ())) timeout
blanchet@33568
   863
      val outcome as (outcome_code, _) =
blanchet@33568
   864
        time_limit (if debug then NONE else timeout)
blanchet@33568
   865
            (pick_them_nits_in_term deadline state params auto orig_assm_ts)
blanchet@33568
   866
            orig_t
blanchet@33568
   867
    in
blanchet@33568
   868
      if expect = "" orelse outcome_code = expect then outcome
blanchet@33568
   869
      else error ("Unexpected outcome: " ^ quote outcome_code ^ ".")
blanchet@33568
   870
    end
blanchet@33192
   871
blanchet@33192
   872
(* Proof.state -> params -> thm -> int -> string * Proof.state *)
blanchet@33192
   873
fun pick_nits_in_subgoal state params auto subgoal =
blanchet@33192
   874
  let
blanchet@33192
   875
    val ctxt = Proof.context_of state
wenzelm@33292
   876
    val t = state |> Proof.raw_goal |> #goal |> prop_of
blanchet@33192
   877
  in
blanchet@33192
   878
    if Logic.count_prems t = 0 then
blanchet@33192
   879
      (priority "No subgoal!"; ("none", state))
blanchet@33192
   880
    else
blanchet@33192
   881
      let
blanchet@33192
   882
        val assms = map term_of (Assumption.all_assms_of ctxt)
blanchet@33192
   883
        val (t, frees) = Logic.goal_params t subgoal
blanchet@33192
   884
      in pick_nits_in_term state params auto assms (subst_bounds (frees, t)) end
blanchet@33192
   885
  end
blanchet@33192
   886
blanchet@33192
   887
end;