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 ((Stdpp.location list * string * string) list *
39 (DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
40 (Stdpp.location * string) Lazy.t * bool) list
41 exception PathNotWellFormed
43 val interpretate_path :
44 context:Cic.name list -> CicNotationPt.term -> Cic.term
46 type 'a disambiguator_input = string * int * 'a
48 type domain = domain_tree list
50 Node of Stdpp.location list * DisambiguateTypes.domain_item * domain
52 type ('term,'metasenv,'subst,'graph) test_result =
53 | Ok of 'term * 'metasenv * 'subst * 'graph
54 | Ko of (Stdpp.location * string) Lazy.t
55 | Uncertain of (Stdpp.location * string) Lazy.t
57 exception Try_again of string Lazy.t
59 val domain_of_ast_term: context:Cic.name list -> CicNotationPt.term -> domain
61 module type Disambiguator =
63 val disambiguate_thing:
68 initial_ugraph:'ugraph ->
69 hint: ('metasenv -> 'raw_thing -> 'raw_thing) *
70 (('refined_thing,'metasenv,'subst,'ugraph) test_result ->
71 ('refined_thing,'metasenv,'subst,'ugraph) test_result) ->
72 aliases:DisambiguateTypes.codomain_item DisambiguateTypes.Environment.t ->
73 universe:DisambiguateTypes.codomain_item list
74 DisambiguateTypes.Environment.t option ->
76 pp_thing:('ast_thing -> string) ->
77 domain_of_thing:(context:'context -> 'ast_thing -> domain) ->
78 interpretate_thing:(context:'context ->
79 env:DisambiguateTypes.codomain_item
80 DisambiguateTypes.Environment.t ->
82 is_path:bool -> 'ast_thing -> localization_tbl:'cichash -> 'raw_thing) ->
83 refine_thing:('metasenv ->
88 'ugraph -> localization_tbl:'cichash ->
89 ('refined_thing, 'metasenv,'subst,'ugraph) test_result) ->
90 localization_tbl:'cichash ->
91 string * int * 'ast_thing ->
92 ((DisambiguateTypes.Environment.key * DisambiguateTypes.codomain_item)
93 list * 'metasenv * 'subst * 'refined_thing * 'ugraph)
96 val disambiguate_term :
97 ?fresh_instances:bool ->
99 context:Cic.context ->
100 metasenv:Cic.metasenv ->
101 subst:Cic.substitution ->
103 ?initial_ugraph:CicUniv.universe_graph ->
104 aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
105 universe:DisambiguateTypes.multiple_environment option ->
106 CicNotationPt.term disambiguator_input ->
107 ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
108 Cic.metasenv * (* new metasenv *)
111 CicUniv.universe_graph) list * (* disambiguated term *)
114 val disambiguate_obj :
115 ?fresh_instances:bool ->
117 aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
118 universe:DisambiguateTypes.multiple_environment option ->
119 uri:UriManager.uri option -> (* required only for inductive types *)
120 CicNotationPt.term CicNotationPt.obj disambiguator_input ->
121 ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
122 Cic.metasenv * (* new metasenv *)
125 CicUniv.universe_graph) list * (* disambiguated obj *)
129 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator