version 0.7.1

[helm.git] / helm / ocaml / cic_disambiguation / disambiguate.mli

diff --git a/helm/ocaml/cic_disambiguation/disambiguate.mli b/helm/ocaml/cic_disambiguation/disambiguate.mli
index 7093b1c9fd72aee206bdfd4437e3a6e7c5864aad..ca33fa4226db2cdd4c667b1090692eb43634faa6 100644 (file)
--- a/helm/ocaml/cic_disambiguation/disambiguate.mli
+++ b/helm/ocaml/cic_disambiguation/disambiguate.mli
@@ -23,38 +23,59 @@
  * http://helm.cs.unibo.it/
  *)
 
-open Disambiguate_struct
-open Disambiguate_types
+(** {2 Disambiguation interface} *)
 
-type interpretation_domain = Domain.t
-type domain_and_interpretation = interpretation_domain * interpretation
+exception NoWellTypedInterpretation
+exception PathNotWellFormed
 
-(*
-val add_symbol_choice:
-  string -> string * interpretation_codomain_item -> unit
-val add_symbol_choices:
-  string -> (string * interpretation_codomain_item) list -> unit
+val interpretate_path :
+ context:Cic.name list -> env:DisambiguateTypes.environment -> CicAst.term ->
+  Cic.term
 
-val add_num_choice: string * interpretation_codomain_item -> unit
-*)
 
-module Make (C : Callbacks) :
-    sig
-      exception NoWellTypedInterpretation
+module type Disambiguator =
+sig
+  val disambiguate_term :
+    dbd:Mysql.dbd ->
+    context:Cic.context ->
+    metasenv:Cic.metasenv ->
+    ?initial_ugraph:CicUniv.universe_graph -> 
+    aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
+    CicAst.term ->
+    (DisambiguateTypes.environment * (* new interpretation status *)
+     Cic.metasenv *                  (* new metasenv *)
+     Cic.term *
+     CicUniv.universe_graph) list    (* disambiguated term *)
 
-      val disambiguate_input :
-        MQIConn.handle -> Cic.context -> Cic.metasenv ->
-        interpretation_domain ->  (* items occuring in parser output *)
-        (interpretation -> Cic.term) -> (* parser output *)
-        domain_and_interpretation ->  (* current interpretation status *)
-        domain_and_interpretation * Cic.metasenv * Cic.term
-          (* new interpretstaion status, new metasenv, disambiguated term *)
-    end
+  val disambiguate_obj :
+    dbd:Mysql.dbd ->
+    aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
+    uri:UriManager.uri option ->     (* required only for inductive types *)
+    TacticAst.obj ->
+    (DisambiguateTypes.environment * (* new interpretation status *)
+     Cic.metasenv *                  (* new metasenv *)
+     Cic.obj *
+     CicUniv.universe_graph) list    (* disambiguated obj *)
+end
 
-  (* TODO move to  CicSomething *)
-val term_of_uri: string -> Cic.term
+module Make (C : DisambiguateTypes.Callbacks) : Disambiguator
 
-val interpretate:
-  context: Cic.name option list -> interp: interpretation -> Ast.term ->
-      Cic.term
+module Trivial:
+sig
+  exception Ambiguous_term of string
 
+  (** disambiguate an _unanmbiguous_ term using dummy callbacks which fail if a
+    * choice from the user is needed to disambiguate the term
+    * @raise Ambiguous_term for ambiguous term *)
+  val disambiguate_string:
+    dbd:Mysql.dbd ->
+    ?context:Cic.context ->
+    ?metasenv:Cic.metasenv ->
+    ?initial_ugraph:CicUniv.universe_graph -> 
+    ?aliases:DisambiguateTypes.environment ->(* previous interpretation status*)
+    string ->
+    (DisambiguateTypes.environment * (* new interpretation status *)
+     Cic.metasenv *                 (* new metasenv *)
+     Cic.term *
+     CicUniv.universe_graph) list   (* disambiguated term *)
+end