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/
29 type interpretation_id = pattern_id
30 type pretty_printer_id = pattern_id
32 module Ast = CicNotationPt
35 { sort: (Cic.id, Ast.sort_kind) Hashtbl.t;
36 uri: (Cic.id, string) Hashtbl.t;
40 let o,_ = CicEnvironment.get_obj CicUniv.empty_ugraph uri in
42 | Cic.InductiveDefinition (l,_,_,_) -> l
45 let name_of_inductive_type uri i =
46 let types = get_types uri in
47 let (name, _, _, _) = try List.nth types i with Not_found -> assert false in
50 (* returns <name, type> pairs *)
51 let constructors_of_inductive_type uri i =
52 let types = get_types uri in
53 let (_, _, _, constructors) =
54 try List.nth types i with Not_found -> assert false
58 (* returns name only *)
59 let constructor_of_inductive_type uri i j =
61 fst (List.nth (constructors_of_inductive_type uri i) (j-1))
62 with Not_found -> assert false)
64 let idref id t = Ast.AttributedTerm (`IdRef id, t)
66 let resolve_binder = function
67 | `Lambda -> "\\lambda"
69 | `Forall -> "\\forall"
70 | `Exists -> "\\exists"
72 let binder_attributes = [None, "mathcolor", "blue"]
73 let atop_attributes = [None, "linethickness", "0pt"]
74 let indent_attributes = [None, "indent", "1em"]
75 let keyword_attributes = [None, "mathcolor", "blue"]
78 let reset_href t = Ast.AttributedTerm (`Href [], t) in
79 let builtin_symbol s = reset_href (Ast.Literal (`Symbol s)) in
81 Ast.AttributedTerm (`XmlAttrs binder_attributes, builtin_symbol s)
83 let rec aux = function
85 Ast.AttributedTerm (`Level (Ast.apply_prec, Ast.apply_assoc),
87 (Ast.Box ((Ast.HOV, true, true),
88 (CicNotationUtil.dress
89 (Ast.Layout Ast.Break)
91 | Ast.Binder (`Forall, (Ast.Ident ("_", _), ty), body)
92 | Ast.Binder (`Pi, (Ast.Ident ("_", _), ty), body) ->
93 Ast.AttributedTerm (`Level (Ast.binder_prec, Ast.binder_assoc),
94 Ast.Layout (Ast.Box ((Ast.HV, false, true), [
99 | Ast.Binder (binder_kind, (id, ty), body) ->
100 Ast.AttributedTerm (`Level (Ast.binder_prec, Ast.binder_assoc),
101 Ast.Layout (Ast.Box ((Ast.HV, false, true), [
102 binder_symbol (resolve_binder binder_kind);
106 Ast.Layout Ast.Break;
109 | t -> CicNotationUtil.visit_ast ~special_k k t
110 and aux_ty = function
111 | None -> builtin_symbol "?"
113 and special_k = function
114 | Ast.AttributedTerm (attrs, t) -> Ast.AttributedTerm (attrs, k t)
119 let ast_of_acic0 term_info acic k =
120 let k = k term_info in
121 let register_uri id uri = Hashtbl.add term_info.uri id uri in
124 Hashtbl.find term_info.sort id
125 with Not_found -> assert false
127 let aux_substs substs =
130 (fun (uri, annterm) -> (UriManager.name_of_uri uri, k annterm))
133 let aux_context context =
137 | Some annterm -> Some (k annterm))
141 | Cic.ARel (id,_,_,b) -> idref id (Ast.Ident (b, None))
142 | Cic.AVar (id,uri,substs) ->
143 register_uri id (UriManager.string_of_uri uri);
144 idref id (Ast.Ident (UriManager.name_of_uri uri, aux_substs substs))
145 | Cic.AMeta (id,n,l) -> idref id (Ast.Meta (n, aux_context l))
146 | Cic.ASort (id,Cic.Prop) -> idref id (Ast.Sort `Prop)
147 | Cic.ASort (id,Cic.Set) -> idref id (Ast.Sort `Set)
148 | Cic.ASort (id,Cic.Type _) -> idref id (Ast.Sort `Type)
149 | Cic.ASort (id,Cic.CProp) -> idref id (Ast.Sort `CProp)
150 | Cic.AImplicit _ -> assert false
151 | Cic.AProd (id,n,s,t) ->
153 match sort_of_id id with
154 | `Set | `Type -> `Pi
155 | `Prop | `CProp -> `Forall
157 idref id (Ast.Binder (binder_kind,
158 (CicNotationUtil.name_of_cic_name n, Some (k s)), k t))
159 | Cic.ACast (id,v,t) -> idref id (Ast.Cast (k v, k t))
160 | Cic.ALambda (id,n,s,t) ->
161 idref id (Ast.Binder (`Lambda,
162 (CicNotationUtil.name_of_cic_name n, Some (k s)), k t))
163 | Cic.ALetIn (id,n,s,t) ->
164 idref id (Ast.LetIn ((CicNotationUtil.name_of_cic_name n, None),
166 | Cic.AAppl (aid,args) -> idref aid (Ast.Appl (List.map k args))
167 | Cic.AConst (id,uri,substs) ->
168 register_uri id (UriManager.string_of_uri uri);
169 idref id (Ast.Ident (UriManager.name_of_uri uri, aux_substs substs))
170 | Cic.AMutInd (id,uri,i,substs) as t ->
171 let name = name_of_inductive_type uri i in
172 let uri_str = UriManager.string_of_uri uri in
174 uri_str ^ "#xpointer(1/" ^ (string_of_int (i + 1)) ^ ")"
176 register_uri id puri_str;
177 idref id (Ast.Ident (name, aux_substs substs))
178 | Cic.AMutConstruct (id,uri,i,j,substs) ->
179 let name = constructor_of_inductive_type uri i j in
180 let uri_str = UriManager.string_of_uri uri in
181 let puri_str = sprintf "%s#xpointer(1/%d/%d)" uri_str (i + 1) j in
182 register_uri id puri_str;
183 idref id (Ast.Ident (name, aux_substs substs))
184 | Cic.AMutCase (id,uri,typeno,ty,te,patterns) ->
185 let name = name_of_inductive_type uri typeno in
186 let constructors = constructors_of_inductive_type uri typeno in
187 let rec eat_branch ty pat =
189 | Cic.Prod (_, _, t), Cic.ALambda (_, name, s, t') ->
190 let (cv, rhs) = eat_branch t t' in
191 (CicNotationUtil.name_of_cic_name name, Some (k s)) :: cv, rhs
196 (fun (name, ty) pat ->
197 let (capture_variables, rhs) = eat_branch ty pat in
198 ((name, capture_variables), rhs))
199 constructors patterns
201 idref id (Ast.Case (k te, Some name, Some (k ty), patterns))
202 | Cic.AFix (id, no, funs) ->
205 (fun (_, n, decr_idx, ty, bo) ->
206 ((Ast.Ident (n, None), Some (k ty)), k bo, decr_idx))
211 (match List.nth defs no with
212 | (Ast.Ident (n, _), _), _, _ when n <> "_" -> n
214 with Not_found -> assert false
216 idref id (Ast.LetRec (`Inductive, defs, Ast.Ident (name, None)))
217 | Cic.ACoFix (id, no, funs) ->
220 (fun (_, n, ty, bo) -> ((Ast.Ident (n, None), Some (k ty)), k bo, 0))
225 (match List.nth defs no with
226 | (Ast.Ident (n, _), _), _, _ when n <> "_" -> n
228 with Not_found -> assert false
230 idref id (Ast.LetRec (`CoInductive, defs, Ast.Ident (name, None)))
234 (* persistent state *)
236 let level1_patterns21 = Hashtbl.create 211
237 let level2_patterns32 = Hashtbl.create 211
238 let interpretations = Hashtbl.create 211 (* symb -> id list ref *)
240 let compiled21 = ref None
241 let compiled32 = ref None
243 let pattern21_matrix = ref []
244 let pattern32_matrix = ref []
246 let get_compiled21 () =
247 match !compiled21 with
248 | None -> assert false
249 | Some f -> Lazy.force f
250 let get_compiled32 () =
251 match !compiled32 with
252 | None -> assert false
253 | Some f -> Lazy.force f
255 let set_compiled21 f = compiled21 := Some f
256 let set_compiled32 f = compiled32 := Some f
258 let instantiate21 env (* precedence associativity *) l1 =
259 let rec subst_singleton env t =
260 CicNotationUtil.group (subst env t)
261 and subst env = function
262 | Ast.AttributedTerm (_, t) -> subst env t
263 | Ast.Variable var ->
264 let name, expected_ty = CicNotationEnv.declaration_of_var var in
268 with Not_found -> assert false
270 assert (CicNotationEnv.well_typed ty value); (* INVARIANT *)
271 (* following assertion should be a conditional that makes this
272 * instantiation fail *)
273 assert (CicNotationEnv.well_typed expected_ty value);
274 [ CicNotationEnv.term_of_value value ]
275 | Ast.Magic m -> subst_magic env m
276 | Ast.Literal (`Keyword k) as t ->
277 [ Ast.AttributedTerm (`XmlAttrs keyword_attributes, t) ]
278 | Ast.Literal _ as t -> [ t ]
279 | Ast.Layout l -> [ Ast.Layout (subst_layout env l) ]
280 | t -> [ CicNotationUtil.visit_ast (subst_singleton env) t ]
281 and subst_magic env = function
282 | Ast.List0 (p, sep_opt)
283 | Ast.List1 (p, sep_opt) ->
284 let rec_decls = CicNotationEnv.declarations_of_term p in
286 List.map (fun (n, _) -> CicNotationEnv.lookup_list env n) rec_decls
288 let values = CicNotationUtil.ncombine rec_values in
292 | Some l -> [ Ast.Literal l ]
294 let rec instantiate_list acc = function
297 let env = CicNotationEnv.combine rec_decls value_set in
298 instantiate_list (CicNotationUtil.group (subst env p) :: acc) []
300 let env = CicNotationEnv.combine rec_decls value_set in
301 instantiate_list (CicNotationUtil.group ((subst env p) @ sep) :: acc) tl
303 instantiate_list [] values
305 let opt_decls = CicNotationEnv.declarations_of_term p in
307 let rec build_env = function
309 | (name, ty) :: tl ->
310 (* assumption: if one of the value is None then all are *)
311 (match CicNotationEnv.lookup_opt env name with
313 | Some v -> (name, (ty, v)) :: build_env tl)
315 try build_env opt_decls with Exit -> []
322 | _ -> assert false (* impossible *)
323 and subst_layout env = function
324 | Ast.Box (kind, tl) ->
325 Ast.Box (kind, List.concat (List.map (subst env) tl))
326 | l -> CicNotationUtil.visit_layout (subst_singleton env) l
328 subst_singleton env l1
330 let rec pp_ast1 term =
331 let rec pp_value = function
332 | CicNotationEnv.NumValue _ as v -> v
333 | CicNotationEnv.StringValue _ as v -> v
334 (* | CicNotationEnv.TermValue t when t == term -> CicNotationEnv.TermValue (pp_ast0 t pp_ast1) *)
335 | CicNotationEnv.TermValue t -> CicNotationEnv.TermValue (pp_ast1 t)
336 | CicNotationEnv.OptValue None as v -> v
337 | CicNotationEnv.OptValue (Some v) ->
338 CicNotationEnv.OptValue (Some (pp_value v))
339 | CicNotationEnv.ListValue vl ->
340 CicNotationEnv.ListValue (List.map pp_value vl)
342 let ast_env_of_env env =
343 List.map (fun (var, (ty, value)) -> (var, (ty, pp_value value))) env
346 | Ast.AttributedTerm (attrs, t) -> Ast.AttributedTerm (attrs, pp_ast1 t)
349 match (get_compiled21 ()) term with
350 | None -> pp_ast0 term pp_ast1
352 let precedence, associativity, l1 =
354 Hashtbl.find level1_patterns21 pid
355 with Not_found -> assert false
357 Ast.AttributedTerm (`Level (precedence, associativity),
358 (instantiate21 (ast_env_of_env env) l1))
361 let instantiate32 term_info env symbol args =
362 let rec instantiate_arg = function
363 | Ast.IdentArg (n, name) ->
364 let t = (try List.assoc name env with Not_found -> assert false) in
365 let rec count_lambda = function
366 | Ast.Binder (`Lambda, _, body) -> 1 + count_lambda body
369 let rec add_lambda t n =
371 let name = CicNotationUtil.fresh_name () in
372 Ast.Binder (`Lambda, (Ast.Ident (name, None), None),
373 Ast.Appl [add_lambda t (n - 1); Ast.Ident (name, None)])
377 add_lambda t (n - count_lambda t)
379 let args' = List.map instantiate_arg args in
380 Ast.Appl (Ast.Symbol (symbol, 0) :: args')
382 let rec ast_of_acic1 term_info annterm =
383 match (get_compiled32 ()) annterm with
384 | None -> ast_of_acic0 term_info annterm ast_of_acic1
387 List.map (fun (name, term) -> (name, ast_of_acic1 term_info term)) env
389 let _, symbol, args, _, uris =
391 Hashtbl.find level2_patterns32 pid
392 with Not_found -> assert false
394 let ast = instantiate32 term_info env' symbol args in
397 | _ -> Ast.AttributedTerm (`Href uris, ast)
399 let load_patterns32 t =
400 set_compiled32 (lazy (CicNotationMatcher.Matcher32.compiler t))
402 let load_patterns21 t =
403 set_compiled21 (lazy (CicNotationMatcher.Matcher21.compiler t))
405 let ast_of_acic id_to_sort annterm =
406 let term_info = { sort = id_to_sort; uri = Hashtbl.create 211 } in
407 let ast = ast_of_acic1 term_info annterm in
410 let pp_ast term = pp_ast1 term
413 let counter = ref ~-1 in
418 let add_interpretation dsc (symbol, args) appl_pattern =
419 let id = fresh_id () in
420 let uris = CicNotationUtil.find_appl_pattern_uris appl_pattern in
421 Hashtbl.add level2_patterns32 id (dsc, symbol, args, appl_pattern, uris);
422 pattern32_matrix := (appl_pattern, id) :: !pattern32_matrix;
423 load_patterns32 !pattern32_matrix;
425 let ids = Hashtbl.find interpretations symbol in
427 with Not_found -> Hashtbl.add interpretations symbol (ref [id]));
430 exception Interpretation_not_found
431 exception Pretty_printer_not_found
433 let lookup_interpretations symbol =
437 let (dsc, _, args, appl_pattern, _) =
439 Hashtbl.find level2_patterns32 id
440 with Not_found -> assert false
442 dsc, args, appl_pattern)
443 !(Hashtbl.find interpretations symbol)
444 with Not_found -> raise Interpretation_not_found
446 let add_pretty_printer ~precedence ~associativity l2 l1 =
447 let id = fresh_id () in
448 let l2' = CicNotationUtil.strip_attributes l2 in
449 Hashtbl.add level1_patterns21 id (precedence, associativity, l1);
450 pattern21_matrix := (l2', id) :: !pattern21_matrix;
451 load_patterns21 !pattern21_matrix;
454 let remove_interpretation id =
456 let _, symbol, _, _, _ = Hashtbl.find level2_patterns32 id in
457 let ids = Hashtbl.find interpretations symbol in
458 ids := List.filter ((<>) id) !ids;
459 Hashtbl.remove level2_patterns32 id;
460 with Not_found -> raise Interpretation_not_found);
461 pattern32_matrix := List.filter (fun (_, id') -> id <> id') !pattern32_matrix;
462 load_patterns32 !pattern32_matrix
464 let remove_pretty_printer id =
466 Hashtbl.remove level1_patterns21 id;
467 with Not_found -> raise Pretty_printer_not_found);
468 pattern21_matrix := List.filter (fun (_, id') -> id <> id') !pattern21_matrix;
469 load_patterns21 !pattern21_matrix