]> matita.cs.unibo.it Git - helm.git/blob - helm/ocaml/cic_disambiguation/disambiguate.mli
Experimental localization of errors during refinement and disambiguation.
[helm.git] / helm / ocaml / cic_disambiguation / disambiguate.mli
1 (* Copyright (C) 2004, 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 (** {2 Disambiguation interface} *)
27
28 exception NoWellTypedInterpretation of
29  (Token.flocation option * string Lazy.t) list
30 exception PathNotWellFormed
31
32 val interpretate_path :
33   context:Cic.name list -> CicNotationPt.term ->
34     Cic.term
35
36 module type Disambiguator =
37 sig
38   (** @param fresh_instances when set to true fresh instances will be generated
39    * for each number _and_ symbol in the disambiguation domain. Instances of the
40    * input AST will be ignored. Defaults to false. *)
41   val disambiguate_term :
42     ?fresh_instances:bool ->
43     dbd:HMysql.dbd ->
44     context:Cic.context ->
45     metasenv:Cic.metasenv ->
46     ?initial_ugraph:CicUniv.universe_graph -> 
47     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
48     universe:DisambiguateTypes.multiple_environment option ->
49     CicNotationPt.term ->
50     ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
51      Cic.metasenv *                  (* new metasenv *)
52      Cic.term *
53      CicUniv.universe_graph) list *  (* disambiguated term *)
54     bool  (* has interactive_interpretation_choice been invoked? *)
55
56   (** @param fresh_instances as per disambiguate_term *)
57   val disambiguate_obj :
58     ?fresh_instances:bool ->
59     dbd:HMysql.dbd ->
60     aliases:DisambiguateTypes.environment ->(* previous interpretation status *)
61     universe:DisambiguateTypes.multiple_environment option ->
62     uri:UriManager.uri option ->     (* required only for inductive types *)
63     CicNotationPt.obj ->
64     ((DisambiguateTypes.domain_item * DisambiguateTypes.codomain_item) list *
65      Cic.metasenv *                  (* new metasenv *)
66      Cic.obj *
67      CicUniv.universe_graph) list *  (* disambiguated obj *)
68     bool  (* has interactive_interpretation_choice been invoked? *)
69 end
70
71 module Make (C : DisambiguateTypes.Callbacks) : Disambiguator
72