helm/software/components/disambiguation/multiPassDisambiguator.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 (** raised when ambiguous input is found but not expected (e.g. in the batch
  27   * compiler) *)
  28 exception Ambiguous_input
  29 (* the integer is an offset to be added to each location *)
  30 exception DisambiguationError of
  31  int *
  32  ((Stdpp.location list * string * string) list *
  33   (DisambiguateTypes.domain_item * string) list *
  34   (Stdpp.location * string) Lazy.t * bool) list list
  35   (** parameters are: option name, error message *)
  36
  37 (** initially false; for debugging only (???) *)
  38 val only_one_pass: bool ref
  39
  40 val passes : unit -> (bool * [> `Library | `Mono | `Multi ] * bool) list
  41
  42 val set_choose_uris_callback:
  43   DisambiguateTypes.interactive_user_uri_choice_type -> unit
  44
  45 val set_choose_interp_callback:
  46   DisambiguateTypes.interactive_interpretation_choice_type -> unit
  47
  48 (** @raise Ambiguous_input if called, default value for internal
  49   * choose_uris_callback if not set otherwise with set_choose_uris_callback
  50   * above *)
  51 val mono_uris_callback: DisambiguateTypes.interactive_user_uri_choice_type
  52
  53 (** @raise Ambiguous_input if called, default value for internal
  54   * choose_interp_callback if not set otherwise with set_choose_interp_callback
  55   * above *)
  56 val mono_interp_callback: DisambiguateTypes.interactive_interpretation_choice_type
  57
  58 val disambiguate_thing:
  59   passes:(bool * [ `Library | `Mono | `Multi ] * bool) list ->
  60   freshen_thing: ('ast_thing -> 'ast_thing) ->
  61   context:'context ->
  62   metasenv:'metasenv ->
  63   subst:'subst ->
  64   string_context_of_context:('context -> string option list) ->
  65   initial_ugraph:'ugraph ->
  66   hint:
  67     ('metasenv -> 'raw_thing -> 'raw_thing) *
  68     (('refined_thing,'metasenv,'subst,'ugraph) Disambiguate.test_result ->
  69        ('refined_thing,'metasenv,'subst,'ugraph) Disambiguate.test_result) ->
  70   mk_implicit:(bool -> 'alias) ->
  71   description_of_alias:('alias -> string) ->
  72   aliases:'alias DisambiguateTypes.Environment.t ->
  73   universe:'alias list
  74     DisambiguateTypes.Environment.t option ->
  75   lookup_in_library:(
  76     DisambiguateTypes.interactive_user_uri_choice_type ->
  77     DisambiguateTypes.input_or_locate_uri_type ->
  78     DisambiguateTypes.Environment.key ->
  79     'alias list) ->
  80   uri:'uri ->
  81   pp_thing:('ast_thing -> string) ->
  82   domain_of_thing:
  83    (context: string option list -> 'ast_thing -> Disambiguate.domain) ->
  84   interpretate_thing:(
  85     context:'context ->
  86     env:'alias DisambiguateTypes.Environment.t ->
  87     uri:'uri ->
  88     is_path:bool ->
  89     'ast_thing ->
  90     localization_tbl:'cichash ->
  91       'raw_thing) ->
  92   refine_thing:(
  93     'metasenv -> 'subst -> 'context -> 'uri -> use_coercions:bool ->
  94     'raw_thing -> 'ugraph -> localization_tbl:'cichash ->
  95       ('refined_thing, 'metasenv,'subst,'ugraph) Disambiguate.test_result) ->
  96   localization_tbl:'cichash ->
  97   string * int * 'ast_thing ->
  98   ((DisambiguateTypes.Environment.key * 'alias) list *
  99    'metasenv * 'subst * 'refined_thing * 'ugraph)
 100   list * bool