1 (* Copyright (C) 2004-2005, 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 module Ast = CicNotationPt
31 module Env = CicNotationEnv
34 let debug_print s = if debug then prerr_endline (Lazy.force s) else ()
37 type pretty_printer_id = pattern_id
39 let resolve_binder = function
40 | `Lambda -> "\\lambda"
42 | `Forall -> "\\forall"
43 | `Exists -> "\\exists"
45 let add_level_info prec t = Ast.AttributedTerm (`Level prec, t)
47 let rec top_pos t = add_level_info ~-1 t
49 let rec remove_level_info =
51 | Ast.AttributedTerm (`Level _, t) -> remove_level_info t
52 | Ast.AttributedTerm (a, t) -> Ast.AttributedTerm (a, remove_level_info t)
55 let add_xml_attrs attrs t =
56 if attrs = [] then t else Ast.AttributedTerm (`XmlAttrs attrs, t)
58 let add_keyword_attrs =
59 add_xml_attrs (RenderingAttrs.keyword_attributes `MathML)
61 let box kind spacing indent content =
62 Ast.Layout (Ast.Box ((kind, spacing, indent), content))
66 let hvbox = box Ast.HV
67 let hovbox = box Ast.HOV
68 let break = Ast.Layout Ast.Break
69 let space = Ast.Literal (`Symbol " ")
70 let builtin_symbol s = Ast.Literal (`Symbol s)
71 let keyword k = add_keyword_attrs (Ast.Literal (`Keyword k))
74 add_xml_attrs (RenderingAttrs.number_attributes `MathML)
75 (Ast.Literal (`Number s))
78 add_xml_attrs (RenderingAttrs.ident_attributes `MathML) (Ast.Ident (i, None))
80 let ident_w_href href i =
84 let href = UriManager.string_of_uri href in
85 add_xml_attrs [Some "xlink", "href", href] (ident i)
88 add_xml_attrs (RenderingAttrs.builtin_symbol_attributes `MathML)
91 let string_of_sort_kind = function
96 | `NType s -> "Type[" ^ s ^ "]"
100 ~sep:[space] (List.map (fun x -> [f x]) l)
107 let rec aux_args level =
111 [ Ast.AttributedTerm (`Level level,k last) ]
113 (Ast.AttributedTerm (`Level level, k hd)) :: aux_args 71 tl
115 add_level_info Ast.apply_prec
116 (hovbox true true (CicNotationUtil.dress break (aux_args 70 ts)))
117 | Ast.Binder (binder_kind, (id, ty), body) ->
118 add_level_info Ast.binder_prec
120 [ binder_symbol (resolve_binder binder_kind);
121 k id; builtin_symbol ":"; aux_ty ty; break;
122 builtin_symbol "."; k body ])
123 | Ast.Case (what, indty_opt, outty_opt, patterns) ->
128 [ space; keyword "return"; space; break; remove_level_info (k outty)]
133 | Some (indty, href) -> [ space; keyword "in"; space; break; ident_w_href href indty ]
138 hvbox false true [keyword "match"; space; break; top_pos (k what)];
140 hvbox false true indty_box;
142 hvbox false true outty_box
150 let mk_case_pattern =
152 Ast.Pattern (head, href, vars) ->
153 hvbox true true (ident_w_href href head ::
154 List.flatten (List.map (fun x -> [break;x]) (map_space aux_var vars)))
155 | Ast.Wildcard -> builtin_symbol "_"
162 mk_case_pattern lhs; break; builtin_symbol "\\Rightarrow";
163 break; top_pos (k rhs) ]))
167 let rec aux_patterns = function
173 last; builtin_symbol "]" ] ]
175 [ break; hbox false false [ builtin_symbol "|"; hd ] ]
180 [ hbox false false [ builtin_symbol "["; builtin_symbol "]" ] ]
183 builtin_symbol "["; one; builtin_symbol "]" ] ]
185 hbox false false [ builtin_symbol "["; hd ]
188 add_level_info Ast.simple_prec
190 hvbox false false ([match_box]); break;
191 hbox false false [ hvbox false false patterns'' ] ])
192 | Ast.Cast (bo, ty) ->
193 add_level_info Ast.simple_prec
195 builtin_symbol "("; top_pos (k bo); break; builtin_symbol ":";
196 top_pos (k ty); builtin_symbol ")"])
197 | Ast.LetIn (var, s, t) ->
198 add_level_info Ast.let_in_prec
201 keyword "let"; space;
204 builtin_symbol "\\def"; break; top_pos (k s) ];
205 break; space; keyword "in"; space ];
208 | Ast.LetRec (rec_kind, funs, where) ->
210 match rec_kind with `Inductive -> "rec" | `CoInductive -> "corec"
212 let mk_fun (args, (name,ty), body, rec_param) =
213 List.flatten (List.map (fun x -> [aux_var x; space]) args),
214 k name, HExtlib.map_option k ty, k body, fst (List.nth args rec_param)
216 let mk_funs = List.map mk_fun in
217 let fst_fun, tl_funs =
218 match mk_funs funs with hd :: tl -> hd, tl | [] -> assert false
221 let (params, name, ty, body, rec_param) = fst_fun in
230 [keyword "on" ; space ; rec_param ;space ] @
231 (match ty with None -> [] | Some ty -> [builtin_symbol ":"; ty]) @
232 [ builtin_symbol "\\def";
238 (fun (params, name, ty, body, rec_param) ->
244 [space; keyword "on" ; space; rec_param ;space ] @
247 | Some ty -> [builtin_symbol ":"; ty]) @
248 [ builtin_symbol "\\def"; break; body ])])
251 add_level_info Ast.let_in_prec
253 (fst_row :: List.flatten tl_rows
254 @ [ break; keyword "in"; break; k where ])))
255 | Ast.Implicit -> builtin_symbol "?"
257 let local_context l =
258 List.map (function None -> None | Some t -> Some (k t)) l
260 Ast.Meta(n, local_context l)
261 | Ast.Sort sort -> aux_sort sort
264 | Ast.Ident (_, None) | Ast.Ident (_, Some [])
265 | Ast.Uri (_, None) | Ast.Uri (_, Some [])
267 | Ast.UserInput as leaf -> leaf
268 | t -> CicNotationUtil.visit_ast ~special_k k t
269 and aux_sort sort_kind =
270 add_xml_attrs (RenderingAttrs.keyword_attributes `MathML)
271 (Ast.Ident (string_of_sort_kind sort_kind, None))
272 and aux_ty = function
273 | None -> builtin_symbol "?"
275 and aux_var = function
278 builtin_symbol "("; name; builtin_symbol ":"; break; k ty;
281 and special_k = function
282 | Ast.AttributedTerm (attrs, t) -> Ast.AttributedTerm (attrs, k t)
284 prerr_endline ("unexpected special: " ^ CicNotationPp.pp_term t);
289 (* persistent state *)
291 let initial_level1_patterns21 () = Hashtbl.create 211
292 let level1_patterns21 = ref (initial_level1_patterns21 ())
293 let compiled21 = ref None
294 let pattern21_matrix = ref []
295 let counter = ref ~-1
300 stack := (!counter,!level1_patterns21,!compiled21,!pattern21_matrix)::!stack;
302 level1_patterns21 := initial_level1_patterns21 ();
304 pattern21_matrix := []
310 | (ocounter,olevel1_patterns21,ocompiled21,opatterns21_matrix)::old ->
313 level1_patterns21 := olevel1_patterns21;
314 compiled21 := ocompiled21;
315 pattern21_matrix := opatterns21_matrix
318 let get_compiled21 () =
319 match !compiled21 with
320 | None -> assert false
321 | Some f -> Lazy.force f
323 let set_compiled21 f = compiled21 := Some f
326 List.fold_right (fun idref t -> Ast.AttributedTerm (`IdRef idref, t))
328 let instantiate21 idrefs env l1 =
329 let rec subst_singleton pos env =
331 Ast.AttributedTerm (attr, t) ->
332 Ast.AttributedTerm (attr, subst_singleton pos env t)
333 | t -> CicNotationUtil.group (subst pos env t)
334 and subst pos env = function
335 | Ast.AttributedTerm (attr, t) ->
336 (* prerr_endline ("loosing attribute " ^ CicNotationPp.pp_attribute attr); *)
338 | Ast.Variable var ->
339 let name, expected_ty = CicNotationEnv.declaration_of_var var in
344 prerr_endline ("name " ^ name ^ " not found in environment");
347 assert (CicNotationEnv.well_typed ty value); (* INVARIANT *)
348 (* following assertion should be a conditional that makes this
349 * instantiation fail *)
350 if not (CicNotationEnv.well_typed expected_ty value) then
352 prerr_endline ("The variable " ^ name ^ " is used with the wrong type in the notation declaration");
355 let value = CicNotationEnv.term_of_value value in
357 match expected_ty with
358 | Env.TermType l -> Ast.AttributedTerm (`Level l,value)
362 | Ast.Magic m -> subst_magic pos env m
363 | Ast.Literal l as t ->
364 let t = add_idrefs idrefs t in
366 | `Keyword k -> [ add_keyword_attrs t ]
368 | Ast.Layout l -> [ Ast.Layout (subst_layout pos env l) ]
369 | t -> [ CicNotationUtil.visit_ast (subst_singleton pos env) t ]
370 and subst_magic pos env = function
371 | Ast.List0 (p, sep_opt)
372 | Ast.List1 (p, sep_opt) ->
373 let rec_decls = CicNotationEnv.declarations_of_term p in
375 List.map (fun (n, _) -> CicNotationEnv.lookup_list env n) rec_decls
377 let values = CicNotationUtil.ncombine rec_values in
381 | Some l -> [ Ast.Literal l; break; space ]
383 let rec instantiate_list acc = function
386 let env = CicNotationEnv.combine rec_decls value_set in
387 instantiate_list (CicNotationUtil.group (subst pos env p) :: acc)
390 let env = CicNotationEnv.combine rec_decls value_set in
391 let terms = subst pos env p in
392 instantiate_list (CicNotationUtil.group (terms @ sep) :: acc) tl
394 if values = [] then []
395 else [hovbox false false (instantiate_list [] values)]
397 let opt_decls = CicNotationEnv.declarations_of_term p in
399 let rec build_env = function
401 | (name, ty) :: tl ->
402 (* assumption: if one of the value is None then all are *)
403 (match CicNotationEnv.lookup_opt env name with
405 | Some v -> (name, (ty, v)) :: build_env tl)
407 try build_env opt_decls with Exit -> []
412 | _ -> subst pos env p
414 | _ -> assert false (* impossible *)
415 and subst_layout pos env = function
416 | Ast.Box (kind, tl) ->
417 let tl' = subst_children pos env tl in
418 Ast.Box (kind, List.concat tl')
419 | l -> CicNotationUtil.visit_layout (subst_singleton pos env) l
420 and subst_children pos env =
428 (* | `None -> assert false *)
431 [ subst pos' env child ]
437 (* | `None -> assert false *)
440 (subst pos env hd) :: subst_children pos' env tl
442 subst_singleton `Left env l1
444 let rec pp_ast1 term =
445 let rec pp_value = function
446 | CicNotationEnv.NumValue _ as v -> v
447 | CicNotationEnv.StringValue _ as v -> v
448 (* | CicNotationEnv.TermValue t when t == term -> CicNotationEnv.TermValue (pp_ast0 t pp_ast1) *)
449 | CicNotationEnv.TermValue t -> CicNotationEnv.TermValue (pp_ast1 t)
450 | CicNotationEnv.OptValue None as v -> v
451 | CicNotationEnv.OptValue (Some v) ->
452 CicNotationEnv.OptValue (Some (pp_value v))
453 | CicNotationEnv.ListValue vl ->
454 CicNotationEnv.ListValue (List.map pp_value vl)
456 let ast_env_of_env env =
457 List.map (fun (var, (ty, value)) -> (var, (ty, pp_value value))) env
459 (* prerr_endline ("pattern matching from 2 to 1 on term " ^ CicNotationPp.pp_term term); *)
461 | Ast.AttributedTerm (attrs, term') ->
462 Ast.AttributedTerm (attrs, pp_ast1 term')
464 (match (get_compiled21 ()) term with
465 | None -> pp_ast0 term pp_ast1
466 | Some (env, ctors, pid) ->
468 List.flatten (List.map CicNotationUtil.get_idrefs ctors)
472 Hashtbl.find !level1_patterns21 pid
473 with Not_found -> assert false
475 instantiate21 idrefs (ast_env_of_env env) l1)
477 let load_patterns21 t =
478 set_compiled21 (lazy (Content2presMatcher.Matcher21.compiler t))
481 debug_print (lazy "pp_ast <-");
482 let ast' = pp_ast1 ast in
483 debug_print (lazy ("pp_ast -> " ^ CicNotationPp.pp_term ast'));
486 exception Pretty_printer_not_found
488 let fill_pos_info l1_pattern = l1_pattern
489 (* let rec aux toplevel pos =
496 | Ast.Variable _ as t -> add_pos_info pos t
499 aux true l1_pattern *)
506 let add_pretty_printer l2 (CicNotationParser.CL1P (l1,precedence)) =
507 let id = fresh_id () in
508 let l1' = add_level_info precedence (fill_pos_info l1) in
509 let l2' = CicNotationUtil.strip_attributes l2 in
510 Hashtbl.add !level1_patterns21 id l1';
511 pattern21_matrix := (l2', id) :: !pattern21_matrix;
512 load_patterns21 !pattern21_matrix;
515 let remove_pretty_printer id =
517 Hashtbl.remove !level1_patterns21 id;
518 with Not_found -> raise Pretty_printer_not_found);
519 pattern21_matrix := List.filter (fun (_, id') -> id <> id') !pattern21_matrix;
520 load_patterns21 !pattern21_matrix
522 (* presentation -> content *)
524 let unopt_names names env =
525 let rec aux acc = function
526 | (name, (ty, v)) :: tl when List.mem name names ->
528 | Env.OptType ty, Env.OptValue (Some v) ->
529 aux ((name, (ty, v)) :: acc) tl
531 | hd :: tl -> aux (hd :: acc) tl
536 let head_names names env =
537 let rec aux acc = function
538 | (name, (ty, v)) :: tl when List.mem name names ->
540 | Env.ListType ty, Env.ListValue (v :: _) ->
541 aux ((name, (ty, v)) :: acc) tl
542 | Env.TermType _, Env.TermValue _ ->
543 aux ((name, (ty, v)) :: acc) tl
545 | _ :: tl -> aux acc tl
546 (* base pattern may contain only meta names, thus we trash all others *)
551 let tail_names names env =
552 let rec aux acc = function
553 | (name, (ty, v)) :: tl when List.mem name names ->
555 | Env.ListType ty, Env.ListValue (_ :: vtl) ->
556 aux ((name, (Env.ListType ty, Env.ListValue vtl)) :: acc) tl
557 | Env.TermType _, Env.TermValue _ ->
558 aux ((name, (ty, v)) :: acc) tl
560 | binding :: tl -> aux (binding :: acc) tl
565 let instantiate_level2 env term =
566 (* prerr_endline ("istanzio: " ^ CicNotationPp.pp_term term); *)
567 let fresh_env = ref [] in
568 let lookup_fresh_name n =
570 List.assoc n !fresh_env
572 let new_name = CicNotationUtil.fresh_name () in
573 fresh_env := (n, new_name) :: !fresh_env;
576 let rec aux env term =
577 (* prerr_endline ("ENV " ^ CicNotationPp.pp_env env); *)
579 | Ast.AttributedTerm (a, term) -> (*Ast.AttributedTerm (a, *)aux env term
580 | Ast.Appl terms -> Ast.Appl (List.map (aux env) terms)
581 | Ast.Binder (binder, var, body) ->
582 Ast.Binder (binder, aux_capture_var env var, aux env body)
583 | Ast.Case (term, indty, outty_opt, patterns) ->
584 Ast.Case (aux env term, indty, aux_opt env outty_opt,
585 List.map (aux_branch env) patterns)
586 | Ast.LetIn (var, t1, t3) ->
587 Ast.LetIn (aux_capture_var env var, aux env t1, aux env t3)
588 | Ast.LetRec (kind, definitions, body) ->
589 Ast.LetRec (kind, List.map (aux_definition env) definitions,
591 | Ast.Uri (name, None) -> Ast.Uri (name, None)
592 | Ast.Uri (name, Some substs) ->
593 Ast.Uri (name, Some (aux_substs env substs))
594 | Ast.Ident (name, Some substs) ->
595 Ast.Ident (name, Some (aux_substs env substs))
596 | Ast.Meta (index, substs) -> Ast.Meta (index, aux_meta_substs env substs)
603 | Ast.UserInput -> term
605 | Ast.Magic magic -> aux_magic env magic
606 | Ast.Variable var -> aux_variable env var
608 | Ast.Cast (t, ty) -> Ast.Cast (aux env t, aux env ty)
611 and aux_opt env = function
612 | Some term -> Some (aux env term)
614 and aux_capture_var env (name, ty_opt) = (aux env name, aux_opt env ty_opt)
615 and aux_branch env (pattern, term) =
616 (aux_pattern env pattern, aux env term)
617 and aux_pattern env =
619 Ast.Pattern (head, hrefs, vars) ->
620 Ast.Pattern (head, hrefs, List.map (aux_capture_var env) vars)
621 | Ast.Wildcard -> Ast.Wildcard
622 and aux_definition env (params, var, term, i) =
623 (List.map (aux_capture_var env) params, aux_capture_var env var, aux env term, i)
624 and aux_substs env substs =
625 List.map (fun (name, term) -> (name, aux env term)) substs
626 and aux_meta_substs env meta_substs = List.map (aux_opt env) meta_substs
627 and aux_variable env = function
628 | Ast.NumVar name -> Ast.Num (Env.lookup_num env name, 0)
629 | Ast.IdentVar name -> Ast.Ident (Env.lookup_string env name, None)
630 | Ast.TermVar (name,(Ast.Level l|Ast.Self l)) ->
631 Ast.AttributedTerm (`Level l,Env.lookup_term env name)
632 | Ast.FreshVar name -> Ast.Ident (lookup_fresh_name name, None)
633 | Ast.Ascription (term, name) -> assert false
634 and aux_magic env = function
635 | Ast.Default (some_pattern, none_pattern) ->
636 let some_pattern_names = CicNotationUtil.names_of_term some_pattern in
637 let none_pattern_names = CicNotationUtil.names_of_term none_pattern in
640 (fun name -> not (List.mem name none_pattern_names))
643 (match opt_names with
644 | [] -> assert false (* some pattern must contain at least 1 name *)
645 | (name :: _) as names ->
646 (match Env.lookup_value env name with
647 | Env.OptValue (Some _) ->
648 (* assumption: if "name" above is bound to Some _, then all
649 * names returned by "meta_names_of" are bound to Some _ as well
651 aux (unopt_names names env) some_pattern
652 | Env.OptValue None -> aux env none_pattern
654 prerr_endline (sprintf
655 "lookup of %s in env %s did not return an optional value"
656 name (CicNotationPp.pp_env env));
658 | Ast.Fold (`Left, base_pattern, names, rec_pattern) ->
659 let acc_name = List.hd names in (* names can't be empty, cfr. parser *)
661 List.filter ((<>) acc_name)
662 (CicNotationUtil.names_of_term rec_pattern)
664 (match meta_names with
665 | [] -> assert false (* as above *)
666 | (name :: _) as names ->
667 let rec instantiate_fold_left acc env' =
668 match Env.lookup_value env' name with
669 | Env.ListValue (_ :: _) ->
670 instantiate_fold_left
672 acc_name, (Env.TermType 0, Env.TermValue acc)
674 aux (acc_binding :: head_names names env') rec_pattern)
675 (tail_names names env')
676 | Env.ListValue [] -> acc
679 instantiate_fold_left (aux env base_pattern) env)
680 | Ast.Fold (`Right, base_pattern, names, rec_pattern) ->
681 let acc_name = List.hd names in (* names can't be empty, cfr. parser *)
683 List.filter ((<>) acc_name)
684 (CicNotationUtil.names_of_term rec_pattern)
686 (match meta_names with
687 | [] -> assert false (* as above *)
688 | (name :: _) as names ->
689 let rec instantiate_fold_right env' =
690 match Env.lookup_value env' name with
691 | Env.ListValue (_ :: _) ->
692 let acc = instantiate_fold_right (tail_names names env') in
694 acc_name, (Env.TermType 0, Env.TermValue acc)
696 aux (acc_binding :: head_names names env') rec_pattern
697 | Env.ListValue [] -> aux env base_pattern
700 instantiate_fold_right env)
701 | Ast.If (_, p_true, p_false) as t ->
702 aux env (CicNotationUtil.find_branch (Ast.Magic t))
703 | Ast.Fail -> assert false
710 let _ = load_patterns21 []