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