ready for 0.1.1 release

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

diff --git a/helm/ocaml/cic_disambiguation/disambiguateTypes.mli b/helm/ocaml/cic_disambiguation/disambiguateTypes.mli
index 525a7e33f8a1f1bb044d4e00190e7b0f6d0b25f5..084ce012287df5d1665871fa68d0817a2a3c445a 100644 (file)
--- a/helm/ocaml/cic_disambiguation/disambiguateTypes.mli
+++ b/helm/ocaml/cic_disambiguation/disambiguateTypes.mli
@@ -28,9 +28,13 @@ type domain_item =
  | Symbol of string * int     (* literal, instance num *)
  | Num of int                 (* instance num *)
 
-module Domain:      Set.S with type elt = domain_item
+(* module Domain:      Set.S with type elt = domain_item *)
 module Environment: Map.S with type key = domain_item
 
+  (** to be raised when a choice is invalid due to some given parameter (e.g.
+   * wrong number of Cic.term arguments received) *)
+exception Invalid_choice
+
 type codomain_item =
   string *  (* description *)
   (environment -> string -> Cic.term list -> Cic.term)
@@ -38,19 +42,41 @@ type codomain_item =
 
 and environment = codomain_item Environment.t
 
+(* a simple case of extension of a disambiguation environment *)
+val env_of_list: (string * string * Cic.term) list -> environment -> environment
+
 module type Callbacks =
   sig
-    val output_html : ?append_NL:bool -> Ui_logger.html_msg -> unit
+
     val interactive_user_uri_choice :
       selection_mode:[`SINGLE | `MULTIPLE] ->
       ?ok:string ->
       ?enable_button_for_non_vars:bool ->
-      title:string -> msg:string -> id:string -> string list -> string list
-    val interactive_interpretation_choice :
-      (string * string) list list -> int
-    val input_or_locate_uri : title:string -> UriManager.uri
+      title:string -> msg:string -> id:string -> UriManager.uri list ->
+       UriManager.uri list
+
+      val interactive_interpretation_choice :
+      (string * string) list list -> int list
+
+    (** @param title gtk window title for user prompting
+     * @param id unbound identifier which originated this callback invocation *)
+    val input_or_locate_uri:
+      title:string -> ?id:string -> unit -> UriManager.uri
   end
 
 val string_of_domain_item: domain_item -> string
-val string_of_domain: Domain.t -> string
+val string_of_domain: domain_item list -> string
+
+(** {3 type shortands} *)
+
+type term = CicNotationPt.term
+type tactic = (term, string) GrafiteAst.tactic
+type tactical = (term, string) GrafiteAst.tactical
+
+type script_entry =
+  | Command of tactical
+  | Comment of CicNotationPt.location * string
+type script = CicNotationPt.location * script_entry list
+
+val empty_environment: environment