1 (* Title: HOL/Tools/Sledgehammer/sledgehammer_isar.ML
2 Author: Jasmin Blanchette, TU Muenchen
4 Adds "sledgehammer" and related commands to Isabelle/Isar's outer syntax.
7 signature SLEDGEHAMMER_ISAR =
9 type params = Sledgehammer_Provers.params
11 val auto : bool Unsynchronized.ref
12 val provers : string Unsynchronized.ref
13 val timeout : int Unsynchronized.ref
14 val full_types : bool Unsynchronized.ref
15 val default_params : Proof.context -> (string * string) list -> params
16 val setup : theory -> theory
19 structure Sledgehammer_Isar : SLEDGEHAMMER_ISAR =
23 open Sledgehammer_Util
24 open Sledgehammer_ATP_Translate
25 open Sledgehammer_Provers
26 open Sledgehammer_Minimize
29 val auto = Unsynchronized.ref false
32 ProofGeneralPgip.add_preference Preferences.category_tracing
33 (Preferences.bool_pref auto "auto-sledgehammer"
34 "Run Sledgehammer automatically.")
36 (** Sledgehammer commands **)
38 val no_relevance_override = {add = [], del = [], only = false}
39 fun add_relevance_override ns : relevance_override =
40 {add = ns, del = [], only = false}
41 fun del_relevance_override ns : relevance_override =
42 {add = [], del = ns, only = false}
43 fun only_relevance_override ns : relevance_override =
44 {add = ns, del = [], only = true}
45 fun merge_relevance_override_pairwise (r1 : relevance_override)
46 (r2 : relevance_override) =
47 {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
48 only = #only r1 andalso #only r2}
49 fun merge_relevance_overrides rs =
50 fold merge_relevance_override_pairwise rs (only_relevance_override [])
54 val provers = Unsynchronized.ref ""
55 val timeout = Unsynchronized.ref 30
56 val full_types = Unsynchronized.ref false
59 ProofGeneralPgip.add_preference Preferences.category_proof
60 (Preferences.string_pref provers
61 "Sledgehammer: Provers"
62 "Default automatic provers (separated by whitespace)")
65 ProofGeneralPgip.add_preference Preferences.category_proof
66 (Preferences.int_pref timeout
67 "Sledgehammer: Time Limit"
68 "ATPs will be interrupted after this time (in seconds)")
71 ProofGeneralPgip.add_preference Preferences.category_proof
72 (Preferences.bool_pref full_types
73 "Sledgehammer: Full Types" "ATPs will use full type information")
75 type raw_param = string * string list
77 val default_default_params =
80 ("overlord", "false"),
81 ("blocking", "false"),
82 ("type_sys", "smart"),
83 ("relevance_thresholds", "0.45 0.85"),
84 ("max_relevant", "smart"),
85 ("monomorphize_limit", "4"),
86 ("explicit_apply", "false"),
87 ("isar_proof", "false"),
88 ("isar_shrink_factor", "1"),
92 [("prover", "provers"),
93 ("atps", "provers"), (* FIXME: legacy *)
94 ("atp", "provers")] (* FIXME: legacy *)
95 val negated_alias_params =
96 [("no_debug", "debug"),
98 ("no_overlord", "overlord"),
99 ("non_blocking", "blocking"),
100 ("partial_types", "full_types"),
101 ("implicit_apply", "explicit_apply"),
102 ("no_isar_proof", "isar_proof"),
103 ("no_slicing", "slicing")]
105 val params_for_minimize =
106 ["debug", "verbose", "overlord", "type_sys", "full_types", "isar_proof",
107 "isar_shrink_factor", "timeout"]
109 val property_dependent_params = ["provers", "full_types", "timeout"]
111 fun is_known_raw_param s =
112 AList.defined (op =) default_default_params s orelse
113 AList.defined (op =) alias_params s orelse
114 AList.defined (op =) negated_alias_params s orelse
115 member (op =) property_dependent_params s orelse s = "expect"
117 fun is_prover_list ctxt s =
118 case space_explode " " s of
119 ss as _ :: _ => forall (is_prover_supported ctxt) ss
122 fun check_and_repair_raw_param ctxt (name, value) =
123 if is_known_raw_param name then (name, value)
124 else if is_prover_list ctxt name andalso null value then ("provers", [name])
125 else error ("Unknown parameter: " ^ quote name ^ ".")
127 fun unalias_raw_param (name, value) =
128 case AList.lookup (op =) alias_params name of
129 SOME name' => (name', value)
131 case AList.lookup (op =) negated_alias_params name of
132 SOME name' => (name', case value of
133 ["false"] => ["true"]
134 | ["true"] => ["false"]
137 | NONE => (name, value)
139 structure Data = Theory_Data
141 type T = raw_param list
142 val empty = default_default_params |> map (apsnd single)
144 fun merge data : T = AList.merge (op =) (K true) data
147 fun remotify_prover_if_supported_and_not_already_remote ctxt name =
148 if String.isPrefix remote_prefix name then
151 let val remote_name = remote_prefix ^ name in
152 if is_prover_supported ctxt remote_name then SOME remote_name else NONE
155 fun remotify_prover_if_not_installed ctxt name =
156 if is_prover_supported ctxt name andalso is_prover_installed ctxt name then
159 remotify_prover_if_supported_and_not_already_remote ctxt name
161 fun avoid_too_many_local_threads _ _ [] = []
162 | avoid_too_many_local_threads ctxt 0 provers =
163 map_filter (remotify_prover_if_supported_and_not_already_remote ctxt)
165 | avoid_too_many_local_threads ctxt n (prover :: provers) =
166 let val n = if String.isPrefix remote_prefix prover then n else n - 1 in
167 prover :: avoid_too_many_local_threads ctxt n provers
170 (* Ensure that type systems such as "simple!" and "mangled_preds?" are handled
172 fun implode_param_value [s, "?"] = s ^ "?"
173 | implode_param_value [s, "!"] = s ^ "!"
174 | implode_param_value ss = space_implode " " ss
176 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
177 timeout, it makes sense to put SPASS first. *)
178 fun default_provers_param_value ctxt =
179 [spassN, eN, vampireN, sine_eN, SMT_Solver.solver_name_of ctxt]
180 |> map_filter (remotify_prover_if_not_installed ctxt)
181 |> avoid_too_many_local_threads ctxt (Multithreading.max_threads_value ())
182 |> implode_param_value
184 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
185 fun default_raw_params ctxt =
186 let val thy = Proof_Context.theory_of ctxt in
188 |> fold (AList.default (op =))
189 [("provers", [case !provers of
190 "" => default_provers_param_value ctxt
192 ("full_types", [if !full_types then "true" else "false"]),
193 ("timeout", let val timeout = !timeout in
194 [if timeout <= 0 then "none"
195 else string_of_int timeout]
199 val infinity_time_in_secs = 60 * 60 * 24 * 365
200 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
202 fun extract_params auto default_params override_params =
204 val override_params = map unalias_raw_param override_params
205 val raw_params = rev override_params @ rev default_params
206 val lookup = Option.map implode_param_value o AList.lookup (op =) raw_params
207 val lookup_string = the_default "" o lookup
208 fun general_lookup_bool option default_value name =
210 SOME s => parse_bool_option option name s
211 | NONE => default_value
212 val lookup_bool = the o general_lookup_bool false (SOME false)
213 fun lookup_time name =
215 SOME s => parse_time_option name s
217 fun lookup_int name =
220 | SOME s => case Int.fromString s of
222 | NONE => error ("Parameter " ^ quote name ^
223 " must be assigned an integer value.")
224 fun lookup_real_pair name =
227 | SOME s => case s |> space_explode " " |> map Real.fromString of
228 [SOME r1, SOME r2] => (r1, r2)
229 | _ => error ("Parameter " ^ quote name ^
230 "must be assigned a pair of floating-point \
231 \values (e.g., \"0.6 0.95\")")
232 fun lookup_int_option name =
235 | _ => SOME (lookup_int name)
236 val debug = not auto andalso lookup_bool "debug"
237 val verbose = debug orelse (not auto andalso lookup_bool "verbose")
238 val overlord = lookup_bool "overlord"
239 val blocking = auto orelse debug orelse lookup_bool "blocking"
240 val provers = lookup_string "provers" |> space_explode " "
241 |> auto ? single o hd
243 case lookup_string "type_sys" of
244 "smart" => Smart_Type_Sys (lookup_bool "full_types")
245 | s => Dumb_Type_Sys (type_sys_from_string s)
246 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
247 val max_relevant = lookup_int_option "max_relevant"
248 val monomorphize_limit = lookup_int "monomorphize_limit"
249 val explicit_apply = lookup_bool "explicit_apply"
250 val isar_proof = lookup_bool "isar_proof"
251 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
252 val slicing = not auto andalso lookup_bool "slicing"
253 val timeout = (if auto then NONE else lookup_time "timeout") |> the_timeout
254 val expect = lookup_string "expect"
256 {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
257 provers = provers, relevance_thresholds = relevance_thresholds,
258 max_relevant = max_relevant, monomorphize_limit = monomorphize_limit,
259 type_sys = type_sys, explicit_apply = explicit_apply,
260 isar_proof = isar_proof, isar_shrink_factor = isar_shrink_factor,
261 slicing = slicing, timeout = timeout, expect = expect}
264 fun get_params auto ctxt = extract_params auto (default_raw_params ctxt)
265 fun default_params thy = get_params false thy o map (apsnd single)
267 (* Sledgehammer the given subgoal *)
269 val sledgehammerN = "sledgehammer"
270 val sledgehammer_paramsN = "sledgehammer_params"
273 val minimizeN = "minimize"
274 val messagesN = "messages"
275 val supported_proversN = "supported_provers"
276 val running_proversN = "running_provers"
277 val kill_proversN = "kill_provers"
278 val refresh_tptpN = "refresh_tptp"
280 val is_raw_param_relevant_for_minimize =
281 member (op =) params_for_minimize o fst o unalias_raw_param
282 fun string_for_raw_param (key, values) =
283 key ^ (case implode_param_value values of "" => "" | value => " = " ^ value)
285 fun minimize_command override_params i prover_name fact_names =
286 sledgehammerN ^ " " ^ minimizeN ^ " [prover = " ^ prover_name ^
287 (override_params |> filter is_raw_param_relevant_for_minimize
288 |> implode o map (prefix ", " o string_for_raw_param)) ^
289 "] (" ^ space_implode " " fact_names ^ ")" ^
290 (if i = 1 then "" else " " ^ string_of_int i)
292 fun hammer_away override_params subcommand opt_i relevance_override state =
294 val ctxt = Proof.context_of state
295 val override_params =
296 override_params |> map (check_and_repair_raw_param ctxt)
298 if subcommand = runN then
299 let val i = the_default 1 opt_i in
300 run_sledgehammer (get_params false ctxt override_params) false i
301 relevance_override (minimize_command override_params i)
305 else if subcommand = minimizeN then
306 run_minimize (get_params false ctxt override_params) (the_default 1 opt_i)
307 (#add relevance_override) state
308 else if subcommand = messagesN then
310 else if subcommand = supported_proversN then
311 supported_provers ctxt
312 else if subcommand = running_proversN then
314 else if subcommand = kill_proversN then
316 else if subcommand = refresh_tptpN then
317 refresh_systems_on_tptp ()
319 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
322 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
323 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
326 fun string_for_raw_param (name, value) = name ^ " = " ^ implode_param_value value
328 fun sledgehammer_params_trans params =
330 (fold set_default_raw_param params
332 let val ctxt = Proof_Context.init_global thy in
333 writeln ("Default parameters for Sledgehammer:\n" ^
334 (case default_raw_params ctxt |> rev of
337 params |> map (check_and_repair_raw_param ctxt)
338 |> map string_for_raw_param
339 |> sort_strings |> cat_lines))
342 val parse_key = Scan.repeat1 Parse.typ_group >> space_implode " "
344 Scan.repeat1 (Parse.xname || Parse.float_number || Parse.$$$ "?"
346 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
347 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
348 val parse_fact_refs =
349 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
350 val parse_relevance_chunk =
351 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
352 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
353 || (parse_fact_refs >> only_relevance_override)
354 val parse_relevance_override =
355 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
356 >> merge_relevance_overrides))
357 no_relevance_override
358 val parse_sledgehammer_command =
359 (Scan.optional Parse.short_ident runN -- parse_params
360 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
361 val parse_sledgehammer_params_command =
362 parse_params #>> sledgehammer_params_trans
365 Outer_Syntax.improper_command sledgehammerN
366 "search for first-order proof using automatic theorem provers" Keyword.diag
367 parse_sledgehammer_command
369 Outer_Syntax.command sledgehammer_paramsN
370 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
371 parse_sledgehammer_params_command
373 fun auto_sledgehammer state =
374 let val ctxt = Proof.context_of state in
375 run_sledgehammer (get_params true ctxt []) true 1 no_relevance_override
376 (minimize_command [] 1) state
379 val setup = Auto_Tools.register_tool (auto, auto_sledgehammer)