1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
(* virt-v2v
* Copyright (C) 2009-2023 Red Hat Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
(** Poor man's XML DOM, mutable for ease of modification. *)
type element
type doc = Doc of element
type attr = string * string
type node =
| PCData of string (** Text. *)
| Comment of string (** <!-- comment --> *)
| Element of element (** <element/> with attrs and children *)
val doc : string -> attr list -> node list -> doc
(** A quick way to create a document. *)
val e : string -> attr list -> node list -> node
(** A quick way to create elements.
Typical use is:
{v
e "foo" [] [
e "bar" [] []
e "baz" [ "a", "b"; "c", "d"] []
]
v}
which creates the following OCaml tree structure:
{v
Element {
e_name = "foo";
e_attrs = [];
e_children = [
Element { e_name = "bar"; ... };
Element { e_name = "baz"; e_attrs = [ "a", "b"; "c", "d" ]; ... };
]
}
v}
which corresponds to the following XML:
{v
<foo>
<bar/>
<baz a="b" c="d"/>
</foo>
v}
*)
val doc_to_string : doc -> string
(** Convert a document to a string representation. *)
val doc_to_chan : out_channel -> doc -> unit
(** Write the XML document to an output channel. *)
val path_to_nodes : doc -> string list -> node list
(** Search down the path and return a list of all matching elements.
Returns an empty list if none were found. *)
val filter_node_list_by_attr : node list -> attr -> node list
(** Find DOM elements which have a particular attribute name=value (not
recursively). If not found, returns an empty list. *)
val find_node_by_attr : node list -> attr -> node
(** Find the first DOM element which has a particular attribute
name=value (not recursively). If not found, raises
[Not_found]. *)
val append_attr : attr -> node -> unit
(** [element] must be an [Element _] node. [append_attr attr element]
appends [attr] to the attributes of [element].
This mutates [element]. *)
val append_child : node -> node -> unit
(** [element] must be an [Element _] node. [append_child child
element] appends [child] to the children of [element].
This mutates [element]. *)
|
