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 option * 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
51 type ('a,'m) test_result =
53 | Ko of Stdpp.location option * string Lazy.t
54 | Uncertain of Stdpp.location option * string Lazy.t
55 exception Try_again of string Lazy.t
57 val domain_of_ast_term: context:Cic.name list -> CicNotationPt.term -> domain
59 module type Disambiguator =
61 val disambiguate_thing:
65 initial_ugraph:'ugraph ->
66 aliases:DisambiguateTypes.codomain_item DisambiguateTypes.Environment.t ->
67 universe:DisambiguateTypes.codomain_item list
68 DisambiguateTypes.Environment.t option ->
70 pp_thing:('ast_thing -> string) ->
71 domain_of_thing:(context:'context -> 'ast_thing -> domain) ->
72 interpretate_thing:(context:'context ->
73 env:DisambiguateTypes.codomain_item
74 DisambiguateTypes.Environment.t ->
78 localization_tbl:'cichash -> 'raw_thing) ->
79 refine_thing:('metasenv ->
83 'ugraph -> localization_tbl:'cichash -> ('refined_thing,
84 'metasenv) test_result * 'ugraph) ->
85 localization_tbl:'cichash ->
86 string * int * 'ast_thing ->
87 ((DisambiguateTypes.Environment.key * DisambiguateTypes.codomain_item)
88 list * 'metasenv * 'refined_thing * 'ugraph)
91 (** @param fresh_instances when set to true fresh instances will be generated
92 * for each number _and_ symbol in the disambiguation domain. Instances of the
93 * input AST will be ignored. Defaults to false. *)
94 val disambiguate_term :
95 ?fresh_instances:bool ->
97 context:Cic.context ->
98 metasenv:Cic.metasenv ->
99 ?initial_ugraph:CicUniv.universe_graph ->
100 aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
101 universe:DisambiguateTypes.multiple_environment option ->
102 CicNotationPt.term disambiguator_input ->
103 ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
104 Cic.metasenv * (* new metasenv *)
106 CicUniv.universe_graph) list * (* disambiguated term *)
107 bool (* has interactive_interpretation_choice been invoked? *)
109 (** @param fresh_instances as per disambiguate_term *)
110 val disambiguate_obj :
111 ?fresh_instances:bool ->
113 aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
114 universe:DisambiguateTypes.multiple_environment option ->
115 uri:UriManager.uri option -> (* required only for inductive types *)
116 CicNotationPt.term CicNotationPt.obj disambiguator_input ->
117 ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
118 Cic.metasenv * (* new metasenv *)
120 CicUniv.universe_graph) list * (* disambiguated obj *)
121 bool (* has interactive_interpretation_choice been invoked? *)
125 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator