module XML:sig
..end
type
attrib
typeaname =
string
val int_attrib : aname -> int -> attrib
val string_attrib : aname -> string -> attrib
val space_sep_attrib : aname -> string list -> attrib
val comma_sep_attrib : aname -> string list -> attrib
val get_int_attrib : aname -> attrib list -> int
val get_string_attrib : aname -> attrib list -> string
val get_attrib_list : aname -> attrib list -> string list
type
elt
typeename =
string
val empty : unit -> elt
val comment : string -> elt
val pcdata : string -> elt
val entity : string -> elt
Neither comment
, pcdata
nor entity
check their argument for invalid
characters. Unsafe characters will be escaped later by the output routines.
val leaf : ?a:attrib list -> ename -> elt
val node : ?a:attrib list -> ename -> elt list -> elt
NB: Leaf ("foo", []) -> "<foo />"
, but Node ("foo", [], []) -> "<foo></foo>"
val encode_unsafe : string -> string
The encoder maps strings to HTML and must encode the unsafe characters
'<'
, '>'
, '"'
, '&'
and the control characters 0-8, 11-12, 14-31, 127
to HTML entities. encode_unsafe
is the default for ?encode
in output
and pretty_print
below. Other implementations are provided by the module
Netencoding
in the
OcamlNet library, e.g.:
let encode = Netencoding.Html.encode ~in_enc:`Enc_iso88591 ~out_enc:`Enc_usascii ()
,
Where national characters are replaced by HTML entities.
The user is of course free to write her own implementation.
val encode_unsafe_and_at : string -> string
In addition, encode "@"
as "@"
in the hope that this will fool
simple minded email address harvesters.
val output : ?preformatted:ename list ->
?no_break:ename list ->
?encode:(string -> string) -> (string -> unit) -> elt -> unit
val pretty_print : ?width:int ->
?preformatted:ename list ->
?no_break:ename list ->
?encode:(string -> string) -> (string -> unit) -> elt -> unit
Children of elements that are mentioned in no_break
do not
generate additional line breaks for pretty printing in order not to
produce spurious white space. In addition, elements that are mentioned
in preformatted
are not pretty printed at all, with all
white space intact.
val decl : ?version:string -> ?encoding:string -> (string -> unit) -> unit -> unit
encoding
is the name of the character encoding, e.g. "US-ASCII"
typeattribs =
attrib list
val amap : (ename -> attribs -> attribs) -> elt -> elt
Recursively edit attributes for the element and all its children.
val amap1 : (ename -> attribs -> attribs) -> elt -> elt
Edit attributes only for one element.
The following can safely be exported by higher level libraries, because removing an attribute from a element is always legal.
val rm_attrib : (aname -> bool) -> attribs -> attribs
val rm_attrib_from_list : (aname -> bool) -> (string -> bool) -> attribs -> attribs
val map_int_attrib : (aname -> bool) -> (int -> int) -> attribs -> attribs
val map_string_attrib : (aname -> bool) -> (string -> string) -> attribs -> attribs
val map_string_attrib_in_list : (aname -> bool) -> (string -> string) -> attribs -> attribs
Exporting the following by higher level libraries would drive a hole through a type system, because they allow to add any attribute to any element.
val add_int_attrib : aname -> int -> attribs -> attribs
val add_string_attrib : aname -> string -> attribs -> attribs
val add_comma_sep_attrib : aname -> string -> attribs -> attribs
val add_space_sep_attrib : aname -> string -> attribs -> attribs
val fold : (unit -> 'a) ->
(string -> 'a) ->
(string -> 'a) ->
(string -> 'a) ->
(ename -> attrib list -> 'a) ->
(ename -> attrib list -> 'a list -> 'a) -> elt -> 'a
val all_int_attribs : ?is_elt:(string -> bool) -> string -> elt -> int list
val all_string_attribs : ?is_elt:(string -> bool) -> string -> elt -> string list
val all_attribs_list : ?is_elt:(string -> bool) -> string -> elt -> string list list
val all_entities : elt -> string list
val translate : (ename -> attrib list -> elt) ->
(ename -> attrib list -> elt list -> elt) ->
('state -> ename -> attrib list -> elt list) ->
('state -> ename -> attrib list -> elt list -> elt list) ->
(ename -> attrib list -> 'state -> 'state) ->
'state -> elt -> elt