helm/ocaml/cic_disambiguation/disambiguateTypes.mli

   1 (* Copyright (C) 2004, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 type domain_item =
  27  | Id of string               (* literal *)
  28  | Symbol of string * int     (* literal, instance num *)
  29  | Num of int                 (* instance num *)
  30
  31 (* module Domain:      Set.S with type elt = domain_item *)
  32 module Environment:
  33 sig
  34   include Map.S with type key = domain_item
  35   val cons: domain_item -> ('a * 'b) -> ('a * 'b) list t -> ('a * 'b) list t
  36   val hd: 'a list t -> 'a t
  37
  38     (** last alias cons-ed will be processed first *)
  39   val fold_flatten: (domain_item -> 'a -> 'b -> 'b) -> 'a list t -> 'b -> 'b
  40 end
  41
  42   (** to be raised when a choice is invalid due to some given parameter (e.g.
  43    * wrong number of Cic.term arguments received) *)
  44 exception Invalid_choice of string Lazy.t
  45
  46 type codomain_item =
  47   string *  (* description *)
  48   (environment -> string -> Cic.term list -> Cic.term)
  49     (* environment, literal number, arguments as needed *)
  50
  51 and environment = codomain_item Environment.t
  52
  53 type multiple_environment = codomain_item list Environment.t
  54
  55 (* a simple case of extension of a disambiguation environment *)
  56 val env_of_list:
  57   (string * string * Cic.term) list -> environment -> environment
  58
  59 val multiple_env_of_list:
  60   (string * string * Cic.term) list -> multiple_environment ->
  61     multiple_environment
  62
  63 module type Callbacks =
  64   sig
  65
  66     val interactive_user_uri_choice :
  67       selection_mode:[`SINGLE | `MULTIPLE] ->
  68       ?ok:string ->
  69       ?enable_button_for_non_vars:bool ->
  70       title:string -> msg:string -> id:string -> UriManager.uri list ->
  71        UriManager.uri list
  72
  73       val interactive_interpretation_choice :
  74       (string * string) list list -> int list
  75
  76     (** @param title gtk window title for user prompting
  77      * @param id unbound identifier which originated this callback invocation *)
  78     val input_or_locate_uri:
  79       title:string -> ?id:string -> unit -> UriManager.uri
  80   end
  81
  82 val string_of_domain_item: domain_item -> string
  83 val string_of_domain: domain_item list -> string
  84
  85 (** {3 type shortands} *)
  86
  87 type term = CicNotationPt.term
  88 type tactic = (term, term, GrafiteAst.reduction, string) GrafiteAst.tactic
  89 type tactical = (term, term, GrafiteAst.reduction, string) GrafiteAst.tactical
  90
  91 type script_entry =
  92   | Command of tactical
  93   | Comment of CicNotationPt.location * string
  94 type script = CicNotationPt.location * script_entry list
  95
  96 val dummy_floc: Lexing.position * Lexing.position
  97