libxml-light-ocaml-dev 2.2-17 / usr / share / doc / libxml-light-ocaml-dev / html / api / Dtd.html

This file is indexed.

/usr/share/doc/libxml-light-ocaml-dev/html/api/Dtd.html is in libxml-light-ocaml-dev 2.2-17.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="next" href="Xml.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Dtd" rel="Chapter" href="Dtd.html">
<link title="Xml" rel="Chapter" href="Xml.html">
<link title="XmlParser" rel="Chapter" href="XmlParser.html"><link title="The DTD Types" rel="Section" href="#6_TheDTDTypes">
<link title="The DTD Functions" rel="Section" href="#6_TheDTDFunctions">
<link title="The DTD Exceptions" rel="Section" href="#6_TheDTDExceptions">
<title>Dtd</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;<a class="post" href="Xml.html" title="Xml">Next</a>
</div>
<h1>Module <a href="type_Dtd.html">Dtd</a></h1>

<pre><span class="keyword">module</span> Dtd: <code class="code">sig</code> <a href="Dtd.html">..</a> <code class="code">end</code></pre><div class="info module top">
Xml Light DTD
<p>

	This module provide several functions to create, check, and use DTD
	to prove Xml documents : <ul>
<li>using the DTD types, you can directly create your own DTD structure</li>
<li>the <a href="Dtd.html#VALcheck"><code class="code">Dtd.check</code></a> function can then be used to check that all DTD
		states have been declared, that no attributes are declared twice,
		and so on.</li>
<li>the <a href="Dtd.html#VALprove"><code class="code">Dtd.prove</code></a> function can be used to check an <a href="Xml.html"><code class="code">Xml</code></a> data
		structure with a checked DTD. The function will return the
		expanded Xml document or raise an exception if the DTD proving
		fails.</li>
</ul>

<p>

	<i>Note about ENTITIES:</i>
<p>

	While parsing Xml, PCDATA is always parsed and
	the Xml entities &amp;amp; &amp;gt; &amp;lt; &amp;apos; &amp;quot; are replaced by their
	corresponding ASCII characters. For Xml attributes, theses can be
	put between either double or simple quotes, and the backslash character
	can be used to escape inner quotes. There is no support for CDATA Xml
	nodes or PCDATA attributes declarations in DTD, and no support for
	user-defined entities using the ENTITY DTD element.<br>
</div>
<hr width="100%">
<br>
<h6 id="6_TheDTDTypes">The DTD Types</h6><br>

<pre><code><span id="TYPEdtd_child"><span class="keyword">type</span> <code class="type"></code>dtd_child</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_child.DTDTag"><span class="constructor">DTDTag</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_child.DTDPCData"><span class="constructor">DTDPCData</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_child.DTDOptional"><span class="constructor">DTDOptional</span></span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEdtd_child">dtd_child</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_child.DTDZeroOrMore"><span class="constructor">DTDZeroOrMore</span></span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEdtd_child">dtd_child</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_child.DTDOneOrMore"><span class="constructor">DTDOneOrMore</span></span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEdtd_child">dtd_child</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_child.DTDChoice"><span class="constructor">DTDChoice</span></span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEdtd_child">dtd_child</a> list</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_child.DTDChildren"><span class="constructor">DTDChildren</span></span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEdtd_child">dtd_child</a> list</code></code></td>

</tr></table>



<pre><code><span id="TYPEdtd_element_type"><span class="keyword">type</span> <code class="type"></code>dtd_element_type</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_element_type.DTDEmpty"><span class="constructor">DTDEmpty</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_element_type.DTDAny"><span class="constructor">DTDAny</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_element_type.DTDChild"><span class="constructor">DTDChild</span></span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEdtd_child">dtd_child</a></code></code></td>

</tr></table>



<pre><code><span id="TYPEdtd_attr_default"><span class="keyword">type</span> <code class="type"></code>dtd_attr_default</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_attr_default.DTDDefault"><span class="constructor">DTDDefault</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_attr_default.DTDRequired"><span class="constructor">DTDRequired</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_attr_default.DTDImplied"><span class="constructor">DTDImplied</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_attr_default.DTDFixed"><span class="constructor">DTDFixed</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr></table>



<pre><code><span id="TYPEdtd_attr_type"><span class="keyword">type</span> <code class="type"></code>dtd_attr_type</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_attr_type.DTDCData"><span class="constructor">DTDCData</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_attr_type.DTDNMToken"><span class="constructor">DTDNMToken</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_attr_type.DTDEnum"><span class="constructor">DTDEnum</span></span> <span class="keyword">of</span> <code class="type">string list</code></code></td>

</tr></table>



<pre><code><span id="TYPEdtd_item"><span class="keyword">type</span> <code class="type"></code>dtd_item</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_item.DTDAttribute"><span class="constructor">DTDAttribute</span></span> <span class="keyword">of</span> <code class="type">string * string * <a href="Dtd.html#TYPEdtd_attr_type">dtd_attr_type</a> * <a href="Dtd.html#TYPEdtd_attr_default">dtd_attr_default</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTdtd_item.DTDElement"><span class="constructor">DTDElement</span></span> <span class="keyword">of</span> <code class="type">string * <a href="Dtd.html#TYPEdtd_element_type">dtd_element_type</a></code></code></td>

</tr></table>



<pre><span id="TYPEdtd"><span class="keyword">type</span> <code class="type"></code>dtd</span> = <code class="type"><a href="Dtd.html#TYPEdtd_item">dtd_item</a> list</code> </pre>


<pre><span id="TYPEchecked"><span class="keyword">type</span> <code class="type"></code>checked</span> </pre>

<br>
<h6 id="6_TheDTDFunctions">The DTD Functions</h6><br>

<pre><span id="VALparse_file"><span class="keyword">val</span> parse_file</span> : <code class="type">string -> <a href="Dtd.html#TYPEdtd">dtd</a></code></pre><div class="info ">
Parse the named file into a Dtd data structure. Raise
	<a href="Xml.html#EXCEPTIONFile_not_found"><code class="code">Xml.File_not_found</code></a> if an error occured while opening the file. 
	Raise <a href="Dtd.html#EXCEPTIONParse_error"><code class="code">Dtd.Parse_error</code></a> if parsing failed.<br>
</div>

<pre><span id="VALparse_in"><span class="keyword">val</span> parse_in</span> : <code class="type">Pervasives.in_channel -> <a href="Dtd.html#TYPEdtd">dtd</a></code></pre><div class="info ">
Read the content of the in_channel and parse it into a Dtd data
 structure. Raise <a href="Dtd.html#EXCEPTIONParse_error"><code class="code">Dtd.Parse_error</code></a> if parsing failed.<br>
</div>

<pre><span id="VALparse_string"><span class="keyword">val</span> parse_string</span> : <code class="type">string -> <a href="Dtd.html#TYPEdtd">dtd</a></code></pre><div class="info ">
Parse the string containing a Dtd document into a Dtd data
 structure. Raise <a href="Dtd.html#EXCEPTIONParse_error"><code class="code">Dtd.Parse_error</code></a> if parsing failed.<br>
</div>

<pre><span id="VALcheck"><span class="keyword">val</span> check</span> : <code class="type"><a href="Dtd.html#TYPEdtd">dtd</a> -> <a href="Dtd.html#TYPEchecked">checked</a></code></pre><div class="info ">
Check the Dtd data structure declaration and return a checked
 DTD. Raise <a href="Dtd.html#EXCEPTIONCheck_error"><code class="code">Dtd.Check_error</code></a> if the DTD checking failed.<br>
</div>

<pre><span id="VALprove"><span class="keyword">val</span> prove</span> : <code class="type"><a href="Dtd.html#TYPEchecked">checked</a> -> string -> <a href="Xml.html#TYPExml">Xml.xml</a> -> <a href="Xml.html#TYPExml">Xml.xml</a></code></pre><div class="info ">
Prove an Xml document using a checked DTD and an entry point.
 The entry point is the first excepted tag of the Xml document,
 the returned Xml document has the same structure has the original
 one, excepted that non declared optional attributes have been set
 to their default value specified in the DTD.
 Raise <a href="Dtd.html#EXCEPTIONCheck_error"><code class="code">Dtd.Check_error</code></a> <code class="code">ElementNotDeclared</code> if the entry point
 is not found, raise <a href="Dtd.html#EXCEPTIONProve_error"><code class="code">Dtd.Prove_error</code></a> if the Xml document failed
 to be proved with the DTD.<br>
</div>

<pre><span id="VALto_string"><span class="keyword">val</span> to_string</span> : <code class="type"><a href="Dtd.html#TYPEdtd_item">dtd_item</a> -> string</code></pre><div class="info ">
Print a DTD element into a string. You can easily get a DTD
 document from a DTD data structure using for example
 <code class="code">String.concat "\n" (List.map Dtd.to_string) my_dtd</code><br>
</div>
<br>
<h6 id="6_TheDTDExceptions">The DTD Exceptions</h6><br>
<br>
There is three types of DTD excecptions : <ul>
<li><a href="Dtd.html#EXCEPTIONParse_error"><code class="code">Dtd.Parse_error</code></a> is raised when an error occured while
	parsing a DTD document into a DTD data structure.</li>
<li><a href="Dtd.html#EXCEPTIONCheck_error"><code class="code">Dtd.Check_error</code></a> is raised when an error occured while
	checking a DTD data structure for completeness, or when the
	prove entry point is not found when calling <a href="Dtd.html#VALprove"><code class="code">Dtd.prove</code></a>.</li>
<li><a href="Dtd.html#EXCEPTIONProve_error"><code class="code">Dtd.Prove_error</code></a> is raised when an error occured while
	proving an Xml document.</li>
</ul>

<p>

	Several string conversion functions are provided to enable you
	to report errors to the user.<br>

<pre><code><span id="TYPEparse_error_msg"><span class="keyword">type</span> <code class="type"></code>parse_error_msg</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparse_error_msg.InvalidDTDDecl"><span class="constructor">InvalidDTDDecl</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparse_error_msg.InvalidDTDElement"><span class="constructor">InvalidDTDElement</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparse_error_msg.InvalidDTDAttribute"><span class="constructor">InvalidDTDAttribute</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparse_error_msg.InvalidDTDTag"><span class="constructor">InvalidDTDTag</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTparse_error_msg.DTDItemExpected"><span class="constructor">DTDItemExpected</span></span></code></td>

</tr></table>



<pre><code><span id="TYPEcheck_error"><span class="keyword">type</span> <code class="type"></code>check_error</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTcheck_error.ElementDefinedTwice"><span class="constructor">ElementDefinedTwice</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTcheck_error.AttributeDefinedTwice"><span class="constructor">AttributeDefinedTwice</span></span> <span class="keyword">of</span> <code class="type">string * string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTcheck_error.ElementEmptyContructor"><span class="constructor">ElementEmptyContructor</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTcheck_error.ElementReferenced"><span class="constructor">ElementReferenced</span></span> <span class="keyword">of</span> <code class="type">string * string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTcheck_error.ElementNotDeclared"><span class="constructor">ElementNotDeclared</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr></table>



<pre><code><span id="TYPEprove_error"><span class="keyword">type</span> <code class="type"></code>prove_error</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprove_error.UnexpectedPCData"><span class="constructor">UnexpectedPCData</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprove_error.UnexpectedTag"><span class="constructor">UnexpectedTag</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprove_error.UnexpectedAttribute"><span class="constructor">UnexpectedAttribute</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprove_error.InvalidAttributeValue"><span class="constructor">InvalidAttributeValue</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprove_error.RequiredAttribute"><span class="constructor">RequiredAttribute</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprove_error.ChildExpected"><span class="constructor">ChildExpected</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprove_error.EmptyExpected"><span class="constructor">EmptyExpected</span></span></code></td>

</tr></table>



<pre><span id="TYPEparse_error"><span class="keyword">type</span> <code class="type"></code>parse_error</span> = <code class="type"><a href="Dtd.html#TYPEparse_error_msg">parse_error_msg</a> * <a href="Xml.html#TYPEerror_pos">Xml.error_pos</a></code> </pre>


<pre><span id="EXCEPTIONParse_error"><span class="keyword">exception</span> Parse_error</span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEparse_error">parse_error</a></code></pre>

<pre><span id="EXCEPTIONCheck_error"><span class="keyword">exception</span> Check_error</span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEcheck_error">check_error</a></code></pre>

<pre><span id="EXCEPTIONProve_error"><span class="keyword">exception</span> Prove_error</span> <span class="keyword">of</span> <code class="type"><a href="Dtd.html#TYPEprove_error">prove_error</a></code></pre>

<pre><span id="VALparse_error"><span class="keyword">val</span> parse_error</span> : <code class="type"><a href="Dtd.html#TYPEparse_error">parse_error</a> -> string</code></pre>
<pre><span id="VALcheck_error"><span class="keyword">val</span> check_error</span> : <code class="type"><a href="Dtd.html#TYPEcheck_error">check_error</a> -> string</code></pre>
<pre><span id="VALprove_error"><span class="keyword">val</span> prove_error</span> : <code class="type"><a href="Dtd.html#TYPEprove_error">prove_error</a> -> string</code></pre></body></html>

APT Browse - Built by Thomas Orozco.