helm/matita/matitaDisambiguator.mli

   1 (* Copyright (C) 2004-2005, 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 open MatitaTypes
  27
  28 (** raised when ambiguous input is found but not expected (e.g. in the batch
  29   * compiler) *)
  30 exception Ambiguous_input
  31
  32 type choose_uris_callback = id:string -> UriManager.uri list -> UriManager.uri list
  33 type choose_interp_callback = (string * string) list list -> int list
  34
  35 val set_choose_uris_callback:   choose_uris_callback -> unit
  36 val set_choose_interp_callback: choose_interp_callback -> unit
  37
  38 (** @raise Ambiguous_input if called, default value for internal
  39   * choose_uris_callback if not set otherwise with set_choose_uris_callback
  40   * above *)
  41 val mono_uris_callback: choose_uris_callback
  42
  43 (** @raise Ambiguous_input if called, default value for internal
  44   * choose_interp_callback if not set otherwise with set_choose_interp_callback
  45   * above *)
  46 val mono_interp_callback: choose_interp_callback
  47
  48 (** for GUI callbacks see MatitaGui.interactive_{interp,user_uri}_choice *)
  49
  50 val disambiguate_term :
  51   dbd:Mysql.dbd ->
  52   context:Cic.context ->
  53   metasenv:Cic.metasenv ->
  54   ?initial_ugraph:CicUniv.universe_graph ->
  55   aliases:DisambiguateTypes.environment -> (* previous interpretation status *)
  56   DisambiguateTypes.term ->
  57   (DisambiguateTypes.environment * (* new interpretation status *)
  58    Cic.metasenv *                  (* new metasenv *)
  59    Cic.term *
  60    CicUniv.universe_graph) list *  (* disambiguated term *)
  61   bool  (* has interactive_interpretation_choice been invoked? *)
  62
  63 (** @param fresh_instances as per disambiguate_term *)
  64 val disambiguate_obj :
  65   dbd:Mysql.dbd ->
  66   aliases:DisambiguateTypes.environment -> (* previous interpretation status *)
  67   uri:UriManager.uri option ->     (* required only for inductive types *)
  68   GrafiteAst.obj ->
  69   (DisambiguateTypes.environment * (* new interpretation status *)
  70    Cic.metasenv *                  (* new metasenv *)
  71    Cic.obj *
  72    CicUniv.universe_graph) list *  (* disambiguated obj *)
  73   bool  (* has interactive_interpretation_choice been invoked? *)
  74