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 = NotationPt
31 module Mpres = Mpresentation
33 type mathml_markup = boxml_markup Mpres.mpres
34 and boxml_markup = mathml_markup Box.box
36 type markup = mathml_markup
38 let atop_attributes = [None, "linethickness", "0pt"]
40 let to_unicode = Utf8Macro.unicode_of_tex
42 let rec make_attributes l1 = function
46 | None -> make_attributes (List.tl l1) tl
48 let p,n = List.hd l1 in
49 (p,n,s) :: make_attributes (List.tl l1) tl)
53 | Mpresentation.Mobject (attrs, box) ->
56 | mpres -> Box.Object ([], mpres)
60 | Box.Object (attrs, mpres) ->
63 | box -> Mpresentation.Mobject ([], box)
65 let rec genuine_math =
67 | Mpresentation.Mobject ([], obj) -> not (genuine_box obj)
71 | Box.Object ([], mpres) -> not (genuine_math mpres)
74 let rec eligible_math =
76 | Mpresentation.Mobject ([], Box.Object ([], mpres)) -> eligible_math mpres
77 | Mpresentation.Mobject ([], _) -> false
80 let rec promote_to_math =
82 | Mpresentation.Mobject ([], Box.Object ([], mpres)) -> promote_to_math mpres
86 Mpresentation.Mspace (RenderingAttrs.small_skip_attributes `MathML)
88 let rec add_mpres_attributes new_attr = function
89 | Mpresentation.Mobject (attr, box) ->
90 Mpresentation.Mobject (attr, add_box_attributes new_attr box)
92 Mpresentation.set_attr (new_attr @ Mpresentation.get_attr mpres) mpres
93 and add_box_attributes new_attr = function
94 | Box.Object (attr, mpres) ->
95 Box.Object (attr, add_mpres_attributes new_attr mpres)
96 | box -> Box.set_attr (new_attr @ Box.get_attr box) box
98 let box_of mathonly spec attrs children =
100 | [t] -> add_mpres_attributes attrs t
102 let kind, spacing, indent = spec in
105 NotationUtil.dress small_skip children
109 if mathonly then Mpresentation.Mrow (attrs, dress children)
112 (if spacing then RenderingAttrs.spacing_attributes `BoxML else [])
113 @ (if indent then RenderingAttrs.indent_attributes `BoxML else [])
118 if List.for_all eligible_math children then
119 Mpresentation.Mrow (attrs',
120 dress (List.map promote_to_math children))
122 mpres_of_box (Box.H (attrs',
123 List.map box_of_mpres children))
124 (* | Ast.H when List.for_all genuine_math children ->
125 Mpresentation.Mrow (attrs', dress children) *)
127 mpres_of_box (Box.V (attrs',
128 List.map box_of_mpres children))
130 mpres_of_box (Box.HV (attrs',
131 List.map box_of_mpres children))
133 mpres_of_box (Box.HOV (attrs',
134 List.map box_of_mpres children))
136 let open_paren = Mpresentation.Mo ([], "(")
137 let closed_paren = Mpresentation.Mo ([], ")")
138 let open_bracket = Mpresentation.Mo ([], "[")
139 let closed_bracket = Mpresentation.Mo ([], "]")
140 let open_brace = Mpresentation.Mo ([], "{")
141 let closed_brace = Mpresentation.Mo ([], "}")
142 let hidden_substs = Mpresentation.Mtext ([], "{...}")
143 let hidden_lctxt = Mpresentation.Mtext ([], "[...]")
144 let open_box_paren = Box.Text ([], "(")
145 let closed_box_paren = Box.Text ([], ")")
146 let semicolon = Mpresentation.Mo ([], ";")
147 let toggle_action children =
148 Mpresentation.Maction ([None, "actiontype", "toggle"], children)
150 type child_pos = [ `Left | `Right | `Inner ]
154 | Gramext.LeftA -> "LeftA"
155 | Gramext.RightA -> "RightA"
156 | Gramext.NonA -> "NonA"
159 let rec aux_mpres = function
165 | Mpres.Mspace _ -> true
166 | Mpres.Mobject (_, box) -> aux_box box
167 | Mpres.Maction (_, [mpres])
168 | Mpres.Mrow (_, [mpres]) -> aux_mpres mpres
170 and aux_box = function
174 | Box.Object (_, mpres) -> aux_mpres mpres
179 | Box.Action (_, [box]) -> aux_box box
184 let add_parens child_prec curr_prec t =
186 ((*prerr_endline ("NOT adding parens around ATOMIC: "^
187 BoxPp.render_to_string (function x::_->x|_->assert false)
188 ~map_unicode_to_tex:false 80 t);*)t)
189 else if child_prec >= 0 && child_prec < curr_prec then
191 (*prerr_endline ("adding parens around: "^
192 BoxPp.render_to_string (function x::_->x|_->assert false)
193 ~map_unicode_to_tex:false 80 t);*)
195 | Mpresentation.Mobject (_, box) ->
196 mpres_of_box (Box.H ([], [ open_box_paren; box; closed_box_paren ]))
197 | mpres -> Mpresentation.Mrow ([], [open_paren; t; closed_paren])
199 ((*prerr_endline ("NOT adding parens around: "^
200 BoxPp.render_to_string (function x::_->x|_->assert false)
201 ~map_unicode_to_tex:false 80 t);*)t)
203 let render status ~lookup_uri ?(prec=(-1)) =
204 let module A = Ast in
205 let module P = Mpresentation in
206 (* let use_unicode = true in *)
207 let make_href xmlattrs xref =
211 match lookup_uri xref with
213 | Some uri -> uri :: uris)
216 let xmlattrs_uris, xmlattrs =
217 let xref_attrs, other_attrs =
219 (function Some "xlink", "href", _ -> true | _ -> false)
222 List.map (fun (_, _, uri) -> uri) xref_attrs,
226 match xmlattrs_uris @ xref_uris with
229 Some (String.concat " "
230 (HExtlib.list_uniq (List.sort String.compare uris)))
233 match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
237 @ make_attributes [Some "helm", "xref"; Some "xlink", "href"]
242 match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
245 make_attributes [Some "helm","xref"] [xrefs]
247 (* when mathonly is true no boxes should be generated, only mrows *)
249 let rec aux xmlattrs mathonly xref prec t =
251 | A.AttributedTerm _ ->
252 aux_attributes xmlattrs mathonly xref prec t
253 | A.Num (literal, _) ->
255 (RenderingAttrs.number_attributes `MathML)
256 @ make_href xmlattrs xref
258 Mpres.Mn (attrs, literal)
259 | A.Symbol (literal, _) ->
261 (RenderingAttrs.symbol_attributes `MathML)
262 @ make_href xmlattrs xref
264 Mpres.Mo (attrs, to_unicode literal)
265 | A.Ident (literal, _) ->
267 (RenderingAttrs.ident_attributes `MathML)
268 @ make_href xmlattrs xref
270 Mpres.Mi (attrs, to_unicode literal)
272 let local_context l =
273 box_of mathonly (A.H, false, false) []
274 ([ Mpres.Mtext ([], "[") ] @
275 (NotationUtil.dress (Mpres.Mtext ([], ";"))
278 | None -> Mpres.Mtext ([], "_")
279 | Some t -> aux xmlattrs mathonly xref prec t) l)) @
280 [ Mpres.Mtext ([], "]")])
282 let lctxt_maction = toggle_action [ hidden_lctxt; local_context l ] in
283 box_of mathonly (A.H, false, false) []
284 ([Mpres.Mtext ([], "?"^string_of_int n) ]
285 @ (if l <> [] then [lctxt_maction] else []))
286 | A.Literal l -> aux_literal xmlattrs xref prec l
287 | A.UserInput -> Mpres.Mtext ([], "%")
288 | A.Layout l -> aux_layout mathonly xref prec l
290 | A.Variable _ -> assert false (* should have been instantiated *)
292 prerr_endline ("unexpected ast: " ^ NotationPp.pp_term status t);
294 and aux_attributes xmlattrs mathonly xref prec t =
295 let reset = ref false in
296 let inferred_level = ref None in
297 let expected_level = ref None in
298 let new_xref = ref [] in
299 let new_xmlattrs = ref [] in
300 let rec aux_attribute =
302 | A.AttributedTerm (attr, t) ->
306 | `Level (-1) -> reset := true
307 | `Level child_prec ->
308 (* assert (!expected_level = None); *)
309 expected_level := !inferred_level;
310 inferred_level := Some child_prec
311 | `IdRef xref -> new_xref := xref :: !new_xref
312 | `XmlAttrs attrs -> new_xmlattrs := attrs @ !new_xmlattrs);
316 match !expected_level with
320 (match !inferred_level with
321 | None -> aux !new_xmlattrs mathonly new_xref prec t
323 let t' = aux !new_xmlattrs mathonly new_xref child_prec t in
325 ("inferred: "^string_of_int child_prec^
326 " exp: "^string_of_int prec ^
327 " term: "^BoxPp.render_to_string ~map_unicode_to_tex:false
328 (function x::_->x|_->assert false) 80 t');*)
330 then ((*prerr_endline "reset";*)t')
331 else add_parens child_prec prec t')
333 (* prerr_endline (NotationPp.pp_term t); *)
335 and aux_literal xmlattrs xref prec l =
336 let attrs = make_href xmlattrs xref in
338 | `Symbol s -> Mpres.Mo (attrs, to_unicode s)
339 | `Keyword s -> Mpres.Mtext (attrs, to_unicode s)
340 | `Number s -> Mpres.Mn (attrs, to_unicode s))
341 and aux_layout mathonly xref prec l =
342 let attrs = make_xref xref in
343 let invoke' t = aux [] true (ref []) prec t in
344 (* use the one below to reset precedence and associativity *)
345 let invoke_reinit t = aux [] mathonly xref ~-1 t in
347 | A.Sup (A.Layout (A.Sub (t1,t2)), t3)
348 | A.Sup (A.AttributedTerm (_,A.Layout (A.Sub (t1,t2))), t3)
349 -> Mpres.Msubsup (attrs, invoke' t1, invoke_reinit t2, invoke_reinit t3)
350 | A.Sub (t1, t2) -> Mpres.Msub (attrs, invoke' t1, invoke_reinit t2)
351 | A.Sup (t1, t2) -> Mpres.Msup (attrs, invoke' t1, invoke_reinit t2)
352 | A.Below (t1, t2) -> Mpres.Munder (attrs, invoke' t1, invoke_reinit t2)
353 | A.Above (t1, t2) -> Mpres.Mover (attrs, invoke' t1, invoke_reinit t2)
356 Mpres.Mfrac (attrs, invoke_reinit t1, invoke_reinit t2)
358 Mpres.Mfrac (atop_attributes @ attrs, invoke_reinit t1,
360 | A.InfRule (t1, t2, t3) ->
361 Mpres.Mstyle ([None,"mathsize","big"],
364 Mpres.Mstyle ([None,"scriptlevel","0"],invoke_reinit t1),
365 Mpres.Mstyle ([None,"scriptlevel","0"],invoke_reinit t2));
366 Mpres.Mstyle ([None,"scriptlevel","2"],
368 (RenderingAttrs.small_skip_attributes `MathML));
369 Mpres.Mstyle ([None,"scriptlevel","1"],invoke_reinit t3)]))
370 | A.Sqrt t -> Mpres.Msqrt (attrs, invoke_reinit t)
372 Mpres.Mroot (attrs, invoke_reinit t1, invoke_reinit t2)
373 | A.Box ((_, spacing, _) as kind, terms) ->
375 aux_children mathonly spacing xref prec
376 (NotationUtil.ungroup terms)
378 box_of mathonly kind attrs children
379 | A.Mstyle (l,terms) ->
381 (List.map (fun (k,v) -> None,k,v) l,
382 box_of mathonly (A.H, false, false) attrs
383 (aux_children mathonly false xref prec
384 (NotationUtil.ungroup terms)))
385 | A.Mpadded (l,terms) ->
387 (List.map (fun (k,v) -> None,k,v) l,
388 box_of mathonly (A.H, false, false) attrs
389 (aux_children mathonly false xref prec
390 (NotationUtil.ungroup terms)))
391 | A.Maction alternatives ->
392 toggle_action (List.map invoke_reinit alternatives)
395 aux_children mathonly false xref prec
396 (NotationUtil.ungroup terms)
398 box_of mathonly (A.H, false, false) attrs children
399 | A.Break -> assert false (* TODO? *)
400 and aux_children mathonly spacing xref prec terms =
402 let rec aux_list first clusters acc =
404 [] when acc = [] -> List.rev clusters
405 | [] -> aux_list first (List.rev acc :: clusters) [] []
406 | (A.Layout A.Break) :: tl when acc = [] ->
407 aux_list first clusters [] tl
408 | (A.Layout A.Break) :: tl ->
409 aux_list first (List.rev acc :: clusters) [] tl
411 aux_list false clusters
412 (aux [] mathonly xref prec hd :: acc) []
414 aux_list false clusters
415 (aux [] mathonly xref prec hd :: acc) tl
422 | tl -> box_of mathonly (A.H, spacing, false) [] tl
424 List.map boxify_pres (find_clusters terms)
426 aux [] false (ref []) prec
428 let rec print_box (t: boxml_markup) =
429 Box.box2xml print_mpres t
430 and print_mpres (t: mathml_markup) =
431 Mpresentation.print_mpres print_box t
433 let print_xml = print_mpres
435 (* let render_to_boxml id_to_uri t =
436 let xml_stream = print_box (box_of_mpres (render id_to_uri t)) in
437 Xml.add_xml_declaration xml_stream *)