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/
28 open DisambiguateTypes
31 exception No_choices of domain_item
32 exception NoWellTypedInterpretation
34 (** raised when an environment is not enough informative to decide *)
38 let debug_print = if debug then prerr_endline else ignore
41 (** print benchmark information *)
43 let max_refinements = ref 0 (* benchmarking is not thread safe *)
44 let actual_refinements = ref 0
45 let domain_size = ref 0
46 let choices_avg = ref 0.
49 let descr_of_domain_item = function
52 | Num i -> string_of_int i
55 | Ok of Cic.term * Cic.metasenv
59 let refine metasenv context term ugraph =
60 (* if benchmark then incr actual_refinements; *)
62 CicMkImplicit.expand_implicits metasenv [] context term in
63 debug_print (sprintf "TEST_INTERPRETATION: %s" (CicPp.ppterm term));
65 let term', _, metasenv',ugraph1 =
66 CicRefine.type_of_aux' metasenv context term ugraph in
67 (Ok (term', metasenv')),ugraph1
69 | CicRefine.Uncertain s ->
70 debug_print ("UNCERTAIN!!! [" ^ s ^ "] " ^ CicPp.ppterm term) ;
72 | CicRefine.RefineFailure msg ->
73 debug_print (sprintf "PRUNED!!!\nterm%s\nmessage:%s"
74 (CicPp.ppterm term) msg);
77 let resolve (env: environment) (item: domain_item) ?(num = "") ?(args = []) () =
79 snd (Environment.find item env) env num args
81 failwith ("Domain item not found: " ^
82 (DisambiguateTypes.string_of_domain_item item))
84 (* TODO move it to Cic *)
85 let find_in_environment name context =
86 let rec aux acc = function
87 | [] -> raise Not_found
88 | Cic.Name hd :: tl when hd = name -> acc
89 | _ :: tl -> aux (acc + 1) tl
93 let interpretate ~context ~env ast =
94 let rec aux loc context = function
95 | CicAst.AttributedTerm (`Loc loc, term) ->
97 | CicAst.AttributedTerm (_, term) -> aux loc context term
98 | CicAst.Appl (CicAst.Symbol (symb, i) :: args) ->
99 let cic_args = List.map (aux loc context) args in
100 resolve env (Symbol (symb, i)) ~args:cic_args ()
101 | CicAst.Appl terms -> Cic.Appl (List.map (aux loc context) terms)
102 | CicAst.Binder (binder_kind, (var, typ), body) ->
103 let cic_type = aux_option loc context typ in
104 let cic_body = aux loc (var :: context) body in
105 (match binder_kind with
106 | `Lambda -> Cic.Lambda (var, cic_type, cic_body)
107 | `Pi | `Forall -> Cic.Prod (var, cic_type, cic_body)
109 resolve env (Symbol ("exists", 0))
110 ~args:[ cic_type; Cic.Lambda (var, cic_type, cic_body) ] ())
111 | CicAst.Case (term, indty_ident, outtype, branches) ->
112 let cic_term = aux loc context term in
113 let cic_outtype = aux_option loc context outtype in
114 let do_branch ((head, args), term) =
115 let rec do_branch' context = function
116 | [] -> aux loc context term
117 | (name, typ) :: tl ->
118 let cic_body = do_branch' (name :: context) tl in
121 | None -> Cic.Implicit (Some `Type)
122 | Some typ -> aux loc context typ
124 Cic.Lambda (name, typ, cic_body)
126 do_branch' context args
128 let (indtype_uri, indtype_no) =
129 match indty_ident with
130 | Some indty_ident ->
131 (match resolve env (Id indty_ident) () with
132 | Cic.MutInd (uri, tyno, _) -> (uri, tyno)
133 | Cic.Implicit _ -> raise Try_again
134 | _ -> raise DisambiguateChoices.Invalid_choice)
136 let fst_constructor =
138 | ((head, _), _) :: _ -> head
139 | [] -> raise DisambiguateChoices.Invalid_choice
141 (match resolve env (Id fst_constructor) () with
142 | Cic.MutConstruct (indtype_uri, indtype_no, _, _) ->
143 (indtype_uri, indtype_no)
144 | Cic.Implicit _ -> raise Try_again
145 | _ -> raise DisambiguateChoices.Invalid_choice)
147 Cic.MutCase (indtype_uri, indtype_no, cic_outtype, cic_term,
148 (List.map do_branch branches))
149 | CicAst.LetIn ((name, typ), def, body) ->
150 let cic_def = aux loc context def in
154 | Some t -> Cic.Cast (cic_def, aux loc context t)
156 let cic_body = aux loc (name :: context) body in
157 Cic.LetIn (name, cic_def, cic_body)
158 | CicAst.LetRec (kind, defs, body) ->
160 List.fold_left (fun acc ((name, _), _, _) -> name :: acc)
163 let cic_body = aux loc context' body in
166 (fun ((name, typ), body, decr_idx) ->
167 let cic_body = aux loc context' body in
168 let cic_type = aux_option loc context typ in
172 CicTextualParser2.fail loc
173 "Recursive functions cannot be anonymous"
174 | Cic.Name name -> name
176 (name, decr_idx, cic_type, cic_body))
179 let counter = ref ~-1 in
180 let build_term funs =
181 (* this is the body of the fold_right function below. Rationale: Fix
182 * and CoFix cases differs only in an additional index in the
183 * inductiveFun list, see Cic.term *)
186 (fun (var, _, _, _) cic ->
188 Cic.LetIn (Cic.Name var, Cic.Fix (!counter, funs), cic))
191 List.map (fun (name, _, typ, body) -> (name, typ, body)) funs
193 (fun (var, _, _, _) cic ->
195 Cic.LetIn (Cic.Name var, Cic.CoFix (!counter, funs), cic))
197 List.fold_right (build_term inductiveFuns) inductiveFuns cic_body
198 | CicAst.Ident (name, subst)
199 | CicAst.Uri (name, subst) as ast ->
200 let is_uri = function CicAst.Uri _ -> true | _ -> false in
202 if is_uri ast then raise Not_found;(* don't search the env for URIs *)
203 let index = find_in_environment name context in
204 if subst <> None then
205 CicTextualParser2.fail loc
206 "Explicit substitutions not allowed here";
210 if is_uri ast then (* we have the URI, build the term out of it *)
212 CicUtil.term_of_uri name
213 with UriManager.IllFormedUri _ ->
214 CicTextualParser2.fail loc "Ill formed URI"
216 resolve env (Id name) ()
220 List.map (fun uri -> UriManager.name_of_uri uri, uri) uris
227 List.assoc s ids_to_uris, aux loc context term
229 raise DisambiguateChoices.Invalid_choice))
231 | None -> List.map (fun uri -> uri, Cic.Implicit None) uris)
235 | Cic.Const (uri, []) ->
236 let o,_ = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
237 let uris = CicUtil.params_of_obj o in
238 Cic.Const (uri, mk_subst uris)
239 | Cic.Var (uri, []) ->
240 let o,_ = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
241 let uris = CicUtil.params_of_obj o in
242 Cic.Var (uri, mk_subst uris)
243 | Cic.MutInd (uri, i, []) ->
244 let o,_ = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
245 let uris = CicUtil.params_of_obj o in
246 Cic.MutInd (uri, i, mk_subst uris)
247 | Cic.MutConstruct (uri, i, j, []) ->
248 let o,_ = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
249 let uris = CicUtil.params_of_obj o in
250 Cic.MutConstruct (uri, i, j, mk_subst uris)
251 | Cic.Meta _ | Cic.Implicit _ as t ->
254 "Warning: %s must be instantiated with _[%s] but we do not enforce it"
258 (fun (s, term) -> s ^ " := " ^ CicAstPp.pp_term term)
263 raise DisambiguateChoices.Invalid_choice
265 CicEnvironment.CircularDependency _ ->
266 raise DisambiguateChoices.Invalid_choice))
267 | CicAst.Implicit -> Cic.Implicit None
268 | CicAst.UserInput -> Cic.Implicit (Some `Hole)
269 (* | CicAst.UserInput -> assert false*)
270 | CicAst.Num (num, i) -> resolve env (Num i) ~num ()
271 | CicAst.Meta (index, subst) ->
274 (function None -> None | Some term -> Some (aux loc context term))
277 Cic.Meta (index, cic_subst)
278 | CicAst.Sort `Prop -> Cic.Sort Cic.Prop
279 | CicAst.Sort `Set -> Cic.Sort Cic.Set
280 | CicAst.Sort `Type -> Cic.Sort (Cic.Type (CicUniv.fresh())) (* TASSI *)
281 | CicAst.Sort `CProp -> Cic.Sort Cic.CProp
282 | CicAst.Symbol (symbol, instance) ->
283 resolve env (Symbol (symbol, instance)) ()
284 and aux_option loc context = function
285 | None -> Cic.Implicit (Some `Type)
286 | Some term -> aux loc context term
289 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
290 | term -> aux CicAst.dummy_floc context term
292 let domain_of_term ~context ast =
293 (* "aux" keeps domain in reverse order and doesn't care about duplicates.
294 * Domain item more in deep in the list will be processed first.
296 let rec aux loc context = function
297 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
298 | CicAst.AttributedTerm (_, term) -> aux loc context term
299 | CicAst.Appl terms ->
300 List.fold_left (fun dom term -> aux loc context term @ dom) [] terms
301 | CicAst.Binder (kind, (var, typ), body) ->
304 | `Exists -> [ Symbol ("exists", 0) ]
307 let type_dom = aux_option loc context typ in
308 let body_dom = aux loc (var :: context) body in
309 body_dom @ type_dom @ kind_dom
310 | CicAst.Case (term, indty_ident, outtype, branches) ->
311 let term_dom = aux loc context term in
312 let outtype_dom = aux_option loc context outtype in
313 let get_first_constructor = function
315 | ((head, _), _) :: _ -> [ Id head ]
317 let do_branch ((head, args), term) =
318 let (term_context, args_domain) =
320 (fun (cont, dom) (name, typ) ->
324 | Some typ -> aux loc cont typ @ dom)))
327 args_domain @ aux loc term_context term
330 List.fold_left (fun dom branch -> do_branch branch @ dom) [] branches
332 branches_dom @ outtype_dom @ term_dom @
333 (match indty_ident with
334 | None -> get_first_constructor branches
335 | Some ident -> [ Id ident ])
336 | CicAst.LetIn ((var, typ), body, where) ->
337 let body_dom = aux loc context body in
338 let type_dom = aux_option loc context typ in
339 let where_dom = aux loc (var :: context) where in
340 where_dom @ type_dom @ body_dom
341 | CicAst.LetRec (kind, defs, where) ->
343 List.fold_left (fun acc ((var, typ), _, _) -> var :: acc)
346 let where_dom = aux loc context' where in
349 (fun dom ((_, typ), body, _) ->
350 aux loc context' body @ aux_option loc context typ)
354 | CicAst.Ident (name, subst) ->
356 let index = find_in_environment name context in
357 if subst <> None then
358 CicTextualParser2.fail loc
359 "Explicit substitutions not allowed here"
367 (fun dom (_, term) ->
368 let dom' = aux loc context term in
372 | CicAst.Implicit -> []
373 | CicAst.Num (num, i) -> [ Num i ]
374 | CicAst.Meta (index, local_context) ->
375 List.fold_left (fun dom term -> aux_option loc context term @ dom) []
377 | CicAst.Sort _ -> []
378 | CicAst.Symbol (symbol, instance) -> [ Symbol (symbol, instance) ]
379 | CicAst.UserInput -> assert false
381 and aux_option loc context = function
383 | Some t -> aux loc context t
386 (* e.g. [5;1;1;1;2;3;4;1;2] -> [2;1;4;3;5] *)
388 let module SortedItem =
390 type t = DisambiguateTypes.domain_item
391 let compare = Pervasives.compare
394 let module Set = Set.Make (SortedItem) in
396 let rev_l = List.rev l in
397 let (_, uniq_rev_l) =
399 (fun (members, rev_l) elt ->
400 if Set.mem elt members then
403 Set.add elt members, elt :: rev_l)
404 (Set.empty, []) rev_l
411 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
412 | term -> aux CicAst.dummy_floc context term)
416 let domain_diff dom1 dom2 =
417 (* let domain_diff = Domain.diff *)
419 List.fold_left (fun pred elt -> (fun elt' -> elt' = elt || pred elt'))
420 (fun _ -> false) dom2
422 List.filter (fun elt -> not (is_in_dom2 elt)) dom1
424 module type Disambiguator =
426 val disambiguate_term :
428 context:Cic.context ->
429 metasenv:Cic.metasenv ->
430 ?initial_ugraph:CicUniv.universe_graph ->
431 aliases:environment -> (* previous interpretation status *)
433 (environment * (* new interpretation status *)
434 Cic.metasenv * (* new metasenv *)
436 CicUniv.universe_graph) list (* disambiguated term *)
439 module Make (C: Callbacks) =
441 let choices_of_id dbd id =
442 let uris = MetadataQuery.locate ~dbd id in
446 [UriManager.string_of_uri (C.input_or_locate_uri
447 ~title:("URI matching \"" ^ id ^ "\" unknown.") ~id ())]
450 C.interactive_user_uri_choice ~selection_mode:`MULTIPLE
451 ~ok:"Try selected." ~enable_button_for_non_vars:true
452 ~title:"Ambiguous input." ~id
453 ~msg: ("Ambiguous input \"" ^ id ^
454 "\". Please, choose one or more interpretations:")
462 CicUtil.term_of_uri uri
465 debug_print (Printexc.to_string exn);
471 let disambiguate_term ~(dbd:Mysql.dbd) ~context ~metasenv
472 ?(initial_ugraph = CicUniv.empty_ugraph) ~aliases:current_env
475 debug_print "NEW DISAMBIGUATE INPUT";
476 let disambiguate_context = (* cic context -> disambiguate context *)
478 (function None -> Cic.Anonymous | Some (name, _) -> name)
481 debug_print ("TERM IS: " ^ (CicAstPp.pp_term term));
482 let term_dom = domain_of_term ~context:disambiguate_context term in
483 debug_print (sprintf "DISAMBIGUATION DOMAIN: %s"
484 (string_of_domain term_dom));
486 Environment.fold (fun item _ dom -> item :: dom) current_env []
488 let todo_dom = domain_diff term_dom current_dom in
489 (* (2) lookup function for any item (Id/Symbol/Num) *)
491 let id_choices = Hashtbl.create 1023 in
497 Hashtbl.find id_choices id
499 let choices = choices_of_id dbd id in
500 Hashtbl.add id_choices id choices;
502 | Symbol (symb, _) -> DisambiguateChoices.lookup_symbol_choices symb
503 | Num instance -> DisambiguateChoices.lookup_num_choices ()
505 if choices = [] then raise (No_choices item);
512 if benchmark then begin
513 let per_item_choices =
517 let len = List.length (lookup_choices dom_item) in
518 debug_print (sprintf "BENCHMARK %s: %d"
519 (string_of_domain_item dom_item) len);
521 with No_choices _ -> 0)
524 max_refinements := List.fold_left ( * ) 1 per_item_choices;
525 actual_refinements := 0;
526 domain_size := List.length term_dom;
528 (float_of_int !max_refinements) ** (1. /. float_of_int !domain_size)
534 (* (3) test an interpretation filling with meta uninterpreted identifiers
536 let test_env current_env todo_dom ugraph =
543 | Id _ | Num _ -> (fun _ _ _ -> Cic.Implicit (Some `Closed))
544 | Symbol _ -> (fun _ _ _ -> Cic.Implicit None))) env)
549 interpretate ~context:disambiguate_context ~env:filled_env term
551 let k,ugraph1 = refine metasenv context cic_term ugraph in
554 | Try_again -> Uncertain,ugraph
555 | DisambiguateChoices.Invalid_choice -> Ko,ugraph
557 (* (4) build all possible interpretations *)
558 let rec aux current_env todo_dom base_univ =
561 (match test_env current_env [] base_univ with
562 | Ok (term, metasenv),new_univ ->
563 [ current_env, metasenv, term, new_univ ]
564 | Ko,_ | Uncertain,_ -> [])
565 | item :: remaining_dom ->
566 debug_print (sprintf "CHOOSED ITEM: %s"
567 (string_of_domain_item item));
568 let choices = lookup_choices item in
569 let rec filter univ = function
571 | codomain_item :: tl ->
572 debug_print (sprintf "%s CHOSEN" (fst codomain_item)) ;
574 Environment.add item codomain_item current_env
576 (match test_env new_env remaining_dom univ with
577 | Ok (term, metasenv),new_univ ->
578 (match remaining_dom with
579 | [] -> [ new_env, metasenv, term, new_univ ]
580 | _ -> aux new_env remaining_dom new_univ )@
582 | Uncertain,new_univ ->
583 (match remaining_dom with
585 | _ -> aux new_env remaining_dom new_univ )@
587 | Ko,_ -> filter univ tl)
589 filter base_univ choices
591 let base_univ = initial_ugraph in
594 match aux current_env todo_dom base_univ with
595 | [] -> raise NoWellTypedInterpretation
596 | [ e,me,t,u ] as l ->
597 debug_print "UNA SOLA SCELTA";
600 debug_print (sprintf "PIU' SCELTE (%d)" (List.length l));
603 (fun (env, _, _, _) ->
607 fst (Environment.find domain_item env)
609 (descr_of_domain_item domain_item, description))
613 let choosed = C.interactive_interpretation_choice choices in
614 List.map (List.nth l) choosed
618 let res_size = List.length res in
620 ("BENCHMARK: %d/%d refinements performed, domain size %d, interps %d, k %.2f\n" ^^
621 "BENCHMARK: estimated %.2f")
622 !actual_refinements !max_refinements !domain_size res_size
624 (float_of_int (!domain_size - 1) *. !choices_avg *. (float_of_int res_size) +. !choices_avg)));
628 CicEnvironment.CircularDependency s ->
629 failwith "Disambiguate: circular dependency"
634 exception Ambiguous_term of string
638 let interactive_user_uri_choice ~selection_mode ?ok
639 ?(enable_button_for_non_vars = true) ~title ~msg ~id uris =
641 let interactive_interpretation_choice interp = raise Exit
642 let input_or_locate_uri ~(title:string) ?id = raise Exit
644 module Disambiguator = Make (Callbacks)
645 let disambiguate_string ~dbd ?(context=[]) ?(metasenv=[]) ?initial_ugraph
646 ?(aliases=DisambiguateTypes.Environment.empty) term =
647 let ast = CicTextualParser2.parse_term (Stream.of_string term) in
649 Disambiguator.disambiguate_term ~dbd ~context ~metasenv ast
650 ?initial_ugraph ~aliases
651 with Exit -> raise (Ambiguous_term term)