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 (* the integer is an offset to be added to each location *)
  27 exception DisambiguationError of
  28  int *
  29  ((Stdpp.location list * string * string) list *
  30   (DisambiguateTypes.domain_item * string) list *
  31   (Stdpp.location * string) Lazy.t * bool) list list
  32   (** parameters are: option name, error message *)
  33
  34 (** initially false; for debugging only (???) *)
  35 val only_one_pass: bool ref
  36
  37 val passes : unit -> (bool * [> `Library | `Mono | `Multi ] * bool) list
  38
  39 val disambiguate_thing:
  40   passes:(bool * [ `Library | `Mono | `Multi ] * bool) list ->
  41   freshen_thing: ('ast_thing -> 'ast_thing) ->
  42   context:'context ->
  43   metasenv:'metasenv ->
  44   subst:'subst ->
  45   string_context_of_context:('context -> string option list) ->
  46   initial_ugraph:'ugraph ->
  47   hint:
  48     ('metasenv -> 'raw_thing -> 'raw_thing) *
  49     (('refined_thing,'metasenv,'subst,'ugraph) Disambiguate.test_result ->
  50        ('refined_thing,'metasenv,'subst,'ugraph) Disambiguate.test_result) ->
  51   mk_implicit:(bool -> 'alias) ->
  52   description_of_alias:('alias -> string) ->
  53   aliases:'alias DisambiguateTypes.Environment.t ->
  54   universe:'alias list
  55     DisambiguateTypes.Environment.t option ->
  56   lookup_in_library:(
  57     DisambiguateTypes.interactive_user_uri_choice_type ->
  58     DisambiguateTypes.input_or_locate_uri_type ->
  59     DisambiguateTypes.Environment.key ->
  60     'alias list) ->
  61   uri:'uri ->
  62   pp_thing:('ast_thing -> string) ->
  63   domain_of_thing:
  64    (context: string option list -> 'ast_thing -> Disambiguate.domain) ->
  65   interpretate_thing:(
  66     context:'context ->
  67     env:'alias DisambiguateTypes.Environment.t ->
  68     uri:'uri ->
  69     is_path:bool ->
  70     'ast_thing ->
  71     localization_tbl:'cichash ->
  72       'raw_thing) ->
  73   refine_thing:(
  74     'metasenv -> 'subst -> 'context -> 'uri -> use_coercions:bool ->
  75     'raw_thing -> 'ugraph -> localization_tbl:'cichash ->
  76       ('refined_thing, 'metasenv,'subst,'ugraph) Disambiguate.test_result) ->
  77   localization_tbl:'cichash ->
  78   string * int * 'ast_thing ->
  79   ((DisambiguateTypes.Environment.key * 'alias) list *
  80    'metasenv * 'subst * 'refined_thing * 'ugraph)
  81   list * bool