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