helm/software/components/content_pres/cicNotationPres.ml

   1 (* Copyright (C) 2004-2005, HELM Team.
   2  *
   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.
   6  *
   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.
  11  *
  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.
  16  *
  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,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 (* $Id$ *)
  27
  28 open Printf
  29
  30 module Ast = CicNotationPt
  31 module Mpres = Mpresentation
  32
  33 type mathml_markup = boxml_markup Mpres.mpres
  34 and boxml_markup = mathml_markup Box.box
  35
  36 type markup = mathml_markup
  37
  38 let atop_attributes = [None, "linethickness", "0pt"]
  39
  40 let to_unicode = Utf8Macro.unicode_of_tex
  41
  42 let rec make_attributes l1 = function
  43   | [] -> []
  44   | hd :: tl ->
  45       (match hd with
  46       | None -> make_attributes (List.tl l1) tl
  47       | Some s ->
  48           let p,n = List.hd l1 in
  49           (p,n,s) :: make_attributes (List.tl l1) tl)
  50
  51 let box_of_mpres =
  52   function
  53   | Mpresentation.Mobject (attrs, box) ->
  54       assert (attrs = []);
  55       box
  56   | mpres -> Box.Object ([], mpres)
  57
  58 let mpres_of_box =
  59   function
  60   | Box.Object (attrs, mpres) ->
  61       assert (attrs = []);
  62       mpres
  63   | box -> Mpresentation.Mobject ([], box)
  64
  65 let rec genuine_math =
  66   function
  67   | Mpresentation.Mobject ([], obj) -> not (genuine_box obj)
  68   | _ -> true
  69 and genuine_box =
  70   function
  71   | Box.Object ([], mpres) -> not (genuine_math mpres)
  72   | _ -> true
  73
  74 let rec eligible_math =
  75   function
  76   | Mpresentation.Mobject ([], Box.Object ([], mpres)) -> eligible_math mpres
  77   | Mpresentation.Mobject ([], _) -> false
  78   | _ -> true
  79
  80 let rec promote_to_math =
  81   function
  82   | Mpresentation.Mobject ([], Box.Object ([], mpres)) -> promote_to_math mpres
  83   | math -> math
  84
  85 let small_skip =
  86   Mpresentation.Mspace (RenderingAttrs.small_skip_attributes `MathML)
  87
  88 let rec add_mpres_attributes new_attr = function
  89   | Mpresentation.Mobject (attr, box) ->
  90       Mpresentation.Mobject (attr, add_box_attributes new_attr box)
  91   | mpres ->
  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
  97
  98 let box_of mathonly spec attrs children =
  99   match children with
 100     | [t] -> add_mpres_attributes attrs t
 101     | _ ->
 102         let kind, spacing, indent = spec in
 103         let dress children =
 104           if spacing then
 105             CicNotationUtil.dress small_skip children
 106           else
 107             children
 108         in
 109           if mathonly then Mpresentation.Mrow (attrs, dress children)
 110           else
 111             let attrs' =
 112               (if spacing then RenderingAttrs.spacing_attributes `BoxML else [])
 113               @ (if indent then RenderingAttrs.indent_attributes `BoxML else [])
 114               @ attrs
 115             in
 116               match kind with
 117                 | Ast.H ->
 118                     if List.for_all eligible_math children then
 119                       Mpresentation.Mrow (attrs',
 120                         dress (List.map promote_to_math children))
 121                     else
 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) *)
 126                 | Ast.V ->
 127                     mpres_of_box (Box.V (attrs',
 128                       List.map box_of_mpres children))
 129                 | Ast.HV ->
 130                     mpres_of_box (Box.HV (attrs',
 131                       List.map box_of_mpres children))
 132                 | Ast.HOV ->
 133                     mpres_of_box (Box.HOV (attrs',
 134                       List.map box_of_mpres children))
 135
 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)
 149
 150 type child_pos = [ `Left | `Right | `Inner ]
 151
 152 let pp_assoc =
 153   function
 154   | Gramext.LeftA -> "LeftA"
 155   | Gramext.RightA -> "RightA"
 156   | Gramext.NonA -> "NonA"
 157
 158 let is_atomic t =
 159   let rec aux_mpres = function
 160     | Mpres.Mi _
 161     | Mpres.Mo _
 162     | Mpres.Mn _
 163     | Mpres.Ms _
 164     | Mpres.Mtext _
 165     | Mpres.Mspace _ -> true
 166     | Mpres.Mobject (_, box) -> aux_box box
 167     | Mpres.Maction (_, [mpres])
 168     | Mpres.Mrow (_, [mpres]) -> aux_mpres mpres
 169     | _ -> false
 170   and aux_box = function
 171     | Box.Space _
 172     | Box.Ink _
 173     | Box.Text _ -> true
 174     | Box.Object (_, mpres) -> aux_mpres mpres
 175     | Box.H (_, [box])
 176     | Box.V (_, [box])
 177     | Box.HV (_, [box])
 178     | Box.HOV (_, [box])
 179     | Box.Action (_, [box]) -> aux_box box
 180     | _ -> false
 181   in
 182   aux_mpres t
 183
 184 let add_parens child_prec curr_prec t =
 185 (*   eprintf
 186     ("add_parens: " ^^
 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)
 189     curr_prec; *)
 190   if is_atomic t then t
 191 (* FG: FIXME: should be < but < causes no brackets when \forall .. \to .. associates to the left *)
 192   else if child_prec >= 0 && child_prec <= curr_prec then
 193     begin (* parens should be added *)
 194 (*      prerr_endline "adding parens!";  *)
 195     match t with
 196     | Mpresentation.Mobject (_, box) ->
 197         mpres_of_box (Box.H ([], [ open_box_paren; box; closed_box_paren ]))
 198     | mpres -> Mpresentation.Mrow ([], [open_paren; t; closed_paren])
 199   end else
 200     t
 201
 202 let render ids_to_uris ?(prec=(-1)) =
 203   let module A = Ast in
 204   let module P = Mpresentation in
 205 (*   let use_unicode = true in *)
 206   let lookup_uri id =
 207     (try
 208       let uri = Hashtbl.find ids_to_uris id in
 209       Some (UriManager.string_of_uri uri)
 210     with Not_found -> None)
 211   in
 212   let make_href xmlattrs xref =
 213     let xref_uris =
 214       List.fold_right
 215         (fun xref uris ->
 216           match lookup_uri xref with
 217           | None -> uris
 218           | Some uri -> uri :: uris)
 219         !xref []
 220     in
 221     let xmlattrs_uris, xmlattrs =
 222       let xref_attrs, other_attrs =
 223         List.partition
 224           (function Some "xlink", "href", _ -> true | _ -> false)
 225           xmlattrs
 226       in
 227       List.map (fun (_, _, uri) -> uri) xref_attrs,
 228       other_attrs
 229     in
 230     let uris =
 231       match xmlattrs_uris @ xref_uris with
 232       | [] -> None
 233       | uris ->
 234           Some (String.concat " "
 235             (HExtlib.list_uniq (List.sort String.compare uris)))
 236     in
 237     let xrefs =
 238       match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
 239     in
 240     xref := [];
 241     xmlattrs
 242     @ make_attributes [Some "helm", "xref"; Some "xlink", "href"]
 243         [xrefs; uris]
 244   in
 245   let make_xref xref =
 246     let xrefs =
 247       match !xref with [] -> None | xrefs -> Some (String.concat " " xrefs)
 248     in
 249     xref := [];
 250     make_attributes [Some "helm","xref"] [xrefs]
 251   in
 252   (* when mathonly is true no boxes should be generated, only mrows *)
 253   (* "xref" is  *)
 254   let rec aux xmlattrs mathonly xref  prec t =
 255     match t with
 256     | A.AttributedTerm _ ->
 257         aux_attributes xmlattrs mathonly xref  prec t
 258     | A.Num (literal, _) ->
 259         let attrs =
 260           (RenderingAttrs.number_attributes `MathML)
 261           @ make_href xmlattrs xref
 262         in
 263         Mpres.Mn (attrs, literal)
 264     | A.Symbol (literal, _) ->
 265         let attrs =
 266           (RenderingAttrs.symbol_attributes `MathML)
 267           @ make_href xmlattrs xref
 268         in
 269         Mpres.Mo (attrs, to_unicode literal)
 270     | A.Ident (literal, subst)
 271     | A.Uri (literal, subst) ->
 272         let attrs =
 273           (RenderingAttrs.ident_attributes `MathML)
 274           @ make_href xmlattrs xref
 275         in
 276         let name = Mpres.Mi (attrs, to_unicode literal) in
 277         (match subst with
 278         | Some []
 279         | None -> name
 280         | Some substs ->
 281             let substs' =
 282               box_of mathonly (A.H, false, false) []
 283                 (open_brace
 284                 :: (CicNotationUtil.dress semicolon
 285                     (List.map
 286                       (fun (name, t) ->
 287                         box_of mathonly (A.H, false, false) [] [
 288                           Mpres.Mi ([], name);
 289                           Mpres.Mo ([], to_unicode "\\def");
 290                           aux [] mathonly xref  prec t ])
 291                       substs))
 292                 @ [ closed_brace ])
 293             in
 294             let substs_maction = toggle_action [ hidden_substs; substs' ] in
 295             box_of mathonly (A.H, false, false) [] [ name; substs_maction ])
 296     | A.Meta(n, l) ->
 297         let local_context l =
 298           box_of mathonly (A.H, false, false) []
 299             ([ Mpres.Mtext ([], "[") ] @
 300             (CicNotationUtil.dress (Mpres.Mtext ([],  ";"))
 301               (List.map
 302                 (function
 303                 | None -> Mpres.Mtext ([],  "_")
 304                 | Some t -> aux xmlattrs mathonly xref  prec t) l)) @
 305              [ Mpres.Mtext ([], "]")])
 306         in
 307         let lctxt_maction = toggle_action [ hidden_lctxt; local_context l ] in
 308         box_of mathonly (A.H, false, false) []
 309           ([Mpres.Mtext ([], "?"^string_of_int n) ]
 310             @ (if l <> [] then [lctxt_maction] else []))
 311     | A.Literal l -> aux_literal xmlattrs xref prec l
 312     | A.UserInput -> Mpres.Mtext ([], "%")
 313     | A.Layout l -> aux_layout mathonly xref  prec l
 314     | A.Magic _
 315     | A.Variable _ -> assert false  (* should have been instantiated *)
 316     | t ->
 317         prerr_endline ("unexpected ast: " ^ CicNotationPp.pp_term t);
 318         assert false
 319   and aux_attributes xmlattrs mathonly xref  prec t =
 320     let reset = ref false in
 321     let inferred_level = ref None in
 322     let expected_level = ref None in
 323     let new_xref = ref [] in
 324     let new_xmlattrs = ref [] in
 325 (*     let reinit = ref false in *)
 326     let rec aux_attribute =
 327       function
 328       | A.AttributedTerm (attr, t) ->
 329           (match attr with
 330           | `Loc _
 331           | `Raw _ -> ()
 332           | `Level (-1) -> reset := true
 333           | `Level child_prec ->
 334               assert (!expected_level = None);
 335               expected_level := !inferred_level;
 336               inferred_level := Some child_prec
 337           | `IdRef xref -> new_xref := xref :: !new_xref
 338           | `XmlAttrs attrs -> new_xmlattrs := attrs @ !new_xmlattrs);
 339           aux_attribute t
 340       | t ->
 341           let prec =
 342             match !expected_level with
 343             | None -> prec
 344             | Some prec -> prec
 345           in
 346           (match !inferred_level with
 347           | None -> aux !new_xmlattrs mathonly new_xref prec t
 348           | Some child_prec ->
 349               let t' =
 350                 aux !new_xmlattrs mathonly new_xref child_prec t in
 351               if !reset
 352               then t'
 353               else add_parens child_prec prec t')
 354     in
 355     aux_attribute t
 356   and aux_literal xmlattrs xref prec l =
 357     let attrs = make_href xmlattrs xref in
 358     (match l with
 359     | `Symbol s -> Mpres.Mo (attrs, to_unicode s)
 360     | `Keyword s -> Mpres.Mtext (attrs, to_unicode s)
 361     | `Number s  -> Mpres.Mn (attrs, to_unicode s))
 362   and aux_layout mathonly xref  prec l =
 363     let attrs = make_xref xref in
 364     let invoke' t = aux [] true (ref [])  prec t in
 365       (* use the one below to reset precedence and associativity *)
 366     let invoke_reinit t = aux [] mathonly xref ~-1 t in
 367     match l with
 368     | A.Sub (t1, t2) -> Mpres.Msub (attrs, invoke' t1, invoke_reinit t2)
 369     | A.Sup (t1, t2) -> Mpres.Msup (attrs, invoke' t1, invoke_reinit t2)
 370     | A.Below (t1, t2) -> Mpres.Munder (attrs, invoke' t1, invoke_reinit t2)
 371     | A.Above (t1, t2) -> Mpres.Mover (attrs, invoke' t1, invoke_reinit t2)
 372     | A.Frac (t1, t2)
 373     | A.Over (t1, t2) ->
 374         Mpres.Mfrac (attrs, invoke_reinit t1, invoke_reinit t2)
 375     | A.Atop (t1, t2) ->
 376         Mpres.Mfrac (atop_attributes @ attrs, invoke_reinit t1,
 377           invoke_reinit t2)
 378     | A.Sqrt t -> Mpres.Msqrt (attrs, invoke_reinit t)
 379     | A.Root (t1, t2) ->
 380         Mpres.Mroot (attrs, invoke_reinit t1, invoke_reinit t2)
 381     | A.Box ((_, spacing, _) as kind, terms) ->
 382         let children =
 383           aux_children mathonly spacing xref  prec
 384             (CicNotationUtil.ungroup terms)
 385         in
 386         box_of mathonly kind attrs children
 387     | A.Group terms ->
 388         let children =
 389           aux_children mathonly false xref  prec
 390             (CicNotationUtil.ungroup terms)
 391         in
 392         box_of mathonly (A.H, false, false) attrs children
 393     | A.Break -> assert false (* TODO? *)
 394   and aux_children mathonly spacing xref  prec terms =
 395     let find_clusters =
 396       let rec aux_list first clusters acc =
 397         function
 398             [] when acc = [] -> List.rev clusters
 399           | [] -> aux_list first (List.rev acc :: clusters) [] []
 400           | (A.Layout A.Break) :: tl when acc = [] ->
 401               aux_list first clusters [] tl
 402           | (A.Layout A.Break) :: tl ->
 403               aux_list first (List.rev acc :: clusters) [] tl
 404           | [hd] ->
 405                 aux_list false clusters
 406                   (aux [] mathonly xref  prec hd :: acc) []
 407           | hd :: tl ->
 408                 aux_list false clusters
 409                   (aux [] mathonly xref  prec hd :: acc) tl
 410       in
 411         aux_list true [] []
 412     in
 413     let boxify_pres =
 414       function
 415           [t] -> t
 416         | tl -> box_of mathonly (A.H, spacing, false) [] tl
 417     in
 418       List.map boxify_pres (find_clusters terms)
 419   in
 420   aux [] false (ref []) prec
 421
 422 let rec print_box (t: boxml_markup) =
 423   Box.box2xml print_mpres t
 424 and print_mpres (t: mathml_markup) =
 425   Mpresentation.print_mpres print_box t
 426
 427 let print_xml = print_mpres
 428
 429 (* let render_to_boxml id_to_uri t =
 430   let xml_stream = print_box (box_of_mpres (render id_to_uri t)) in
 431   Xml.add_xml_declaration xml_stream *)
 432