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 = CicNotationPt
29 module Mpres = Mpresentation
31 type mathml_markup = boxml_markup Mpres.mpres
32 and boxml_markup = mathml_markup Box.box
34 type markup = mathml_markup
36 let atop_attributes = [None, "linethickness", "0pt"]
38 let to_unicode = Utf8Macro.unicode_of_tex
40 let rec make_attributes l1 = function
44 | None -> make_attributes (List.tl l1) tl
46 let p,n = List.hd l1 in
47 (p,n,s) :: make_attributes (List.tl l1) tl)
51 | Mpresentation.Mobject (attrs, box) ->
54 | mpres -> Box.Object ([], mpres)
58 | Box.Object (attrs, mpres) ->
61 | box -> Mpresentation.Mobject ([], box)
63 let rec genuine_math =
65 | Mpresentation.Mobject ([], obj) -> not (genuine_box obj)
69 | Box.Object ([], mpres) -> not (genuine_math mpres)
72 let rec eligible_math =
74 | Mpresentation.Mobject ([], Box.Object ([], mpres)) -> eligible_math mpres
75 | Mpresentation.Mobject ([], _) -> false
78 let rec promote_to_math =
80 | Mpresentation.Mobject ([], Box.Object ([], mpres)) -> promote_to_math mpres
84 Mpresentation.Mspace (RenderingAttrs.small_skip_attributes `MathML)
86 let rec add_mpres_attributes new_attr = function
87 | Mpresentation.Mobject (attr, box) ->
88 Mpresentation.Mobject (attr, add_box_attributes new_attr box)
90 Mpresentation.set_attr (new_attr @ Mpresentation.get_attr mpres) mpres
91 and add_box_attributes new_attr = function
92 | Box.Object (attr, mpres) ->
93 Box.Object (attr, add_mpres_attributes new_attr mpres)
94 | box -> Box.set_attr (new_attr @ Box.get_attr box) box
96 let box_of mathonly spec attrs children =
98 | [t] -> add_mpres_attributes attrs t
100 let kind, spacing, indent = spec in
103 CicNotationUtil.dress small_skip children
107 if mathonly then Mpresentation.Mrow (attrs, dress children)
110 (if spacing then RenderingAttrs.spacing_attributes `BoxML else [])
111 @ (if indent then RenderingAttrs.indent_attributes `BoxML else [])
116 if List.for_all eligible_math children then
117 Mpresentation.Mrow (attrs',
118 dress (List.map promote_to_math children))
120 mpres_of_box (Box.H (attrs',
121 List.map box_of_mpres children))
122 (* | Ast.H when List.for_all genuine_math children ->
123 Mpresentation.Mrow (attrs', dress children) *)
125 mpres_of_box (Box.V (attrs',
126 List.map box_of_mpres children))
128 mpres_of_box (Box.HV (attrs',
129 List.map box_of_mpres children))
131 mpres_of_box (Box.HOV (attrs',
132 List.map box_of_mpres children))
134 let open_paren = Mpresentation.Mo ([], "(")
135 let closed_paren = Mpresentation.Mo ([], ")")
136 let open_brace = Mpresentation.Mo ([], "{")
137 let closed_brace = Mpresentation.Mo ([], "}")
138 let hidden_substs = Mpresentation.Mtext ([], "{...}")
139 let open_box_paren = Box.Text ([], "(")
140 let closed_box_paren = Box.Text ([], ")")
141 let semicolon = Mpresentation.Mo ([], ";")
142 let toggle_action children =
143 Mpresentation.Maction ([None, "actiontype", "toggle"], children)
145 type child_pos = [ `Left | `Right | `Inner ]
149 | Gramext.LeftA -> "LeftA"
150 | Gramext.RightA -> "RightA"
151 | Gramext.NonA -> "NonA"
154 let rec aux_mpres = function
160 | Mpres.Mspace _ -> true
161 | Mpres.Mobject (_, box) -> aux_box box
162 | Mpres.Maction (_, [mpres])
163 | Mpres.Mrow (_, [mpres]) -> aux_mpres mpres
165 and aux_box = function
169 | Box.Object (_, mpres) -> aux_mpres mpres
174 | Box.Action (_, [box]) -> aux_box box
179 let add_parens child_prec child_assoc child_pos curr_prec t =
180 if is_atomic t then t
181 else if child_prec >= 0
182 && (child_prec < curr_prec
183 || (child_prec = curr_prec &&
184 child_assoc = Gramext.LeftA &&
186 || (child_prec = curr_prec &&
187 child_assoc = Gramext.RightA &&
189 then (* parens should be added *)
190 (* (prerr_endline "adding parens";
191 prerr_endline (Printf.sprintf "child_prec = %d\nchild_assoc = %s\nchild_pos = %s\ncurr_prec= %d"
192 child_prec (pp_assoc child_assoc) (CicNotationPp.pp_pos
193 child_pos) curr_prec); *)
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])
201 let render ids_to_uris =
202 let module A = Ast in
203 let module P = Mpresentation in
204 (* let use_unicode = true in *)
207 let uri = Hashtbl.find ids_to_uris id in
208 Some (UriManager.string_of_uri uri)
209 with Not_found -> None)
211 let make_href xmlattrs xref =
215 match lookup_uri xref with
217 | Some uri -> uri :: uris)
220 let xmlattrs_uris, xmlattrs =
221 let xref_attrs, other_attrs =
223 (function Some "xlink", "href", _ -> true | _ -> false)
226 List.map (fun (_, _, uri) -> uri) xref_attrs,
230 match xmlattrs_uris @ xref_uris with
233 Some (String.concat " "
234 (HExtlib.list_uniq (List.sort String.compare uris)))
237 match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
241 @ make_attributes [Some "helm", "xref"; Some "xlink", "href"]
246 match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
249 make_attributes [Some "helm","xref"] [xrefs]
251 (* when mathonly is true no boxes should be generated, only mrows *)
253 let rec aux xmlattrs mathonly xref pos prec t =
255 | A.AttributedTerm _ ->
256 aux_attributes xmlattrs mathonly xref pos prec t
257 | A.Num (literal, _) ->
259 (RenderingAttrs.number_attributes `MathML)
260 @ make_href xmlattrs xref
262 Mpres.Mn (attrs, literal)
263 | A.Symbol (literal, _) ->
265 (RenderingAttrs.symbol_attributes `MathML)
266 @ make_href xmlattrs xref
268 Mpres.Mo (attrs, to_unicode literal)
269 | A.Ident (literal, subst)
270 | A.Uri (literal, subst) ->
272 (RenderingAttrs.ident_attributes `MathML)
273 @ make_href xmlattrs xref
275 let name = Mpres.Mi (attrs, to_unicode literal) in
281 box_of mathonly (A.H, false, false) []
283 :: (CicNotationUtil.dress semicolon
286 box_of mathonly (A.H, false, false) [] [
288 Mpres.Mo ([], to_unicode "\\def");
289 aux [] mathonly xref pos prec t ])
293 let substs_maction = toggle_action [ hidden_substs; substs' ] in
294 box_of mathonly (A.H, false, false) [] [ name; substs_maction ])
295 | A.Literal l -> aux_literal xmlattrs xref prec l
296 | A.UserInput -> Mpres.Mtext ([], "%")
297 | A.Layout l -> aux_layout mathonly xref pos prec l
299 | A.Variable _ -> assert false (* should have been instantiated *)
301 prerr_endline ("unexpected ast: " ^ CicNotationPp.pp_term t);
303 and aux_attributes xmlattrs mathonly xref pos prec t =
304 let reset = ref false in
305 let new_level = ref None in
306 let new_xref = ref [] in
307 let new_xmlattrs = ref [] in
308 let new_pos = ref pos in
309 (* let reinit = ref false in *)
310 let rec aux_attribute =
312 | A.AttributedTerm (attr, t) ->
316 | `Level (-1, _) -> reset := true
317 | `Level (child_prec, child_assoc) ->
318 new_level := Some (child_prec, child_assoc)
319 | `IdRef xref -> new_xref := xref :: !new_xref
320 | `ChildPos pos -> new_pos := pos
321 | `XmlAttrs attrs -> new_xmlattrs := attrs @ !new_xmlattrs);
324 (match !new_level with
325 | None -> aux !new_xmlattrs mathonly new_xref !new_pos prec t
326 | Some (child_prec, child_assoc) ->
328 aux !new_xmlattrs mathonly new_xref !new_pos child_prec t
331 else add_parens child_prec child_assoc !new_pos prec t')
334 and aux_literal xmlattrs xref prec l =
335 let attrs = make_href xmlattrs xref in
337 | `Symbol s -> Mpres.Mo (attrs, to_unicode s)
338 | `Keyword s -> Mpres.Mo (attrs, to_unicode s)
339 | `Number s -> Mpres.Mn (attrs, to_unicode s))
340 and aux_layout mathonly xref pos prec l =
341 let attrs = make_xref xref in
342 let invoke' t = aux [] true (ref []) pos prec t in
343 (* use the one below to reset precedence and associativity *)
344 let invoke_reinit t = aux [] mathonly xref `Inner ~-1 t in
346 | A.Sub (t1, t2) -> Mpres.Msub (attrs, invoke' t1, invoke_reinit t2)
347 | A.Sup (t1, t2) -> Mpres.Msup (attrs, invoke' t1, invoke_reinit t2)
348 | A.Below (t1, t2) -> Mpres.Munder (attrs, invoke' t1, invoke_reinit t2)
349 | A.Above (t1, t2) -> Mpres.Mover (attrs, invoke' t1, invoke_reinit t2)
352 Mpres.Mfrac (attrs, invoke_reinit t1, invoke_reinit t2)
354 Mpres.Mfrac (atop_attributes @ attrs, invoke_reinit t1,
356 | A.Sqrt t -> Mpres.Msqrt (attrs, invoke_reinit t)
358 Mpres.Mroot (attrs, invoke_reinit t1, invoke_reinit t2)
359 | A.Box ((_, spacing, _) as kind, terms) ->
361 aux_children mathonly spacing xref pos prec
362 (CicNotationUtil.ungroup terms)
364 box_of mathonly kind attrs children
367 aux_children mathonly false xref pos prec
368 (CicNotationUtil.ungroup terms)
370 box_of mathonly (A.H, false, false) attrs children
371 | A.Break -> assert false (* TODO? *)
372 and aux_children mathonly spacing xref pos prec terms =
374 let rec aux_list first clusters acc =
376 [] when acc = [] -> List.rev clusters
377 | [] -> aux_list first (List.rev acc :: clusters) [] []
378 | (A.Layout A.Break) :: tl when acc = [] ->
379 aux_list first clusters [] tl
380 | (A.Layout A.Break) :: tl ->
381 aux_list first (List.rev acc :: clusters) [] tl
393 aux_list false clusters
394 (aux [] mathonly xref pos prec hd :: acc) []
397 match pos, first with
399 | `None, false -> `Inner
400 | `Left, true -> `Left
401 | `Left, false -> `Inner
402 | `Right, _ -> `Inner
403 | `Inner, _ -> `Inner
405 aux_list false clusters
406 (aux [] mathonly xref pos prec hd :: acc) tl
413 | tl -> box_of mathonly (A.H, spacing, false) [] tl
415 List.map boxify_pres (find_clusters terms)
417 aux [] false (ref []) `Inner ~-1
419 let rec print_box (t: boxml_markup) =
420 Box.box2xml print_mpres t
421 and print_mpres (t: mathml_markup) =
422 Mpresentation.print_mpres print_box t
424 let print_xml = print_mpres
426 (* let render_to_boxml id_to_uri t =
427 let xml_stream = print_box (box_of_mpres (render id_to_uri t)) in
428 Xml.add_xml_declaration xml_stream *)