src/HOL/Tools/res_atp.ML
author mengj
Wed Sep 20 13:53:03 2006 +0200 (2006-09-20)
changeset 20643 267f30cbe2cb
parent 20532 64181717e37c
child 20661 46832fee1215
permissions -rw-r--r--
Removed include_min_comb and include_combS.
     1 (*  Author: Jia Meng, Cambridge University Computer Laboratory, NICTA
     2     ID: $Id$
     3     Copyright 2004 University of Cambridge
     4 
     5 ATPs with TPTP format input.
     6 *)
     7 
     8 (*FIXME: Do we need this signature?*)
     9 signature RES_ATP =
    10 sig
    11   val prover: string ref
    12   val custom_spass: string list ref
    13   val destdir: string ref
    14   val helper_path: string -> string -> string
    15   val problem_name: string ref
    16   val time_limit: int ref
    17    
    18   datatype mode = Auto | Fol | Hol
    19   val linkup_logic_mode : mode ref
    20   val write_subgoal_file: bool -> mode -> Proof.context -> thm list -> thm list -> int -> string
    21   val vampire_time: int ref
    22   val eprover_time: int ref
    23   val spass_time: int ref
    24   val run_vampire: int -> unit
    25   val run_eprover: int -> unit
    26   val run_spass: int -> unit
    27   val vampireLimit: unit -> int
    28   val eproverLimit: unit -> int
    29   val spassLimit: unit -> int
    30   val atp_method: (Proof.context -> thm list -> int -> tactic) ->
    31     Method.src -> Proof.context -> Proof.method
    32   val cond_rm_tmp: string -> unit
    33   val keep_atp_input: bool ref
    34   val fol_keep_types: bool ref
    35   val hol_full_types: unit -> unit
    36   val hol_partial_types: unit -> unit
    37   val hol_const_types_only: unit -> unit
    38   val hol_no_types: unit -> unit
    39   val hol_typ_level: unit -> ResHolClause.type_level
    40   val include_all: bool ref
    41   val run_relevance_filter: bool ref
    42   val run_blacklist_filter: bool ref
    43   val blacklist: string list ref
    44   val add_all : unit -> unit
    45   val add_claset : unit -> unit
    46   val add_simpset : unit -> unit
    47   val add_clasimp : unit -> unit
    48   val add_atpset : unit -> unit
    49   val rm_all : unit -> unit
    50   val rm_claset : unit -> unit
    51   val rm_simpset : unit -> unit
    52   val rm_atpset : unit -> unit
    53   val rm_clasimp : unit -> unit
    54 end;
    55 
    56 structure ResAtp =
    57 struct
    58 
    59 (********************************************************************)
    60 (* some settings for both background automatic ATP calling procedure*)
    61 (* and also explicit ATP invocation methods                         *)
    62 (********************************************************************)
    63 
    64 (*** background linkup ***)
    65 val call_atp = ref false; 
    66 val hook_count = ref 0;
    67 val time_limit = ref 80;
    68 val prover = ref "E";   (* use E as the default prover *)
    69 val custom_spass =   (*specialized options for SPASS*)
    70       ref ["-Auto=0","-FullRed=0","-IORe","-IOFc","-RTaut","-RFSub","-RBSub"];
    71 val destdir = ref "";   (*Empty means write files to /tmp*)
    72 val problem_name = ref "prob";
    73 
    74 (*Return the path to a "helper" like SPASS or tptp2X, first checking that
    75   it exists.  FIXME: modify to use Path primitives and move to some central place.*)  
    76 fun helper_path evar base =
    77   case getenv evar of
    78       "" => error  ("Isabelle environment variable " ^ evar ^ " not defined")
    79     | home => 
    80         let val path = home ^ "/" ^ base
    81         in  if File.exists (File.unpack_platform_path path) then path 
    82 	    else error ("Could not find the file " ^ path)
    83 	end;  
    84 
    85 fun probfile_nosuffix _ = 
    86   if !destdir = "" then File.platform_path (File.tmp_path (Path.basic (!problem_name)))
    87   else if File.exists (File.unpack_platform_path (!destdir))
    88   then !destdir ^ "/" ^ !problem_name
    89   else error ("No such directory: " ^ !destdir);
    90 
    91 fun prob_pathname n = probfile_nosuffix n ^ "_" ^ Int.toString n;
    92 
    93 
    94 (*** ATP methods ***)
    95 val vampire_time = ref 60;
    96 val eprover_time = ref 60;
    97 val spass_time = ref 60;
    98 
    99 fun run_vampire time =  
   100     if (time >0) then vampire_time:= time
   101     else vampire_time:=60;
   102 
   103 fun run_eprover time = 
   104     if (time > 0) then eprover_time:= time
   105     else eprover_time:=60;
   106 
   107 fun run_spass time = 
   108     if (time > 0) then spass_time:=time
   109     else spass_time:=60;
   110 
   111 
   112 fun vampireLimit () = !vampire_time;
   113 fun eproverLimit () = !eprover_time;
   114 fun spassLimit () = !spass_time;
   115 
   116 val keep_atp_input = ref false;
   117 val fol_keep_types = ResClause.keep_types;
   118 val hol_full_types = ResHolClause.full_types;
   119 val hol_partial_types = ResHolClause.partial_types;
   120 val hol_const_types_only = ResHolClause.const_types_only;
   121 val hol_no_types = ResHolClause.no_types;
   122 fun hol_typ_level () = ResHolClause.find_typ_level ();
   123 fun is_typed_hol () = 
   124     let val tp_level = hol_typ_level()
   125     in
   126 	not (tp_level = ResHolClause.T_NONE)
   127     end;
   128 
   129 fun atp_input_file () =
   130     let val file = !problem_name 
   131     in
   132 	if !destdir = "" then File.platform_path (File.tmp_path (Path.basic file))
   133 	else if File.exists (File.unpack_platform_path (!destdir))
   134 	then !destdir ^ "/" ^ file
   135 	else error ("No such directory: " ^ !destdir)
   136     end;
   137 
   138 val include_all = ref false;
   139 val include_simpset = ref false;
   140 val include_claset = ref false; 
   141 val include_atpset = ref true;
   142 
   143 (*Tests show that follow_defs gives VERY poor results with "include_all"*)
   144 fun add_all() = (include_all:=true; ReduceAxiomsN.follow_defs := false);
   145 fun rm_all() = include_all:=false;
   146 
   147 fun add_simpset() = include_simpset:=true;
   148 fun rm_simpset() = include_simpset:=false;
   149 
   150 fun add_claset() = include_claset:=true;
   151 fun rm_claset() = include_claset:=false;
   152 
   153 fun add_clasimp() = (include_simpset:=true;include_claset:=true);
   154 fun rm_clasimp() = (include_simpset:=false;include_claset:=false);
   155 
   156 fun add_atpset() = include_atpset:=true;
   157 fun rm_atpset() = include_atpset:=false;
   158 
   159 
   160 (**** relevance filter ****)
   161 val run_relevance_filter = ReduceAxiomsN.run_relevance_filter;
   162 val run_blacklist_filter = ref true;
   163 
   164 (******************************************************************)
   165 (* detect whether a given problem (clauses) is FOL/HOL/HOLC/HOLCS *)
   166 (******************************************************************)
   167 
   168 datatype logic = FOL | HOL | HOLC | HOLCS;
   169 
   170 fun string_of_logic FOL = "FOL"
   171   | string_of_logic HOL = "HOL"
   172   | string_of_logic HOLC = "HOLC"
   173   | string_of_logic HOLCS = "HOLCS";
   174 
   175 fun is_fol_logic FOL = true
   176   | is_fol_logic  _ = false
   177 
   178 (*HOLCS will not occur here*)
   179 fun upgrade_lg HOLC _ = HOLC
   180   | upgrade_lg HOL HOLC = HOLC
   181   | upgrade_lg HOL _ = HOL
   182   | upgrade_lg FOL lg = lg; 
   183 
   184 (* check types *)
   185 fun has_bool_hfn (Type("bool",_)) = true
   186   | has_bool_hfn (Type("fun",_)) = true
   187   | has_bool_hfn (Type(_, Ts)) = exists has_bool_hfn Ts
   188   | has_bool_hfn _ = false;
   189 
   190 fun is_hol_fn tp =
   191     let val (targs,tr) = strip_type tp
   192     in
   193 	exists (has_bool_hfn) (tr::targs)
   194     end;
   195 
   196 fun is_hol_pred tp =
   197     let val (targs,tr) = strip_type tp
   198     in
   199 	exists (has_bool_hfn) targs
   200     end;
   201 
   202 exception FN_LG of term;
   203 
   204 fun fn_lg (t as Const(f,tp)) (lg,seen) = 
   205     if is_hol_fn tp then (upgrade_lg HOL lg, t ins seen) else (lg, t ins seen) 
   206   | fn_lg (t as Free(f,tp)) (lg,seen) = 
   207     if is_hol_fn tp then (upgrade_lg HOL lg, t ins seen) else (lg, t ins seen) 
   208   | fn_lg (t as Var(f,tp)) (lg,seen) =
   209     if is_hol_fn tp then (upgrade_lg HOL lg,t ins seen) else (lg,t ins seen)
   210   | fn_lg (t as Abs(_,_,_)) (lg,seen) = (upgrade_lg HOLC lg,t ins seen)
   211   | fn_lg f _ = raise FN_LG(f); 
   212 
   213 
   214 fun term_lg [] (lg,seen) = (lg,seen)
   215   | term_lg (tm::tms) (FOL,seen) =
   216       let val (f,args) = strip_comb tm
   217 	  val (lg',seen') = if f mem seen then (FOL,seen) 
   218 			    else fn_lg f (FOL,seen)
   219       in
   220 	if is_fol_logic lg' then ()
   221         else Output.debug ("Found a HOL term: " ^ Display.raw_string_of_term f);
   222         term_lg (args@tms) (lg',seen')
   223       end
   224   | term_lg _ (lg,seen) = (lg,seen)
   225 
   226 exception PRED_LG of term;
   227 
   228 fun pred_lg (t as Const(P,tp)) (lg,seen)= 
   229       if is_hol_pred tp then (upgrade_lg HOL lg, t ins seen) else (lg,t ins seen) 
   230   | pred_lg (t as Free(P,tp)) (lg,seen) =
   231       if is_hol_pred tp then (upgrade_lg HOL lg, t ins seen) else (lg,t ins seen)
   232   | pred_lg (t as Var(_,_)) (lg,seen) = (upgrade_lg HOL lg, t ins seen)
   233   | pred_lg P _ = raise PRED_LG(P);
   234 
   235 
   236 fun lit_lg (Const("Not",_) $ P) (lg,seen) = lit_lg P (lg,seen)
   237   | lit_lg P (lg,seen) =
   238       let val (pred,args) = strip_comb P
   239 	  val (lg',seen') = if pred mem seen then (lg,seen) 
   240 			    else pred_lg pred (lg,seen)
   241       in
   242 	if is_fol_logic lg' then ()
   243 	else Output.debug ("Found a HOL predicate: " ^ Display.raw_string_of_term pred);
   244 	term_lg args (lg',seen')
   245       end;
   246 
   247 fun lits_lg [] (lg,seen) = (lg,seen)
   248   | lits_lg (lit::lits) (FOL,seen) =
   249       let val (lg,seen') = lit_lg lit (FOL,seen)
   250       in
   251 	if is_fol_logic lg then ()
   252 	else Output.debug ("Found a HOL literal: " ^ Display.raw_string_of_term lit);
   253 	lits_lg lits (lg,seen')
   254       end
   255   | lits_lg lits (lg,seen) = (lg,seen);
   256 
   257 fun dest_disj_aux (Const ("op |", _) $ t $ t') disjs = 
   258     dest_disj_aux t (dest_disj_aux t' disjs)
   259   | dest_disj_aux t disjs = t::disjs;
   260 
   261 fun dest_disj t = dest_disj_aux t [];
   262 
   263 fun logic_of_clause tm (lg,seen) =
   264     let val tm' = HOLogic.dest_Trueprop tm
   265 	val disjs = dest_disj tm'
   266     in
   267 	lits_lg disjs (lg,seen)
   268     end;
   269 
   270 fun logic_of_clauses [] (lg,seen) = (lg,seen)
   271   | logic_of_clauses (cls::clss) (FOL,seen) =
   272     let val (lg,seen') = logic_of_clause cls (FOL,seen)
   273 	val _ =
   274           if is_fol_logic lg then ()
   275           else Output.debug ("Found a HOL clause: " ^ Display.raw_string_of_term cls)
   276     in
   277 	logic_of_clauses clss (lg,seen')
   278     end
   279   | logic_of_clauses (cls::clss) (lg,seen) = (lg,seen);
   280 
   281 fun problem_logic_goals_aux [] (lg,seen) = lg
   282   | problem_logic_goals_aux (subgoal::subgoals) (lg,seen) = 
   283     problem_logic_goals_aux subgoals (logic_of_clauses subgoal (lg,seen));
   284     
   285 fun problem_logic_goals subgoals = problem_logic_goals_aux subgoals (FOL,[]);
   286 
   287 (***************************************************************)
   288 (* Retrieving and filtering lemmas                             *)
   289 (***************************************************************)
   290 
   291 (*** white list and black list of lemmas ***)
   292 
   293 (*The rule subsetI is frequently omitted by the relevance filter.*)
   294 val whitelist = ref [subsetI]; 
   295 
   296 (*Names of theorems and theorem lists to be banned. The final numeric suffix of
   297   theorem lists is first removed.
   298 
   299   These theorems typically produce clauses that are prolific (match too many equality or
   300   membership literals) and relate to seldom-used facts. Some duplicate other rules.
   301   FIXME: this blacklist needs to be maintained using theory data and added to using
   302   an attribute.*)
   303 val blacklist = ref
   304   ["Datatype.prod.size",
   305    "Datatype.unit.induct", (*"unit" thms cause unsound proofs; unit.nchotomy is caught automatically*)
   306    "Datatype.unit.inducts",
   307    "Datatype.unit.split_asm", 
   308    "Datatype.unit.split",
   309    "Datatype.unit.splits",
   310    "Divides.dvd_0_left_iff",
   311    "Finite_Set.card_0_eq",
   312    "Finite_Set.card_infinite",
   313    "Finite_Set.Max_ge",
   314    "Finite_Set.Max_in",
   315    "Finite_Set.Max_le_iff",
   316    "Finite_Set.Max_less_iff",
   317    "Finite_Set.max.f_below_strict_below.below_f_conv", (*duplicates in Orderings.*)
   318    "Finite_Set.max.f_below_strict_below.strict_below_f_conv", (*duplicates in Orderings.*)
   319    "Finite_Set.Min_ge_iff",
   320    "Finite_Set.Min_gr_iff",
   321    "Finite_Set.Min_in",
   322    "Finite_Set.Min_le",
   323    "Finite_Set.min_max.below_inf_sup_Inf_Sup.inf_Sup_absorb", 
   324    "Finite_Set.min_max.below_inf_sup_Inf_Sup.sup_Inf_absorb", 
   325    "Finite_Set.min.f_below_strict_below.below_f_conv",        (*duplicates in Orderings.*)
   326    "Finite_Set.min.f_below_strict_below.strict_below_f_conv", (*duplicates in Orderings.*)
   327    "Fun.vimage_image_eq",   (*involves an existential quantifier*)
   328    "HOL.split_if_asm",     (*splitting theorem*)
   329    "HOL.split_if",         (*splitting theorem*)
   330    "IntDef.abs_split",
   331    "IntDef.Integ.Abs_Integ_inject",
   332    "IntDef.Integ.Abs_Integ_inverse",
   333    "IntDiv.zdvd_0_left",
   334    "List.append_eq_append_conv",
   335    "List.hd_Cons_tl",   (*Says everything is [] or Cons. Probably prolific.*)
   336    "List.in_listsD",
   337    "List.in_listsI",
   338    "List.lists.Cons",
   339    "List.listsE",
   340    "Nat.less_one", (*not directional? obscure*)
   341    "Nat.not_gr0",
   342    "Nat.one_eq_mult_iff", (*duplicate by symmetry*)
   343    "NatArith.of_nat_0_eq_iff",
   344    "NatArith.of_nat_eq_0_iff",
   345    "NatArith.of_nat_le_0_iff",
   346    "NatSimprocs.divide_le_0_iff_number_of",  (*too many clauses*)
   347    "NatSimprocs.divide_less_0_iff_number_of",
   348    "NatSimprocs.equation_minus_iff_1",  (*not directional*)
   349    "NatSimprocs.equation_minus_iff_number_of", (*not directional*)
   350    "NatSimprocs.le_minus_iff_1", (*not directional*)
   351    "NatSimprocs.le_minus_iff_number_of",  (*not directional*)
   352    "NatSimprocs.less_minus_iff_1", (*not directional*)
   353    "NatSimprocs.less_minus_iff_number_of", (*not directional*)
   354    "NatSimprocs.minus_equation_iff_number_of", (*not directional*)
   355    "NatSimprocs.minus_le_iff_1", (*not directional*)
   356    "NatSimprocs.minus_le_iff_number_of", (*not directional*)
   357    "NatSimprocs.minus_less_iff_1", (*not directional*)
   358    "NatSimprocs.mult_le_cancel_left_number_of", (*excessive case analysis*)
   359    "NatSimprocs.mult_le_cancel_right_number_of", (*excessive case analysis*)
   360    "NatSimprocs.mult_less_cancel_left_number_of", (*excessive case analysis*)
   361    "NatSimprocs.mult_less_cancel_right_number_of", (*excessive case analysis*)
   362    "NatSimprocs.zero_le_divide_iff_number_of", (*excessive case analysis*)
   363    "NatSimprocs.zero_less_divide_iff_number_of",
   364    "OrderedGroup.abs_0_eq", (*duplicate by symmetry*)
   365    "OrderedGroup.diff_eq_0_iff_eq", (*prolific?*)
   366    "OrderedGroup.join_0_eq_0",
   367    "OrderedGroup.meet_0_eq_0",
   368    "OrderedGroup.pprt_eq_0",   (*obscure*)
   369    "OrderedGroup.pprt_eq_id",   (*obscure*)
   370    "OrderedGroup.pprt_mono",   (*obscure*)
   371    "Orderings.split_max",      (*splitting theorem*)
   372    "Orderings.split_min",      (*splitting theorem*)
   373    "Parity.even_nat_power",   (*obscure, somewhat prolilfic*)
   374    "Parity.power_eq_0_iff_number_of",
   375    "Parity.power_le_zero_eq_number_of",   (*obscure and prolific*)
   376    "Parity.power_less_zero_eq_number_of",
   377    "Parity.zero_le_power_eq_number_of",   (*obscure and prolific*)
   378    "Parity.zero_less_power_eq_number_of",   (*obscure and prolific*)
   379    "Power.zero_less_power_abs_iff",
   380    "Product_Type.split_eta_SetCompr",   (*involves an existential quantifier*)
   381    "Product_Type.split_paired_Ball_Sigma",     (*splitting theorem*)
   382    "Product_Type.split_paired_Bex_Sigma",      (*splitting theorem*)
   383    "Product_Type.split_split_asm",             (*splitting theorem*)
   384    "Product_Type.split_split",                 (*splitting theorem*)
   385    "Product_Type.unit_abs_eta_conv",
   386    "Product_Type.unit_induct",
   387    "Relation.diagI",
   388    "Relation.Domain_def",   (*involves an existential quantifier*)
   389    "Relation.Image_def",   (*involves an existential quantifier*)
   390    "Relation.ImageI",
   391    "Ring_and_Field.divide_cancel_left", (*fields are seldom used & often prolific*)
   392    "Ring_and_Field.divide_cancel_right",
   393    "Ring_and_Field.divide_divide_eq_left",
   394    "Ring_and_Field.divide_divide_eq_right",
   395    "Ring_and_Field.divide_eq_0_iff",
   396    "Ring_and_Field.divide_eq_1_iff",
   397    "Ring_and_Field.divide_eq_eq_1",
   398    "Ring_and_Field.divide_le_0_1_iff",
   399    "Ring_and_Field.divide_le_eq_1_neg",  (*obscure and prolific*)
   400    "Ring_and_Field.divide_le_eq_1_pos",  (*obscure and prolific*)
   401    "Ring_and_Field.divide_less_0_1_iff",
   402    "Ring_and_Field.divide_less_eq_1_neg",  (*obscure and prolific*)
   403    "Ring_and_Field.divide_less_eq_1_pos",  (*obscure and prolific*)
   404    "Ring_and_Field.eq_divide_eq_1", (*duplicate by symmetry*)
   405    "Ring_and_Field.field_mult_cancel_left",
   406    "Ring_and_Field.field_mult_cancel_right",
   407    "Ring_and_Field.inverse_le_iff_le_neg",
   408    "Ring_and_Field.inverse_le_iff_le",
   409    "Ring_and_Field.inverse_less_iff_less_neg",
   410    "Ring_and_Field.inverse_less_iff_less",
   411    "Ring_and_Field.le_divide_eq_1_neg", (*obscure and prolific*)
   412    "Ring_and_Field.le_divide_eq_1_pos", (*obscure and prolific*)
   413    "Ring_and_Field.less_divide_eq_1_neg", (*obscure and prolific*)
   414    "Ring_and_Field.less_divide_eq_1_pos", (*obscure and prolific*)
   415    "Ring_and_Field.one_eq_divide_iff",  (*duplicate by symmetry*)
   416    "Set.ball_simps", "Set.bex_simps",   (*quantifier rewriting: useless*)
   417    "Set.Collect_bex_eq",   (*involves an existential quantifier*)
   418    "Set.Collect_ex_eq",   (*involves an existential quantifier*)
   419    "Set.Diff_eq_empty_iff", (*redundant with paramodulation*)
   420    "Set.Diff_insert0",
   421    "Set.disjoint_insert",
   422    "Set.empty_Union_conv",   (*redundant with paramodulation*)
   423    "Set.full_SetCompr_eq",   (*involves an existential quantifier*)
   424    "Set.image_Collect",      (*involves an existential quantifier*)
   425    "Set.image_def",          (*involves an existential quantifier*)
   426    "Set.insert_disjoint",
   427    "Set.Int_UNIV",  (*redundant with paramodulation*)
   428    "Set.Inter_iff", (*We already have InterI, InterE*)
   429    "Set.Inter_UNIV_conv",
   430    "Set.psubsetE",    (*too prolific and obscure*)
   431    "Set.psubsetI",
   432    "Set.singleton_insert_inj_eq'",
   433    "Set.singleton_insert_inj_eq",
   434    "Set.singletonD",  (*these two duplicate some "insert" lemmas*)
   435    "Set.singletonI",
   436    "Set.Un_empty", (*redundant with paramodulation*)
   437    "Set.UNION_def",   (*involves an existential quantifier*)
   438    "Set.Union_empty_conv", (*redundant with paramodulation*)
   439    "Set.Union_iff",              (*We already have UnionI, UnionE*)
   440    "SetInterval.atLeastAtMost_iff", (*obscure and prolific*)
   441    "SetInterval.atLeastLessThan_iff", (*obscure and prolific*)
   442    "SetInterval.greaterThanAtMost_iff", (*obscure and prolific*)
   443    "SetInterval.greaterThanLessThan_iff", (*obscure and prolific*)
   444    "SetInterval.ivl_subset"];  (*excessive case analysis*)
   445 
   446 
   447 (*These might be prolific but are probably OK, and min and max are basic.
   448    "Orderings.max_less_iff_conj", 
   449    "Orderings.min_less_iff_conj",
   450    "Orderings.min_max.below_inf.below_inf_conv",
   451    "Orderings.min_max.below_sup.above_sup_conv",
   452 Very prolific and somewhat obscure:
   453    "Set.InterD",
   454    "Set.UnionI",
   455 *)
   456 
   457 (*** retrieve lemmas from clasimpset and atpset, may filter them ***)
   458 
   459 fun fake_thm_name th = 
   460     Context.theory_name (theory_of_thm th) ^ "." ^ gensym"";
   461 
   462 fun put_name_pair ("",th) = (fake_thm_name th, th)
   463   | put_name_pair (a,th)  = (a,th);
   464 
   465 (*Hashing to detect duplicate and variant clauses, e.g. from the [iff] attribute*)
   466 
   467 exception HASH_CLAUSE and HASH_STRING;
   468 
   469 (*Catches (for deletion) theorems automatically generated from other theorems*)
   470 fun insert_suffixed_names ht x = 
   471      (Polyhash.insert ht (x^"_iff1", ()); 
   472       Polyhash.insert ht (x^"_iff2", ()); 
   473       Polyhash.insert ht (x^"_dest", ())); 
   474 
   475 (*Are all characters in this string digits?*)
   476 fun all_numeric s = null (String.tokens Char.isDigit s);
   477 
   478 (*Delete a suffix of the form _\d+*)
   479 fun delete_numeric_suffix s =
   480   case rev (String.fields (fn c => c = #"_") s) of
   481       last::rest => 
   482           if all_numeric last 
   483           then [s, space_implode "_" (rev rest)]
   484           else [s]
   485     | [] => [s];
   486 
   487 fun banned_thmlist s =
   488   (Sign.base_name s) mem_string ["induct","inducts","split","splits","split_asm"];
   489 
   490 fun make_banned_test xs = 
   491   let val ht = Polyhash.mkTable (Polyhash.hash_string, op =)
   492                                 (6000, HASH_STRING)
   493       fun banned_aux s = isSome (Polyhash.peek ht s) orelse banned_thmlist s
   494       fun banned s = exists banned_aux (delete_numeric_suffix s)
   495   in  app (fn x => Polyhash.insert ht (x,())) (!blacklist);
   496       app (insert_suffixed_names ht) (!blacklist @ xs); 
   497       banned
   498   end;
   499 
   500 (** a hash function from Term.term to int, and also a hash table **)
   501 val xor_words = List.foldl Word.xorb 0w0;
   502 
   503 fun hashw_term ((Const(c,_)), w) = Polyhash.hashw_string (c,w)
   504   | hashw_term ((Free(_,_)), w) = w
   505   | hashw_term ((Var(_,_)), w) = w
   506   | hashw_term ((Bound _), w) = w
   507   | hashw_term ((Abs(_,_,t)), w) = hashw_term (t, w)
   508   | hashw_term ((P$Q), w) = hashw_term (Q, (hashw_term (P, w)));
   509 
   510 fun hashw_pred (P,w) = 
   511     let val (p,args) = strip_comb P
   512     in
   513 	List.foldl hashw_term w (p::args)
   514     end;
   515 
   516 fun hash_literal (Const("Not",_)$P) = Word.notb(hashw_pred(P,0w0))
   517   | hash_literal P = hashw_pred(P,0w0);
   518 
   519 
   520 fun get_literals (Const("Trueprop",_)$P) lits = get_literals P lits
   521   | get_literals (Const("op |",_)$P$Q) lits = get_literals Q (get_literals P lits)
   522   | get_literals lit lits = (lit::lits);
   523 
   524 
   525 fun hash_term t = Word.toIntX (xor_words (map hash_literal (get_literals t [])));
   526 
   527 fun equal_thm (thm1,thm2) = Term.aconv(prop_of thm1, prop_of thm2);
   528 
   529 (*Create a hash table for clauses, of the given size*)
   530 fun mk_clause_table n =
   531       Polyhash.mkTable (hash_term o prop_of, equal_thm)
   532                        (n, HASH_CLAUSE);
   533 
   534 (*Use a hash table to eliminate duplicates from xs. Argument is a list of
   535   (name, theorem) pairs, but the theorems are hashed into the table. *)
   536 fun make_unique xs = 
   537   let val ht = mk_clause_table 2200
   538   in
   539       (app (ignore o Polyhash.peekInsert ht) (map swap xs);  
   540        map swap (Polyhash.listItems ht))
   541   end;
   542 
   543 (*FIXME: SLOW!!!*)
   544 fun mem_thm th [] = false
   545   | mem_thm th ((th',_)::thms_names) = equal_thm (th,th') orelse mem_thm th thms_names;
   546 
   547 (*FIXME: SLOW!!! These two functions are called only by get_relevant_clauses.
   548   It would be faster to compare names, rather than theorems, and to use
   549   a symbol table or hash table.*)
   550 fun insert_thms [] thms_names = thms_names
   551   | insert_thms ((thm,name)::thms_names) thms_names' =
   552       if mem_thm thm thms_names' then insert_thms thms_names thms_names' 
   553       else insert_thms thms_names ((thm,name)::thms_names');
   554 
   555 (* filter axiom clauses, but keep supplied clauses and clauses in whitelist *)
   556 fun get_relevant_clauses thy cls_thms white_cls goals =
   557   insert_thms white_cls (ReduceAxiomsN.relevance_filter thy cls_thms goals);
   558 
   559 
   560 fun display_thms [] = ()
   561   | display_thms ((name,thm)::nthms) = 
   562       let val nthm = name ^ ": " ^ (string_of_thm thm)
   563       in Output.debug nthm; display_thms nthms  end;
   564  
   565 fun all_facts_of ctxt =
   566   FactIndex.find (ProofContext.fact_index_of ctxt) ([], [])
   567   |> maps #2 |> map (`Thm.name_of_thm);
   568 
   569 (* get lemmas from claset, simpset, atpset and extra supplied rules *)
   570 fun get_clasimp_atp_lemmas ctxt user_thms = 
   571   let val included_thms =
   572 	if !include_all 
   573 	then (tap (fn ths => Output.debug
   574 	             ("Including all " ^ Int.toString (length ths) ^ " theorems")) 
   575 	          (all_facts_of ctxt @ PureThy.all_thms_of (ProofContext.theory_of ctxt)))
   576 	else 
   577 	let val claset_thms =
   578 		if !include_claset then ResAxioms.claset_rules_of_ctxt ctxt
   579 		else []
   580 	    val simpset_thms = 
   581 		if !include_simpset then ResAxioms.simpset_rules_of_ctxt ctxt
   582 		else []
   583 	    val atpset_thms =
   584 		if !include_atpset then ResAxioms.atpset_rules_of_ctxt ctxt
   585 		else []
   586 	    val _ = if !Output.show_debug_msgs 
   587 		    then (Output.debug "ATP theorems: "; display_thms atpset_thms) 
   588 		    else ()		 
   589 	in  claset_thms @ simpset_thms @ atpset_thms  end
   590       val user_rules = map (put_name_pair o ResAxioms.pairname)
   591 			   (if null user_thms then !whitelist else user_thms)
   592   in
   593       (map put_name_pair included_thms, user_rules)
   594   end;
   595 
   596 (*Remove lemmas that are banned from the backlist. Also remove duplicates. *)
   597 fun blacklist_filter thms = 
   598   if !run_blacklist_filter then 
   599       let val banned = make_banned_test (map #1 thms)
   600 	  fun ok (a,_) = not (banned a)
   601       in  filter ok thms  end
   602   else thms;
   603 
   604 
   605 (***************************************************************)
   606 (* ATP invocation methods setup                                *)
   607 (***************************************************************)
   608 
   609 fun cnf_hyps_thms ctxt = 
   610     let val ths = Assumption.prems_of ctxt
   611     in fold (fold (insert Thm.eq_thm) o ResAxioms.skolem_thm) ths [] end;
   612 
   613 (*Translation mode can be auto-detected, or forced to be first-order or higher-order*)
   614 datatype mode = Auto | Fol | Hol;
   615 
   616 val linkup_logic_mode = ref Auto;
   617 
   618 (*Ensures that no higher-order theorems "leak out"*)
   619 fun restrict_to_logic logic cls =
   620   if is_fol_logic logic then filter (Meson.is_fol_term o prop_of o fst) cls 
   621 	                else cls;
   622 
   623 fun tptp_writer logic goals filename (axioms,classrels,arities) user_lemmas =
   624     if is_fol_logic logic 
   625     then ResClause.tptp_write_file goals filename (axioms, classrels, arities)
   626     else ResHolClause.tptp_write_file goals filename (axioms, classrels, arities) user_lemmas;
   627 
   628 fun dfg_writer logic goals filename (axioms,classrels,arities) user_lemmas =
   629     if is_fol_logic logic 
   630     then ResClause.dfg_write_file goals filename (axioms, classrels, arities)
   631     else ResHolClause.dfg_write_file goals filename (axioms, classrels, arities) user_lemmas;
   632 
   633 (*Called by the oracle-based methods declared in res_atp_methods.ML*)
   634 fun write_subgoal_file dfg mode ctxt conjectures user_thms n =
   635     let val conj_cls = make_clauses conjectures 
   636                          |> ResAxioms.assume_abstract_list |> Meson.finish_cnf
   637 	val hyp_cls = cnf_hyps_thms ctxt
   638 	val goal_cls = conj_cls@hyp_cls
   639 	val logic = case mode of 
   640                             Auto => problem_logic_goals [map prop_of goal_cls]
   641 			  | Fol => FOL
   642 			  | Hol => HOL
   643 	val (included_thms,user_rules) = get_clasimp_atp_lemmas ctxt user_thms
   644 	val user_lemmas_names = map #1 user_rules
   645 	val cla_simp_atp_clauses = included_thms |> blacklist_filter
   646 	                             |> make_unique |> ResAxioms.cnf_rules_pairs
   647                                      |> restrict_to_logic logic 
   648 	val user_cls = ResAxioms.cnf_rules_pairs user_rules
   649 	val thy = ProofContext.theory_of ctxt
   650 	val axclauses = get_relevant_clauses thy cla_simp_atp_clauses
   651 	                            user_cls (map prop_of goal_cls)
   652 	val keep_types = if is_fol_logic logic then !fol_keep_types else is_typed_hol ()
   653 	val classrel_clauses = if keep_types then ResClause.classrel_clauses_thy thy else []
   654 	val arity_clauses = if keep_types then ResClause.arity_clause_thy thy else []
   655         val writer = if dfg then dfg_writer else tptp_writer 
   656 	val file = atp_input_file()
   657     in
   658 	(writer logic goal_cls file (axclauses,classrel_clauses,arity_clauses) user_lemmas_names;
   659 	 Output.debug ("Writing to " ^ file);
   660 	 file)
   661     end;
   662 
   663 
   664 (**** remove tmp files ****)
   665 fun cond_rm_tmp file = 
   666     if !keep_atp_input then Output.debug "ATP input kept..." 
   667     else if !destdir <> "" then Output.debug ("ATP input kept in directory " ^ (!destdir))
   668     else (Output.debug "deleting ATP inputs..."; OS.FileSys.remove file);
   669 
   670 
   671 (****** setup ATPs as Isabelle methods ******)
   672 fun atp_meth' tac ths ctxt = 
   673     Method.SIMPLE_METHOD' HEADGOAL
   674     (tac ctxt ths);
   675 
   676 fun atp_meth tac ths ctxt = 
   677     let val thy = ProofContext.theory_of ctxt
   678 	val _ = ResClause.init thy
   679 	val _ = ResHolClause.init thy
   680     in
   681 	atp_meth' tac ths ctxt
   682     end;
   683 
   684 fun atp_method tac = Method.thms_ctxt_args (atp_meth tac);
   685 
   686 (***************************************************************)
   687 (* automatic ATP invocation                                    *)
   688 (***************************************************************)
   689 
   690 (* call prover with settings and problem file for the current subgoal *)
   691 fun watcher_call_provers sign sg_terms (childin, childout, pid) =
   692   let
   693     fun make_atp_list [] n = []
   694       | make_atp_list (sg_term::xs) n =
   695           let
   696             val probfile = prob_pathname n
   697             val time = Int.toString (!time_limit)
   698           in
   699             Output.debug ("problem file in watcher_call_provers is " ^ probfile);
   700             (*options are separated by Watcher.setting_sep, currently #"%"*)
   701             if !prover = "spass"
   702             then
   703               let val spass = helper_path "SPASS_HOME" "SPASS"
   704                   val sopts =
   705    "-Auto%-SOS=1%-PGiven=0%-PProblem=0%-Splits=0%-FullRed=0%-DocProof%-TimeLimit=" ^ time
   706               in 
   707                   ("spass", spass, sopts, probfile) :: make_atp_list xs (n+1)
   708               end
   709             else if !prover = "vampire"
   710 	    then 
   711               let val vampire = helper_path "VAMPIRE_HOME" "vampire"
   712                   val casc = if !time_limit > 70 then "--mode casc%" else ""
   713                   val vopts = casc ^ "-m 100000%-t " ^ time
   714               in
   715                   ("vampire", vampire, vopts, probfile) :: make_atp_list xs (n+1)
   716               end
   717       	     else if !prover = "E"
   718       	     then
   719 	       let val Eprover = helper_path "E_HOME" "eproof"
   720 	       in
   721 		  ("E", Eprover, 
   722 		     "--tptp-in%-l5%-xAuto%-tAuto%--silent%--cpu-limit=" ^ time, probfile) ::
   723 		   make_atp_list xs (n+1)
   724 	       end
   725 	     else error ("Invalid prover name: " ^ !prover)
   726           end
   727 
   728     val atp_list = make_atp_list sg_terms 1
   729   in
   730     Watcher.callResProvers(childout,atp_list);
   731     Output.debug "Sent commands to watcher!"
   732   end
   733   
   734 fun trace_array fname =
   735   let val path = File.tmp_path (Path.basic fname)
   736   in  Array.app (File.append path o (fn s => s ^ "\n"))  end;
   737 
   738 (*Converting a subgoal into negated conjecture clauses*)
   739 fun neg_clauses th n =
   740   let val tacs = [rtac ccontr, ObjectLogic.atomize_tac, skolemize_tac]
   741       val st = Seq.hd (EVERY' tacs n th)
   742       val negs = Option.valOf (metahyps_thms n st)
   743   in make_clauses negs |> ResAxioms.assume_abstract_list |> Meson.finish_cnf end;
   744 		                       
   745 (*We write out problem files for each subgoal. Argument probfile generates filenames,
   746   and allows the suppression of the suffix "_1" in problem-generation mode.
   747   FIXME: does not cope with &&, and it isn't easy because one could have multiple
   748   subgoals, each involving &&.*)
   749 fun write_problem_files probfile (ctxt,th)  =
   750   let val goals = Thm.prems_of th
   751       val _ = Output.debug ("number of subgoals = " ^ Int.toString (length goals))
   752       val thy = ProofContext.theory_of ctxt
   753       fun get_neg_subgoals [] _ = []
   754         | get_neg_subgoals (gl::gls) n = neg_clauses th n :: get_neg_subgoals gls (n+1)
   755       val goal_cls = get_neg_subgoals goals 1
   756       val logic = case !linkup_logic_mode of
   757 		Auto => problem_logic_goals (map ((map prop_of)) goal_cls)
   758 	      | Fol => FOL
   759 	      | Hol => HOL
   760       val (included_thms,white_thms) = get_clasimp_atp_lemmas ctxt []
   761       val included_cls = included_thms |> blacklist_filter
   762                                        |> make_unique |> ResAxioms.cnf_rules_pairs 
   763                                        |> restrict_to_logic logic 
   764       val white_cls = ResAxioms.cnf_rules_pairs white_thms
   765       (*clauses relevant to goal gl*)
   766       val axcls_list = map (fn gl => get_relevant_clauses thy included_cls white_cls [gl])
   767                            goals
   768       val _ = Output.debug ("clauses = " ^ Int.toString(length included_cls))
   769       val keep_types = if is_fol_logic logic then !ResClause.keep_types 
   770                        else is_typed_hol ()
   771       val classrel_clauses = if keep_types then ResClause.classrel_clauses_thy thy
   772                              else []
   773       val _ = Output.debug ("classrel clauses = " ^ 
   774                             Int.toString (length classrel_clauses))
   775       val arity_clauses = if keep_types then ResClause.arity_clause_thy thy 
   776                           else []
   777       val _ = Output.debug ("arity clauses = " ^ Int.toString (length arity_clauses))
   778       val writer = if !prover = "spass" then dfg_writer else tptp_writer 
   779       fun write_all [] [] _ = []
   780 	| write_all (ccls::ccls_list) (axcls::axcls_list) k =
   781 	   (writer logic ccls (probfile k) (axcls,classrel_clauses,arity_clauses) [],
   782 	    probfile k) 
   783 	   :: write_all ccls_list axcls_list (k+1)
   784       val (clnames::_, filenames) = ListPair.unzip (write_all goal_cls axcls_list 1)
   785       val thm_names = Array.fromList clnames
   786       val _ = if !Output.show_debug_msgs 
   787               then trace_array "thm_names" thm_names else ()
   788   in
   789       (filenames, thm_names)
   790   end;
   791 
   792 val last_watcher_pid = ref (NONE : (TextIO.instream * TextIO.outstream * 
   793                                     Posix.Process.pid * string list) option);
   794 
   795 fun kill_last_watcher () =
   796     (case !last_watcher_pid of 
   797          NONE => ()
   798        | SOME (_, _, pid, files) => 
   799 	  (Output.debug ("Killing old watcher, pid = " ^ string_of_pid pid);
   800 	   Watcher.killWatcher pid;  
   801 	   ignore (map (try OS.FileSys.remove) files)))
   802      handle OS.SysErr _ => Output.debug "Attempt to kill watcher failed";
   803 
   804 (*writes out the current clasimpset to a tptp file;
   805   turns off xsymbol at start of function, restoring it at end    *)
   806 val isar_atp = setmp print_mode [] 
   807  (fn (ctxt, th) =>
   808   if Thm.no_prems th then ()
   809   else
   810     let
   811       val _ = kill_last_watcher()
   812       val (files,thm_names) = write_problem_files prob_pathname (ctxt,th)
   813       val (childin, childout, pid) = Watcher.createWatcher (th, thm_names)
   814     in
   815       last_watcher_pid := SOME (childin, childout, pid, files);
   816       Output.debug ("problem files: " ^ space_implode ", " files); 
   817       Output.debug ("pid: " ^ string_of_pid pid);
   818       watcher_call_provers (sign_of_thm th) (Thm.prems_of th) (childin, childout, pid)
   819     end);
   820 
   821 val isar_atp_writeonly = setmp print_mode [] 
   822       (fn (ctxt,th) =>
   823        if Thm.no_prems th then ()
   824        else 
   825          let val probfile = if Thm.nprems_of th = 1 then probfile_nosuffix 
   826           	            else prob_pathname
   827          in ignore (write_problem_files probfile (ctxt,th)) end);
   828 
   829 
   830 (** the Isar toplevel hook **)
   831 
   832 fun invoke_atp_ml (ctxt, goal) =
   833   let val thy = ProofContext.theory_of ctxt;
   834   in
   835     Output.debug ("subgoals in isar_atp:\n" ^ 
   836 		  Pretty.string_of (ProofContext.pretty_term ctxt
   837 		    (Logic.mk_conjunction_list (Thm.prems_of goal))));
   838     Output.debug ("current theory: " ^ Context.theory_name thy);
   839     inc hook_count;
   840     Output.debug ("in hook for time: " ^ Int.toString (!hook_count));
   841     ResClause.init thy;
   842     ResHolClause.init thy;
   843     if !destdir = "" andalso !time_limit > 0 then isar_atp (ctxt, goal)
   844     else isar_atp_writeonly (ctxt, goal)
   845   end;
   846 
   847 val invoke_atp = Toplevel.no_timing o Toplevel.unknown_proof o Toplevel.keep
   848  (fn state =>
   849   let val (ctxt, (_, goal)) = Proof.get_goal (Toplevel.proof_of state)
   850   in  invoke_atp_ml (ctxt, goal)  end);
   851 
   852 val call_atpP =
   853   OuterSyntax.command 
   854     "ProofGeneral.call_atp" 
   855     "call automatic theorem provers" 
   856     OuterKeyword.diag
   857     (Scan.succeed invoke_atp);
   858 
   859 val _ = OuterSyntax.add_parsers [call_atpP];
   860 
   861 end;