/usr/share/doc/libxml-light-ocaml-dev/html/api/XmlParser.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 | <!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="previous" 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"><title>XmlParser</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Xml.html" title="Xml">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Module <a href="type_XmlParser.html">XmlParser</a></h1>
<pre><span class="keyword">module</span> XmlParser: <code class="code">sig</code> <a href="XmlParser.html">..</a> <code class="code">end</code></pre><div class="info module top">
Xml Light Parser
<p>
While basic parsing functions can be used in the <a href="Xml.html"><code class="code">Xml</code></a> module, this module
is providing a way to create, configure and run an Xml parser.<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
Abstract type for an Xml parser.<br>
</div>
<pre><code><span id="TYPEsource"><span class="keyword">type</span> <code class="type"></code>source</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="TYPEELTsource.SFile"><span class="constructor">SFile</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="TYPEELTsource.SChannel"><span class="constructor">SChannel</span></span> <span class="keyword">of</span> <code class="type">Pervasives.in_channel</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="TYPEELTsource.SString"><span class="constructor">SString</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="TYPEELTsource.SLexbuf"><span class="constructor">SLexbuf</span></span> <span class="keyword">of</span> <code class="type">Lexing.lexbuf</code></code></td>
</tr></table>
<div class="info ">
Several kind of resources can contain Xml documents.<br>
</div>
<pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">unit -> <a href="XmlParser.html#TYPEt">t</a></code></pre><div class="info ">
This function returns a new parser with default options.<br>
</div>
<pre><span id="VALprove"><span class="keyword">val</span> prove</span> : <code class="type"><a href="XmlParser.html#TYPEt">t</a> -> bool -> unit</code></pre><div class="info ">
This function enable or disable automatic DTD proving with the parser.
Note that Xml documents having no reference to a DTD are never proved
when parsed (but you can prove them later using the <a href="Dtd.html"><code class="code">Dtd</code></a> module
<i>(by default, prove is true)</i>.<br>
</div>
<pre><span id="VALresolve"><span class="keyword">val</span> resolve</span> : <code class="type"><a href="XmlParser.html#TYPEt">t</a> -> (string -> <a href="Dtd.html#TYPEchecked">Dtd.checked</a>) -> unit</code></pre><div class="info ">
When parsing an Xml document from a file using the <a href="Xml.html#VALparse_file"><code class="code">Xml.parse_file</code></a>
function, the DTD file if declared by the Xml document has to be in the
same directory as the xml file. When using other parsing functions,
such as on a string or on a channel, the parser will raise everytime
<a href="Xml.html#EXCEPTIONFile_not_found"><code class="code">Xml.File_not_found</code></a> if a DTD file is needed and prove enabled. To enable
the DTD loading of the file, the user have to configure the Xml parser
with a <code class="code">resolve</code> function which is taking as argument the DTD filename and
is returning a checked DTD. The user can then implement any kind of DTD
loading strategy, and can use the <a href="Dtd.html"><code class="code">Dtd</code></a> module functions to parse and check
the DTD file <i>(by default, the resolve function is raising</i>
<a href="Xml.html#EXCEPTIONFile_not_found"><code class="code">Xml.File_not_found</code></a>).<br>
</div>
<pre><span id="VALcheck_eof"><span class="keyword">val</span> check_eof</span> : <code class="type"><a href="XmlParser.html#TYPEt">t</a> -> bool -> unit</code></pre><div class="info ">
When a Xml document is parsed, the parser will check that the end of the
document is reached, so for example parsing <code class="code">"<A/><B/>"</code> will fail instead
of returning only the A element. You can turn off this check by setting
<code class="code">check_eof</code> to <code class="code">false</code> <i>(by default, check_eof is true)</i>.<br>
</div>
<pre><span id="VALparse"><span class="keyword">val</span> parse</span> : <code class="type"><a href="XmlParser.html#TYPEt">t</a> -> <a href="XmlParser.html#TYPEsource">source</a> -> <a href="Xml.html#TYPExml">Xml.xml</a></code></pre><div class="info ">
Once the parser is configurated, you can run the parser on a any kind
of xml document source to parse its contents into an Xml data structure.<br>
</div>
<pre><span id="VALconcat_pcdata"><span class="keyword">val</span> concat_pcdata</span> : <code class="type"><a href="XmlParser.html#TYPEt">t</a> -> bool -> unit</code></pre><div class="info ">
When several PCData elements are separed by a \n (or \r\n), you can
either split the PCData in two distincts PCData or merge them with \n
as seperator into one PCData. The default behavior is to concat the
PCData, but this can be changed for a given parser with this flag.<br>
</div>
</body></html>
|