helm/gTopLevel/disambiguate.mli

   1 (* Copyright (C) 2000-2002, 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://cs.unibo.it/helm/.
  24  *)
  25
  26 (******************************************************************************)
  27 (*                                                                            *)
  28 (*                               PROJECT HELM                                 *)
  29 (*                                                                            *)
  30 (*                Claudio Sacerdoti Coen <sacerdot@cs.unibo.it>               *)
  31 (*                                 15/01/2003                                 *)
  32 (*                                                                            *)
  33 (*                                                                            *)
  34 (******************************************************************************)
  35
  36 (** This module provides a functor to disambiguate the input **)
  37 (** given a set of user-interface call-backs                 **)
  38
  39 module type Callbacks =
  40   sig
  41     (* The following two functions are used to save/restore the metasenv *)
  42     (* before/after the parsing.                                         *)
  43     (*CSC: This should be made functional sooner or later! *)
  44     val get_metasenv : unit -> Cic.metasenv
  45     val set_metasenv : Cic.metasenv -> unit
  46
  47     val output_html : string -> unit
  48     val interactive_user_uri_choice :
  49       selection_mode:[`SINGLE | `MULTIPLE] ->
  50       ?ok:string ->
  51       ?enable_button_for_non_vars:bool ->
  52       title:string -> msg:string -> id:string -> string list -> string list
  53     val interactive_interpretation_choice :
  54       (string * string) list list -> int
  55     val input_or_locate_uri : title:string -> UriManager.uri
  56   end
  57
  58 type domain_and_interpretation =
  59  CicTextualParser0.interpretation_domain_item list *
  60   CicTextualParser0.interpretation
  61
  62 module Make (C : Callbacks) :
  63     sig
  64       exception ThereDoesNotExistAnyWellTypedInterpretationOfTheInput
  65       val disambiguate_input :
  66         MQIConn.handle ->
  67         Cic.context ->
  68         Cic.metasenv ->
  69         CicTextualParser0.interpretation_domain_item list ->
  70         (CicTextualParser0.interpretation -> Cic.metasenv * Cic.term) ->
  71         id_to_uris:domain_and_interpretation ->
  72         domain_and_interpretation * Cic.metasenv * Cic.term
  73     end