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/
28 module Ast = NotationPt
30 let visit_ast ?(special_k = fun _ -> assert false)
31 ?(clear_interpretation= false)
32 ?(map_xref_option= fun x -> x) ?(map_case_indty= fun x -> x)
34 fun k x -> match x with None -> None | Some x -> Some (k x))
37 let rec aux = function
38 | Ast.Appl terms -> Ast.Appl (List.map k terms)
39 | Ast.Binder (kind, var, body) ->
40 Ast.Binder (kind, aux_capture_variable var, k body)
41 | Ast.Case (term, indtype, typ, patterns) ->
42 Ast.Case (k term, map_case_indty indtype, map_case_outtype k typ,
43 aux_patterns map_xref_option patterns)
44 | Ast.Cast (t1, t2) -> Ast.Cast (k t1, k t2)
45 | Ast.LetIn (var, t1, t3) ->
46 Ast.LetIn (aux_capture_variable var, k t1, k t3)
47 | Ast.LetRec (kind, definitions, term) ->
50 (fun (params, var, ty, decrno) ->
51 List.map aux_capture_variable params, aux_capture_variable var,
55 Ast.LetRec (kind, definitions, k term)
56 | Ast.Meta (index, substs) -> Ast.Meta (index, List.map aux_opt substs)
57 | (Ast.AttributedTerm _
61 | Ast.Variable _) as t -> special_k t
62 | Ast.Ident (id,_) when clear_interpretation -> Ast.Ident (id,`Ambiguous)
63 | Ast.Symbol (s,_) when clear_interpretation -> Ast.Symbol (s,None)
64 | Ast.Num (n,_) when clear_interpretation -> Ast.Num (n,None)
72 | Ast.UserInput) as t -> t
73 and aux_opt = function
75 | Some term -> Some (k term)
76 and aux_capture_variable (term, typ_opt) = k term, aux_opt typ_opt
77 and aux_patterns k_xref patterns = List.map (aux_pattern k_xref) patterns
78 and aux_pattern k_xref =
80 Ast.Pattern (head, hrefs, vars), term ->
81 Ast.Pattern (head, k_xref hrefs, List.map aux_capture_variable vars), k term
82 | Ast.Wildcard, term -> Ast.Wildcard, k term
86 let visit_layout k = function
87 | Ast.Sub (t1, t2) -> Ast.Sub (k t1, k t2)
88 | Ast.Sup (t1, t2) -> Ast.Sup (k t1, k t2)
89 | Ast.Below (t1, t2) -> Ast.Below (k t1, k t2)
90 | Ast.Above (t1, t2) -> Ast.Above (k t1, k t2)
91 | Ast.Over (t1, t2) -> Ast.Over (k t1, k t2)
92 | Ast.Atop (t1, t2) -> Ast.Atop (k t1, k t2)
93 | Ast.Frac (t1, t2) -> Ast.Frac (k t1, k t2)
94 | Ast.InfRule (t1, t2, t3) -> Ast.InfRule (k t1, k t2, k t3)
95 | Ast.Sqrt t -> Ast.Sqrt (k t)
96 | Ast.Root (arg, index) -> Ast.Root (k arg, k index)
97 | Ast.Break -> Ast.Break
98 | Ast.Box (kind, terms) -> Ast.Box (kind, List.map k terms)
99 | Ast.Group terms -> Ast.Group (List.map k terms)
100 | Ast.Mstyle (l, term) -> Ast.Mstyle (l, List.map k term)
101 | Ast.Mpadded (l, term) -> Ast.Mpadded (l, List.map k term)
102 | Ast.Maction terms -> Ast.Maction (List.map k terms)
104 let visit_magic k = function
105 | Ast.List0 (t, l) -> Ast.List0 (k t, l)
106 | Ast.List1 (t, l) -> Ast.List1 (k t, l)
107 | Ast.Opt t -> Ast.Opt (k t)
108 | Ast.Fold (kind, t1, names, t2) -> Ast.Fold (kind, k t1, names, k t2)
109 | Ast.Default (t1, t2) -> Ast.Default (k t1, k t2)
110 | Ast.If (t1, t2, t3) -> Ast.If (k t1, k t2, k t3)
111 | Ast.Fail -> Ast.Fail
113 let visit_variable k = function
117 | Ast.FreshVar _ as t -> t
118 | Ast.Ascription (t, s) -> Ast.Ascription (k t, s)
120 let variables_of_term t =
121 let rec vars = ref [] in
123 if List.mem v !vars then ()
124 else vars := v :: !vars
126 let rec aux = function
127 | Ast.Magic m -> Ast.Magic (visit_magic aux m)
128 | Ast.Layout l -> Ast.Layout (visit_layout aux l)
129 | Ast.Variable v -> Ast.Variable (aux_variable v)
130 | Ast.Literal _ as t -> t
131 | Ast.AttributedTerm (_, t) -> aux t
132 | t -> visit_ast aux t
133 and aux_variable = function
136 | Ast.TermVar _) as t ->
139 | Ast.FreshVar _ as t -> t
140 | Ast.Ascription _ -> assert false
145 let names_of_term t =
149 | Ast.TermVar (s,_) -> s
152 List.map aux (variables_of_term t)
154 let keywords_of_term t =
155 let rec keywords = ref [] in
156 let add_keyword k = keywords := k :: !keywords in
157 let rec aux = function
158 | Ast.AttributedTerm (_, t) -> aux t
159 | Ast.Layout l -> Ast.Layout (visit_layout aux l)
160 | Ast.Literal (_,`Keyword (k,_)) as t ->
163 | Ast.Literal _ as t -> t
164 | Ast.Magic m -> Ast.Magic (visit_magic aux m)
165 | Ast.Variable _ as v -> v
166 | t -> visit_ast aux t
171 let rec strip_attributes t =
172 let special_k = function
173 | Ast.AttributedTerm (_, term) -> strip_attributes term
174 | Ast.Magic m -> Ast.Magic (visit_magic strip_attributes m)
175 | Ast.Variable _ as t -> t
178 visit_ast ~special_k strip_attributes t
182 | Ast.Symbol (csym,Some (uri,desc)) -> [csym,uri,desc]
185 let meta_names_of_term term =
186 let rec names = ref [] in
188 if List.mem n !names then ()
189 else names := n :: !names
191 let rec aux = function
192 | Ast.AttributedTerm (_, term) -> aux term
193 | Ast.Appl terms -> List.iter aux terms
194 | Ast.Binder (_, _, body) -> aux body
195 | Ast.Case (term, indty, outty_opt, patterns) ->
198 List.iter aux_branch patterns
199 | Ast.LetIn (_, t1, t3) ->
202 | Ast.LetRec (_, definitions, body) ->
203 List.iter aux_definition definitions ;
205 | Ast.Meta (_, substs) -> aux_meta_substs substs
212 | Ast.UserInput -> ()
214 | Ast.Magic magic -> aux_magic magic
215 | Ast.Variable var -> aux_variable var
218 and aux_opt = function
219 | Some term -> aux term
221 and aux_capture_var (_, ty_opt) = aux_opt ty_opt
222 and aux_branch (pattern, term) =
223 aux_pattern pattern ;
227 Ast.Pattern (head, _, vars) -> List.iter aux_capture_var vars
229 and aux_definition (params, var, term, decrno) =
230 List.iter aux_capture_var params ;
231 aux_capture_var var ;
233 and aux_meta_substs meta_substs = List.iter aux_opt meta_substs
234 and aux_variable = function
235 | Ast.NumVar name -> add_name name
236 | Ast.IdentVar name -> add_name name
237 | Ast.TermVar (name,_) -> add_name name
238 | Ast.FreshVar _ -> ()
239 | Ast.Ascription _ -> assert false
240 and aux_magic = function
241 | Ast.Default (t1, t2)
242 | Ast.Fold (_, t1, _, t2) ->
245 | Ast.If (t1, t2, t3) ->
255 let rectangular matrix =
256 let columns = Array.length matrix.(0) in
258 Array.iter (fun a -> if Array.length a <> columns then raise Exit) matrix;
263 let matrix = Array.of_list (List.map Array.of_list ll) in
264 assert (rectangular matrix);
265 let rows = Array.length matrix in
266 let columns = Array.length matrix.(0) in
267 let lists = ref [] in
268 for j = 0 to columns - 1 do
270 for i = 0 to rows - 1 do
271 l := matrix.(i).(j) :: !l
273 lists := List.rev !l :: !lists
277 let href s = function
279 | Some u, None -> "<A href=\"" ^ u ^ "\">" ^ s ^ "</A>"
281 "<A href=\"cic:/fakeuri.con\" title=\"" ^ desc ^ "\">" ^ s ^ "</A>"
282 | Some u, Some desc ->
283 "<A href=\"" ^ u ^ "\" title=\"" ^ desc ^ "\">" ^ s ^ "</A>"
285 let string_of_literal = function
288 | `Number (s,x) -> href s x
290 let html_of_literal = function
294 href (Netencoding.Html.encode ~in_enc:`Enc_utf8 ()
295 (Utf8Macro.unicode_of_tex s)) x
297 let boxify = function
299 | l -> Ast.Layout (Ast.Box ((Ast.H, false, false), l))
301 let unboxify = function
302 | Ast.Layout (Ast.Box ((Ast.H, false, false), [ a ])) -> a
307 | l -> Ast.Layout (Ast.Group l)
313 | Ast.Layout (Ast.Group terms) :: terms' -> aux acc (terms @ terms')
314 | term :: terms -> aux (term :: acc) terms
318 let dress ~sep:sauce =
323 | hd :: tl -> hd :: sauce :: aux tl
327 let dressn ~sep:sauces =
332 | hd :: tl -> hd :: sauces @ aux tl
336 let find_appl_pattern_uris ap =
339 | Ast.NRefPattern nref -> nref :: acc
340 | Ast.ImplicitPattern
341 | Ast.VarPattern _ -> acc
342 | Ast.ApplPattern apl -> List.fold_left aux acc apl
344 let uris = aux [] ap in
345 HExtlib.list_uniq (List.fast_sort NReference.compare uris)
347 let rec find_branch =
349 Ast.Magic (Ast.If (_, Ast.Magic Ast.Fail, t)) -> find_branch t
350 | Ast.Magic (Ast.If (_, t, _)) -> find_branch t
353 let fresh_index = ref ~-1
355 type notation_id = int
361 (* TODO ensure that names generated by fresh_var do not clash with user's *)
362 (* FG: "η" is not an identifier (it is rendered, but not be parsed) *)
363 let fresh_name () = "eta" ^ string_of_int (fresh_id ())
365 (* XXX FIXME: was used to add instance indices to symbols/numbers
366 * do we even need a similar operation?
367 * currently an identity function! *)
368 let rec freshen_term ?(index = ref 0) term =
369 let freshen_term = freshen_term ~index in
370 let fresh_instance () = incr index; !index in
371 let special_k = function
372 | Ast.AttributedTerm (attr, t) -> Ast.AttributedTerm (attr, freshen_term t)
373 | Ast.Layout l -> Ast.Layout (visit_layout freshen_term l)
374 | Ast.Magic m -> Ast.Magic (visit_magic freshen_term m)
375 | Ast.Variable v -> Ast.Variable (visit_variable freshen_term v)
376 | Ast.Literal _ as t -> t
380 | Ast.Symbol (s, x) -> Ast.Symbol (s, x (* fresh_instance () *))
381 | Ast.Num (s, x) -> Ast.Num (s, x (* fresh_instance () *))
382 | t -> visit_ast ~special_k freshen_term t
384 let freshen_obj obj =
386 let freshen_term = freshen_term ~index in
387 let freshen_name_ty = List.map (fun (n, t) -> (n, freshen_term t)) in
388 let freshen_name_ty_b = List.map (fun (n,t,b,i) -> (n,freshen_term t,b,i)) in
389 let freshen_capture_variables =
390 List.map (fun (n,t) -> (freshen_term n, HExtlib.map_option freshen_term t))
393 | NotationPt.Inductive (params, indtypes) ->
396 (fun (n, co, ty, ctors) -> (n, co, ty, freshen_name_ty ctors))
399 NotationPt.Inductive (freshen_capture_variables params, indtypes)
400 | NotationPt.Theorem (flav, n, t, ty_opt,p) ->
402 match ty_opt with None -> None | Some ty -> Some (freshen_term ty)
404 NotationPt.Theorem (flav, n, freshen_term t, ty_opt,p)
405 | NotationPt.Record (params, n, ty, fields) ->
406 NotationPt.Record (freshen_capture_variables params, n,
407 freshen_term ty, freshen_name_ty_b fields)
409 let freshen_term = freshen_term ?index:None
411 let rec refresh_uri_in_term ~refresh_uri_in_term:refresh_in_cic
412 ~refresh_uri_in_reference
415 NotationPt.NRef ref -> NotationPt.NRef (refresh_uri_in_reference ref)
416 | NotationPt.NCic t -> NotationPt.NCic (refresh_in_cic t)
419 (refresh_uri_in_term ~refresh_uri_in_term:refresh_in_cic
420 ~refresh_uri_in_reference) t
421 ~special_k:(fun x -> x)
422 ~map_xref_option:(function Some ref -> Some (refresh_uri_in_reference ref)
424 ~map_case_indty:(function (Some (s,Some ref)) -> Some (s, Some
425 (refresh_uri_in_reference ref)) | x -> x)