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.params
11 val atps: string Unsynchronized.ref
12 val timeout: int Unsynchronized.ref
13 val full_types: bool Unsynchronized.ref
14 val default_params : theory -> (string * string) list -> params
17 structure Sledgehammer_Isar : SLEDGEHAMMER_ISAR =
21 open Sledgehammer_Util
23 open Sledgehammer_Fact_Minimize
25 (** Sledgehammer commands **)
27 fun add_to_relevance_override ns : relevance_override =
28 {add = ns, del = [], only = false}
29 fun del_from_relevance_override ns : relevance_override =
30 {add = [], del = ns, only = false}
31 fun only_relevance_override ns : relevance_override =
32 {add = ns, del = [], only = true}
33 fun merge_relevance_override_pairwise (r1 : relevance_override)
34 (r2 : relevance_override) =
35 {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
36 only = #only r1 andalso #only r2}
37 fun merge_relevance_overrides rs =
38 fold merge_relevance_override_pairwise rs (only_relevance_override [])
42 val atps = Unsynchronized.ref ""
43 val timeout = Unsynchronized.ref 60
44 val full_types = Unsynchronized.ref false
47 ProofGeneralPgip.add_preference Preferences.category_proof
48 (Preferences.string_pref atps
50 "Default automatic provers (separated by whitespace)")
53 ProofGeneralPgip.add_preference Preferences.category_proof
54 (Preferences.int_pref timeout
55 "Sledgehammer: Time Limit"
56 "ATPs will be interrupted after this time (in seconds)")
59 ProofGeneralPgip.add_preference Preferences.category_proof
60 (Preferences.bool_pref full_types
61 "Sledgehammer: Full Types" "ATPs will use full type information")
63 type raw_param = string * string list
65 val default_default_params =
68 ("overlord", "false"),
69 ("explicit_apply", "false"),
70 ("relevance_thresholds", "45 85"),
71 ("max_relevant", "smart"),
72 ("theory_relevant", "smart"),
73 ("isar_proof", "false"),
74 ("isar_shrink_factor", "1")]
78 val negated_alias_params =
79 [("no_debug", "debug"),
81 ("no_overlord", "overlord"),
82 ("partial_types", "full_types"),
83 ("implicit_apply", "explicit_apply"),
84 ("theory_irrelevant", "theory_relevant"),
85 ("no_isar_proof", "isar_proof")]
87 val params_for_minimize =
88 ["debug", "verbose", "overlord", "full_types", "isar_proof",
89 "isar_shrink_factor", "timeout"]
91 val property_dependent_params = ["atps", "full_types", "timeout"]
93 fun is_known_raw_param s =
94 AList.defined (op =) default_default_params s orelse
95 AList.defined (op =) alias_params s orelse
96 AList.defined (op =) negated_alias_params s orelse
97 member (op =) property_dependent_params s
99 fun check_raw_param (s, _) =
100 if is_known_raw_param s then ()
101 else error ("Unknown parameter: " ^ quote s ^ ".")
103 fun unalias_raw_param (name, value) =
104 case AList.lookup (op =) alias_params name of
105 SOME name' => (name', value)
107 case AList.lookup (op =) negated_alias_params name of
108 SOME name' => (name', case value of
109 ["false"] => ["true"]
110 | ["true"] => ["false"]
113 | NONE => (name, value)
115 structure Data = Theory_Data(
116 type T = raw_param list
117 val empty = default_default_params |> map (apsnd single)
119 fun merge p : T = AList.merge (op =) (K true) p)
121 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
122 fun default_raw_params thy =
124 |> fold (AList.default (op =))
125 [("atps", [case !atps of "" => default_atps_param_value () | s => s]),
126 ("full_types", [if !full_types then "true" else "false"]),
127 ("timeout", let val timeout = !timeout in
128 [if timeout <= 0 then "none"
129 else string_of_int timeout ^ " s"]
132 val infinity_time_in_secs = 60 * 60 * 24 * 365
133 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
135 fun extract_params default_params override_params =
137 val override_params = map unalias_raw_param override_params
138 val raw_params = rev override_params @ rev default_params
139 val lookup = Option.map (space_implode " ") o AList.lookup (op =) raw_params
140 val lookup_string = the_default "" o lookup
141 fun general_lookup_bool option default_value name =
143 SOME s => parse_bool_option option name s
144 | NONE => default_value
145 val lookup_bool = the o general_lookup_bool false (SOME false)
146 val lookup_bool_option = general_lookup_bool true NONE
147 fun lookup_time name =
148 the_timeout (case lookup name of
150 | SOME s => parse_time_option name s)
151 fun lookup_int name =
154 | SOME s => case Int.fromString s of
156 | NONE => error ("Parameter " ^ quote name ^
157 " must be assigned an integer value.")
158 fun lookup_int_pair name =
161 | SOME s => case s |> space_explode " " |> map Int.fromString of
162 [SOME n1, SOME n2] => (n1, n2)
163 | _ => error ("Parameter " ^ quote name ^
164 "must be assigned a pair of integer values \
166 fun lookup_int_option name =
169 | _ => SOME (lookup_int name)
170 val debug = lookup_bool "debug"
171 val verbose = debug orelse lookup_bool "verbose"
172 val overlord = lookup_bool "overlord"
173 val atps = lookup_string "atps" |> space_explode " "
174 val full_types = lookup_bool "full_types"
175 val explicit_apply = lookup_bool "explicit_apply"
176 val relevance_thresholds =
177 lookup_int_pair "relevance_thresholds"
178 |> pairself (fn n => 0.01 * Real.fromInt n)
179 val max_relevant = lookup_int_option "max_relevant"
180 val theory_relevant = lookup_bool_option "theory_relevant"
181 val isar_proof = lookup_bool "isar_proof"
182 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
183 val timeout = lookup_time "timeout"
185 {debug = debug, verbose = verbose, overlord = overlord, atps = atps,
186 full_types = full_types, explicit_apply = explicit_apply,
187 relevance_thresholds = relevance_thresholds, max_relevant = max_relevant,
188 theory_relevant = theory_relevant, isar_proof = isar_proof,
189 isar_shrink_factor = isar_shrink_factor, timeout = timeout}
192 fun get_params thy = extract_params (default_raw_params thy)
193 fun default_params thy = get_params thy o map (apsnd single)
195 (* Sledgehammer the given subgoal *)
197 val sledgehammerN = "sledgehammer"
198 val sledgehammer_paramsN = "sledgehammer_params"
201 val minimizeN = "minimize"
202 val messagesN = "messages"
203 val available_atpsN = "available_atps"
204 val running_atpsN = "running_atps"
205 val kill_atpsN = "kill_atps"
206 val refresh_tptpN = "refresh_tptp"
208 val is_raw_param_relevant_for_minimize =
209 member (op =) params_for_minimize o fst o unalias_raw_param
210 fun string_for_raw_param (key, values) =
211 key ^ (case space_implode " " values of "" => "" | value => " = " ^ value)
213 fun minimize_command override_params i atp_name fact_names =
214 sledgehammerN ^ " " ^ minimizeN ^ " [atp = " ^ atp_name ^
215 (override_params |> filter is_raw_param_relevant_for_minimize
216 |> implode o map (prefix ", " o string_for_raw_param)) ^
217 "] (" ^ space_implode " " fact_names ^ ")" ^
218 (if i = 1 then "" else " " ^ string_of_int i)
220 fun hammer_away override_params subcommand opt_i relevance_override state =
222 val thy = Proof.theory_of state
223 val _ = app check_raw_param override_params
225 if subcommand = runN then
226 let val i = the_default 1 opt_i in
227 run_sledgehammer (get_params thy override_params) i relevance_override
228 (minimize_command override_params i) state
230 else if subcommand = minimizeN then
231 run_minimize (get_params thy override_params) (the_default 1 opt_i)
232 (#add relevance_override) state
233 else if subcommand = messagesN then
235 else if subcommand = available_atpsN then
237 else if subcommand = running_atpsN then
239 else if subcommand = kill_atpsN then
241 else if subcommand = refresh_tptpN then
242 refresh_systems_on_tptp ()
244 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
247 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
248 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
251 fun string_for_raw_param (name, value) = name ^ " = " ^ space_implode " " value
253 fun sledgehammer_params_trans params =
255 (fold set_default_raw_param params
257 writeln ("Default parameters for Sledgehammer:\n" ^
258 (case rev (default_raw_params thy) of
261 (map check_raw_param params;
262 params |> map string_for_raw_param
263 |> sort_strings |> cat_lines)))))
265 val parse_key = Scan.repeat1 Parse.typ_group >> space_implode " "
266 val parse_value = Scan.repeat1 Parse.xname
267 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
268 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
269 val parse_fact_refs =
270 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon)
271 (Parse.xname -- Scan.option Attrib.thm_sel)
272 >> (fn (name, interval) =>
273 Facts.Named ((name, Position.none), interval)))
274 val parse_relevance_chunk =
275 (Args.add |-- Args.colon |-- parse_fact_refs >> add_to_relevance_override)
276 || (Args.del |-- Args.colon |-- parse_fact_refs
277 >> del_from_relevance_override)
278 || (parse_fact_refs >> only_relevance_override)
279 val parse_relevance_override =
280 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
281 >> merge_relevance_overrides))
282 (add_to_relevance_override [])
283 val parse_sledgehammer_command =
284 (Scan.optional Parse.short_ident runN -- parse_params
285 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
286 val parse_sledgehammer_params_command =
287 parse_params #>> sledgehammer_params_trans
290 Outer_Syntax.improper_command sledgehammerN
291 "search for first-order proof using automatic theorem provers" Keyword.diag
292 parse_sledgehammer_command
294 Outer_Syntax.command sledgehammer_paramsN
295 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
296 parse_sledgehammer_params_command