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