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