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