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