locate_in_* functions generalized to handle equalities in a context.

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

diff --git a/helm/ocaml/tactics/proofEngineHelpers.mli b/helm/ocaml/tactics/proofEngineHelpers.mli
index 574a9441318fd8c03f909dfe12d06011ff5ee563..6d1c7ffaa102a984ec8edef5fab9d0749c9dcbaa 100644 (file)
--- a/helm/ocaml/tactics/proofEngineHelpers.mli
+++ b/helm/ocaml/tactics/proofEngineHelpers.mli
@@ -68,7 +68,10 @@ val pattern_of:
 * 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. *)
+* hypothesis may be empty. 
+*
+* @raise Bad_pattern
+* *)
 val select:
  metasenv:Cic.metasenv ->
  ugraph:CicUniv.universe_graph ->
@@ -80,29 +83,25 @@ val select:
   ] option list *
   (Cic.context * Cic.term) list
 
-exception TermNotFound
-exception TermFoundMultipleTimes
-
 (** locate_in_term equality what where context
 * [what] must match a subterm of [where] according to [equality]
-* It returns the matched term together with its context in [where]
+* It returns the matched terms together with their contexts in [where]
 * [equality] defaults to physical equality
 * [context] must be the context of [where]
-* It may raise TermNotFound or TermFoundMultipleTimes
 *)
 val locate_in_term:
- ?equality:(Cic.term -> Cic.term -> bool) -> Cic.term -> where:Cic.term ->
-  Cic.context -> Cic.context * Cic.term
+ ?equality:(Cic.context -> Cic.term -> Cic.term -> bool) ->
+  Cic.term -> where:Cic.term -> Cic.context -> (Cic.context * Cic.term) list
 
-(** locate_in_conjecture equality what where
+(** locate_in_conjecture equality what where context
 * [what] must match a subterm of [where] according to [equality]
-* It returns the context of [what] in [where]
+* It returns the matched terms together with their contexts in [where]
 * [equality] defaults to physical equality
-* It may raise TermNotFound or TermFoundMultipleTimes
+* [context] must be the context of [where]
 *)
 val locate_in_conjecture:
- ?equality:(Cic.term -> Cic.term -> bool) -> Cic.term -> Cic.conjecture ->
-  Cic.context
+ ?equality:(Cic.context -> Cic.term -> Cic.term -> bool) ->
+  Cic.term -> Cic.conjecture -> (Cic.context * Cic.term) list
 
 (* saturate_term newmeta metasenv context ty                                  *)
 (* Given a type [ty] (a backbone), it returns its head and a new metasenv in  *)