New functions UriManager.uri_is_var, UriManager.uri_is_con.

[helm.git] / helm / ocaml / cic / cicUtil.mli

diff --git a/helm/ocaml/cic/cicUtil.mli b/helm/ocaml/cic/cicUtil.mli
index 0b98e51fa1b66dd0c6fbed83b60992abbfc508e4..39316586e2360ec2fa702dfe52e33732cc381ee2 100644 (file)
--- a/helm/ocaml/cic/cicUtil.mli
+++ b/helm/ocaml/cic/cicUtil.mli
@@ -27,15 +27,55 @@ exception Meta_not_found of int
 exception Subst_not_found of int
 
 val lookup_meta: int -> Cic.metasenv -> Cic.conjecture
-val lookup_subst: int -> Cic.substitution -> Cic.context * Cic.term
+val lookup_subst: int -> Cic.substitution -> Cic.context * Cic.term * Cic.term
 val exists_meta: int -> Cic.metasenv -> bool
 val clean_up_local_context :
   Cic.substitution -> Cic.metasenv -> int -> (Cic.term option) list 
   -> (Cic.term option) list
 
 val is_closed : Cic.term -> bool
+val is_meta_closed : Cic.term -> bool
 
-val meta_closed : Cic.term -> bool
+  (** @raise Failure "not enough prods" *)
+val strip_prods: int -> Cic.term -> Cic.term
 
-val term_of_uri: string -> Cic.term
+(** conversions between terms which are fully representable as uris (Var, Const,
+ * Mutind, and MutConstruct) and corresponding tree representations *)
+val term_of_uri: UriManager.uri -> Cic.term (** @raise UriManager.IllFormedUri *)
+val uri_of_term: Cic.term -> UriManager.uri (** @raise Invalid_argument "uri_of_term" *)
 
+(*
+  (** packing/unpacking of several terms into a single one *)
+val pack: Cic.term list -> Cic.term
+val unpack: Cic.term -> Cic.term list
+*)
+
+(** {2 Cic selectors} *)
+
+val params_of_obj: Cic.obj -> UriManager.uri list
+val attributes_of_obj: Cic.obj -> Cic.attribute list
+
+(** {2 Contexts}
+ * A context is a Cic term in which Cic.Implicit terms annotated with `Hole
+ * appears *)
+
+(** create a context from a term and a list of subterm.
+* @param equality equality function used while walking the term. Defaults to
+* physical equality (==) *)
+val context_of:
+  ?equality:(Cic.term -> Cic.term -> bool) -> term:Cic.term -> Cic.term list ->
+    Cic.term
+
+(** select all subterms of a given term matching a given context (i.e. subtrees
+* rooted at context's holes. The first component is the number of binder the
+* term is below *)
+val select: term:Cic.term -> context:Cic.term -> (int * Cic.term) list
+
+(** mk_rels [howmany] [from] 
+ * creates a list of [howmany] rels starting from [from] in decreasing order *)
+val mk_rels : int -> int -> Cic.term list
+
+(** profile s
+ * returns a profiling function; [s] is used for labelling the total time at
+   the end of the execution *)
+val profile : string -> ('a -> 'b) -> 'a -> 'b