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 = []) () =
66 snd (Environment.find item env) env num args
68 (* TODO move it to Cic *)
69 let find_in_environment name context =
70 let rec aux acc = function
71 | [] -> raise Not_found
72 | Cic.Name hd :: tl when hd = name -> acc
73 | _ :: tl -> aux (acc + 1) tl
77 let interpretate ~context ~env ast =
78 let rec aux loc context = function
79 | CicAst.AttributedTerm (`Loc loc, term) ->
81 | CicAst.AttributedTerm (_, term) -> aux loc context term
82 | CicAst.Appl (CicAst.Symbol (symb, i) :: args) ->
83 let cic_args = List.map (aux loc context) args in
84 resolve env (Symbol (symb, i)) ~args:cic_args ()
85 | CicAst.Appl terms -> Cic.Appl (List.map (aux loc context) terms)
86 | CicAst.Binder (binder_kind, (var, typ), body) ->
87 let cic_type = aux_option loc context typ in
88 let cic_body = aux loc (var :: context) body in
89 (match binder_kind with
90 | `Lambda -> Cic.Lambda (var, cic_type, cic_body)
91 | `Pi | `Forall -> Cic.Prod (var, cic_type, cic_body)
93 resolve env (Symbol ("exists", 0))
94 ~args:[ cic_type; Cic.Lambda (var, cic_type, cic_body) ] ())
95 | CicAst.Case (term, indty_ident, outtype, branches) ->
96 let cic_term = aux loc context term in
97 let cic_outtype = aux_option loc context outtype in
98 let do_branch ((head, args), term) =
99 let rec do_branch' context = function
100 | [] -> aux loc context term
101 | (name, typ) :: tl ->
102 let cic_body = do_branch' (name :: context) tl in
105 | None -> Cic.Implicit (Some `Type)
106 | Some typ -> aux loc context typ
108 Cic.Lambda (name, typ, cic_body)
110 do_branch' context args
112 let (indtype_uri, indtype_no) =
113 match resolve env (Id indty_ident) () with
114 | Cic.MutInd (uri, tyno, _) -> uri, tyno
115 | Cic.Implicit _ -> raise Try_again
116 | _ -> raise DisambiguateChoices.Invalid_choice
118 Cic.MutCase (indtype_uri, indtype_no, cic_outtype, cic_term,
119 (List.map do_branch branches))
120 | CicAst.LetIn ((name, typ), def, body) ->
121 let cic_def = aux loc context def in
125 | Some t -> Cic.Cast (cic_def, aux loc context t)
127 let cic_body = aux loc (name :: context) body in
128 Cic.LetIn (name, cic_def, cic_body)
129 | CicAst.LetRec (kind, defs, body) ->
131 List.fold_left (fun acc ((name, _), _, _) -> name :: acc)
134 let cic_body = aux loc context' body in
137 (fun ((name, typ), body, decr_idx) ->
138 let cic_body = aux loc context' body in
139 let cic_type = aux_option loc context typ in
143 CicTextualParser2.fail loc
144 "Recursive functions cannot be anonymous"
145 | Cic.Name name -> name
147 (name, decr_idx, cic_type, cic_body))
150 let counter = ref ~-1 in
151 let build_term funs =
152 (* this is the body of the fold_right function below. Rationale: Fix
153 * and CoFix cases differs only in an additional index in the
154 * inductiveFun list, see Cic.term *)
157 (fun (var, _, _, _) cic ->
159 Cic.LetIn (Cic.Name var, Cic.Fix (!counter, funs), cic))
162 List.map (fun (name, _, typ, body) -> (name, typ, body)) funs
164 (fun (var, _, _, _) cic ->
166 Cic.LetIn (Cic.Name var, Cic.CoFix (!counter, funs), cic))
168 List.fold_right (build_term inductiveFuns) inductiveFuns cic_body
169 | CicAst.Ident (name, subst) ->
170 (* TODO hanlde explicit substitutions *)
172 let index = find_in_environment name context in
174 CicTextualParser2.fail loc
175 "Explicit substitutions not allowed here";
178 let cic = resolve env (Id name) () in
181 List.map (fun uri -> UriManager.name_of_uri uri, uri) uris
186 List.assoc s ids_to_uris, aux loc context term
187 with Not_found -> raise DisambiguateChoices.Invalid_choice))
191 | Cic.Const (uri, []) ->
193 match CicEnvironment.get_obj uri with
194 | Cic.Constant (_, _, _, uris) -> uris
197 Cic.Const (uri, mk_subst uris)
198 | Cic.Var (uri, []) ->
200 match CicEnvironment.get_obj uri with
201 | Cic.Variable (_, _, _, uris) -> uris
204 Cic.Var (uri, mk_subst uris)
205 | Cic.MutInd (uri, i, []) ->
207 match CicEnvironment.get_obj uri with
208 | Cic.InductiveDefinition (_, uris, _) -> uris
211 Cic.MutInd (uri, i, mk_subst uris)
212 | Cic.MutConstruct (uri, i, j, []) ->
214 match CicEnvironment.get_obj uri with
215 | Cic.InductiveDefinition (_, uris, _) -> uris
218 Cic.MutConstruct (uri, i, j, mk_subst uris)
219 | Cic.Meta _ | Cic.Implicit _ as t ->
221 prerr_endline (sprintf
222 "Warning: %s must be instantiated with _[%s] but we do not enforce it"
226 (fun (s, term) -> s ^ " := " ^ CicAstPp.pp_term term)
231 raise DisambiguateChoices.Invalid_choice))
232 | CicAst.Implicit -> Cic.Implicit None
233 | CicAst.Num (num, i) -> resolve env (Num i) ~num ()
234 | CicAst.Meta (index, subst) ->
237 (function None -> None | Some term -> Some (aux loc context term))
240 Cic.Meta (index, cic_subst)
241 | CicAst.Sort `Prop -> Cic.Sort Cic.Prop
242 | CicAst.Sort `Set -> Cic.Sort Cic.Set
243 | CicAst.Sort `Type -> Cic.Sort Cic.Type
244 | CicAst.Sort `CProp -> Cic.Sort Cic.CProp
245 | CicAst.Symbol (symbol, instance) ->
246 resolve env (Symbol (symbol, instance)) ()
247 and aux_option loc context = function
248 | None -> Cic.Implicit (Some `Type)
249 | Some term -> aux loc context term
252 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
253 | term -> aux (-1, -1) context term
255 let domain_of_term ~context ast =
256 (* "aux" keeps domain in reverse order and doesn't care about duplicates.
257 * Domain item more in deep in the list will be processed first.
259 let rec aux loc context = function
260 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
261 | CicAst.AttributedTerm (_, term) -> aux loc context term
262 | CicAst.Appl terms ->
263 List.fold_left (fun dom term -> aux loc context term @ dom) [] terms
264 | CicAst.Binder (_, (var, typ), body) ->
265 let type_dom = aux_option loc context typ in
266 let body_dom = aux loc (var :: context) body in
268 | CicAst.Case (term, indty_ident, outtype, branches) ->
269 let term_dom = aux loc context term in
270 let outtype_dom = aux_option loc context outtype in
271 let do_branch ((head, args), term) =
272 let (term_context, args_domain) =
274 (fun (cont, dom) (name, typ) ->
278 | Some typ -> aux loc cont typ @ dom)))
281 args_domain @ aux loc term_context term
284 List.fold_left (fun dom branch -> do_branch branch @ dom) [] branches
286 branches_dom @ outtype_dom @ term_dom @ [ Id indty_ident ]
287 | CicAst.LetIn ((var, typ), body, where) ->
288 let body_dom = aux loc context body in
289 let type_dom = aux_option loc context typ in
290 let where_dom = aux loc (var :: context) where in
291 where_dom @ type_dom @ body_dom
292 | CicAst.LetRec (kind, defs, where) ->
294 List.fold_left (fun acc ((var, typ), _, _) -> var :: acc)
297 let where_dom = aux loc context' where in
300 (fun dom ((_, typ), body, _) ->
301 aux loc context' body @ aux_option loc context typ)
305 | CicAst.Ident (name, subst) ->
306 (* TODO hanlde explicit substitutions *)
308 let index = find_in_environment name context in
310 CicTextualParser2.fail loc
311 "Explicit substitutions not allowed here";
315 (fun dom (_, term) ->
316 let dom' = aux loc context term in
319 | CicAst.Implicit -> []
320 | CicAst.Num (num, i) -> [ Num i ]
321 | CicAst.Meta (index, local_context) ->
322 List.fold_left (fun dom term -> aux_option loc context term @ dom) []
324 | CicAst.Sort _ -> []
325 | CicAst.Symbol (symbol, instance) -> [ Symbol (symbol, instance) ]
327 and aux_option loc context = function
329 | Some t -> aux loc context t
332 (* e.g. [5;1;1;1;2;3;4;1;2] -> [2;1;4;3;5] *)
334 let module SortedItem =
336 type t = DisambiguateTypes.domain_item
337 let compare = Pervasives.compare
340 let module Set = Set.Make (SortedItem) in
342 let rev_l = List.rev l in
343 let (_, uniq_rev_l) =
345 (fun (members, rev_l) elt ->
346 if Set.mem elt members then
349 Set.add elt members, elt :: rev_l)
350 (Set.empty, []) rev_l
357 | CicAst.AttributedTerm (`Loc loc, term) -> aux loc context term
358 | term -> aux (-1, -1) context term)
362 let domain_diff dom1 dom2 =
363 (* let domain_diff = Domain.diff *)
365 List.fold_left (fun pred elt -> (fun elt' -> elt' = elt || pred elt'))
366 (fun _ -> false) dom2
368 List.filter (fun elt -> not (is_in_dom2 elt)) dom1
370 module Make (C: Callbacks) =
372 let choices_of_id mqi_handle id =
373 let query = MQueryGenerator.locate id in
374 let result = MQueryInterpreter.execute mqi_handle query in
378 MQueryMisc.wrong_xpointer_format_from_wrong_xpointer_format' uri
380 HelmLogger.log (`Msg (`T "Locate query:"));
381 MQueryUtil.text_of_query
382 (fun s -> HelmLogger.log ~append_NL:false (`Msg (`T s)))
384 HelmLogger.log (`Msg (`T "Result:"));
385 MQueryUtil.text_of_result
386 (fun s -> HelmLogger.log (`Msg (`T s))) "" result;
390 [UriManager.string_of_uri (C.input_or_locate_uri
391 ~title:("URI matching \"" ^ id ^ "\" unknown."))]
394 C.interactive_user_uri_choice ~selection_mode:`MULTIPLE
395 ~ok:"Try selected." ~enable_button_for_non_vars:true
396 ~title:"Ambiguous input." ~id
397 ~msg: ("Ambiguous input \"" ^ id ^
398 "\". Please, choose one or more interpretations:")
406 HelmLibraryObjects.term_of_uri (UriManager.uri_of_string uri)
407 with _ -> assert false
412 let disambiguate_term mqi_handle context metasenv term ~aliases:current_env
414 debug_print "NEW DISAMBIGUATE INPUT";
415 let disambiguate_context = (* cic context -> disambiguate context *)
417 (function None -> Cic.Anonymous | Some (name, _) -> name)
420 let term_dom = domain_of_term ~context:disambiguate_context term in
421 debug_print (sprintf "DISAMBIGUATION DOMAIN: %s"
422 (string_of_domain term_dom));
424 Environment.fold (fun item _ dom -> item :: dom) current_env []
426 let todo_dom = domain_diff term_dom current_dom in
427 (* (2) lookup function for any item (Id/Symbol/Num) *)
429 let id_choices = Hashtbl.create 1023 in
435 Hashtbl.find id_choices id
437 let choices = choices_of_id mqi_handle id in
438 Hashtbl.add id_choices id choices;
440 | Symbol (symb, _) -> DisambiguateChoices.lookup_symbol_choices symb
441 | Num instance -> DisambiguateChoices.lookup_num_choices ()
443 if choices = [] then raise (No_choices item);
446 (* (3) test an interpretation filling with meta uninterpreted identifiers
448 let test_env current_env todo_dom =
455 | Id _ | Num _ -> (fun _ _ _ -> Cic.Implicit (Some `Closed))
456 | Symbol _ -> (fun _ _ _ -> Cic.Implicit None))) env)
461 interpretate ~context:disambiguate_context ~env:filled_env term
463 refine metasenv context cic_term
465 | Try_again -> Uncertain
466 | DisambiguateChoices.Invalid_choice -> Ko
468 (* (4) build all possible interpretations *)
469 let rec aux current_env todo_dom =
472 (match test_env current_env [] with
473 | Ok (term, metasenv) -> [ current_env, term, metasenv ]
474 | Ko | Uncertain -> [])
475 | item :: remaining_dom ->
476 debug_print (sprintf "CHOOSED ITEM: %s"
477 (string_of_domain_item item));
478 let choices = lookup_choices item in
479 let rec filter = function
481 | codomain_item :: tl ->
482 debug_print (sprintf "%s CHOSEN" (fst codomain_item)) ;
484 Environment.add item codomain_item current_env
486 (match test_env new_env remaining_dom with
487 | Ok (term, metasenv) ->
488 (match remaining_dom with
489 | [] -> [ new_env, term, metasenv ]
490 | _ -> aux new_env remaining_dom) @ filter tl
492 (match remaining_dom with
494 | _ -> aux new_env remaining_dom) @ filter tl
499 let (choosed_env, choosed_term, choosed_metasenv) =
500 match aux current_env todo_dom with
501 | [] -> raise NoWellTypedInterpretation
503 debug_print "UNA SOLA SCELTA";
506 debug_print (sprintf "PIU' SCELTE (%d)" (List.length l));
513 fst (Environment.find domain_item env)
515 (descr_of_domain_item domain_item, description))
519 let choosed = C.interactive_interpretation_choice choices in
522 (choosed_env, choosed_metasenv, choosed_term)