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 =
78 [("blocking", "false"),
81 ("overlord", "false"),
82 ("type_sys", "smart"),
83 ("explicit_apply", "false"),
84 ("relevance_thresholds", "0.45 0.85"),
85 ("max_relevant", "smart"),
86 ("isar_proof", "false"),
87 ("isar_shrink_factor", "1")]
90 [("prover", "provers"),
91 ("atps", "provers"), (* FIXME: legacy *)
92 ("atp", "provers")] (* FIXME: legacy *)
93 val negated_alias_params =
94 [("non_blocking", "blocking"),
95 ("no_debug", "debug"),
97 ("no_overlord", "overlord"),
98 ("partial_types", "full_types"),
99 ("implicit_apply", "explicit_apply"),
100 ("no_isar_proof", "isar_proof")]
102 val params_for_minimize =
103 ["debug", "verbose", "overlord", "type_sys", "full_types", "isar_proof",
104 "isar_shrink_factor", "timeout"]
106 val property_dependent_params = ["provers", "full_types", "timeout"]
108 fun is_known_raw_param s =
109 AList.defined (op =) default_default_params s orelse
110 AList.defined (op =) alias_params s orelse
111 AList.defined (op =) negated_alias_params s orelse
112 member (op =) property_dependent_params s orelse s = "expect"
114 fun check_raw_param (s, _) =
115 if is_known_raw_param s then ()
116 else error ("Unknown parameter: " ^ quote s ^ ".")
118 fun unalias_raw_param (name, value) =
119 case AList.lookup (op =) alias_params name of
120 SOME name' => (name', value)
122 case AList.lookup (op =) negated_alias_params name of
123 SOME name' => (name', case value of
124 ["false"] => ["true"]
125 | ["true"] => ["false"]
128 | NONE => (name, value)
130 structure Data = Theory_Data(
131 type T = raw_param list
132 val empty = default_default_params |> map (apsnd single)
134 fun merge p : T = AList.merge (op =) (K true) p)
136 fun remotify_prover_if_available_and_not_already_remote ctxt name =
137 if String.isPrefix remote_prefix name then
140 let val remote_name = remote_prefix ^ name in
141 if is_prover_available ctxt remote_name then SOME remote_name else NONE
144 fun remotify_prover_if_not_installed ctxt name =
145 if is_prover_available ctxt name andalso is_prover_installed ctxt name then
148 remotify_prover_if_available_and_not_already_remote ctxt name
150 fun avoid_too_many_local_threads _ _ [] = []
151 | avoid_too_many_local_threads ctxt 0 provers =
152 map_filter (remotify_prover_if_available_and_not_already_remote ctxt)
154 | avoid_too_many_local_threads ctxt n (prover :: provers) =
155 let val n = if String.isPrefix remote_prefix prover then n else n - 1 in
156 prover :: avoid_too_many_local_threads ctxt n provers
159 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
160 timeout, it makes sense to put SPASS first. *)
161 fun default_provers_param_value ctxt =
162 [spassN, eN, vampireN, sine_eN, SMT_Solver.solver_name_of ctxt]
163 |> map_filter (remotify_prover_if_not_installed ctxt)
164 |> avoid_too_many_local_threads ctxt (Multithreading.max_threads_value ())
167 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
168 fun default_raw_params ctxt =
169 let val thy = ProofContext.theory_of ctxt in
171 |> fold (AList.default (op =))
172 [("provers", [case !provers of
173 "" => default_provers_param_value ctxt
175 ("full_types", [if !full_types then "true" else "false"]),
176 ("timeout", let val timeout = !timeout in
177 [if timeout <= 0 then "none"
178 else string_of_int timeout]
182 val infinity_time_in_secs = 60 * 60 * 24 * 365
183 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
185 fun extract_params auto default_params override_params =
187 val override_params = map unalias_raw_param override_params
188 val raw_params = rev override_params @ rev default_params
189 val lookup = Option.map (space_implode " ") o AList.lookup (op =) raw_params
190 val lookup_string = the_default "" o lookup
191 fun general_lookup_bool option default_value name =
193 SOME s => parse_bool_option option name s
194 | NONE => default_value
195 val lookup_bool = the o general_lookup_bool false (SOME false)
196 fun lookup_time name =
198 SOME s => parse_time_option name s
200 fun lookup_int name =
203 | SOME s => case Int.fromString s of
205 | NONE => error ("Parameter " ^ quote name ^
206 " must be assigned an integer value.")
207 fun lookup_real_pair name =
210 | SOME s => case s |> space_explode " " |> map Real.fromString of
211 [SOME r1, SOME r2] => (r1, r2)
212 | _ => error ("Parameter " ^ quote name ^
213 "must be assigned a pair of floating-point \
214 \values (e.g., \"0.6 0.95\")")
215 fun lookup_int_option name =
218 | _ => SOME (lookup_int name)
219 val blocking = auto orelse lookup_bool "blocking"
220 val debug = not auto andalso lookup_bool "debug"
221 val verbose = debug orelse (not auto andalso lookup_bool "verbose")
222 val overlord = lookup_bool "overlord"
223 val provers = lookup_string "provers" |> space_explode " "
224 |> auto ? single o hd
226 case (lookup_string "type_sys", lookup_bool "full_types") of
227 ("tags", full_types) => Tags full_types
228 | ("preds", full_types) => Preds full_types
229 | ("const_args", _) => Const_Args
230 | ("none", _) => No_Types
231 | ("smart", true) => Tags true
232 | ("smart", false) => Const_Args
233 | (type_sys, _) => error ("Unknown type system: " ^ quote type_sys ^ ".")
234 val explicit_apply = lookup_bool "explicit_apply"
235 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
236 val max_relevant = lookup_int_option "max_relevant"
237 val isar_proof = lookup_bool "isar_proof"
238 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
239 val timeout = (if auto then NONE else lookup_time "timeout") |> the_timeout
240 val expect = lookup_string "expect"
242 {blocking = blocking, debug = debug, verbose = verbose, overlord = overlord,
243 provers = provers, type_sys = type_sys, explicit_apply = explicit_apply,
244 relevance_thresholds = relevance_thresholds, max_relevant = max_relevant,
245 isar_proof = isar_proof, isar_shrink_factor = isar_shrink_factor,
246 timeout = timeout, expect = expect}
249 fun get_params auto ctxt = extract_params auto (default_raw_params ctxt)
250 fun default_params thy = get_params false thy o map (apsnd single)
252 (* Sledgehammer the given subgoal *)
254 val sledgehammerN = "sledgehammer"
255 val sledgehammer_paramsN = "sledgehammer_params"
258 val minimizeN = "minimize"
259 val messagesN = "messages"
260 val available_proversN = "available_provers"
261 val running_proversN = "running_provers"
262 val kill_proversN = "kill_provers"
263 val refresh_tptpN = "refresh_tptp"
265 val is_raw_param_relevant_for_minimize =
266 member (op =) params_for_minimize o fst o unalias_raw_param
267 fun string_for_raw_param (key, values) =
268 key ^ (case space_implode " " values of "" => "" | value => " = " ^ value)
270 fun minimize_command override_params i prover_name fact_names =
271 sledgehammerN ^ " " ^ minimizeN ^ " [prover = " ^ prover_name ^
272 (override_params |> filter is_raw_param_relevant_for_minimize
273 |> implode o map (prefix ", " o string_for_raw_param)) ^
274 "] (" ^ space_implode " " fact_names ^ ")" ^
275 (if i = 1 then "" else " " ^ string_of_int i)
277 fun hammer_away override_params subcommand opt_i relevance_override state =
279 val ctxt = Proof.context_of state
280 val _ = app check_raw_param override_params
282 if subcommand = runN then
283 let val i = the_default 1 opt_i in
284 run_sledgehammer (get_params false ctxt override_params) false i
285 relevance_override (minimize_command override_params i)
289 else if subcommand = minimizeN then
290 run_minimize (get_params false ctxt override_params) (the_default 1 opt_i)
291 (#add relevance_override) state
292 else if subcommand = messagesN then
294 else if subcommand = available_proversN then
295 available_provers ctxt
296 else if subcommand = running_proversN then
298 else if subcommand = kill_proversN then
300 else if subcommand = refresh_tptpN then
301 refresh_systems_on_tptp ()
303 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
306 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
307 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
310 fun string_for_raw_param (name, value) = name ^ " = " ^ space_implode " " value
312 fun sledgehammer_params_trans params =
314 (fold set_default_raw_param params
316 let val ctxt = ProofContext.init_global thy in
317 writeln ("Default parameters for Sledgehammer:\n" ^
318 (case default_raw_params ctxt |> rev of
321 (map check_raw_param params;
322 params |> map string_for_raw_param
323 |> sort_strings |> cat_lines)))
326 val parse_key = Scan.repeat1 Parse.typ_group >> space_implode " "
327 val parse_value = Scan.repeat1 (Parse.xname || Parse.float_number)
328 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
329 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
330 val parse_fact_refs =
331 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
332 val parse_relevance_chunk =
333 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
334 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
335 || (parse_fact_refs >> only_relevance_override)
336 val parse_relevance_override =
337 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
338 >> merge_relevance_overrides))
339 no_relevance_override
340 val parse_sledgehammer_command =
341 (Scan.optional Parse.short_ident runN -- parse_params
342 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
343 val parse_sledgehammer_params_command =
344 parse_params #>> sledgehammer_params_trans
347 Outer_Syntax.improper_command sledgehammerN
348 "search for first-order proof using automatic theorem provers" Keyword.diag
349 parse_sledgehammer_command
351 Outer_Syntax.command sledgehammer_paramsN
352 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
353 parse_sledgehammer_params_command
355 fun auto_sledgehammer state =
356 let val ctxt = Proof.context_of state in
357 run_sledgehammer (get_params true ctxt []) true 1 no_relevance_override
358 (minimize_command [] 1) state
361 val setup = Auto_Tools.register_tool (auto, auto_sledgehammer)