Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add export streaming functions #223

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions implem/tyxml_html.ml
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,8 @@ module Make_printer = Xml_print.Make_typed(Tyxml_xml)(M)
include M
include P

module E = Xml_stream.Typed_export(Tyxml_xml)(M)
include E

let _pp = pp ()
let _pp_elt = pp_elt ()
8 changes: 8 additions & 0 deletions implem/tyxml_html.mli
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@ val pp_elt :
?encode:(string -> string) -> ?indent:bool -> unit ->
Format.formatter -> 'a elt -> unit

(** {2 Export} *)

(** [export l] converts the Tyxml elements [l] into a signal.
This signal is roughtly compatible with libraries to manipulate HTML
and SVG such as Markup and Lambdasoup.
*)
val export : 'a elt list -> Xml_stream.output Seq.t

(** Parametrized stream printer for Html documents.
@deprecated Use {!pp} instead.
*)
Expand Down
3 changes: 3 additions & 0 deletions implem/tyxml_svg.ml
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,8 @@ module Make_printer = Xml_print.Make_typed(Tyxml_xml)(M)
include M
include P

module E = Xml_stream.Typed_export(Tyxml_xml)(M)
include E

let _pp = pp ()
let _pp_elt = pp_elt ()
8 changes: 8 additions & 0 deletions implem/tyxml_svg.mli
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@ val pp_elt :
?encode:(string -> string) -> ?indent:bool -> unit ->
Format.formatter -> 'a elt -> unit

(** {2 Export} *)

(** [export l] converts the Tyxml elements [l] into a signal.
This signal is roughtly compatible with libraries to manipulate HTML
and SVG such as Markup and Lambdasoup.
*)
val export : 'a elt list -> Xml_stream.output Seq.t

(** Parametrized stream printer for Svg documents.
@deprecated Use {!pp} instead.
*)
Expand Down
5 changes: 4 additions & 1 deletion implem/tyxml_xml.ml
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,11 @@ include M
include Xml_print.Make_simple(M)(struct let emptytags = [] end)
[@@ocaml.warning "-3"]

include Xml_iter.Make(M)
module Iter = Xml_iter.Make(M)
include Iter
include Xml_print.Make_fmt(M)(struct let emptytags = [] end)

include Xml_stream.Import(M)
include Xml_stream.Export(struct include M include Iter end)

let print fmt x = print_list ~output:(Format.pp_print_string fmt) [x]
2 changes: 2 additions & 0 deletions implem/tyxml_xml.mli
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ include Xml_sigs.Pp

val of_seq : Xml_stream.signal Seq.t -> elt list

val to_seq : ?namespace:ename -> elt -> Xml_stream.output Seq.t
val to_seql : ?namespace:ename -> elt list -> Xml_stream.output Seq.t

(** {2 Iterators} *)

Expand Down
3 changes: 2 additions & 1 deletion lib/xml_sigs.mli
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,13 @@ end

module type Typed_xml = sig

module Xml : NoWrap
module Xml : T
module Info : Info

type 'a elt
type doc
val toelt : 'a elt -> Xml.elt
val toeltl : ('a elt) Xml.list_wrap -> Xml.elt Xml.list_wrap
val doc_toelt : doc -> Xml.elt

end
Expand Down
56 changes: 56 additions & 0 deletions lib/xml_stream.ml
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,59 @@ module Import
| _ -> raise Malformed_stream

end

(** Output *)

type output = [ signal | `Raw of string list ]

module Export
(Xml : Xml_sigs.Iterable)
= struct

let mk ~ns name = (ns, name)

let convert_attributes ~ns attributes =
attributes |> List.map @@ fun attribute ->
let value =
match Xml.acontent attribute with
| AFloat n -> Xml_print.string_of_number n
| AInt n -> string_of_int n
| AStr s -> s
| AStrL (Space, ss) -> String.concat " " ss
| AStrL (Comma, ss) -> String.concat ", " ss
in
(mk ~ns (Xml.aname attribute), value)

let (++) x l = Seq.Cons (x, l)
let rec mk_elt ~ns x q () : output Seq.node =
match Xml.content x with
| Empty -> q ()
| Comment s -> `Comment s ++ q
| EncodedPCDATA s -> `Raw [s] ++ q
| PCDATA s -> `Text [s] ++ q
| Entity s -> `Raw ["&"^s^";"] ++ q
| Leaf (name, attributes) ->
`Start_element (mk ~ns name, convert_attributes ~ns attributes) ++
fun () -> `End_element ++ q
| Node (name, attributes, children) ->
`Start_element (mk ~ns name, convert_attributes ~ns attributes) ++
mk_list ~ns children q
and mk_list ~ns l q () : output Seq.node =
match l with
| [] -> Seq.Nil
| h :: t -> mk_elt ~ns h (mk_list ~ns t q) ()

let to_seq ?(namespace="") xml : output Seq.t =
mk_elt ~ns:namespace xml Seq.empty
let to_seql ?(namespace="") l : output Seq.t =
mk_list ~ns:namespace l Seq.empty
end

module Typed_export
(Xml : Xml_sigs.Iterable)
(Typed_xml : Xml_sigs.Typed_xml with module Xml := Xml)
= struct
module E = Export(Xml)
let export l =
E.to_seql ~namespace:Typed_xml.Info.namespace @@ Typed_xml.toeltl l
end
25 changes: 24 additions & 1 deletion lib/xml_stream.mli
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,30 @@ type signal = [
]

exception Malformed_stream

module Import (Xml : Xml_sigs.T) : sig
val of_seq : signal Seq.t -> Xml.elt Xml.list_wrap
end

(** {2 Output} *)

type output = [ signal | `Raw of string list ]

module Typed_export
(Xml : Xml_sigs.Iterable)
(Typed_xml : Xml_sigs.Typed_xml with module Xml := Xml)
: sig

(** [export l] converts the Tyxml elements [l] into a signal.
This signal is roughtly compatible with libraries to manipulate HTML
and SVG such as Markup and Lambdasoup.
*)
val export : 'a Typed_xml.elt list -> output Seq.t
end

module Export
(Xml : Xml_sigs.Iterable)
: sig
val to_seq : ?namespace:string -> Xml.elt -> output Seq.t
val to_seql : ?namespace:string -> Xml.elt list -> output Seq.t
end