(* Copyright (C) 2004-2005, HELM Team.
 * 
 * This file is part of HELM, an Hypertextual, Electronic
 * Library of Mathematics, developed at the Computer Science
 * Department, University of Bologna, Italy.
 * 
 * HELM is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * HELM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HELM; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA  02111-1307, USA.
 * 
 * For details, see the HELM World-Wide-Web page,
 * http://helm.cs.unibo.it/
 *)

(** raised when ambiguous input is found but not expected (e.g. in the batch
  * compiler) *)
exception Ambiguous_input
(* the integer is an offset to be added to each location *)
exception DisambiguationError of
 int *
 ((Stdpp.location list * string * string) list *
  (DisambiguateTypes.domain_item * string) list *
  (Stdpp.location * string) Lazy.t * bool) list list
  (** parameters are: option name, error message *)

(** initially false; for debugging only (???) *)
val only_one_pass: bool ref

val passes : unit -> (bool * [> `Library | `Mono | `Multi ] * bool) list

val set_choose_uris_callback:
  DisambiguateTypes.interactive_user_uri_choice_type -> unit

val set_choose_interp_callback:
  DisambiguateTypes.interactive_interpretation_choice_type -> unit

(** @raise Ambiguous_input if called, default value for internal
  * choose_uris_callback if not set otherwise with set_choose_uris_callback
  * above *)
val mono_uris_callback: DisambiguateTypes.interactive_user_uri_choice_type

(** @raise Ambiguous_input if called, default value for internal
  * choose_interp_callback if not set otherwise with set_choose_interp_callback
  * above *)
val mono_interp_callback: DisambiguateTypes.interactive_interpretation_choice_type

val disambiguate_thing:
  passes:(bool * [ `Library | `Mono | `Multi ] * bool) list ->
  freshen_thing: ('ast_thing -> 'ast_thing) ->
  context:'context ->
  metasenv:'metasenv ->
  subst:'subst ->
  mk_implicit:(bool -> 'refined_term) ->
  string_context_of_context:('context -> string option list) ->
  initial_ugraph:'ugraph ->
  hint: 
    ('metasenv -> 'raw_thing -> 'raw_thing) * 
    (('refined_thing,'metasenv,'subst,'ugraph) Disambiguate.test_result ->
       ('refined_thing,'metasenv,'subst,'ugraph) Disambiguate.test_result) ->
  aliases:'refined_term DisambiguateTypes.codomain_item 
    DisambiguateTypes.Environment.t ->
  universe:'refined_term DisambiguateTypes.codomain_item list
    DisambiguateTypes.Environment.t option ->
  lookup_in_library:(
    DisambiguateTypes.interactive_user_uri_choice_type ->
    DisambiguateTypes.input_or_locate_uri_type ->
    DisambiguateTypes.Environment.key ->
    'refined_term DisambiguateTypes.codomain_item list) ->
  uri:'uri ->
  pp_thing:('ast_thing -> string) ->
  domain_of_thing:
   (context: string option list -> 'ast_thing -> Disambiguate.domain) ->
  interpretate_thing:(
    context:'context ->
    env:'refined_term DisambiguateTypes.codomain_item
           DisambiguateTypes.Environment.t ->
    uri:'uri ->
    is_path:bool -> 
    'ast_thing -> 
    localization_tbl:'cichash -> 
      'raw_thing) ->
  refine_thing:(
    'metasenv -> 'subst -> 'context -> 'uri -> use_coercions:bool ->
    'raw_thing -> 'ugraph -> localization_tbl:'cichash -> 
      ('refined_thing, 'metasenv,'subst,'ugraph) Disambiguate.test_result) ->
  localization_tbl:'cichash ->
  string * int * 'ast_thing ->
  ((DisambiguateTypes.Environment.key * 
    'refined_term DisambiguateTypes.codomain_item) list * 
   'metasenv * 'subst * 'refined_thing * 'ugraph)
  list * bool