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