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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleXMLUtils</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<h1 class="unit">Unit CastleXMLUtils</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Uses">Uses</a></td><td><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td>Types</td><td>Constants</td><td>Variables</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Various XML and DOM utilities.</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li>DOM</li><li><a href="CastleUtils.html">CastleUtils</a></li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleXMLUtils.EDOMAttributeMissing.html"><code>EDOMAttributeMissing</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleXMLUtils.TDOMElementHelper.html"><code>TDOMElementHelper</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleXMLUtils.EDOMChildElementError.html"><code>EDOMChildElementError</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleXMLUtils.TXMLElementIterator.html"><code>TXMLElementIterator</code></a></td>
<td class="itemdesc">Iterate over all children elements of given XML element.</td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleXMLUtils.TXMLElementFilteringIterator.html"><code>TXMLElementFilteringIterator</code></a></td>
<td class="itemdesc">Iterate over children elements of given XML element, that have matching TagName.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleXMLUtils.TXMLCDataIterator.html"><code>TXMLCDataIterator</code></a></td>
<td class="itemdesc">Iterate over all CDATA nodes of given XML element.</td>
</tr>
</table>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetAttribute">DOMGetAttribute</a></b>(const Element: TDOMElement; const AttrName: string; var Value: string): boolean; deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetCardinalAttribute">DOMGetCardinalAttribute</a></b>(const Element: TDOMElement; const AttrName: string; var Value: Cardinal): boolean; deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetIntegerAttribute">DOMGetIntegerAttribute</a></b>(const Element: TDOMElement; const AttrName: string; var Value: Integer): boolean; deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetSingleAttribute">DOMGetSingleAttribute</a></b>(const Element: TDOMElement; const AttrName: string; var Value: Single): boolean; deprecated;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetFloatAttribute">DOMGetFloatAttribute</a></b>(const Element: TDOMElement; const AttrName: string; var Value: <a href="CastleUtils.html#Float">Float</a>): boolean; deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetBooleanAttribute">DOMGetBooleanAttribute</a></b>(const Element: TDOMElement; const AttrName: string; var Value: boolean): boolean;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetOneChildElement">DOMGetOneChildElement</a></b>(const Element: TDOMElement): TDOMElement;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetChildElement">DOMGetChildElement</a></b>(const Element: TDOMElement; const ChildName: string; RaiseOnError: boolean): TDOMElement;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetTextData">DOMGetTextData</a></b>(const Element: TDOMElement): DOMString;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleXMLUtils.html#DOMGetTextChild">DOMGetTextChild</a></b>(const Element: TDOMElement; const ChildName: string): string;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleXMLUtils.html#FreeChildNodes">FreeChildNodes</a></b>(const ChildNodes: TDOMNodeList);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleXMLUtils.html#URLReadXML">URLReadXML</a></b>(out Doc: TXMLDocument; const URL: String);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleXMLUtils.html#URLReadXML">URLReadXML</a></b>(out Doc: TXMLDocument; const URL: String; const BlowFishKeyPhrase: string);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleXMLUtils.html#URLWriteXML">URLWriteXML</a></b>(Doc: TXMLDocument; const URL: String);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleXMLUtils.html#URLWriteXML">URLWriteXML</a></b>(Doc: TXMLDocument; const URL: String; const BlowFishKeyPhrase: string);</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetAttribute"></a><code>function <b>DOMGetAttribute</b>(const Element: TDOMElement; const AttrName: string; var Value: string): boolean; deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Retrieves from Element attribute Value and returns <code>True</code>, or (of there is no such attribute) returns <code>False</code> and does not modify Value. Value is a "var", not "out" param, because in the latter case it's guaranteed that the old Value will not be cleared.
<p> Deprecated, use Element.AttributeString instead.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetCardinalAttribute"></a><code>function <b>DOMGetCardinalAttribute</b>(const Element: TDOMElement; const AttrName: string; var Value: Cardinal): boolean; deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Like <a class="normal" href="CastleXMLUtils.html#DOMGetAttribute">DOMGetAttribute</a>, but reads Cardinal value.
<p> Deprecated, use Element.AttributeCardinal instead.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetIntegerAttribute"></a><code>function <b>DOMGetIntegerAttribute</b>(const Element: TDOMElement; const AttrName: string; var Value: Integer): boolean; deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Like <a class="normal" href="CastleXMLUtils.html#DOMGetAttribute">DOMGetAttribute</a>, but reads Integer value.
<p> Deprecated, use Element.AttributeInteger instead.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetSingleAttribute"></a><code>function <b>DOMGetSingleAttribute</b>(const Element: TDOMElement; const AttrName: string; var Value: Single): boolean; deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Like <a class="normal" href="CastleXMLUtils.html#DOMGetAttribute">DOMGetAttribute</a>, but reads Single value.
<p> Deprecated, use Element.AttributeSingle instead.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetFloatAttribute"></a><code>function <b>DOMGetFloatAttribute</b>(const Element: TDOMElement; const AttrName: string; var Value: <a href="CastleUtils.html#Float">Float</a>): boolean; deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Like <a class="normal" href="CastleXMLUtils.html#DOMGetAttribute">DOMGetAttribute</a>, but reads Float value.
<p> Deprecated, use Element.AttributeFloat instead.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetBooleanAttribute"></a><code>function <b>DOMGetBooleanAttribute</b>(const Element: TDOMElement; const AttrName: string; var Value: boolean): boolean;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Like <a class="normal" href="CastleXMLUtils.html#DOMGetAttribute">DOMGetAttribute</a>, but reads Boolean value. A boolean value is interpreted just like FPC's TXMLConfig objects: true is designated by word <code>true</code>, false by word <code>false</code>, case is ignored.
<p>If attribute exists but it's value is not <code>true</code> or <code>false</code>, then returns <code>False</code> and doesn't modify Value paramater. So behaves just like the attribute didn't exist.
<p> Deprecated, use Element.AttributeBoolean instead.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetOneChildElement"></a><code>function <b>DOMGetOneChildElement</b>(const Element: TDOMElement): TDOMElement;</code></td>
</tr>
<tr><td colspan="1">
<p>
This returns the <i>one and only</i> child element of this Element. If given Element has none or more than one child elements, returns <code>Nil</code>. This is handy for parsing XML in cases when you know that given element must contain exactly one other element in correct XML file.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetChildElement"></a><code>function <b>DOMGetChildElement</b>(const Element: TDOMElement; const ChildName: string; RaiseOnError: boolean): TDOMElement;</code></td>
</tr>
<tr><td colspan="1">
<p>
Searches children elements inside Element for element with given ChildName.
<p>For example
<p></p>
<pre class="preformatted">
<level>
<creatures>
...
</creatures>
<items>
...
</items>
</level>
</pre>
<p>
<p>If you pass as Element the <level> node, and 'items' as ChildNode, then the TDOMElement representing <items> will be returned. If given ChildName will not exist <i>or it will exist more than once (yes, that's checked)</i>, then will return <code>Nil</code> or raise <a class="normal" href="CastleXMLUtils.EDOMChildElementError.html">EDOMChildElementError</a> (depending on RaiseOnError).
<p></p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleXMLUtils.EDOMChildElementError.html">EDOMChildElementError</a></dt>
<dd>If child not found or found more than once and RaiseOnError</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetTextData"></a><code>function <b>DOMGetTextData</b>(const Element: TDOMElement): DOMString;</code></td>
</tr>
<tr><td colspan="1">
<p>
This returns the text data contained in this element.
<p>This is suitable if an element is supposed to contain only some text. It raises an error if an element contains any other element as child.
<p>It concatenates all text data nodes that are direct children of this element. So if there are no text data nodes, it returns empty string without raising any error.
<p>AFAIK it's uncommon but possible to have here more than one text node. Normally, more than one text nodes occur because they are separated by other child elements, but we already eliminated this possibility (i.e. we raise error in this case). Still, if you operated on DOM tree, e.g. deleted some elements, or inserted some text nodes, then I think it's possible that you will have more than one text node within this element. So this procedure should still work OK in this case.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DOMGetTextChild"></a><code>function <b>DOMGetTextChild</b>(const Element: TDOMElement; const ChildName: string): string;</code></td>
</tr>
<tr><td colspan="1">
<p>
Gets a child of Element named ChildName, and gets text data within this child.
<p>This is just a shortcut for <code><a class="normal" href="CastleXMLUtils.html#DOMGetTextData">DOMGetTextData</a>(<a class="normal" href="CastleXMLUtils.html#DOMGetChildElement">DOMGetChildElement</a>(Element, ChildName, true))</code>.
<p></p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleXMLUtils.EDOMChildElementError.html">EDOMChildElementError</a></dt>
<dd>If child not found or found more than once and RaiseOnError</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FreeChildNodes"></a><code>procedure <b>FreeChildNodes</b>(const ChildNodes: TDOMNodeList);</code></td>
</tr>
<tr><td colspan="1">
<p>
If needed, free result of TDOMElement.ChildNodes.
<p>This abstracts FPC DOM unit differences: </p>
<ul class="paragraph_spacing">
<li><p> For FPC <= 2.2.x, it was needed to call ChildNodes.Release when you're done with them.</p></li>
<li><p> For FPC trunk, you do not have to free them at all (since rev 13143), and their Release method doesn't exist (since rev 13113).</p></li>
</ul>
<p></p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="URLReadXML"></a><code>procedure <b>URLReadXML</b>(out Doc: TXMLDocument; const URL: String);</code></td>
</tr>
<tr><td colspan="1">
<p>
Replacements for standard ReadXMLFile and WriteXMLFile that operate on URLs. Optionally they can encrypt / decrypt content using BlowFish. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="URLReadXML"></a><code>procedure <b>URLReadXML</b>(out Doc: TXMLDocument; const URL: String; const BlowFishKeyPhrase: string);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="URLWriteXML"></a><code>procedure <b>URLWriteXML</b>(Doc: TXMLDocument; const URL: String);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="URLWriteXML"></a><code>procedure <b>URLWriteXML</b>(Doc: TXMLDocument; const URL: String; const BlowFishKeyPhrase: string);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:13</em>
</span>
</td></tr></table></body></html>
|
