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 (** Functions that should be moved in another module **)
  37 exception IllFormedUri of string
  38 val string_of_cic_textual_parser_uri : CicTextualParser0.uri -> string
  39 val cic_textual_parser_uri_of_string : string -> CicTextualParser0.uri
  40
  41 val wrong_xpointer_format_from_wrong_xpointer_format' : string -> string
  42
  43 (** This module provides a functor to disambiguate the input **)
  44 (** given a set of user-interface call-backs                 **)
  45
  46 module type Callbacks =
  47   sig
  48     val output_html : string -> unit
  49     val interactive_user_uri_choice :
  50       selection_mode:[`SINGLE | `EXTENDED] ->
  51       ?ok:string ->
  52       ?enable_button_for_non_vars:bool ->
  53       title:string -> msg:string -> id:string -> string list -> string list
  54     val interactive_interpretation_choice :
  55       (string * string) list list -> int
  56     val input_or_locate_uri : title:string -> UriManager.uri
  57   end
  58
  59 type domain_and_interpretation =
  60  string list * (string -> CicTextualParser0.uri option)
  61
  62 module Make :
  63   functor (C : Callbacks) ->
  64     sig
  65       exception ThereDoesNotExistAnyWellTypedInterpretationOfTheInput
  66       val disambiguate_input :
  67         Cic.context ->
  68         Cic.metasenv ->
  69         string list ->
  70         ((string -> CicTextualParser0.interp_codomain option) ->
  71          Cic.metasenv * Cic.term) ->
  72         id_to_uris:domain_and_interpretation ->
  73         domain_and_interpretation * Cic.metasenv * Cic.term
  74     end