src/HOL/Tools/Sledgehammer/sledgehammer_isar.ML
author blanchet
Thu Oct 21 14:55:09 2010 +0200 (2010-10-21 ago)
changeset 40059 6ad9081665db
parent 39335 87a9ff4d5817
child 40060 5ef6747aa619
permissions -rw-r--r--
use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet@36375
     1
(*  Title:      HOL/Tools/Sledgehammer/sledgehammer_isar.ML
blanchet@35866
     2
    Author:     Jasmin Blanchette, TU Muenchen
blanchet@35866
     3
blanchet@35866
     4
Adds "sledgehammer" and related commands to Isabelle/Isar's outer syntax.
blanchet@35866
     5
*)
blanchet@35866
     6
blanchet@35963
     7
signature SLEDGEHAMMER_ISAR =
blanchet@35963
     8
sig
blanchet@38021
     9
  type params = Sledgehammer.params
blanchet@35963
    10
blanchet@39318
    11
  val auto : bool Unsynchronized.ref
blanchet@40059
    12
  val provers : string Unsynchronized.ref
blanchet@39318
    13
  val timeout : int Unsynchronized.ref
blanchet@39318
    14
  val full_types : bool Unsynchronized.ref
blanchet@35963
    15
  val default_params : theory -> (string * string) list -> params
blanchet@39318
    16
  val setup : theory -> theory
blanchet@35963
    17
end;
blanchet@35963
    18
blanchet@35971
    19
structure Sledgehammer_Isar : SLEDGEHAMMER_ISAR =
blanchet@35866
    20
struct
blanchet@35866
    21
blanchet@38028
    22
open ATP_Systems
blanchet@35971
    23
open Sledgehammer_Util
blanchet@38021
    24
open Sledgehammer
blanchet@38988
    25
open Sledgehammer_Minimize
blanchet@35866
    26
blanchet@39318
    27
val auto = Unsynchronized.ref false
blanchet@39318
    28
blanchet@39318
    29
val _ =
blanchet@39318
    30
  ProofGeneralPgip.add_preference Preferences.category_tracing
blanchet@39318
    31
      (Preferences.bool_pref auto "auto-sledgehammer"
blanchet@39327
    32
           "Run Sledgehammer automatically.")
blanchet@39318
    33
blanchet@36394
    34
(** Sledgehammer commands **)
blanchet@36394
    35
blanchet@39318
    36
val no_relevance_override = {add = [], del = [], only = false}
blanchet@39318
    37
fun add_relevance_override ns : relevance_override =
blanchet@35966
    38
  {add = ns, del = [], only = false}
blanchet@39318
    39
fun del_relevance_override ns : relevance_override =
blanchet@35966
    40
  {add = [], del = ns, only = false}
blanchet@35966
    41
fun only_relevance_override ns : relevance_override =
blanchet@35966
    42
  {add = ns, del = [], only = true}
blanchet@36003
    43
fun merge_relevance_override_pairwise (r1 : relevance_override)
blanchet@36003
    44
                                      (r2 : relevance_override) =
blanchet@35966
    45
  {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
blanchet@36183
    46
   only = #only r1 andalso #only r2}
blanchet@36188
    47
fun merge_relevance_overrides rs =
blanchet@36188
    48
  fold merge_relevance_override_pairwise rs (only_relevance_override [])
blanchet@35965
    49
blanchet@36371
    50
(*** parameters ***)
blanchet@36371
    51
blanchet@40059
    52
val provers = Unsynchronized.ref ""
blanchet@39335
    53
val timeout = Unsynchronized.ref 30
blanchet@36371
    54
val full_types = Unsynchronized.ref false
blanchet@36371
    55
blanchet@36371
    56
val _ =
blanchet@36371
    57
  ProofGeneralPgip.add_preference Preferences.category_proof
blanchet@40059
    58
      (Preferences.string_pref provers
blanchet@40059
    59
          "Sledgehammer: Provers"
blanchet@36371
    60
          "Default automatic provers (separated by whitespace)")
blanchet@36371
    61
blanchet@36371
    62
val _ =
blanchet@36371
    63
  ProofGeneralPgip.add_preference Preferences.category_proof
blanchet@36371
    64
      (Preferences.int_pref timeout
blanchet@36373
    65
          "Sledgehammer: Time Limit"
blanchet@36371
    66
          "ATPs will be interrupted after this time (in seconds)")
blanchet@36371
    67
blanchet@36371
    68
val _ =
blanchet@36371
    69
  ProofGeneralPgip.add_preference Preferences.category_proof
blanchet@36371
    70
      (Preferences.bool_pref full_types
blanchet@36373
    71
          "Sledgehammer: Full Types" "ATPs will use full type information")
blanchet@36371
    72
blanchet@35963
    73
type raw_param = string * string list
blanchet@35963
    74
blanchet@35963
    75
val default_default_params =
blanchet@38982
    76
  [("blocking", "false"),
blanchet@38982
    77
   ("debug", "false"),
blanchet@35963
    78
   ("verbose", "false"),
blanchet@36143
    79
   ("overlord", "false"),
blanchet@36235
    80
   ("explicit_apply", "false"),
blanchet@38939
    81
   ("relevance_thresholds", "45 85"),
blanchet@38744
    82
   ("max_relevant", "smart"),
blanchet@35963
    83
   ("isar_proof", "false"),
blanchet@38590
    84
   ("isar_shrink_factor", "1")]
blanchet@35963
    85
blanchet@36140
    86
val alias_params =
blanchet@40059
    87
  [("prover", "provers"),
blanchet@40059
    88
   ("atps", "provers"), (* FIXME: legacy *)
blanchet@40059
    89
   ("atp", "provers")]  (* FIXME: legacy *)
blanchet@36140
    90
val negated_alias_params =
blanchet@38982
    91
  [("non_blocking", "blocking"),
blanchet@38982
    92
   ("no_debug", "debug"),
blanchet@35963
    93
   ("quiet", "verbose"),
blanchet@36143
    94
   ("no_overlord", "overlord"),
blanchet@36399
    95
   ("partial_types", "full_types"),
blanchet@36235
    96
   ("implicit_apply", "explicit_apply"),
blanchet@36908
    97
   ("no_isar_proof", "isar_proof")]
blanchet@35963
    98
blanchet@36281
    99
val params_for_minimize =
blanchet@38100
   100
  ["debug", "verbose", "overlord", "full_types", "isar_proof",
blanchet@38590
   101
   "isar_shrink_factor", "timeout"]
blanchet@36281
   102
blanchet@40059
   103
val property_dependent_params = ["provers", "full_types", "timeout"]
blanchet@35866
   104
blanchet@35963
   105
fun is_known_raw_param s =
blanchet@35963
   106
  AList.defined (op =) default_default_params s orelse
blanchet@36140
   107
  AList.defined (op =) alias_params s orelse
blanchet@36140
   108
  AList.defined (op =) negated_alias_params s orelse
blanchet@38985
   109
  member (op =) property_dependent_params s orelse s = "expect"
blanchet@35963
   110
blanchet@35963
   111
fun check_raw_param (s, _) =
blanchet@35963
   112
  if is_known_raw_param s then ()
blanchet@35963
   113
  else error ("Unknown parameter: " ^ quote s ^ ".")
blanchet@35866
   114
blanchet@36140
   115
fun unalias_raw_param (name, value) =
blanchet@36140
   116
  case AList.lookup (op =) alias_params name of
blanchet@36140
   117
    SOME name' => (name', value)
blanchet@36140
   118
  | NONE =>
blanchet@36140
   119
    case AList.lookup (op =) negated_alias_params name of
blanchet@36140
   120
      SOME name' => (name', case value of
blanchet@36140
   121
                              ["false"] => ["true"]
blanchet@36140
   122
                            | ["true"] => ["false"]
blanchet@36140
   123
                            | [] => ["false"]
blanchet@36140
   124
                            | _ => value)
blanchet@36140
   125
    | NONE => (name, value)
blanchet@35963
   126
blanchet@35963
   127
structure Data = Theory_Data(
blanchet@35963
   128
  type T = raw_param list
blanchet@35963
   129
  val empty = default_default_params |> map (apsnd single)
blanchet@35963
   130
  val extend = I
blanchet@35963
   131
  fun merge p : T = AList.merge (op =) (K true) p)
blanchet@35866
   132
blanchet@40059
   133
fun maybe_remote_atp thy name =
blanchet@40059
   134
  name |> not (is_atp_installed thy name) ? prefix remote_atp_prefix
blanchet@40059
   135
blanchet@40059
   136
(* The first ATP of the list is used by Auto Sledgehammer. Because of the low
blanchet@40059
   137
   timeout, it makes sense to put SPASS first. *)
blanchet@40059
   138
fun default_provers_param_value thy =
blanchet@40059
   139
  (filter (is_atp_installed thy) [spassN] @
blanchet@40059
   140
   [maybe_remote_atp thy eN,
blanchet@40059
   141
    if forall (is_atp_installed thy) [spassN, eN] then
blanchet@40059
   142
      remote_atp_prefix ^ vampireN
blanchet@40059
   143
    else
blanchet@40059
   144
      maybe_remote_atp thy vampireN,
blanchet@40059
   145
    remote_atp_prefix ^ sine_eN])
blanchet@40059
   146
  |> space_implode " "
blanchet@40059
   147
blanchet@36140
   148
val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
blanchet@35963
   149
fun default_raw_params thy =
blanchet@35963
   150
  Data.get thy
blanchet@36140
   151
  |> fold (AList.default (op =))
blanchet@40059
   152
          [("provers", [case !provers of
blanchet@40059
   153
                          "" => default_provers_param_value thy
blanchet@40059
   154
                        | s => s]),
blanchet@36140
   155
           ("full_types", [if !full_types then "true" else "false"]),
blanchet@36142
   156
           ("timeout", let val timeout = !timeout in
blanchet@36142
   157
                         [if timeout <= 0 then "none"
blanchet@36142
   158
                          else string_of_int timeout ^ " s"]
blanchet@36142
   159
                       end)]
blanchet@35963
   160
blanchet@35963
   161
val infinity_time_in_secs = 60 * 60 * 24 * 365
blanchet@35963
   162
val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
blanchet@35866
   163
blanchet@39318
   164
fun extract_params auto default_params override_params =
blanchet@35963
   165
  let
blanchet@36140
   166
    val override_params = map unalias_raw_param override_params
blanchet@35963
   167
    val raw_params = rev override_params @ rev default_params
blanchet@35963
   168
    val lookup = Option.map (space_implode " ") o AList.lookup (op =) raw_params
blanchet@35963
   169
    val lookup_string = the_default "" o lookup
blanchet@35963
   170
    fun general_lookup_bool option default_value name =
blanchet@35963
   171
      case lookup name of
blanchet@35970
   172
        SOME s => parse_bool_option option name s
blanchet@35963
   173
      | NONE => default_value
blanchet@35963
   174
    val lookup_bool = the o general_lookup_bool false (SOME false)
blanchet@35963
   175
    fun lookup_time name =
blanchet@39318
   176
      case lookup name of
blanchet@39318
   177
        SOME s => parse_time_option name s
blanchet@39318
   178
      | NONE => NONE
blanchet@35966
   179
    fun lookup_int name =
blanchet@35963
   180
      case lookup name of
blanchet@35966
   181
        NONE => 0
blanchet@35966
   182
      | SOME s => case Int.fromString s of
blanchet@35966
   183
                    SOME n => n
blanchet@35966
   184
                  | NONE => error ("Parameter " ^ quote name ^
blanchet@35966
   185
                                   " must be assigned an integer value.")
blanchet@38745
   186
    fun lookup_int_pair name =
blanchet@38745
   187
      case lookup name of
blanchet@38745
   188
        NONE => (0, 0)
blanchet@38745
   189
      | SOME s => case s |> space_explode " " |> map Int.fromString of
blanchet@38745
   190
                    [SOME n1, SOME n2] => (n1, n2)
blanchet@38745
   191
                  | _ => error ("Parameter " ^ quote name ^
blanchet@38745
   192
                                "must be assigned a pair of integer values \
blanchet@38745
   193
                                \(e.g., \"60 95\")")
blanchet@38589
   194
    fun lookup_int_option name =
blanchet@38589
   195
      case lookup name of
blanchet@38589
   196
        SOME "smart" => NONE
blanchet@38589
   197
      | _ => SOME (lookup_int name)
blanchet@39318
   198
    val blocking = auto orelse lookup_bool "blocking"
blanchet@39318
   199
    val debug = not auto andalso lookup_bool "debug"
blanchet@39318
   200
    val verbose = debug orelse (not auto andalso lookup_bool "verbose")
blanchet@36143
   201
    val overlord = lookup_bool "overlord"
blanchet@40059
   202
    val provers = lookup_string "provers" |> space_explode " "
blanchet@40059
   203
                  |> auto ? single o hd
blanchet@35963
   204
    val full_types = lookup_bool "full_types"
blanchet@36235
   205
    val explicit_apply = lookup_bool "explicit_apply"
blanchet@38745
   206
    val relevance_thresholds =
blanchet@38745
   207
      lookup_int_pair "relevance_thresholds"
blanchet@38745
   208
      |> pairself (fn n => 0.01 * Real.fromInt n)
blanchet@38744
   209
    val max_relevant = lookup_int_option "max_relevant"
blanchet@35963
   210
    val isar_proof = lookup_bool "isar_proof"
blanchet@36924
   211
    val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
blanchet@39318
   212
    val timeout = (if auto then NONE else lookup_time "timeout") |> the_timeout
blanchet@38985
   213
    val expect = lookup_string "expect"
blanchet@35963
   214
  in
blanchet@38982
   215
    {blocking = blocking, debug = debug, verbose = verbose, overlord = overlord,
blanchet@40059
   216
     provers = provers, full_types = full_types,
blanchet@40059
   217
     explicit_apply = explicit_apply,
blanchet@38745
   218
     relevance_thresholds = relevance_thresholds, max_relevant = max_relevant,
blanchet@38997
   219
     isar_proof = isar_proof, isar_shrink_factor = isar_shrink_factor,
blanchet@38997
   220
     timeout = timeout, expect = expect}
blanchet@35963
   221
  end
blanchet@35866
   222
blanchet@39318
   223
fun get_params auto thy = extract_params auto (default_raw_params thy)
blanchet@39318
   224
fun default_params thy = get_params false thy o map (apsnd single)
blanchet@35866
   225
blanchet@36373
   226
(* Sledgehammer the given subgoal *)
blanchet@36373
   227
blanchet@36373
   228
val sledgehammerN = "sledgehammer"
blanchet@36373
   229
val sledgehammer_paramsN = "sledgehammer_params"
blanchet@36373
   230
blanchet@35965
   231
val runN = "run"
blanchet@35965
   232
val minimizeN = "minimize"
blanchet@35965
   233
val messagesN = "messages"
blanchet@40059
   234
val available_proversN = "available_provers"
blanchet@40059
   235
val running_proversN = "running_provers"
blanchet@40059
   236
val kill_proversN = "kill_provers"
blanchet@35965
   237
val refresh_tptpN = "refresh_tptp"
blanchet@35866
   238
blanchet@36281
   239
val is_raw_param_relevant_for_minimize =
blanchet@36281
   240
  member (op =) params_for_minimize o fst o unalias_raw_param
blanchet@36281
   241
fun string_for_raw_param (key, values) =
blanchet@36481
   242
  key ^ (case space_implode " " values of "" => "" | value => " = " ^ value)
blanchet@36281
   243
blanchet@40059
   244
fun minimize_command override_params i prover_name fact_names =
blanchet@40059
   245
  sledgehammerN ^ " " ^ minimizeN ^ " [prover = " ^ prover_name ^
blanchet@36281
   246
  (override_params |> filter is_raw_param_relevant_for_minimize
blanchet@36281
   247
                   |> implode o map (prefix ", " o string_for_raw_param)) ^
blanchet@37171
   248
  "] (" ^ space_implode " " fact_names ^ ")" ^
blanchet@36281
   249
  (if i = 1 then "" else " " ^ string_of_int i)
blanchet@36281
   250
blanchet@35966
   251
fun hammer_away override_params subcommand opt_i relevance_override state =
blanchet@35963
   252
  let
blanchet@35963
   253
    val thy = Proof.theory_of state
blanchet@36481
   254
    val _ = app check_raw_param override_params
blanchet@35965
   255
  in
blanchet@35965
   256
    if subcommand = runN then
blanchet@36281
   257
      let val i = the_default 1 opt_i in
blanchet@39318
   258
        run_sledgehammer (get_params false thy override_params) false i
blanchet@39318
   259
                         relevance_override (minimize_command override_params i)
blanchet@39318
   260
                         state
blanchet@39318
   261
        |> K ()
blanchet@36281
   262
      end
blanchet@35965
   263
    else if subcommand = minimizeN then
blanchet@39318
   264
      run_minimize (get_params false thy override_params) (the_default 1 opt_i)
blanchet@38590
   265
                   (#add relevance_override) state
blanchet@35965
   266
    else if subcommand = messagesN then
blanchet@35965
   267
      messages opt_i
blanchet@40059
   268
    else if subcommand = available_proversN then
blanchet@40059
   269
      available_provers thy
blanchet@40059
   270
    else if subcommand = running_proversN then
blanchet@40059
   271
      running_provers ()
blanchet@40059
   272
    else if subcommand = kill_proversN then
blanchet@40059
   273
      kill_provers ()
blanchet@35965
   274
    else if subcommand = refresh_tptpN then
blanchet@35965
   275
      refresh_systems_on_tptp ()
blanchet@35965
   276
    else
blanchet@35965
   277
      error ("Unknown subcommand: " ^ quote subcommand ^ ".")
blanchet@35965
   278
  end
blanchet@35963
   279
blanchet@35966
   280
fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
blanchet@35966
   281
  Toplevel.keep (hammer_away params subcommand opt_i relevance_override
blanchet@35966
   282
                 o Toplevel.proof_of)
blanchet@35963
   283
blanchet@35963
   284
fun string_for_raw_param (name, value) = name ^ " = " ^ space_implode " " value
blanchet@35963
   285
blanchet@35965
   286
fun sledgehammer_params_trans params =
blanchet@35963
   287
  Toplevel.theory
blanchet@35965
   288
      (fold set_default_raw_param params
blanchet@39318
   289
       #> tap (fn thy =>
blanchet@35963
   290
                  writeln ("Default parameters for Sledgehammer:\n" ^
blanchet@35963
   291
                           (case rev (default_raw_params thy) of
blanchet@35963
   292
                              [] => "none"
blanchet@35963
   293
                            | params =>
blanchet@35963
   294
                              (map check_raw_param params;
blanchet@35963
   295
                               params |> map string_for_raw_param
blanchet@35963
   296
                                      |> sort_strings |> cat_lines)))))
blanchet@35963
   297
wenzelm@36960
   298
val parse_key = Scan.repeat1 Parse.typ_group >> space_implode " "
wenzelm@36960
   299
val parse_value = Scan.repeat1 Parse.xname
wenzelm@36960
   300
val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
wenzelm@36960
   301
val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
blanchet@35965
   302
val parse_fact_refs =
blanchet@38996
   303
  Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
blanchet@35966
   304
val parse_relevance_chunk =
blanchet@39318
   305
  (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
blanchet@39318
   306
  || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
blanchet@36188
   307
  || (parse_fact_refs >> only_relevance_override)
blanchet@35966
   308
val parse_relevance_override =
blanchet@36188
   309
  Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
blanchet@36188
   310
                              >> merge_relevance_overrides))
blanchet@39318
   311
                no_relevance_override
blanchet@35963
   312
val parse_sledgehammer_command =
blanchet@37399
   313
  (Scan.optional Parse.short_ident runN -- parse_params
blanchet@37399
   314
   -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
blanchet@35963
   315
val parse_sledgehammer_params_command =
blanchet@35963
   316
  parse_params #>> sledgehammer_params_trans
blanchet@35963
   317
blanchet@35963
   318
val _ =
wenzelm@36960
   319
  Outer_Syntax.improper_command sledgehammerN
wenzelm@36960
   320
      "search for first-order proof using automatic theorem provers" Keyword.diag
blanchet@36394
   321
      parse_sledgehammer_command
blanchet@35963
   322
val _ =
wenzelm@36960
   323
  Outer_Syntax.command sledgehammer_paramsN
wenzelm@36960
   324
      "set and display the default parameters for Sledgehammer" Keyword.thy_decl
blanchet@36394
   325
      parse_sledgehammer_params_command
blanchet@36394
   326
blanchet@39318
   327
fun auto_sledgehammer state =
blanchet@39318
   328
  if not (!auto) then
blanchet@39318
   329
    (false, state)
blanchet@39318
   330
  else
blanchet@39318
   331
    let val thy = Proof.theory_of state in
blanchet@39318
   332
      run_sledgehammer (get_params true thy []) true 1 no_relevance_override
blanchet@39318
   333
                       (minimize_command [] 1) state
blanchet@39318
   334
    end
blanchet@39318
   335
blanchet@39324
   336
val setup = Auto_Tools.register_tool ("sledgehammer", auto_sledgehammer)
blanchet@39318
   337
blanchet@35866
   338
end;