misc tuning and comments based on review of Theory_Data, Proof_Data, Generic_Data usage;
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 ("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 [("no_debug", "debug"),
96 ("no_overlord", "overlord"),
97 ("non_blocking", "blocking"),
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 is_prover_list ctxt s =
115 case space_explode " " s of
116 ss as _ :: _ => forall (is_prover_available ctxt) ss
119 fun check_and_repair_raw_param ctxt (name, value) =
120 if is_known_raw_param name then (name, value)
121 else if is_prover_list ctxt name andalso null value then ("provers", [name])
122 else error ("Unknown parameter: " ^ quote name ^ ".")
124 fun unalias_raw_param (name, value) =
125 case AList.lookup (op =) alias_params name of
126 SOME name' => (name', value)
128 case AList.lookup (op =) negated_alias_params name of
129 SOME name' => (name', case value of
130 ["false"] => ["true"]
131 | ["true"] => ["false"]
134 | NONE => (name, value)
136 structure Data = Theory_Data
138 type T = raw_param list
139 val empty = default_default_params |> map (apsnd single)
141 fun merge data : T = AList.merge (op =) (K true) data
144 fun remotify_prover_if_available_and_not_already_remote ctxt name =
145 if String.isPrefix remote_prefix name then
148 let val remote_name = remote_prefix ^ name in
149 if is_prover_available ctxt remote_name then SOME remote_name else NONE
152 fun remotify_prover_if_not_installed ctxt name =
153 if is_prover_available ctxt name andalso is_prover_installed ctxt name then
156 remotify_prover_if_available_and_not_already_remote ctxt name
158 fun avoid_too_many_local_threads _ _ [] = []
159 | avoid_too_many_local_threads ctxt 0 provers =
160 map_filter (remotify_prover_if_available_and_not_already_remote ctxt)
162 | avoid_too_many_local_threads ctxt n (prover :: provers) =
163 let val n = if String.isPrefix remote_prefix prover then n else n - 1 in
164 prover :: avoid_too_many_local_threads ctxt n provers
167 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
168 timeout, it makes sense to put SPASS first. *)
169 fun default_provers_param_value ctxt =
170 [spassN, eN, vampireN, sine_eN, SMT_Solver.solver_name_of ctxt]
171 |> map_filter (remotify_prover_if_not_installed ctxt)
172 |> avoid_too_many_local_threads ctxt (Multithreading.max_threads_value ())
175 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
176 fun default_raw_params ctxt =
177 let val thy = ProofContext.theory_of ctxt in
179 |> fold (AList.default (op =))
180 [("provers", [case !provers of
181 "" => default_provers_param_value ctxt
183 ("full_types", [if !full_types then "true" else "false"]),
184 ("timeout", let val timeout = !timeout in
185 [if timeout <= 0 then "none"
186 else string_of_int timeout]
190 val smart_full_type_sys = Tags true
191 val smart_partial_type_sys = Const_Args
193 val infinity_time_in_secs = 60 * 60 * 24 * 365
194 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
196 fun extract_params auto default_params override_params =
198 val override_params = map unalias_raw_param override_params
199 val raw_params = rev override_params @ rev default_params
200 val lookup = Option.map (space_implode " ") o AList.lookup (op =) raw_params
201 val lookup_string = the_default "" o lookup
202 fun general_lookup_bool option default_value name =
204 SOME s => parse_bool_option option name s
205 | NONE => default_value
206 val lookup_bool = the o general_lookup_bool false (SOME false)
207 fun lookup_time name =
209 SOME s => parse_time_option name s
211 fun lookup_int name =
214 | SOME s => case Int.fromString s of
216 | NONE => error ("Parameter " ^ quote name ^
217 " must be assigned an integer value.")
218 fun lookup_real_pair name =
221 | SOME s => case s |> space_explode " " |> map Real.fromString of
222 [SOME r1, SOME r2] => (r1, r2)
223 | _ => error ("Parameter " ^ quote name ^
224 "must be assigned a pair of floating-point \
225 \values (e.g., \"0.6 0.95\")")
226 fun lookup_int_option name =
229 | _ => SOME (lookup_int name)
230 val debug = not auto andalso lookup_bool "debug"
231 val verbose = debug orelse (not auto andalso lookup_bool "verbose")
232 val overlord = lookup_bool "overlord"
233 val blocking = auto orelse debug orelse lookup_bool "blocking"
234 val provers = lookup_string "provers" |> space_explode " "
235 |> auto ? single o hd
237 case (lookup_string "type_sys", lookup_bool "full_types") of
238 ("tags", full_types) => Tags full_types
239 | ("preds", full_types) => Preds full_types
240 | ("const_args", false) => Const_Args
241 | ("none", false) => No_Types
242 | (type_sys, full_types) =>
243 if member (op =) ["const_args", "none", "smart"] type_sys then
244 if full_types then smart_full_type_sys else smart_partial_type_sys
246 error ("Unknown type system: " ^ quote type_sys ^ ".")
247 val explicit_apply = lookup_bool "explicit_apply"
248 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
249 val max_relevant = lookup_int_option "max_relevant"
250 val isar_proof = lookup_bool "isar_proof"
251 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
252 val timeout = (if auto then NONE else lookup_time "timeout") |> the_timeout
253 val expect = lookup_string "expect"
255 {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
256 provers = provers, type_sys = type_sys, explicit_apply = explicit_apply,
257 relevance_thresholds = relevance_thresholds, max_relevant = max_relevant,
258 isar_proof = isar_proof, isar_shrink_factor = isar_shrink_factor,
259 timeout = timeout, expect = expect}
262 fun get_params auto ctxt = extract_params auto (default_raw_params ctxt)
263 fun default_params thy = get_params false thy o map (apsnd single)
265 (* Sledgehammer the given subgoal *)
267 val sledgehammerN = "sledgehammer"
268 val sledgehammer_paramsN = "sledgehammer_params"
271 val minimizeN = "minimize"
272 val messagesN = "messages"
273 val available_proversN = "available_provers"
274 val running_proversN = "running_provers"
275 val kill_proversN = "kill_provers"
276 val refresh_tptpN = "refresh_tptp"
278 val is_raw_param_relevant_for_minimize =
279 member (op =) params_for_minimize o fst o unalias_raw_param
280 fun string_for_raw_param (key, values) =
281 key ^ (case space_implode " " values of "" => "" | value => " = " ^ value)
283 fun minimize_command override_params i prover_name fact_names =
284 sledgehammerN ^ " " ^ minimizeN ^ " [prover = " ^ prover_name ^
285 (override_params |> filter is_raw_param_relevant_for_minimize
286 |> implode o map (prefix ", " o string_for_raw_param)) ^
287 "] (" ^ space_implode " " fact_names ^ ")" ^
288 (if i = 1 then "" else " " ^ string_of_int i)
290 fun hammer_away override_params subcommand opt_i relevance_override state =
292 val ctxt = Proof.context_of state
293 val override_params =
294 override_params |> map (check_and_repair_raw_param ctxt)
296 if subcommand = runN then
297 let val i = the_default 1 opt_i in
298 run_sledgehammer (get_params false ctxt override_params) false i
299 relevance_override (minimize_command override_params i)
303 else if subcommand = minimizeN then
304 run_minimize (get_params false ctxt override_params) (the_default 1 opt_i)
305 (#add relevance_override) state
306 else if subcommand = messagesN then
308 else if subcommand = available_proversN then
309 available_provers ctxt
310 else if subcommand = running_proversN then
312 else if subcommand = kill_proversN then
314 else if subcommand = refresh_tptpN then
315 refresh_systems_on_tptp ()
317 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
320 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
321 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
324 fun string_for_raw_param (name, value) = name ^ " = " ^ space_implode " " value
326 fun sledgehammer_params_trans params =
328 (fold set_default_raw_param params
330 let val ctxt = ProofContext.init_global thy in
331 writeln ("Default parameters for Sledgehammer:\n" ^
332 (case default_raw_params ctxt |> rev of
335 params |> map (check_and_repair_raw_param ctxt)
336 |> map string_for_raw_param
337 |> sort_strings |> cat_lines))
340 val parse_key = Scan.repeat1 Parse.typ_group >> space_implode " "
341 val parse_value = Scan.repeat1 (Parse.xname || Parse.float_number)
342 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
343 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
344 val parse_fact_refs =
345 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
346 val parse_relevance_chunk =
347 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
348 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
349 || (parse_fact_refs >> only_relevance_override)
350 val parse_relevance_override =
351 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
352 >> merge_relevance_overrides))
353 no_relevance_override
354 val parse_sledgehammer_command =
355 (Scan.optional Parse.short_ident runN -- parse_params
356 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
357 val parse_sledgehammer_params_command =
358 parse_params #>> sledgehammer_params_trans
361 Outer_Syntax.improper_command sledgehammerN
362 "search for first-order proof using automatic theorem provers" Keyword.diag
363 parse_sledgehammer_command
365 Outer_Syntax.command sledgehammer_paramsN
366 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
367 parse_sledgehammer_params_command
369 fun auto_sledgehammer state =
370 let val ctxt = Proof.context_of state in
371 run_sledgehammer (get_params true ctxt []) true 1 no_relevance_override
372 (minimize_command [] 1) state
375 val setup = Auto_Tools.register_tool (auto, auto_sledgehammer)