Module `Xtmpl.Xml`Source

Regular XML trees

Sourcemodule SMap : Map.S with type key = string

Locations

Sourcetype pos = {

line : int;
bol : int;
char : int;
file : string option;

}

A position in a source (file, string, ...).

Sourceval pos : ?file:string -> line:int -> bol:int -> char:int -> unit -> pos

Sourcetype loc = {

loc_start : pos;
loc_stop : pos;

}

A location is a range defined by two positions.

Sourceval string_of_loc : loc -> string

Sourceval loc_sprintf : loc option -> ('a, unit, string) format -> 'a

Sourcetype 'a with_loc = 'a * loc option

Sourceval loc : pos -> pos -> loc

loc loc_start loc_stop creates a loc structure with the given positions.

Errors

Sourcetype error = loc * string

Sourceexception Error of error

Sourceval error : loc -> string -> 'a

Sourceval string_of_error : (loc * string) -> string

Names

Sourcetype name = string * string

Sourceval string_of_name : (string * string) -> string

Sourceval name_of_string : string -> string * string

name_of_string str cuts a name according to first ':' character. If no such character is found, return ("",str).

Sourcemodule Name_ord : Map.OrderedType with type t = name

Sourcemodule Name_map : Map.S with type key = name

Sourcemodule Name_set : Set.S with type elt = name

Sourcemodule SSet : Set.S with type elt = string

XML trees

Sourcetype cdata = {

loc : loc option;
text : string;
quoted : bool;

}

Sourcetype comment = {

loc : loc option;
comment : string;

}

Sourcetype proc_inst = {

loc : loc option;
app : name;
args : string;

}

Sourcetype 'a attributes = 'a Name_map.t

Sourcetype str_attributes = string with_loc attributes

Sourcetype xml_decl = {

loc : loc option;
atts : str_attributes;

}

Sourcetype doctype = {

loc : loc option;
name : name;
args : string;

}

Sourcetype node = {

loc : loc option;
name : name;
atts : str_attributes;
subs : tree list;

}

Sourceand tree =

| E of node
| D of cdata
| C of comment
| PI of proc_inst

Sourcetype prolog_misc =

| PC of comment
| PPI of proc_inst

Sourcetype prolog = {

decl : xml_decl option;
misc : prolog_misc list;
doctype : doctype option;

}

Sourcetype 'a doc = {

prolog : prolog;
elements : 'a list;

}

Constructors

Sourceval node : ?loc:loc -> name -> ?atts:str_attributes -> tree list -> tree

Sourceval cdata : ?loc:loc -> ?quoted:bool -> string -> tree

Sourceval comment : ?loc:loc -> string -> tree

Sourceval prolog_comment : ?loc:loc -> string -> prolog_misc

Sourceval pi : ?loc:loc -> name -> string -> tree

Sourceval prolog_pi : ?loc:loc -> name -> string -> prolog_misc

Sourceval xml_decl : ?loc:loc -> str_attributes -> xml_decl

Sourceval doctype : ?loc:loc -> name -> string -> doctype

Sourceval prolog : ?decl:xml_decl -> ?doctype:doctype -> prolog_misc list -> prolog

Sourceval doc : prolog -> tree list -> tree doc

Sourceval merge_cdata : cdata -> cdata -> cdata

Sourceval doctype_name : 'a doc -> name option

Input/output

Sourcetype parse_param = {

ignore_unclosed : bool;
(*
auto-close unclosed elements
*)
self_closing : SSet.t;
(*
self-closing elements
*)
entities : Uchar.t SMap.t;
(*
entity references to unescape to utf-8 chars
*)

}

Sourceval default_parse_param : parse_param

Default: no self-closing tags, unescape XML entities (amp, apos,quot, lt, gt). ignore_unclosed: false.

Sourceval xml_entities : Uchar.t SMap.t

mapping from XML entities to utf-8 code points

Sourceval html_entities : Uchar.t SMap.t

mapping from XML entities to utf-8 code points

mapping from HTML entities to utf-8 code points

Sourceval unescape : parse_param -> ?entities:bool -> string -> string

Unescape character references and entity references from parse_param.entities.

parameter entities
can be set to false not to unescape entity references.

Sourceval escape : ?quotes:bool -> string -> string

Replace the following characters: < by <, > by >, & by &. Also replace simple and double quotes by ' and " if quotes = true (which is false by default).

Sourceval from_string : ?param:parse_param -> ?pos_start:pos -> string -> tree list

Source

val from_channel : 
  ?param:parse_param ->
  ?pos_start:pos ->
  in_channel ->
  tree list

Sourceval from_file : ?param:parse_param -> string -> tree list

Source

val doc_from_string : 
  ?param:parse_param ->
  ?pos_start:pos ->
  string ->
  tree doc

Source

val doc_from_channel : 
  ?param:parse_param ->
  ?pos_start:pos ->
  in_channel ->
  tree doc

Sourceval doc_from_file : ?param:parse_param -> string -> tree doc

Sourceval to_string : tree list -> string

Sourceval doc_to_string : tree doc -> string

Attributes

Sourceval atts_empty : 'a attributes

Sourceval atts_of_list : ?atts:'a attributes -> (name * 'a) list -> 'a attributes

Same as Rewrite.atts_of_list but for generic attributes.

Sourceval atts_one : ?atts:'a attributes -> name -> 'a -> 'a attributes

Same as Rewrite.atts_one but for generic attributes.

Sourceval atts_remove : name -> 'a attributes -> 'a attributes

Same as Rewrite.atts_remove but for generic attributes.

Sourceval atts_replace : name -> 'a -> 'a attributes -> 'a attributes

Same as Rewrite.atts_replace but for generic attributes.

Sourceval get_att : 'a attributes -> name -> 'a option

Same as Rewrite.get_att but for generic attributes.

Sourceval opt_att : str_attributes -> ?def:string -> name -> string * loc option

Same as Rewrite.opt_att but for str_attributes.

Sourceval string_of_atts : str_attributes -> string

Return a string representation of the given str_attributes.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/xtmpl/Xtmpl/Xml/index.html

Module `Xtmpl.Xml`Source

Locations

Errors

Names

XML trees

Constructors

Input/output

Attributes

package xtmpl

Install

Dune Dependency

Authors

Maintainers

Sources

doc/xtmpl/Xtmpl/Xml/index.html

Module Xtmpl.XmlSource

Locations

Errors

Names

XML trees

Constructors

Input/output

Attributes

Module `Xtmpl.Xml`Source