1 (* Copyright (C) 2004, HELM Team.
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.
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.
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.
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,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
26 (** {2 Disambiguation interface} *)
28 (* the integer is an offset to be added to each location *)
29 (* list of located error messages, each list is a tuple:
30 * - environment in string form
34 * - significancy of the error message, if false the error is likely to be
35 * useless for the final user ... *)
36 exception NoWellTypedInterpretation of
38 ((Token.flocation list * string * string) list *
39 (DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
40 Token.flocation option * string Lazy.t * bool) list
41 exception PathNotWellFormed
43 val interpretate_path :
44 context:Cic.name list -> CicNotationPt.term ->
47 type 'a disambiguator_input = string * int * 'a
49 module type Disambiguator =
51 (** @param fresh_instances when set to true fresh instances will be generated
52 * for each number _and_ symbol in the disambiguation domain. Instances of the
53 * input AST will be ignored. Defaults to false. *)
54 val disambiguate_term :
55 ?fresh_instances:bool ->
57 context:Cic.context ->
58 metasenv:Cic.metasenv ->
59 ?initial_ugraph:CicUniv.universe_graph ->
60 aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
61 universe:DisambiguateTypes.multiple_environment option ->
62 CicNotationPt.term disambiguator_input ->
63 ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
64 Cic.metasenv * (* new metasenv *)
66 CicUniv.universe_graph) list * (* disambiguated term *)
67 bool (* has interactive_interpretation_choice been invoked? *)
69 (** @param fresh_instances as per disambiguate_term *)
70 val disambiguate_obj :
71 ?fresh_instances:bool ->
73 aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
74 universe:DisambiguateTypes.multiple_environment option ->
75 uri:UriManager.uri option -> (* required only for inductive types *)
76 CicNotationPt.term CicNotationPt.obj disambiguator_input ->
77 ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
78 Cic.metasenv * (* new metasenv *)
80 CicUniv.universe_graph) list * (* disambiguated obj *)
81 bool (* has interactive_interpretation_choice been invoked? *)
84 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator