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/
30 open DisambiguateTypes
33 module Ast = CicNotationPt
35 (* the integer is an offset to be added to each location *)
36 exception NoWellTypedInterpretation of
38 ((Stdpp.location list * string * string) list *
39 (DisambiguateTypes.domain_item * string) list *
40 (Stdpp.location * string) Lazy.t * bool) list
41 exception PathNotWellFormed
43 (** raised when an environment is not enough informative to decide *)
44 exception Try_again of string Lazy.t
46 type ('alias,'term) aliases= bool * 'term DisambiguateTypes.environment
47 type 'a disambiguator_input = string * int * 'a
49 type domain = domain_tree list
50 and domain_tree = Node of Stdpp.location list * domain_item * domain
52 let rec string_of_domain =
55 | Node (_,domain_item,l)::tl ->
56 DisambiguateTypes.string_of_domain_item domain_item ^
57 " [ " ^ string_of_domain l ^ " ] " ^ string_of_domain tl
59 let rec filter_map_domain f =
62 | Node (locs,domain_item,l)::tl ->
63 match f locs domain_item with
64 None -> filter_map_domain f l @ filter_map_domain f tl
65 | Some res -> res :: filter_map_domain f l @ filter_map_domain f tl
67 let rec map_domain f =
70 | Node (locs,domain_item,l)::tl ->
71 f locs domain_item :: map_domain f l @ map_domain f tl
77 | Node (locs,domain_item,l)::tl ->
78 if List.mem domain_item seen then
79 let seen,l = aux seen l in
80 let seen,tl = aux seen tl in
83 let seen,l = aux (domain_item::seen) l in
84 let seen,tl = aux seen tl in
85 seen, Node (locs,domain_item,l)::tl
90 let debug_print s = if debug then prerr_endline (Lazy.force s) else ()
93 (** print benchmark information *)
95 let max_refinements = ref 0 (* benchmarking is not thread safe *)
96 let actual_refinements = ref 0
97 let domain_size = ref 0
98 let choices_avg = ref 0.
101 let descr_of_domain_item = function
104 | Num i -> string_of_int i
106 type ('term,'metasenv,'subst,'graph) test_result =
107 | Ok of 'term * 'metasenv * 'subst * 'graph
108 | Ko of (Stdpp.location * string) Lazy.t
109 | Uncertain of (Stdpp.location * string) Lazy.t
111 let resolve ~env ~mk_choice (item: domain_item) arg =
113 match snd (mk_choice (Environment.find item env)), arg with
114 `Num_interp f, `Num_arg n -> f n
115 | `Sym_interp f, `Args l -> f l
116 | `Sym_interp f, `Num_arg n -> (* Implicit number! *) f []
117 | _,_ -> assert false
119 failwith ("Domain item not found: " ^
120 (DisambiguateTypes.string_of_domain_item item))
122 (* TODO move it to Cic *)
123 let find_in_context name context =
124 let rec aux acc = function
125 | [] -> raise Not_found
126 | Some hd :: tl when hd = name -> acc
127 | _ :: tl -> aux (acc + 1) tl
133 | Ast.Ident (n, None) -> Some n
137 let rec domain_of_term ?(loc = HExtlib.dummy_floc) ~context = function
138 | Ast.AttributedTerm (`Loc loc, term) ->
139 domain_of_term ~loc ~context term
140 | Ast.AttributedTerm (_, term) ->
141 domain_of_term ~loc ~context term
142 | Ast.Symbol (symbol, instance) ->
143 [ Node ([loc], Symbol (symbol, instance), []) ]
144 (* to be kept in sync with Ast.Appl (Ast.Symbol ...) *)
145 | Ast.Appl (Ast.Symbol (symbol, instance) as hd :: args)
146 | Ast.Appl (Ast.AttributedTerm (_,Ast.Symbol (symbol, instance)) as hd :: args)
150 (fun term acc -> domain_of_term ~loc ~context term @ acc)
154 Ast.AttributedTerm (`Loc loc,_) -> loc
157 [ Node ([loc], Symbol (symbol, instance), args_dom) ]
158 | Ast.Appl (Ast.Ident (name, subst) as hd :: args)
159 | Ast.Appl (Ast.AttributedTerm (_,Ast.Ident (name, subst)) as hd :: args) ->
162 (fun term acc -> domain_of_term ~loc ~context term @ acc)
166 Ast.AttributedTerm (`Loc loc,_) -> loc
170 (* the next line can raise Not_found *)
171 ignore(find_in_context name context);
172 if subst <> None then
173 Ast.fail loc "Explicit substitutions not allowed here"
178 | None -> [ Node ([loc], Id name, args_dom) ]
182 (fun dom (_, term) ->
183 let dom' = domain_of_term ~loc ~context term in
186 [ Node ([loc], Id name, terms @ args_dom) ]))
189 (fun term acc -> domain_of_term ~loc ~context term @ acc)
191 | Ast.Binder (kind, (var, typ), body) ->
192 let type_dom = domain_of_term_option ~loc ~context typ in
195 ~context:(string_of_name var :: context) body in
197 | `Exists -> [ Node ([loc], Symbol ("exists", 0), (type_dom @ body_dom)) ]
198 | _ -> type_dom @ body_dom)
199 | Ast.Case (term, indty_ident, outtype, branches) ->
200 let term_dom = domain_of_term ~loc ~context term in
201 let outtype_dom = domain_of_term_option ~loc ~context outtype in
202 let rec get_first_constructor = function
204 | (Ast.Pattern (head, _, _), _) :: _ -> [ Node ([loc], Id head, []) ]
205 | _ :: tl -> get_first_constructor tl in
208 Ast.Pattern (head, _, args), term ->
209 let (term_context, args_domain) =
211 (fun (cont, dom) (name, typ) ->
212 (string_of_name name :: cont,
215 | Some typ -> dom @ domain_of_term ~loc ~context:cont typ)))
218 domain_of_term ~loc ~context:term_context term @ args_domain
219 | Ast.Wildcard, term ->
220 domain_of_term ~loc ~context term
223 List.fold_left (fun dom branch -> dom @ do_branch branch) [] branches in
224 (match indty_ident with
225 | None -> get_first_constructor branches
226 | Some (ident, _) -> [ Node ([loc], Id ident, []) ])
227 @ term_dom @ outtype_dom @ branches_dom
228 | Ast.Cast (term, ty) ->
229 let term_dom = domain_of_term ~loc ~context term in
230 let ty_dom = domain_of_term ~loc ~context ty in
232 | Ast.LetIn ((var, typ), body, where) ->
233 let body_dom = domain_of_term ~loc ~context body in
234 let type_dom = domain_of_term_option ~loc ~context typ in
236 domain_of_term ~loc ~context:(string_of_name var :: context) where in
237 body_dom @ type_dom @ where_dom
238 | Ast.LetRec (kind, defs, where) ->
239 let add_defs context =
241 (fun acc (_, (var, _), _, _) -> string_of_name var :: acc
243 let where_dom = domain_of_term ~loc ~context:(add_defs context) where in
246 (fun dom (params, (_, typ), body, _) ->
250 (fun acc (var,_) -> string_of_name var :: acc)
256 (fun (context,res) (var,ty) ->
257 string_of_name var :: context,
258 domain_of_term_option ~loc ~context ty @ res)
259 (add_defs context,[]) params))
261 @ domain_of_term_option ~loc ~context:context' typ
262 @ domain_of_term ~loc ~context:context' body
266 | Ast.Ident (name, subst) ->
268 (* the next line can raise Not_found *)
269 ignore(find_in_context name context);
270 if subst <> None then
271 Ast.fail loc "Explicit substitutions not allowed here"
276 | None -> [ Node ([loc], Id name, []) ]
280 (fun dom (_, term) ->
281 let dom' = domain_of_term ~loc ~context term in
284 [ Node ([loc], Id name, terms) ]))
287 | Ast.Num (num, i) -> [ Node ([loc], Num i, []) ]
288 | Ast.Meta (index, local_context) ->
290 (fun dom term -> dom @ domain_of_term_option ~loc ~context term)
297 | Ast.Variable _ -> assert false
299 and domain_of_term_option ~loc ~context = function
301 | Some t -> domain_of_term ~loc ~context t
303 let domain_of_term ~context term =
304 uniq_domain (domain_of_term ~context term)
306 let domain_of_obj ~context ast =
307 assert (context = []);
309 | Ast.Theorem (_,_,ty,bo) ->
313 | Some bo -> domain_of_term [] bo)
314 | Ast.Inductive (params,tyl) ->
317 (fun (context, dom) (var, ty) ->
318 let context' = string_of_name var :: context in
320 None -> context', dom
321 | Some ty -> context', dom @ domain_of_term context ty
323 let context_w_types =
324 List.rev_map (fun (var, _, _, _) -> Some var) tyl @ context in
329 domain_of_term context ty
332 (fun (_,ty) -> domain_of_term context_w_types ty) cl))
334 | Ast.Record (params,var,ty,fields) ->
337 (fun (context, dom) (var, ty) ->
338 let context' = string_of_name var :: context in
340 None -> context', dom
341 | Some ty -> context', dom @ domain_of_term context ty
343 let context_w_types = Some var :: context in
345 @ domain_of_term context ty
348 (fun (context,res) (name,ty,_,_) ->
349 Some name::context, res @ domain_of_term context ty
350 ) (context_w_types,[]) fields)
352 let domain_of_obj ~context obj =
353 uniq_domain (domain_of_obj ~context obj)
355 let domain_of_ast_term = domain_of_term;;
358 let domain_diff dom1 dom2 =
359 (* let domain_diff = Domain.diff *)
363 | Symbol (symb, 0) ->
365 Symbol (symb',_) when symb = symb' -> true
377 | Node (_,elt,l)::tl when is_in_dom2 elt -> aux (l @ tl)
378 | Node (loc,elt,l)::tl -> Node (loc,elt,aux l)::(aux tl)
382 module type Disambiguator =
384 val disambiguate_thing:
386 metasenv:'metasenv ->
388 use_coercions:bool ->
389 string_context_of_context:('context -> string option list) ->
390 initial_ugraph:'ugraph ->
392 ('metasenv -> 'raw_thing -> 'raw_thing) *
393 (('refined_thing,'metasenv,'subst,'ugraph) test_result ->
394 ('refined_thing,'metasenv,'subst,'ugraph) test_result) ->
395 mk_implicit:(bool -> 'alias) ->
396 description_of_alias:('alias -> string) ->
397 aliases:'alias DisambiguateTypes.Environment.t ->
398 universe:'alias list DisambiguateTypes.Environment.t option ->
400 DisambiguateTypes.interactive_user_uri_choice_type ->
401 DisambiguateTypes.input_or_locate_uri_type ->
402 DisambiguateTypes.Environment.key ->
405 pp_thing:('ast_thing -> string) ->
406 domain_of_thing:(context: string option list -> 'ast_thing -> domain) ->
409 env:'alias DisambiguateTypes.Environment.t ->
413 localization_tbl:'cichash ->
416 'metasenv -> 'subst -> 'context -> 'uri -> use_coercions:bool ->
417 'raw_thing -> 'ugraph -> localization_tbl:'cichash ->
418 ('refined_thing, 'metasenv,'subst,'ugraph) test_result) ->
419 localization_tbl:'cichash ->
420 string * int * 'ast_thing ->
421 ((DisambiguateTypes.Environment.key * 'alias) list *
422 'metasenv * 'subst * 'refined_thing * 'ugraph)
426 module Make (C: Callbacks) =
428 let refine_profiler = HExtlib.profile "disambiguate_thing.refine_thing"
430 let disambiguate_thing
431 ~context ~metasenv ~subst ~use_coercions
432 ~string_context_of_context
433 ~initial_ugraph:base_univ ~hint
434 ~mk_implicit ~description_of_alias
435 ~aliases ~universe ~lookup_in_library
436 ~uri ~pp_thing ~domain_of_thing ~interpretate_thing ~refine_thing
438 (thing_txt,thing_txt_prefix_len,thing)
440 debug_print (lazy "DISAMBIGUATE INPUT");
441 debug_print (lazy ("TERM IS: " ^ (pp_thing thing)));
443 domain_of_thing ~context:(string_context_of_context context) thing in
445 (lazy (sprintf "DISAMBIGUATION DOMAIN: %s"(string_of_domain thing_dom)));
447 debug_print (lazy (sprintf "DISAMBIGUATION ENVIRONMENT: %s"
448 (DisambiguatePp.pp_environment aliases)));
449 debug_print (lazy (sprintf "DISAMBIGUATION UNIVERSE: %s"
450 (match universe with None -> "None" | Some _ -> "Some _")));
453 Environment.fold (fun item _ dom -> item :: dom) aliases [] in
454 let todo_dom = domain_diff thing_dom current_dom in
456 (lazy (sprintf "DISAMBIGUATION DOMAIN AFTER DIFF: %s"(string_of_domain todo_dom)));
457 (* (2) lookup function for any item (Id/Symbol/Num) *)
463 C.interactive_user_uri_choice
464 C.input_or_locate_uri item
469 | Symbol (symb, _) -> Symbol (symb, 0)
472 Environment.find item e
475 C.interactive_user_uri_choice
476 C.input_or_locate_uri item)
481 if benchmark then begin
482 let per_item_choices =
486 let len = List.length (lookup_choices dom_item) in
487 debug_print (lazy (sprintf "BENCHMARK %s: %d"
488 (string_of_domain_item dom_item) len));
490 with No_choices _ -> 0)
493 max_refinements := List.fold_left ( * ) 1 per_item_choices;
494 actual_refinements := 0;
495 domain_size := List.length thing_dom;
497 (float_of_int !max_refinements) ** (1. /. float_of_int !domain_size)
503 (* (3) test an interpretation filling with meta uninterpreted identifiers
505 let test_env aliases todo_dom ugraph =
507 let rec aux env = function
509 | Node (_, item, l) :: tl ->
513 (match item with | Id _ | Num _ -> true | Symbol _ -> false))
515 aux (aux env l) tl in
516 let filled_env = aux aliases todo_dom in
518 interpretate_thing ~context ~env:filled_env
519 ~uri ~is_path:false thing ~localization_tbl
521 let cic_thing = (fst hint) metasenv cic_thing in
524 refine_thing metasenv subst context uri
525 ~use_coercions cic_thing ugraph ~localization_tbl
527 let k = (snd hint) k in
529 in refine_profiler.HExtlib.profile foo ()
531 | Try_again msg -> Uncertain (lazy (Stdpp.dummy_loc,Lazy.force msg))
532 | Invalid_choice loc_msg -> Ko loc_msg
534 (* (4) build all possible interpretations *)
535 let (@@) (l1,l2,l3) (l1',l2',l3') = l1@l1', l2@l2', l3@l3' in
536 (* aux returns triples Ok/Uncertain/Ko *)
537 (* rem_dom is the concatenation of all the remainin domains *)
538 let rec aux aliases diff lookup_in_todo_dom todo_dom rem_dom =
539 debug_print (lazy ("ZZZ: " ^ string_of_domain todo_dom));
542 assert (lookup_in_todo_dom = None);
543 (match test_env aliases rem_dom base_univ with
544 | Ok (thing, metasenv,subst,new_univ) ->
545 [ aliases, diff, metasenv, subst, thing, new_univ ], [], []
546 | Ko loc_msg -> [],[],[aliases,diff,loc_msg,true]
547 | Uncertain loc_msg ->
548 [],[aliases,diff,loc_msg],[])
549 | Node (locs,item,inner_dom) :: remaining_dom ->
550 debug_print (lazy (sprintf "CHOOSED ITEM: %s"
551 (string_of_domain_item item)));
553 match lookup_in_todo_dom with
554 None -> lookup_choices item
555 | Some choices -> choices in
561 "No choices for " ^ string_of_domain_item item)),
565 (* just one choice. We perform a one-step look-up and
566 if the next set of choices is also a singleton we
567 skip this refinement step *)
568 debug_print(lazy (sprintf "%s CHOSEN" (fst codomain_item)));
569 let new_env = Environment.add item codomain_item aliases in
570 let new_diff = (item,codomain_item)::diff in
571 let lookup_in_todo_dom,next_choice_is_single =
572 match remaining_dom with
575 let choices = lookup_choices he in
576 Some choices,List.length choices = 1
578 if next_choice_is_single then
579 aux new_env new_diff lookup_in_todo_dom remaining_dom
582 (match test_env new_env remaining_dom base_univ with
583 | Ok (thing, metasenv),new_univ ->
584 (match remaining_dom with
586 [ new_env, new_diff, metasenv, thing, new_univ ], []
588 aux new_env new_diff lookup_in_todo_dom
589 remaining_dom new_univ)
590 | Uncertain (loc,msg),new_univ ->
591 (match remaining_dom with
592 | [] -> [], [new_env,new_diff,loc,msg,true]
594 aux new_env new_diff lookup_in_todo_dom
595 remaining_dom new_univ)
596 | Ko (loc,msg),_ -> [], [new_env,new_diff,loc,msg,true])
599 let mark_not_significant failures =
601 (fun (env, diff, loc_msg, _b) ->
602 env, diff, loc_msg, false)
604 let classify_errors ((ok_l,uncertain_l,error_l) as outcome) =
605 if ok_l <> [] || uncertain_l <> [] then
606 ok_l,uncertain_l,mark_not_significant error_l
609 let rec filter = function
611 | codomain_item :: tl ->
612 (*debug_print(lazy (sprintf "%s CHOSEN" (fst codomain_item)));*)
613 let new_env = Environment.add item codomain_item aliases in
614 let new_diff = (item,codomain_item)::diff in
617 (inner_dom@remaining_dom@rem_dom) base_univ
619 | Ok (thing, metasenv,subst,new_univ) ->
621 (match inner_dom with
623 [new_env,new_diff,metasenv,subst,thing,new_univ],
626 aux new_env new_diff None inner_dom
627 (remaining_dom@rem_dom)
631 | Uncertain loc_msg ->
633 (match inner_dom with
634 | [] -> [],[new_env,new_diff,loc_msg],[]
636 aux new_env new_diff None inner_dom
637 (remaining_dom@rem_dom)
642 let res = [],[],[new_env,new_diff,loc_msg,true] in
645 let ok_l,uncertain_l,error_l =
646 classify_errors (filter choices)
650 (fun (env,diff,_,_,_,_) res ->
651 aux env diff None remaining_dom rem_dom @@ res
652 ) ok_l ([],[],error_l)
655 (fun (env,diff,_) res ->
656 aux env diff None remaining_dom rem_dom @@ res
657 ) uncertain_l res_after_ok_l
659 let aux' aliases diff lookup_in_todo_dom todo_dom =
660 match test_env aliases todo_dom base_univ with
663 aux aliases diff lookup_in_todo_dom todo_dom []
664 | Ko (loc_msg) -> [],[],[aliases,diff,loc_msg,true]
667 match aux' aliases [] None todo_dom with
668 | [],uncertain,errors ->
671 (fun (env,diff,loc_msg) -> (env,diff,loc_msg,true)
676 (fun (env,diff,loc_msg,significant) ->
679 (fun locs domain_item ->
682 description_of_alias (Environment.find domain_item env)
684 Some (locs,descr_of_domain_item domain_item,description)
689 let diff= List.map (fun a,b -> a,description_of_alias b) diff in
690 env',diff,loc_msg,significant
693 raise (NoWellTypedInterpretation (0,errors))
694 | [_,diff,metasenv,subst,t,ugraph],_,_ ->
695 debug_print (lazy "SINGLE INTERPRETATION");
696 [diff,metasenv,subst,t,ugraph], false
699 (lazy (sprintf "MANY INTERPRETATIONS (%d)" (List.length l)));
702 (fun (env, _, _, _, _, _) ->
704 (fun locs domain_item ->
706 description_of_alias (Environment.find domain_item env)
708 locs,descr_of_domain_item domain_item, description)
713 C.interactive_interpretation_choice
714 thing_txt thing_txt_prefix_len choices
716 (List.map (fun n->let _,d,m,s,t,u= List.nth l n in d,m,s,t,u)