This commit makes ProofEngineHelpers.select reach its full potentials.

[helm.git] / helm / ocaml / tactics / proofEngineHelpers.mli

diff --git a/helm/ocaml/tactics/proofEngineHelpers.mli b/helm/ocaml/tactics/proofEngineHelpers.mli
index c11ad6ecaac179e63441525e07ea02d52229d564..85dc61e81d7fa5e03fbc86b115f5884453c63e3b 100644 (file)
--- a/helm/ocaml/tactics/proofEngineHelpers.mli
+++ b/helm/ocaml/tactics/proofEngineHelpers.mli
@@ -48,18 +48,22 @@ val compare_metasenvs :
  * A pattern is a Cic term in which Cic.Implicit terms annotated with `Hole
  * appears *)
 
-(** create a pattern from a term and a list of subterm.
-* @param equality equality function used while walking the term. Defaults to
-* physical equality (==) *)
-val pattern_of:
-  ?equality:(Cic.term -> Cic.term -> bool) -> term:Cic.term -> Cic.term list ->
-    Cic.term
-
-(** select context term (what,where)
-* select all subterms of [term] matching [what] in positions rooted at the holes
-* of the pattern [where]. [context] is the context of [term]. It returns
-* the list of the matched terms (that can be compared using physical equality)
-* together with their contexts. *)
+(** select metasenv conjecture pattern
+* select all subterms of [conjecture] matching [pattern].
+* It returns the set of matched terms (that can be compared using physical
+* equality to the subterms of [conjecture]) together with their contexts.
+* The representation of the set mimics the conjecture type (but for the id):
+* a list of (possibly removed) hypothesis (without their names) together with
+* the list of its matched subterms (and their contexts) + the list of matched
+* subterms of the conclusion with their context. Note: in the result the list
+* of hypotheses * has an entry for each entry in the context and in the same
+* order. Of course the list of terms (with their context) associated to one
+* hypothesis may be empty. *)
 val select:
- context:Cic.context -> term:Cic.term -> pattern:(Cic.term option * Cic.term) ->
+ metasenv:Cic.metasenv ->
+ conjecture:Cic.conjecture ->
+ pattern:ProofEngineTypes.pattern ->
+  [ `Decl of (Cic.context * Cic.term) list
+  | `Def of (Cic.context * Cic.term) list * (Cic.context * Cic.term) list option
+  ] option list *
   (Cic.context * Cic.term) list