ocaml 3.09 transition

[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..e8d21c0cda5f98c57b74aa845a4e3e831217393f 100644 (file)
--- a/helm/ocaml/cic_disambiguation/disambiguate.mli
+++ b/helm/ocaml/cic_disambiguation/disambiguate.mli
@@ -23,38 +23,69 @@
  * http://helm.cs.unibo.it/
  *)
 
-open Disambiguate_struct
-open Disambiguate_types
-
-type interpretation_domain = Domain.t
-type domain_and_interpretation = interpretation_domain * interpretation
-
-(*
-val add_symbol_choice:
-  string -> string * interpretation_codomain_item -> unit
-val add_symbol_choices:
-  string -> (string * interpretation_codomain_item) list -> unit
-
-val add_num_choice: string * interpretation_codomain_item -> unit
-*)
-
-module Make (C : Callbacks) :
-    sig
-      exception NoWellTypedInterpretation
-
-      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
-
-  (* TODO move to  CicSomething *)
-val term_of_uri: string -> Cic.term
-
-val interpretate:
-  context: Cic.name option list -> interp: interpretation -> Ast.term ->
-      Cic.term
+(** {2 Disambiguation interface} *)
+
+exception NoWellTypedInterpretation of string Lazy.t list
+exception PathNotWellFormed
+
+val interpretate_path :
+  context:Cic.name list -> DisambiguateTypes.term ->
+    Cic.term
+
+module type Disambiguator =
+sig
+  (** @param fresh_instances when set to true fresh instances will be generated
+   * for each number _and_ symbol in the disambiguation domain. Instances of the
+   * input AST will be ignored. Defaults to false. *)
+  val disambiguate_term :
+    ?fresh_instances:bool ->
+    dbd:HMysql.dbd ->
+    context:Cic.context ->
+    metasenv:Cic.metasenv ->
+    ?initial_ugraph:CicUniv.universe_graph -> 
+    aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
+    universe:DisambiguateTypes.multiple_environment option ->
+    DisambiguateTypes.term ->
+    ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
+     Cic.metasenv *                  (* new metasenv *)
+     Cic.term *
+     CicUniv.universe_graph) list *  (* disambiguated term *)
+    bool  (* has interactive_interpretation_choice been invoked? *)
+
+  (** @param fresh_instances as per disambiguate_term *)
+  val disambiguate_obj :
+    ?fresh_instances:bool ->
+    dbd:HMysql.dbd ->
+    aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
+    universe:DisambiguateTypes.multiple_environment option ->
+    uri:UriManager.uri option ->     (* required only for inductive types *)
+    GrafiteAst.obj ->
+    ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
+     Cic.metasenv *                  (* new metasenv *)
+     Cic.obj *
+     CicUniv.universe_graph) list *  (* disambiguated obj *)
+    bool  (* has interactive_interpretation_choice been invoked? *)
+end
+
+module Make (C : DisambiguateTypes.Callbacks) : Disambiguator
+
+module Trivial:
+sig
+  exception Ambiguous_term of string Lazy.t
+
+  (** 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:HMysql.dbd ->
+    ?context:Cic.context ->
+    ?metasenv:Cic.metasenv ->
+    ?initial_ugraph:CicUniv.universe_graph -> 
+    ?aliases:DisambiguateTypes.environment ->(* previous interpretation status*)
+    string ->
+    ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
+     Cic.metasenv *                 (* new metasenv *)
+     Cic.term *
+     CicUniv.universe_graph) list   (* disambiguated term *)
+end