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
40 let descr_of_domain_item = function
43 | Num i -> string_of_int i
46 | Ok of Cic.term * Cic.metasenv
50 let refine metasenv context term =
51 let metasenv, term = CicMkImplicit.expand_implicits metasenv context term in
52 debug_print (sprintf "TEST_INTERPRETATION: %s" (CicPp.ppterm term));
54 let term', _, metasenv' = CicRefine.type_of_aux' metasenv context term in
57 | CicRefine.Uncertain _ ->
58 debug_print ("%%% UNCERTAIN!!! " ^ CicPp.ppterm term) ;
61 (* TODO we should catch only the RefineFailure excecption *)
62 debug_print ("%%% PRUNED!!! " ^ CicPp.ppterm term) ;
65 let resolve (env: environment) (item: domain_item) ?(num = "") ?(args = []) () =
67 snd (Environment.find item env) env num args
68 with Not_found -> assert false
70 (* TODO move it to Cic *)
71 let find_in_environment name context =
72 let rec aux acc = function
73 | [] -> raise Not_found
74 | Cic.Name hd :: tl when hd = name -> acc
75 | _ :: tl -> aux (acc + 1) tl
79 let interpretate ~context ~env ast =
80 let rec aux loc context = function
81 | CicAst.AttributedTerm (`Loc loc, term) ->
83 | CicAst.AttributedTerm (_, term) -> aux loc context term
84 | CicAst.Appl (CicAst.Symbol (symb, i) :: args) ->
85 let cic_args = List.map (aux loc context) args in
86 resolve env (Symbol (symb, i)) ~args:cic_args ()
87 | CicAst.Appl terms -> Cic.Appl (List.map (aux loc context) terms)
88 | CicAst.Binder (binder_kind, (var, typ), body) ->
89 let cic_type = aux_option loc context typ in
90 let cic_body = aux loc (var :: context) body in
91 (match binder_kind with
92 | `Lambda -> Cic.Lambda (var, cic_type, cic_body)
93 | `Pi | `Forall -> Cic.Prod (var, cic_type, cic_body)
95 resolve env (Symbol ("exists", 0))
96 ~args:[ cic_type; Cic.Lambda (var, cic_type, cic_body) ] ())
97 | CicAst.Case (term, indty_ident, outtype, branches) ->
98 let cic_term = aux loc context term in
99 let cic_outtype = aux_option loc context outtype in
100 let do_branch ((head, args), term) =
101 let rec do_branch' context = function
102 | [] -> aux loc context term
103 | (name, typ) :: tl ->
104 let cic_body = do_branch' (name :: context) tl in
107 | None -> Cic.Implicit (Some `Type)
108 | Some typ -> aux loc context typ
110 Cic.Lambda (name, typ, cic_body)
112 do_branch' context args
114 let (indtype_uri, indtype_no) =
115 match indty_ident with
116 | Some indty_ident ->
117 (match resolve env (Id indty_ident) () with
118 | Cic.MutInd (uri, tyno, _) -> (uri, tyno)
119 | Cic.Implicit _ -> raise Try_again
120 | _ -> raise DisambiguateChoices.Invalid_choice)
122 let fst_constructor =
124 | ((head, _), _) :: _ -> head
125 | [] -> raise DisambiguateChoices.Invalid_choice
127 (match resolve env (Id fst_constructor) () with
128 | Cic.MutConstruct (indtype_uri, indtype_no, _, _) ->
129 (indtype_uri, indtype_no)
130 | Cic.Implicit _ -> raise Try_again
131 | _ -> raise DisambiguateChoices.Invalid_choice)
133 Cic.MutCase (indtype_uri, indtype_no, cic_outtype, cic_term,
134 (List.map do_branch branches))
135 | CicAst.LetIn ((name, typ), def, body) ->
136 let cic_def = aux loc context def in
140 | Some t -> Cic.Cast (cic_def, aux loc context t)
142 let cic_body = aux loc (name :: context) body in
143 Cic.LetIn (name, cic_def, cic_body)
144 | CicAst.LetRec (kind, defs, body) ->
146 List.fold_left (fun acc ((name, _), _, _) -> name :: acc)
149 let cic_body = aux loc context' body in
152 (fun ((name, typ), body, decr_idx) ->
153 let cic_body = aux loc context' body in
154 let cic_type = aux_option loc context typ in
158 CicTextualParser2.fail loc
159 "Recursive functions cannot be anonymous"
160 | Cic.Name name -> name
162 (name, decr_idx, cic_type, cic_body))
165 let counter = ref ~-1 in
166 let build_term funs =
167 (* this is the body of the fold_right function below. Rationale: Fix
168 * and CoFix cases differs only in an additional index in the
169 * inductiveFun list, see Cic.term *)
172 (fun (var, _, _, _) cic ->
174 Cic.LetIn (Cic.Name var, Cic.Fix (!counter, funs), cic))
177 List.map (fun (name, _, typ, body) -> (name, typ, body)) funs
179 (fun (var, _, _, _) cic ->
181 Cic.LetIn (Cic.Name var, Cic.CoFix (!counter, funs), cic))
183 List.fold_right (build_term inductiveFuns) inductiveFuns cic_body
184 | CicAst.Ident (name, subst) ->
185 (* TODO hanlde explicit substitutions *)
187 let index = find_in_environment name context in
189 CicTextualParser2.fail loc
190 "Explicit substitutions not allowed here";
193 let cic = resolve env (Id name) () in
196 List.map (fun uri -> UriManager.name_of_uri uri, uri) uris
201 List.assoc s ids_to_uris, aux loc context term
202 with Not_found -> raise DisambiguateChoices.Invalid_choice))
206 | Cic.Const (uri, []) ->
208 match CicEnvironment.get_obj uri with
209 | Cic.Constant (_, _, _, uris) -> uris
212 Cic.Const (uri, mk_subst uris)
213 | Cic.Var (uri, []) ->
215 match CicEnvironment.get_obj uri with
216 | Cic.Variable (_, _, _, uris) -> uris
219 Cic.Var (uri, mk_subst uris)
220 | Cic.MutInd (uri, i, []) ->
222 match CicEnvironment.get_obj uri with
223 | Cic.InductiveDefinition (_, uris, _) -> uris
226 Cic.MutInd (uri, i, mk_subst uris)
227 | Cic.MutConstruct (uri, i, j, []) ->
229 match CicEnvironment.get_obj uri with
230 | Cic.InductiveDefinition (_, uris, _) -> uris
233 Cic.MutConstruct (uri, i, j, mk_subst uris)
234 | Cic.Meta _ | Cic.Implicit _ as t ->
236 prerr_endline (sprintf
237 "Warning: %s must be instantiated with _[%s] but we do not enforce it"
241 (fun (s, term) -> s ^ " := " ^ CicAstPp.pp_term term)
246 raise DisambiguateChoices.Invalid_choice))
247 | CicAst.Implicit -> Cic.Implicit None
248 | CicAst.Num (num, i) -> resolve env (Num i) ~num ()
249 | CicAst.Meta (index, subst) ->
252 (function None -> None | Some term -> Some (aux loc context term))
255 Cic.Meta (index, cic_subst)
256 | CicAst.Sort `Prop -> Cic.Sort Cic.Prop
257 | CicAst.Sort `Set -> Cic.Sort Cic.Set
258 | CicAst.Sort `Type -> Cic.Sort Cic.Type
259 | CicAst.Sort `CProp -> Cic.Sort Cic.CProp
260 | CicAst.Symbol (symbol, instance) ->
261 resolve env (Symbol (symbol, instance)) ()
262 and aux_option loc context = function
263 | None -> Cic.Implicit (Some `Type)
264 | Some term -> aux loc context term
267 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
268 | term -> aux (-1, -1) context term
270 let domain_of_term ~context ast =
271 (* "aux" keeps domain in reverse order and doesn't care about duplicates.
272 * Domain item more in deep in the list will be processed first.
274 let rec aux loc context = function
275 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
276 | CicAst.AttributedTerm (_, term) -> aux loc context term
277 | CicAst.Appl terms ->
278 List.fold_left (fun dom term -> aux loc context term @ dom) [] terms
279 | CicAst.Binder (kind, (var, typ), body) ->
282 | `Exists -> [ Symbol ("exists", 0) ]
285 let type_dom = aux_option loc context typ in
286 let body_dom = aux loc (var :: context) body in
287 body_dom @ type_dom @ kind_dom
288 | CicAst.Case (term, indty_ident, outtype, branches) ->
289 let term_dom = aux loc context term in
290 let outtype_dom = aux_option loc context outtype in
291 let do_branch ((head, args), term) =
292 let (term_context, args_domain) =
294 (fun (cont, dom) (name, typ) ->
298 | Some typ -> aux loc cont typ @ dom)))
301 args_domain @ aux loc term_context term
304 List.fold_left (fun dom branch -> do_branch branch @ dom) [] branches
306 branches_dom @ outtype_dom @ term_dom @
307 (match indty_ident with None -> [] | Some ident -> [ Id ident ])
308 | CicAst.LetIn ((var, typ), body, where) ->
309 let body_dom = aux loc context body in
310 let type_dom = aux_option loc context typ in
311 let where_dom = aux loc (var :: context) where in
312 where_dom @ type_dom @ body_dom
313 | CicAst.LetRec (kind, defs, where) ->
315 List.fold_left (fun acc ((var, typ), _, _) -> var :: acc)
318 let where_dom = aux loc context' where in
321 (fun dom ((_, typ), body, _) ->
322 aux loc context' body @ aux_option loc context typ)
326 | CicAst.Ident (name, subst) ->
327 (* TODO hanlde explicit substitutions *)
329 let index = find_in_environment name context in
331 CicTextualParser2.fail loc
332 "Explicit substitutions not allowed here";
336 (fun dom (_, term) ->
337 let dom' = aux loc context term in
340 | CicAst.Implicit -> []
341 | CicAst.Num (num, i) -> [ Num i ]
342 | CicAst.Meta (index, local_context) ->
343 List.fold_left (fun dom term -> aux_option loc context term @ dom) []
345 | CicAst.Sort _ -> []
346 | CicAst.Symbol (symbol, instance) -> [ Symbol (symbol, instance) ]
348 and aux_option loc context = function
350 | Some t -> aux loc context t
353 (* e.g. [5;1;1;1;2;3;4;1;2] -> [2;1;4;3;5] *)
355 let module SortedItem =
357 type t = DisambiguateTypes.domain_item
358 let compare = Pervasives.compare
361 let module Set = Set.Make (SortedItem) in
363 let rev_l = List.rev l in
364 let (_, uniq_rev_l) =
366 (fun (members, rev_l) elt ->
367 if Set.mem elt members then
370 Set.add elt members, elt :: rev_l)
371 (Set.empty, []) rev_l
378 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
379 | term -> aux (-1, -1) context term)
383 let domain_diff dom1 dom2 =
384 (* let domain_diff = Domain.diff *)
386 List.fold_left (fun pred elt -> (fun elt' -> elt' = elt || pred elt'))
387 (fun _ -> false) dom2
389 List.filter (fun elt -> not (is_in_dom2 elt)) dom1
391 module Make (C: Callbacks) =
393 let choices_of_id mqi_handle id =
394 let query = MQueryGenerator.locate id in
395 let result = MQueryInterpreter.execute mqi_handle query in
399 MQueryMisc.wrong_xpointer_format_from_wrong_xpointer_format' uri
401 HelmLogger.log (`Msg (`T "Locate query:"));
402 MQueryUtil.text_of_query
403 (fun s -> HelmLogger.log ~append_NL:false (`Msg (`T s)))
405 HelmLogger.log (`Msg (`T "Result:"));
406 MQueryUtil.text_of_result
407 (fun s -> HelmLogger.log (`Msg (`T s))) "" result;
411 [UriManager.string_of_uri (C.input_or_locate_uri
412 ~title:("URI matching \"" ^ id ^ "\" unknown."))]
415 C.interactive_user_uri_choice ~selection_mode:`MULTIPLE
416 ~ok:"Try selected." ~enable_button_for_non_vars:true
417 ~title:"Ambiguous input." ~id
418 ~msg: ("Ambiguous input \"" ^ id ^
419 "\". Please, choose one or more interpretations:")
427 HelmLibraryObjects.term_of_uri (UriManager.uri_of_string uri)
428 with _ -> assert false
433 let disambiguate_term mqi_handle context metasenv term ~aliases:current_env
435 debug_print "NEW DISAMBIGUATE INPUT";
436 let disambiguate_context = (* cic context -> disambiguate context *)
438 (function None -> Cic.Anonymous | Some (name, _) -> name)
441 let term_dom = domain_of_term ~context:disambiguate_context term in
442 debug_print (sprintf "DISAMBIGUATION DOMAIN: %s"
443 (string_of_domain term_dom));
445 Environment.fold (fun item _ dom -> item :: dom) current_env []
447 let todo_dom = domain_diff term_dom current_dom in
448 (* (2) lookup function for any item (Id/Symbol/Num) *)
450 let id_choices = Hashtbl.create 1023 in
456 Hashtbl.find id_choices id
458 let choices = choices_of_id mqi_handle id in
459 Hashtbl.add id_choices id choices;
461 | Symbol (symb, _) -> DisambiguateChoices.lookup_symbol_choices symb
462 | Num instance -> DisambiguateChoices.lookup_num_choices ()
464 if choices = [] then raise (No_choices item);
467 (* (3) test an interpretation filling with meta uninterpreted identifiers
469 let test_env current_env todo_dom =
476 | Id _ | Num _ -> (fun _ _ _ -> Cic.Implicit (Some `Closed))
477 | Symbol _ -> (fun _ _ _ -> Cic.Implicit None))) env)
482 interpretate ~context:disambiguate_context ~env:filled_env term
484 refine metasenv context cic_term
486 | Try_again -> Uncertain
487 | DisambiguateChoices.Invalid_choice -> Ko
489 (* (4) build all possible interpretations *)
490 let rec aux current_env todo_dom =
493 (match test_env current_env [] with
494 | Ok (term, metasenv) -> [ current_env, term, metasenv ]
495 | Ko | Uncertain -> [])
496 | item :: remaining_dom ->
497 debug_print (sprintf "CHOOSED ITEM: %s"
498 (string_of_domain_item item));
499 let choices = lookup_choices item in
500 let rec filter = function
502 | codomain_item :: tl ->
503 debug_print (sprintf "%s CHOSEN" (fst codomain_item)) ;
505 Environment.add item codomain_item current_env
507 (match test_env new_env remaining_dom with
508 | Ok (term, metasenv) ->
509 (match remaining_dom with
510 | [] -> [ new_env, term, metasenv ]
511 | _ -> aux new_env remaining_dom) @ filter tl
513 (match remaining_dom with
515 | _ -> aux new_env remaining_dom) @ filter tl
520 let (choosed_env, choosed_term, choosed_metasenv) =
521 match aux current_env todo_dom with
522 | [] -> raise NoWellTypedInterpretation
524 debug_print "UNA SOLA SCELTA";
527 debug_print (sprintf "PIU' SCELTE (%d)" (List.length l));
534 fst (Environment.find domain_item env)
536 (descr_of_domain_item domain_item, description))
540 let choosed = C.interactive_interpretation_choice choices in
543 (choosed_env, choosed_metasenv, choosed_term)