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 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 CicNotationUtil.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 child_assoc child_pos curr_prec t =
187 "child_prec = %d\nchild_assoc = %s\nchild_pos = %s\ncurr_prec= %d\n\n%!")
188 child_prec (pp_assoc child_assoc) (CicNotationPp.pp_pos child_pos)
190 if is_atomic t then t
191 else if child_prec >= 0
192 && (child_prec < curr_prec
193 || (child_prec = curr_prec &&
194 child_assoc = Gramext.LeftA &&
196 || (child_prec = curr_prec &&
197 child_assoc = Gramext.RightA &&
198 child_pos <> `Right))
199 then begin (* parens should be added *)
200 (* prerr_endline "adding parens!"; *)
202 | Mpresentation.Mobject (_, box) ->
203 mpres_of_box (Box.H ([], [ open_box_paren; box; closed_box_paren ]))
204 | mpres -> Mpresentation.Mrow ([], [open_paren; t; closed_paren])
208 let render ids_to_uris ?(prec=(-1)) =
209 let module A = Ast in
210 let module P = Mpresentation in
211 (* let use_unicode = true in *)
214 let uri = Hashtbl.find ids_to_uris id in
215 Some (UriManager.string_of_uri uri)
216 with Not_found -> None)
218 let make_href xmlattrs xref =
222 match lookup_uri xref with
224 | Some uri -> uri :: uris)
227 let xmlattrs_uris, xmlattrs =
228 let xref_attrs, other_attrs =
230 (function Some "xlink", "href", _ -> true | _ -> false)
233 List.map (fun (_, _, uri) -> uri) xref_attrs,
237 match xmlattrs_uris @ xref_uris with
240 Some (String.concat " "
241 (HExtlib.list_uniq (List.sort String.compare uris)))
244 match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
248 @ make_attributes [Some "helm", "xref"; Some "xlink", "href"]
253 match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
256 make_attributes [Some "helm","xref"] [xrefs]
258 (* when mathonly is true no boxes should be generated, only mrows *)
260 let rec aux xmlattrs mathonly xref pos prec t =
262 | A.AttributedTerm _ ->
263 aux_attributes xmlattrs mathonly xref pos prec t
264 | A.Num (literal, _) ->
266 (RenderingAttrs.number_attributes `MathML)
267 @ make_href xmlattrs xref
269 Mpres.Mn (attrs, literal)
270 | A.Symbol (literal, _) ->
272 (RenderingAttrs.symbol_attributes `MathML)
273 @ make_href xmlattrs xref
275 Mpres.Mo (attrs, to_unicode literal)
276 | A.Ident (literal, subst)
277 | A.Uri (literal, subst) ->
279 (RenderingAttrs.ident_attributes `MathML)
280 @ make_href xmlattrs xref
282 let name = Mpres.Mi (attrs, to_unicode literal) in
288 box_of mathonly (A.H, false, false) []
290 :: (CicNotationUtil.dress semicolon
293 box_of mathonly (A.H, false, false) [] [
295 Mpres.Mo ([], to_unicode "\\def");
296 aux [] mathonly xref pos prec t ])
300 let substs_maction = toggle_action [ hidden_substs; substs' ] in
301 box_of mathonly (A.H, false, false) [] [ name; substs_maction ])
303 let local_context l =
304 box_of mathonly (A.H, false, false) []
305 ([ Mpres.Mtext ([], "[") ] @
306 (CicNotationUtil.dress (Mpres.Mtext ([], ";"))
309 | None -> Mpres.Mtext ([], "_")
310 | Some t -> aux xmlattrs mathonly xref pos prec t) l)) @
311 [ Mpres.Mtext ([], "]")])
313 let lctxt_maction = toggle_action [ hidden_lctxt; local_context l ] in
314 box_of mathonly (A.H, false, false) []
315 ([Mpres.Mtext ([], "?"^string_of_int n) ]
316 @ (if l <> [] then [lctxt_maction] else []))
317 | A.Literal l -> aux_literal xmlattrs xref prec l
318 | A.UserInput -> Mpres.Mtext ([], "%")
319 | A.Layout l -> aux_layout mathonly xref pos prec l
321 | A.Variable _ -> assert false (* should have been instantiated *)
323 prerr_endline ("unexpected ast: " ^ CicNotationPp.pp_term t);
325 and aux_attributes xmlattrs mathonly xref pos prec t =
326 let reset = ref false in
327 let inferred_level = ref None in
328 let expected_level = ref None in
329 let new_xref = ref [] in
330 let new_xmlattrs = ref [] in
331 let new_pos = ref pos in
332 (* let reinit = ref false in *)
333 let rec aux_attribute =
335 | A.AttributedTerm (attr, t) ->
339 | `Level (-1, _) -> reset := true
340 | `Level (child_prec, child_assoc) ->
341 assert (!expected_level = None);
342 expected_level := !inferred_level;
343 inferred_level := Some (child_prec, child_assoc)
344 | `IdRef xref -> new_xref := xref :: !new_xref
345 | `ChildPos pos -> new_pos := pos
346 | `XmlAttrs attrs -> new_xmlattrs := attrs @ !new_xmlattrs);
350 match !expected_level with
352 | Some (prec, _) -> prec
354 (match !inferred_level with
355 | None -> aux !new_xmlattrs mathonly new_xref !new_pos prec t
356 | Some (child_prec, child_assoc) ->
358 aux !new_xmlattrs mathonly new_xref !new_pos child_prec t in
361 else add_parens child_prec child_assoc !new_pos prec t')
364 and aux_literal xmlattrs xref prec l =
365 let attrs = make_href xmlattrs xref in
367 | `Symbol s -> Mpres.Mo (attrs, to_unicode s)
368 | `Keyword s -> Mpres.Mtext (attrs, to_unicode s)
369 | `Number s -> Mpres.Mn (attrs, to_unicode s))
370 and aux_layout mathonly xref pos prec l =
371 let attrs = make_xref xref in
372 let invoke' t = aux [] true (ref []) pos prec t in
373 (* use the one below to reset precedence and associativity *)
374 let invoke_reinit t = aux [] mathonly xref `Inner ~-1 t in
376 | A.Sub (t1, t2) -> Mpres.Msub (attrs, invoke' t1, invoke_reinit t2)
377 | A.Sup (t1, t2) -> Mpres.Msup (attrs, invoke' t1, invoke_reinit t2)
378 | A.Below (t1, t2) -> Mpres.Munder (attrs, invoke' t1, invoke_reinit t2)
379 | A.Above (t1, t2) -> Mpres.Mover (attrs, invoke' t1, invoke_reinit t2)
382 Mpres.Mfrac (attrs, invoke_reinit t1, invoke_reinit t2)
384 Mpres.Mfrac (atop_attributes @ attrs, invoke_reinit t1,
386 | A.Sqrt t -> Mpres.Msqrt (attrs, invoke_reinit t)
388 Mpres.Mroot (attrs, invoke_reinit t1, invoke_reinit t2)
389 | A.Box ((_, spacing, _) as kind, terms) ->
391 aux_children mathonly spacing xref pos prec
392 (CicNotationUtil.ungroup terms)
394 box_of mathonly kind attrs children
397 aux_children mathonly false xref pos prec
398 (CicNotationUtil.ungroup terms)
400 box_of mathonly (A.H, false, false) attrs children
401 | A.Break -> assert false (* TODO? *)
402 and aux_children mathonly spacing xref pos prec terms =
404 let rec aux_list first clusters acc =
406 [] when acc = [] -> List.rev clusters
407 | [] -> aux_list first (List.rev acc :: clusters) [] []
408 | (A.Layout A.Break) :: tl when acc = [] ->
409 aux_list first clusters [] tl
410 | (A.Layout A.Break) :: tl ->
411 aux_list first (List.rev acc :: clusters) [] tl
423 aux_list false clusters
424 (aux [] mathonly xref pos prec hd :: acc) []
427 match pos, first with
429 | `None, false -> `Inner
430 | `Left, true -> `Left
431 | `Left, false -> `Inner
432 | `Right, _ -> `Inner
433 | `Inner, _ -> `Inner
435 aux_list false clusters
436 (aux [] mathonly xref pos prec hd :: acc) tl
443 | tl -> box_of mathonly (A.H, spacing, false) [] tl
445 List.map boxify_pres (find_clusters terms)
447 aux [] false (ref []) `Inner prec
449 let rec print_box (t: boxml_markup) =
450 Box.box2xml print_mpres t
451 and print_mpres (t: mathml_markup) =
452 Mpresentation.print_mpres print_box t
454 let print_xml = print_mpres
456 (* let render_to_boxml id_to_uri t =
457 let xml_stream = print_box (box_of_mpres (render id_to_uri t)) in
458 Xml.add_xml_declaration xml_stream *)