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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>pugixml: pugi::xml_document Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6-NO -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespacepugi.html">pugi</a>::<a class="el" href="classpugi_1_1xml__document.html">xml_document</a></div>
<h1>pugi::xml_document Class Reference</h1><!-- doxytag: class="pugi::xml_document" --><!-- doxytag: inherits="pugi::xml_node" -->Inheritance diagram for pugi::xml_document:<p><center><img src="classpugi_1_1xml__document__inherit__graph.png" border="0" usemap="#pugi_1_1xml__document__inherit__map" alt="Inheritance graph"></center>
<map name="pugi_1_1xml__document__inherit__map">
<area href="classpugi_1_1xml__node.html" shape="rect" coords="24,7,136,34" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for pugi::xml_document:<p><center><img src="classpugi_1_1xml__document__coll__graph.png" border="0" usemap="#pugi_1_1xml__document__coll__map" alt="Collaboration graph"></center>
<map name="pugi_1_1xml__document__coll__map">
<area href="classpugi_1_1xml__node.html" shape="rect" coords="17,98,129,125" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classpugi_1_1xml__document-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Document class (DOM tree root).
<p>
This class has noncopyable semantics (private copy ctor/assignment operator).
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8db801c1d42eaa9073d14dfafda84f37"></a><!-- doxytag: member="pugi::xml_document::xml_document" ref="8db801c1d42eaa9073d14dfafda84f37" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#8db801c1d42eaa9073d14dfafda84f37">xml_document</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default ctor, makes empty document. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16c086e679286271b0ccd4541d1c1290"></a><!-- doxytag: member="pugi::xml_document::~xml_document" ref="16c086e679286271b0ccd4541d1c1290" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#16c086e679286271b0ccd4541d1c1290">~xml_document</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dtor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#ea4dd8757cc94d3b262674609315afdd">load</a> (std::istream &stream, unsigned int options=<a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load document from stream. <a href="#ea4dd8757cc94d3b262674609315afdd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#77501ece75c709bfb4e479d7cf5f92e3">load</a> (const char *contents, unsigned int options=<a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load document from string. <a href="#77501ece75c709bfb4e479d7cf5f92e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#0362034d3715646568869514dbf8f419">load_file</a> (const char *name, unsigned int options=<a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load document from file. <a href="#0362034d3715646568869514dbf8f419"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#6df96142a186efcbd14a496cd1d54c71">parse</a> (char *xmlstr, unsigned int options=<a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the given XML string in-situ. <a href="#6df96142a186efcbd14a496cd1d54c71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#2742c9acf467f0d3e2651c25bed76634">parse</a> (const <a class="el" href="structpugi_1_1transfer__ownership__tag.html">transfer_ownership_tag</a> &, char *xmlstr, unsigned int options=<a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the given XML string in-situ (gains ownership). <a href="#2742c9acf467f0d3e2651c25bed76634"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#716c23429fcac408ee1073353056485d">save_file</a> (const char *name, const char *indent="\t", unsigned int flags=<a class="el" href="namespacepugi.html#325f48a35abbaeacdfd8b7fc9ed1713c">format_default</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save XML to file. <a href="#716c23429fcac408ee1073353056485d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="952fa74a00a02d64ab7600ac2c72fb4b"></a><!-- doxytag: member="pugi::xml_document::precompute_document_order" ref="952fa74a00a02d64ab7600ac2c72fb4b" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpugi_1_1xml__document.html#952fa74a00a02d64ab7600ac2c72fb4b">precompute_document_order</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute document order for the whole tree Sometimes this makes evaluation of XPath queries faster. <br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ea4dd8757cc94d3b262674609315afdd"></a><!-- doxytag: member="pugi::xml_document::load" ref="ea4dd8757cc94d3b262674609315afdd" args="(std::istream &stream, unsigned int options=parse_default)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool pugi::xml_document::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::istream & </td>
<td class="mdname" nowrap> <em>stream</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>options</em> = <code><a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a></code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load document from stream.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stream</em> </td><td>- stream with xml data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>- parsing options </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>success flag </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="77501ece75c709bfb4e479d7cf5f92e3"></a><!-- doxytag: member="pugi::xml_document::load" ref="77501ece75c709bfb4e479d7cf5f92e3" args="(const char *contents, unsigned int options=parse_default)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool pugi::xml_document::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>contents</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>options</em> = <code><a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a></code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load document from string.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>contents</em> </td><td>- input string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>- parsing options </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>success flag </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="0362034d3715646568869514dbf8f419"></a><!-- doxytag: member="pugi::xml_document::load_file" ref="0362034d3715646568869514dbf8f419" args="(const char *name, unsigned int options=parse_default)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool pugi::xml_document::load_file </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>options</em> = <code><a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a></code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load document from file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- file name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>- parsing options </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>success flag </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="6df96142a186efcbd14a496cd1d54c71"></a><!-- doxytag: member="pugi::xml_document::parse" ref="6df96142a186efcbd14a496cd1d54c71" args="(char *xmlstr, unsigned int options=parse_default)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool pugi::xml_document::parse </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname" nowrap> <em>xmlstr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>options</em> = <code><a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a></code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Parse the given XML string in-situ.
<p>
The string is modified; you should ensure that string data will persist throughout the document's lifetime. Although, document does not gain ownership over the string, so you should free the memory occupied by it manually.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xmlstr</em> </td><td>- readwrite string with xml data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>- parsing options </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>success flag </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="2742c9acf467f0d3e2651c25bed76634"></a><!-- doxytag: member="pugi::xml_document::parse" ref="2742c9acf467f0d3e2651c25bed76634" args="(const transfer_ownership_tag &, char *xmlstr, unsigned int options=parse_default)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool pugi::xml_document::parse </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structpugi_1_1transfer__ownership__tag.html">transfer_ownership_tag</a> & </td>
<td class="mdname" nowrap>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char * </td>
<td class="mdname" nowrap> <em>xmlstr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>options</em> = <code><a class="el" href="namespacepugi.html#d7c927d1c1752330637c3318b0d7b366">parse_default</a></code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Parse the given XML string in-situ (gains ownership).
<p>
The string is modified; document gains ownership over the string, so you don't have to worry about it's lifetime. Call example: doc.parse(transfer_ownership_tag(), string, options);<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xmlstr</em> </td><td>- readwrite string with xml data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>- parsing options </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>success flag </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="716c23429fcac408ee1073353056485d"></a><!-- doxytag: member="pugi::xml_document::save_file" ref="716c23429fcac408ee1073353056485d" args="(const char *name, const char *indent="\t", unsigned int flags=format_default)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool pugi::xml_document::save_file </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>indent</em> = <code>"\t"</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int </td>
<td class="mdname" nowrap> <em>flags</em> = <code><a class="el" href="namespacepugi.html#325f48a35abbaeacdfd8b7fc9ed1713c">format_default</a></code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Save XML to file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>- file name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>indent</em> </td><td>- indentation string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>- formatting flags </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>success flag </dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Wed Feb 21 22:19:52 2007 for pugixml by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
</body>
</html>
|
