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