1 (***********************************************************************)
5 (* Kim Nguyen, LRI UMR8623 *)
6 (* Université Paris-Sud & CNRS *)
8 (* Copyright 2010-2012 Université Paris-Sud and Centre National de la *)
9 (* Recherche Scientifique. All rights reserved. This file is *)
10 (* distributed under the terms of the GNU Lesser General Public *)
11 (* License, with the special exception on linking described in file *)
14 (***********************************************************************)
16 (** Implementation of documents as binary trees *)
19 (** The type of a tree node *)
22 (** The type of trees *)
25 (** Nil node, denoting the first/second child of a leaf or the parent of
29 (** Dummy node that is guaranteed to never occur in any tree *)
31 val load_xml_file : in_channel -> t
32 (** Takes a file descriptor and returns the XML data stored in the
33 corresponding file. Start at the current position in the file
34 descriptor (which is not necessarily the begining of file)
37 val load_xml_string : string -> t
38 (** Loads XML data stored in a string *)
40 val print_xml : out_channel -> t -> node -> unit
41 (** Outputs the tree as an XML document on the given output_channel *)
45 (** Returns the root of the tree *)
47 val first_child : t -> node -> node
48 (** [first_child t n] returns the first child of node [n] in tree [t].
49 Returns [nil] if [n] is a leaf. Returns [nil] if [n == nil].
52 val next_sibling : t -> node -> node
53 (** [next_sibling t n] returns the next_sibling of node [n] in tree [t].
54 Returns [nil] if [n] is the last child of a node.
55 Returns [nil] if [n == nil].
58 val parent : t -> node -> node
59 (** [next_sibling t n] returns the parent of node [n] in tree [t].
60 Returns [nil] if [n] is the root of the tree.
61 Returns [nil] if [n == nil].
64 val tag : t -> node -> QName.t
65 (** Returns the label of a given node *)
67 val data : t -> node -> string
68 (** Returns the character data associated with a node.
69 The only node having character data are those whose label is
70 QName.text, QName.cdata_section or QName.comment
73 val preorder : t -> node -> int
74 (** Returns the position of a node in pre-order in the tree. The
75 root has preorder 0. [nil] has pre-order [-1].