<!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="Up" href="Pxp_core_types.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 class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Pxp_types" rel="Chapter" href="Pxp_types.html">
<link title="Pxp_document" rel="Chapter" href="Pxp_document.html">
<link title="Pxp_dtd" rel="Chapter" href="Pxp_dtd.html">
<link title="Pxp_tree_parser" rel="Chapter" href="Pxp_tree_parser.html">
<link title="Pxp_core_types" rel="Chapter" href="Pxp_core_types.html">
<link title="Pxp_ev_parser" rel="Chapter" href="Pxp_ev_parser.html">
<link title="Pxp_event" rel="Chapter" href="Pxp_event.html">
<link title="Pxp_dtd_parser" rel="Chapter" href="Pxp_dtd_parser.html">
<link title="Pxp_codewriter" rel="Chapter" href="Pxp_codewriter.html">
<link title="Pxp_marshal" rel="Chapter" href="Pxp_marshal.html">
<link title="Pxp_yacc" rel="Chapter" href="Pxp_yacc.html">
<link title="Pxp_reader" rel="Chapter" href="Pxp_reader.html">
<link title="Intro_trees" rel="Chapter" href="Intro_trees.html">
<link title="Intro_extensions" rel="Chapter" href="Intro_extensions.html">
<link title="Intro_namespaces" rel="Chapter" href="Intro_namespaces.html">
<link title="Intro_events" rel="Chapter" href="Intro_events.html">
<link title="Intro_resolution" rel="Chapter" href="Intro_resolution.html">
<link title="Intro_getting_started" rel="Chapter" href="Intro_getting_started.html">
<link title="Intro_advanced" rel="Chapter" href="Intro_advanced.html">
<link title="Intro_preprocessor" rel="Chapter" href="Intro_preprocessor.html">
<link title="Example_readme" rel="Chapter" href="Example_readme.html"><link title="Identifiers" rel="Section" href="#2_Identifiers">
<link title="Content models (in DTDs)" rel="Section" href="#2_ContentmodelsinDTDs">
<link title="Attribute value" rel="Section" href="#2_Attributevalue">
<link title="Warnings" rel="Section" href="#2_Warnings">
<link title="Encoding" rel="Section" href="#2_Encoding">
<link title="Exceptions" rel="Section" href="#2_Exceptions">
<link title="Output destination" rel="Section" href="#2_Outputdestination">
<link title="Pools" rel="Section" href="#2_Pools">
<title>PXP Reference : Pxp_core_types.S</title>
</head>
<body>
<div class="navbar"> <a class="up" href="Pxp_core_types.html" title="Pxp_core_types">Up</a>
</div>
<h1>Module type <a href="type_Pxp_core_types.S.html">Pxp_core_types.S</a></h1>
<pre><span class="keyword">module type</span> S = <code class="code"><span class="keyword">sig</span></code> <a href="Pxp_core_types.S.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><code class="code"><span class="constructor">S</span></code> is the signature of <code class="code"><span class="constructor">I</span></code>, defined below. <code class="code"><span class="constructor">S</span></code> is also included into
the interface of <a href="Pxp_types.html"><code class="code"><span class="constructor">Pxp_types</span></code></a>.
<p>
<b>User code must not refer directly to this module type! The definitions
are all also available in <a href="Pxp_types.html"><code class="code"><span class="constructor">Pxp_types</span></code></a>, and can be used from there!
</b><br>
<hr width="100%">
<pre><span class="keyword">module</span> <a href="Pxp_core_types.S.StringMap.html">StringMap</a>: <code class="type">Map.S</code><code class="type"> with type key = string</code></pre><div class="info">
For maps with string keys
</div>
<br>
<span id="2_Identifiers"><h2>Identifiers</h2></span><br>
<pre><span id="TYPEext_id"><span class="keyword">type</span> <code class="type"></code>ext_id</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEext_id">Pxp_core_types.A.ext_id</a></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="TYPEELText_id.System"><span class="constructor">System</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="TYPEELText_id.Public"><span class="constructor">Public</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="TYPEELText_id.Anonymous"><span class="constructor">Anonymous</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="TYPEELText_id.Private"><span class="constructor">Private</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEprivate_id">private_id</a></code></code></td>
</tr></table>
<div class="info">
External identifiers are names for documents. A <code class="code"><span class="constructor">System</span></code> identifier is
a URL. PXP (without extensions) only supports file URLs in the form
<code class="code">file:///directory/directory/.../file</code>. Note that the percent encoding
(% plus two hex digits) is supported in file URLs. A public identifier
can be looked up in a catalog to find a local copy of the file; this
type is mostly used for well-known documents (e.g. after
standardization). A public identifier can be accompanied by a
system identifier (<code class="code"><span class="constructor">Public</span>(pubid,sysid)</code>), but the system identifier
can be the empty string. The value <code class="code"><span class="constructor">Anonymous</span></code> should not be used
to identify a real document; it is more thought as a placeholder when
an ID is not yet known. <code class="code"><span class="constructor">Private</span></code> identifiers are used by PXP internally.
These identifiers have, unlike system or public IDs, no textual
counterparts.
<p>
The identifiers are encoded as UTF-8 strings.<br>
</div>
<pre><span id="TYPEprivate_id"><span class="keyword">type</span> <code class="type"></code>private_id</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEprivate_id">Pxp_core_types.A.private_id</a></code> </pre>
<div class="info">
A private ID is an opaque identifier<br>
</div>
<pre><span id="VALallocate_private_id"><span class="keyword">val</span> allocate_private_id</span> : <code class="type">unit -> <a href="Pxp_core_types.S.html#TYPEprivate_id">private_id</a></code></pre><div class="info">
Get a new unique private ID<br>
</div>
<pre><span id="TYPEresolver_id"><span class="keyword">type</span> <code class="type"></code>resolver_id</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEresolver_id">Pxp_core_types.A.resolver_id</a></code> = {</pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTresolver_id.rid_private">rid_private</span> :<code class="type"><a href="Pxp_core_types.S.html#TYPEprivate_id">private_id</a> option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTresolver_id.rid_public">rid_public</span> :<code class="type">string option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTresolver_id.rid_system">rid_system</span> :<code class="type">string option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTresolver_id.rid_system_base">rid_system_base</span> :<code class="type">string option</code>;</code></td>
</tr></table>
}
<div class="info">
A resolver ID is a version of external identifiers used during
resolving (i.e. the process of mapping the identifier to a real
resource). The same entity can have several names during resolving:
one private ID, one public ID, and one system ID. For resolving
system IDs, the base URL is also remembered (usually the system ID
of the opener of the entity).<br>
</div>
<pre><span id="VALresolver_id_of_ext_id"><span class="keyword">val</span> resolver_id_of_ext_id</span> : <code class="type"><a href="Pxp_core_types.S.html#TYPEext_id">ext_id</a> -> <a href="Pxp_core_types.S.html#TYPEresolver_id">resolver_id</a></code></pre><div class="info">
The standard way of converting an ext_id into a resolver ID.
A <code class="code"><span class="constructor">System</span></code> ID is turned into a <code class="code">resolver_id</code> where only <code class="code">rid_system</code> is
set. A <code class="code"><span class="constructor">Public</span></code> ID is turned into a <code class="code">resolver_id</code> where both <code class="code">rid_public</code>
and <code class="code">rid_system</code> are set. A <code class="code"><span class="constructor">Private</span></code> ID is turned into a <code class="code">resolver_id</code>
where only <code class="code">rid_private</code> is set. An <code class="code"><span class="constructor">Anonymous</span></code> ID is turned into a
<code class="code">resolver_id</code> without any value (all components are None).<br>
</div>
<pre><span id="TYPEdtd_id"><span class="keyword">type</span> <code class="type"></code>dtd_id</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEdtd_id">Pxp_core_types.A.dtd_id</a></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_id.External"><span class="constructor">External</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEext_id">ext_id</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >DTD is completely external</td><td class="typefieldcomment" align="left" valign="bottom" ><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_id.Derived"><span class="constructor">Derived</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEext_id">ext_id</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >DTD is derived from an external DTD</td><td class="typefieldcomment" align="left" valign="bottom" ><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_id.Internal"><span class="constructor">Internal</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >DTD is completely internal</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Identifier for DTDs<br>
</div>
<br>
<span id="2_ContentmodelsinDTDs"><h2>Content models (in DTDs)</h2></span><br>
<pre><span id="TYPEcontent_model_type"><span class="keyword">type</span> <code class="type"></code>content_model_type</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEcontent_model_type">Pxp_core_types.A.content_model_type</a></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="TYPEELTcontent_model_type.Unspecified"><span class="constructor">Unspecified</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >A specification of the model has not yet been
found</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTcontent_model_type.Empty"><span class="constructor">Empty</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Nothing is allowed as content</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTcontent_model_type.Any"><span class="constructor">Any</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Everything is allowed as content</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTcontent_model_type.Mixed"><span class="constructor">Mixed</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEmixed_spec">mixed_spec</a> list</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The contents consist of elements and <code class="code"><span class="constructor">PCDATA</span></code>
in arbitrary order. What is allowed in
particular is given as <code class="code">mixed_spec</code>.</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTcontent_model_type.Regexp"><span class="constructor">Regexp</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEregexp_spec">regexp_spec</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >The contents are elements following this
regular expression</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Element declaration in a DTD<br>
</div>
<pre><span id="TYPEmixed_spec"><span class="keyword">type</span> <code class="type"></code>mixed_spec</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEmixed_spec">Pxp_core_types.A.mixed_spec</a></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="TYPEELTmixed_spec.MPCDATA"><span class="constructor">MPCDATA</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">PCDATA</span></code> children are allowed</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTmixed_spec.MChild"><span class="constructor">MChild</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >This kind of Element is allowed</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Children of an element in "mixed"-style declaration<br>
</div>
<pre><span id="TYPEregexp_spec"><span class="keyword">type</span> <code class="type"></code>regexp_spec</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEregexp_spec">Pxp_core_types.A.regexp_spec</a></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="TYPEELTregexp_spec.Optional"><span class="constructor">Optional</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEregexp_spec">regexp_spec</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >subexpression?</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTregexp_spec.Repeated"><span class="constructor">Repeated</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEregexp_spec">regexp_spec</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >subexpression*</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTregexp_spec.Repeated1"><span class="constructor">Repeated1</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEregexp_spec">regexp_spec</a></code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >subexpression+</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTregexp_spec.Alt"><span class="constructor">Alt</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEregexp_spec">regexp_spec</a> list</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >subexpr1 | subexpr2 | ... | subexprN</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTregexp_spec.Seq"><span class="constructor">Seq</span></span> <span class="keyword">of</span> <code class="type"><a href="Pxp_core_types.S.html#TYPEregexp_spec">regexp_spec</a> list</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >subexpr1 , subexpr2 , ... , subexprN</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTregexp_spec.Child"><span class="constructor">Child</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >This kind of Element is allowed here</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Children of an element in a regexp-style declaration<br>
</div>
<pre><span id="TYPEatt_type"><span class="keyword">type</span> <code class="type"></code>att_type</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEatt_type">Pxp_core_types.A.att_type</a></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="TYPEELTatt_type.A_cdata"><span class="constructor">A_cdata</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">CDATA</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_id"><span class="constructor">A_id</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">ID</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_idref"><span class="constructor">A_idref</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">IDREF</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_idrefs"><span class="constructor">A_idrefs</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">IDREFS</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_entity"><span class="constructor">A_entity</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">ENTITY</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_entities"><span class="constructor">A_entities</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">ENTITIES</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_nmtoken"><span class="constructor">A_nmtoken</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">NMTOKEN</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_nmtokens"><span class="constructor">A_nmtokens</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">NMTOKENS</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_notation"><span class="constructor">A_notation</span></span> <span class="keyword">of</span> <code class="type">string list</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">NOTATION</span></code> (name1 | name2 | ... | nameN)</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_type.A_enum"><span class="constructor">A_enum</span></span> <span class="keyword">of</span> <code class="type">string list</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >(name1 | name2 | ... | nameN)</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Attribute declaration in a DTD<br>
</div>
<pre><span id="TYPEatt_default"><span class="keyword">type</span> <code class="type"></code>att_default</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEatt_default">Pxp_core_types.A.att_default</a></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="TYPEELTatt_default.D_required"><span class="constructor">D_required</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="keywordsign">#</span><span class="constructor">REQUIRED</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_default.D_implied"><span class="constructor">D_implied</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="keywordsign">#</span><span class="constructor">IMPLIED</span></code></td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_default.D_default"><span class="constructor">D_default</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >a value default -- the value is already expanded</td><td class="typefieldcomment" align="left" valign="bottom" ><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="TYPEELTatt_default.D_fixed"><span class="constructor">D_fixed</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">FIXED</span></code> value default -- the value is already expanded</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Default value of an attribute<br>
</div>
<br>
<span id="2_Attributevalue"><h2>Attribute value</h2></span><br>
<pre><span id="TYPEatt_value"><span class="keyword">type</span> <code class="type"></code>att_value</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEatt_value">Pxp_core_types.A.att_value</a></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="TYPEELTatt_value.Value"><span class="constructor">Value</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="TYPEELTatt_value.Valuelist"><span class="constructor">Valuelist</span></span> <span class="keyword">of</span> <code class="type">string 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="TYPEELTatt_value.Implied_value"><span class="constructor">Implied_value</span></span></code></td>
</tr></table>
<div class="info">
Enumerates the possible values of an attribute:<ul>
<li><code class="code"><span class="constructor">Value</span> s</code>: The attribute is declared as a non-list type, or the
attribute is undeclared; and the attribute is either defined with
value <code class="code"><span class="string">"s"</span></code>, or it is missing but has the default value <code class="code">s</code>.</li>
<li><code class="code">[<span class="constructor">Valuelist</span> [s1;...;sk]]</code>: The attribute is declared as a list type,
and the attribute is either defined with value <code class="code"><span class="string">"s1 ... sk"</span></code>
(space-separated words),
or it is missing but has the default value <code class="code"><span class="string">"s1 ... sk"</span></code>.</li>
<li><code class="code"><span class="constructor">Implied_value</span></code>: The attribute is declared without default value,
and there is no definition for the attribute.</li>
</ul>
<br>
</div>
<br>
<span id="2_Warnings"><h2>Warnings</h2></span><br>
<pre><span id="TYPEcollect_warnings"><span class="keyword">class type</span> <a href="Pxp_core_types.S.collect_warnings-c.html">collect_warnings</a></span> = <code class="code"><span class="keyword">object</span></code> <a href="Pxp_core_types.S.collect_warnings-c.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
This object is sometimes used for outputting user warnings
</div>
<pre><span name="TYPEdrop_warnings"><span class="keyword">class</span> <a href="Pxp_core_types.S.drop_warnings-c.html">drop_warnings</a></span> : <code class="type"></code><code class="type"><a href="Pxp_core_types.S.collect_warnings-c.html">collect_warnings</a></code></pre><div class="info">
Drop any warnings
</div>
<pre><span id="TYPEwarning"><span class="keyword">type</span> <code class="type"></code>warning</span> = <code class="type">[ `W_XML_version_not_supported of string<br> | `W_code_point_cannot_be_represented of int<br> | `W_element_mentioned_but_not_declared of string<br> | `W_entity_declared_twice of string<br> | `W_multiple_ATTLIST_declarations of string<br> | `W_multiple_attribute_declarations of string * string<br> | `W_name_is_reserved_for_extensions of string ]</code> </pre>
<div class="info">
Kinds of warnings<br>
</div>
<pre><span id="TYPEsymbolic_warnings"><span class="keyword">class type</span> <a href="Pxp_core_types.S.symbolic_warnings-c.html">symbolic_warnings</a></span> = <code class="code"><span class="keyword">object</span></code> <a href="Pxp_core_types.S.symbolic_warnings-c.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
This object is sometimes used for outputting user warnings
</div>
<pre><span id="VALstring_of_warning"><span class="keyword">val</span> string_of_warning</span> : <code class="type"><a href="Pxp_core_types.S.html#TYPEwarning">warning</a> -> string</code></pre><div class="info">
Turn the warning into a human-readable message<br>
</div>
<pre><span id="VALwarn"><span class="keyword">val</span> warn</span> : <code class="type"><a href="Pxp_core_types.S.symbolic_warnings-c.html">symbolic_warnings</a> option -><br> <a href="Pxp_core_types.S.collect_warnings-c.html">collect_warnings</a> -> <a href="Pxp_core_types.S.html#TYPEwarning">warning</a> -> unit</code></pre><div class="info">
Send a warning to the <code class="code">symbolic_warnings</code> object, and then to the
<code class="code">collect_warnings</code> object.<br>
</div>
<br>
<span id="2_Encoding"><h2>Encoding</h2></span><br>
<pre><span id="TYPEencoding"><span class="keyword">type</span> <code class="type"></code>encoding</span> = <code class="type">Netconversion.encoding</code> </pre>
<div class="info">
For the representation of external resources (files etc.)
we accept all encodings for character sets which are defined in
Netconversion (package netstring).<br>
</div>
<pre><span id="TYPErep_encoding"><span class="keyword">type</span> <code class="type"></code>rep_encoding</span> = <code class="type">[ `Enc_cp1006<br> | `Enc_cp437<br> | `Enc_cp737<br> | `Enc_cp775<br> | `Enc_cp850<br> | `Enc_cp852<br> | `Enc_cp855<br> | `Enc_cp856<br> | `Enc_cp857<br> | `Enc_cp860<br> | `Enc_cp861<br> | `Enc_cp862<br> | `Enc_cp863<br> | `Enc_cp864<br> | `Enc_cp865<br> | `Enc_cp866<br> | `Enc_cp869<br> | `Enc_cp874<br> | `Enc_iso88591<br> | `Enc_iso885910<br> | `Enc_iso885913<br> | `Enc_iso885914<br> | `Enc_iso885915<br> | `Enc_iso885916<br> | `Enc_iso88592<br> | `Enc_iso88593<br> | `Enc_iso88594<br> | `Enc_iso88595<br> | `Enc_iso88596<br> | `Enc_iso88597<br> | `Enc_iso88598<br> | `Enc_iso88599<br> | `Enc_koi8r<br> | `Enc_macroman<br> | `Enc_usascii<br> | `Enc_utf8<br> | `Enc_windows1250<br> | `Enc_windows1251<br> | `Enc_windows1252<br> | `Enc_windows1253<br> | `Enc_windows1254<br> | `Enc_windows1255<br> | `Enc_windows1256<br> | `Enc_windows1257<br> | `Enc_windows1258 ]</code> </pre>
<div class="info">
The subset of <code class="code">encoding</code> that may be used for the internal representation
of strings. The common property of the following encodings is that
they are ASCII-compatible - the PXP code relies on that.<br>
</div>
<br>
<span id="2_Exceptions"><h2>Exceptions</h2></span><br>
<pre><span id="EXCEPTIONValidation_error"><span class="keyword">exception</span> Validation_error</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
Violation of a validity constraint<br>
</div>
<pre><span id="EXCEPTIONWF_error"><span class="keyword">exception</span> WF_error</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
Violation of a well-formedness constraint<br>
</div>
<pre><span id="EXCEPTIONNamespace_error"><span class="keyword">exception</span> Namespace_error</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
Violation of a namespace constraint<br>
</div>
<pre><span id="EXCEPTIONError"><span class="keyword">exception</span> Error</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
Other error<br>
</div>
<pre><span id="EXCEPTIONCharacter_not_supported"><span class="keyword">exception</span> Character_not_supported</span></pre>
<pre><span id="EXCEPTIONAt"><span class="keyword">exception</span> At</span> <span class="keyword">of</span> <code class="type">(string * exn)</code></pre>
<div class="info">
The string is a description where the exn happened. The exn value can
again be <code class="code"><span class="constructor">At</span>(_,_)</code> (for example, when an entity within an entity causes
the error).<br>
</div>
<pre><span id="EXCEPTIONUndeclared"><span class="keyword">exception</span> Undeclared</span></pre>
<div class="info">
Indicates that no declaration is available and because of this every kind
of usage is allowed. (Raised by some DTD methods.)<br>
</div>
<pre><span id="EXCEPTIONMethod_not_applicable"><span class="keyword">exception</span> Method_not_applicable</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
Indicates that a method has been called that is not applicable for
the class. The argument is the name of the method.<br>
</div>
<pre><span id="EXCEPTIONNamespace_method_not_applicable"><span class="keyword">exception</span> Namespace_method_not_applicable</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
Indicates that the called method is a namespace method but that the
object does not support namespaces. The argument is the name of the method.<br>
</div>
<pre><span id="EXCEPTIONNot_competent"><span class="keyword">exception</span> Not_competent</span></pre>
<div class="info">
The resolver cannot open this kind of entity ID<br>
</div>
<pre><span id="EXCEPTIONNot_resolvable"><span class="keyword">exception</span> Not_resolvable</span> <span class="keyword">of</span> <code class="type">exn</code></pre>
<div class="info">
While opening the entity, the nested exception occurred<br>
</div>
<pre><span id="EXCEPTIONNamespace_not_managed"><span class="keyword">exception</span> Namespace_not_managed</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
A namespace URI is used but not declared in the namespace manager.
The string argument is the URI in question.<br>
</div>
<pre><span id="EXCEPTIONNamespace_prefix_not_managed"><span class="keyword">exception</span> Namespace_prefix_not_managed</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
A namespace prefix is used but not declared in the namespace manager.
The string argument is the prefix in question.<br>
</div>
<pre><span id="EXCEPTIONNamespace_not_in_scope"><span class="keyword">exception</span> Namespace_not_in_scope</span> <span class="keyword">of</span> <code class="type">string</code></pre>
<div class="info">
The namespace scope does not know the URI<br>
</div>
<pre><span id="VALstring_of_exn"><span class="keyword">val</span> string_of_exn</span> : <code class="type">exn -> string</code></pre><div class="info">
Converts a PXP exception into a readable string<br>
</div>
<br>
<span id="2_Outputdestination"><h2>Output destination</h2></span><br>
<pre><span id="TYPEoutput_stream"><span class="keyword">type</span> <code class="type"></code>output_stream</span> = <code class="type">[ `Out_buffer of Buffer.t<br> | `Out_channel of Pervasives.out_channel<br> | `Out_function of string -> int -> int -> unit<br> | `Out_netchannel of Netchannels.out_obj_channel ]</code> </pre>
<div class="info">
Designates an output destination for several printers:<ul>
<li><code class="code"><span class="keywordsign">`</span><span class="constructor">Out_buffer</span> b</code>: Output to buffer <code class="code">b</code></li>
<li><code class="code"><span class="keywordsign">`</span><span class="constructor">Out_channel</span> ch</code>: Output to channel <code class="code">ch</code></li>
<li><code class="code"><span class="keywordsign">`</span><span class="constructor">Out_function</span> f</code>: Output to function <code class="code">f</code>. The function <code class="code">f</code> is
used like <code class="code"><span class="constructor">Pervasives</span>.output_string</code>.</li>
<li><code class="code"><span class="keywordsign">`</span><span class="constructor">Out_netchannel</span> n</code>: Output to the ocamlnet channel <code class="code">n</code></li>
</ul>
<br>
</div>
<pre><span id="VALwrite"><span class="keyword">val</span> write</span> : <code class="type"><a href="Pxp_core_types.S.html#TYPEoutput_stream">output_stream</a> -> string -> int -> int -> unit</code></pre><div class="info">
<code class="code">write os s pos len</code>: Writes the string (portion) to the
buffer/channel/stream<br>
</div>
<br>
<span id="2_Pools"><h2>Pools</h2></span><br>
<pre><span id="TYPEpool"><span class="keyword">type</span> <code class="type"></code>pool</span> = <code class="type"><a href="Pxp_core_types.A.html#TYPEpool">Pxp_core_types.A.pool</a></code> </pre>
<div class="info">
A pool designates a way to increase string sharing<br>
</div>
<pre><span id="VALmake_probabilistic_pool"><span class="keyword">val</span> make_probabilistic_pool</span> : <code class="type">?fraction:float -> int -> <a href="Pxp_core_types.S.html#TYPEpool">pool</a></code></pre><div class="info">
A probalistic string pool tries to map strings to pool strings in order
to make it more likely that equal strings are stored in the same memory
block.
The int argument is the size of the pool; this is the number of entries
of the pool. However, not all entries of the pool are used; the fraction
argument (default: 0.3) determines the fraction of the actually used
entries. The higher the fraction is, the more strings can be managed
at the same time; the lower the fraction is, the more likely it is that
a new string can be added to the pool.<br>
</div>
<pre><span id="VALpool_string"><span class="keyword">val</span> pool_string</span> : <code class="type"><a href="Pxp_core_types.S.html#TYPEpool">pool</a> -> string -> string</code></pre><div class="info">
Tries to find the passed string in the pool; if the string is in the
pool, the pool string is returned. Otherwise, the function tries to
add the passed string to the pool, and the passed string is returned.<br>
</div>
</body></html>
