helm/ocaml/tactics/proofEngineHelpers.mli

   1 (* Copyright (C) 2000-2002, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://cs.unibo.it/helm/.
  24  *)
  25
  26 exception Bad_pattern of string
  27
  28 (* Returns the first meta whose number is above the *)
  29 (* number of the higher meta.                       *)
  30 val new_meta_of_proof : proof:ProofEngineTypes.proof -> int
  31
  32 val subst_meta_in_proof :
  33   ProofEngineTypes.proof ->
  34   int -> Cic.term -> Cic.metasenv ->
  35   ProofEngineTypes.proof * Cic.metasenv
  36 val subst_meta_and_metasenv_in_proof :
  37   ProofEngineTypes.proof ->
  38   int -> (Cic.term -> Cic.term) -> Cic.metasenv ->
  39   ProofEngineTypes.proof * Cic.metasenv
  40
  41 (* returns the list of goals that are in newmetasenv and were not in
  42    oldmetasenv *)
  43 val compare_metasenvs :
  44   oldmetasenv:Cic.metasenv -> newmetasenv:Cic.metasenv -> int list
  45
  46
  47 (** { Patterns }
  48  * A pattern is a Cic term in which Cic.Implicit terms annotated with `Hole
  49  * appears *)
  50
  51 (** create a pattern from a term and a list of subterms.
  52 * the pattern is granted to have a ? for every subterm that has no selected
  53 * subterms
  54 * @param equality equality function used while walking the term. Defaults to
  55 * physical equality (==) *)
  56 val pattern_of:
  57  ?equality:(Cic.term -> Cic.term -> bool) -> term:Cic.term -> Cic.term list ->
  58    Cic.term
  59
  60
  61 (** select metasenv conjecture pattern
  62 * select all subterms of [conjecture] matching [pattern].
  63 * It returns the set of matched terms (that can be compared using physical
  64 * equality to the subterms of [conjecture]) together with their contexts.
  65 * The representation of the set mimics the conjecture type (but for the id):
  66 * a list of (possibly removed) hypothesis (without their names) together with
  67 * the list of its matched subterms (and their contexts) + the list of matched
  68 * subterms of the conclusion with their context. Note: in the result the list
  69 * of hypotheses * has an entry for each entry in the context and in the same
  70 * order. Of course the list of terms (with their context) associated to one
  71 * hypothesis may be empty. *)
  72 val select:
  73  metasenv:Cic.metasenv ->
  74  ugraph:CicUniv.universe_graph ->
  75  conjecture:Cic.conjecture ->
  76  pattern:ProofEngineTypes.pattern ->
  77   Cic.substitution * Cic.metasenv * CicUniv.universe_graph *
  78   [ `Decl of (Cic.context * Cic.term) list
  79   | `Def of (Cic.context * Cic.term) list * (Cic.context * Cic.term) list option
  80   ] option list *
  81   (Cic.context * Cic.term) list
  82
  83 exception TermNotFound
  84 exception TermFoundMultipleTimes
  85
  86 (** locate_in_term equality what where context
  87 * [what] must match a subterm of [where] according to [equality]
  88 * It returns the matched term together with its context in [where]
  89 * [equality] defaults to physical equality
  90 * [context] must be the context of [where]
  91 * It may raise TermNotFound or TermFoundMultipleTimes
  92 *)
  93 val locate_in_term:
  94  ?equality:(Cic.term -> Cic.term -> bool) -> Cic.term -> where:Cic.term ->
  95   Cic.context -> Cic.context * Cic.term
  96
  97 (** locate_in_conjecture equality what where
  98 * [what] must match a subterm of [where] according to [equality]
  99 * It returns the context of [what] in [where]
 100 * [equality] defaults to physical equality
 101 * It may raise TermNotFound or TermFoundMultipleTimes
 102 *)
 103 val locate_in_conjecture:
 104  ?equality:(Cic.term -> Cic.term -> bool) -> Cic.term -> Cic.conjecture ->
 105   Cic.context
 106
 107 (* saturate_term newmeta metasenv context ty                                  *)
 108 (* Given a type [ty] (a backbone), it returns its head and a new metasenv in  *)
 109 (* which there is new a META for each hypothesis, a list of arguments for the *)
 110 (* new applications and the index of the last new META introduced. The nth    *)
 111 (* argument in the list of arguments is just the nth new META.                *)
 112 val saturate_term:
 113  int -> Cic.metasenv -> Cic.context -> Cic.term ->
 114   Cic.term * Cic.metasenv * Cic.term list * int
 115
 116 (* returns the index and the type of a premise in a context *)
 117 val lookup_type: Cic.metasenv -> Cic.context -> string -> int * Cic.term
 118