<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 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"><title>PXP Reference : Index of types</title>
</head>
<body>
<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Index of types</h1>
<table>
<tr><td align="left"><br>A</td></tr>
<tr><td><a href="Pxp_reader.html#TYPEaccepted_id">accepted_id</a> [<a href="Pxp_reader.html">Pxp_reader</a>]</td>
<td><div class="info">
When a resolver accepts an ID, this triple specifies how to proceed.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEatt_default">att_default</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Default value of an attribute
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEatt_default">att_default</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEatt_type">att_type</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Attribute declaration in a DTD
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEatt_type">att_type</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEatt_value">att_value</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Enumerates the possible values of an attribute: <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>., <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>., <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.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEatt_value">att_value</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td align="left"><br>C</td></tr>
<tr><td><a href="Pxp_reader.html#TYPEcombination_mode">combination_mode</a> [<a href="Pxp_reader.html">Pxp_reader</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_yacc.html#TYPEconfig">config</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#TYPEconfig"><code class="code"><span class="constructor">Pxp_types</span>.config</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#TYPEconfig">config</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEcontent_model_type">content_model_type</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Element declaration in a DTD
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEcontent_model_type">content_model_type</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td align="left"><br>D</td></tr>
<tr><td><a href="Pxp_document.html#TYPEdata_node_classification">data_node_classification</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
This type enumerates the result values of the method
<code class="code">classify_data_node</code>: <code class="code"><span class="constructor">CD_normal</span></code>: Adding <code class="code">n</code> does not violate any validation
constraint, <code class="code"><span class="constructor">CD_other</span></code>: <code class="code">n</code> is not a data node, <code class="code"><span class="constructor">CD_empty</span></code>: The element <code class="code">obj</code> is declared as <code class="code"><span class="constructor">EMTPY</span></code>, and
<code class="code">n</code> contains the empty string. It is allowed to append
<code class="code">n</code> but it does not make sense, <code class="code"><span class="constructor">CD_ignorable</span></code>: The element <code class="code">obj</code> is declared such that
it is forbidden to put character data into it. However,
the node <code class="code">n</code> only contains white space which is allowed
as an exception to this rule. This means that it is allowed
to append <code class="code">n</code> but <code class="code">n</code> would not contain any information
except formatting hints., <code class="code"><span class="constructor">CD_error</span> e</code>: It is an error to append <code class="code">n</code>. The exception
<code class="code">e</code>, usually a <code class="code"><span class="constructor">Validation_error</span></code>, contains details about
the problem.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEdtd_id">dtd_id</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Identifier for DTDs
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEdtd_id">dtd_id</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_event.html#TYPEdtd_style">dtd_style</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td></td></tr>
<tr><td align="left"><br>E</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEencoding">encoding</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><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).
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#TYPEentity">entity</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
The representation of entities
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#TYPEentity_id">entity_id</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
An <code class="code">entity_id</code> is an identifier for an entity, or a fake identifier.
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#TYPEentry">entry</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
Entry points for the parser (used to call <code class="code">process_entity</code>): <code class="code"><span class="keywordsign">`</span><span class="constructor">Entry_document</span></code>: The parser reads a complete document that
must have a DOCTYPE and may have a DTD., <code class="code"><span class="keywordsign">`</span><span class="constructor">Entry_declarations</span></code>: The parser reads the external subset
of a DTD, <code class="code"><span class="keywordsign">`</span><span class="constructor">Entry_element_content</span></code>:
The parser reads an entity containing contents, but there must
be one top element, i.e. "misc* element misc*". At the beginning,
there can be an XML declaration as for external entities., <code class="code"><span class="keywordsign">`</span><span class="constructor">Entry_content</span></code>:
The parser reads an entity containing contents, but without the
restriction of having a top element. At the beginning,
there can be an XML declaration as for external entities., <code class="code"><span class="keywordsign">`</span><span class="constructor">Entry_expr</span></code>: The parser reads a single element, a single
processing instruction or a single comment, or whitespace, whatever is
found. In contrast to the other entry points, the expression
need not to be a complete entity, but can start and end in
the middle of an entity
More entry points might be defined in the future.
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#TYPEevent">event</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
The type of XML events.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEext_id">ext_id</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
External identifiers are names for documents.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEext_id">ext_id</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td align="left"><br>F</td></tr>
<tr><td><a href="Pxp_event.html#TYPEfilter">filter</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
A filter transforms a pull function into another pull function
</div>
</td></tr>
<tr><td align="left"><br>L</td></tr>
<tr><td><a href="Pxp_reader.html#TYPElexer_source">lexer_source</a> [<a href="Pxp_reader.html">Pxp_reader</a>]</td>
<td><div class="info">
The parser chooses one of these ways of lexing the input into tokens.
</div>
</td></tr>
<tr><td align="left"><br>M</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEmixed_spec">mixed_spec</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Children of an element in "mixed"-style declaration
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEmixed_spec">mixed_spec</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td align="left"><br>N</td></tr>
<tr><td><a href="Pxp_document.html#TYPEnode_type">node_type</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
This type enumerates the possible node types: <code class="code"><span class="constructor">T_element</span> name</code>: The node is an element and has element type <code class="code">name</code>, <code class="code"><span class="constructor">T_data</span></code>: The node is a data node, <code class="code"><span class="constructor">T_super_root</span></code>: The node is a super root node, <code class="code"><span class="constructor">T_pinstr</span> name</code>: The node contains a processing instruction with
target <code class="code">name</code>, <code class="code"><span class="constructor">T_comment</span></code>: The node is a comment, <code class="code"><span class="constructor">T_attribute</span> name</code>: The node contains an attribute called <code class="code">name</code>, <code class="code"><span class="constructor">T_namespace</span> prefix</code>: The node identifies a namespace for the
normalized <code class="code">prefix</code>, <code class="code"><span class="constructor">T_none</span></code>: This is a "bottom value" used if there is no reasonable
type.
Note that attribute and namespace nodes can only live outside the
regular tree, and are only returned by special methods.
</div>
</td></tr>
<tr><td align="left"><br>O</td></tr>
<tr><td><a href="Pxp_document.html#TYPEord_index">ord_index</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
The type of ordinal indexes.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEoutput_stream">output_stream</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Designates an output destination for several printers: <code class="code"><span class="keywordsign">`</span><span class="constructor">Out_buffer</span> b</code>: Output to buffer <code class="code">b</code>, <code class="code"><span class="keywordsign">`</span><span class="constructor">Out_channel</span> ch</code>: Output to channel <code class="code">ch</code>, <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>., <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>
</div>
</td></tr>
<tr><td align="left"><br>P</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEpool">pool</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
A pool designates a way to increase string sharing
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEpool">pool</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEprivate_id">private_id</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
A private ID is an opaque identifier
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEprivate_id">private_id</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_event.html#TYPEpull_fn">pull_fn</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
The result type of <a href="Pxp_ev_parser.html#VALcreate_pull_parser"><code class="code"><span class="constructor">Pxp_ev_parser</span>.create_pull_parser</code></a>
</div>
</td></tr>
<tr><td align="left"><br>R</td></tr>
<tr><td><a href="Pxp_marshal.html#TYPEreconstruction_cmd">reconstruction_cmd</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
A tree is translated into a sequence of <code class="code">reconstrucion_cmd</code> tokens.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEregexp_spec">regexp_spec</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Children of an element in a regexp-style declaration
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEregexp_spec">regexp_spec</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPErep_encoding">rep_encoding</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
The subset of <code class="code">encoding</code> that may be used for the internal representation
of strings.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEresolver_id">resolver_id</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
A resolver ID is a version of external identifiers used during
resolving (i.e.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.A.html#TYPEresolver_id">resolver_id</a> [<a href="Pxp_core_types.A.html">Pxp_core_types.A</a>]</td>
<td></td></tr>
<tr><td align="left"><br>S</td></tr>
<tr><td><a href="Pxp_document.html#TYPEsolid_xml">solid_xml</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Solid XML can be a (sub)tree <code class="code"><span class="keywordsign">`</span><span class="constructor">Node</span> n</code>, or a closed <code class="code"><span class="keywordsign">`</span><span class="constructor">Document</span></code>
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#TYPEsource">source</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#TYPEsource"><code class="code"><span class="constructor">Pxp_types</span>.source</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#TYPEsource">source</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
The three basic flavours of sources: <code class="code"><span class="constructor">Entity</span>(m,r)</code> is a very low-level way of denoting a source. After the
parser has created the DTD object <code class="code">d</code>, it calls
<code class="code"> e = m d </code>
and uses the entity object <code class="code">e</code> together with the resolver <code class="code">r</code>. This kind
of <code class="code">source</code> is intended to implement customized versions of the entity
classes. Use it only if there is a strong need to do so., <code class="code"><span class="constructor">ExtID</span>(xid,r)</code> is the normal way of denoting a source. The external entity
referred to by the ID <code class="code">xid</code> is opened by using the resolver <code class="code">r</code>., <code class="code"><span class="constructor">XExtID</span>(xid,sys_base,r)</code> is an extension of <code class="code"><span class="constructor">ExtID</span></code>. The additional parameter
<code class="code">sys_base</code> is the base URI to assume if <code class="code">xid</code> is a relative URI (i.e.
a <code class="code"><span class="constructor">SYSTEM</span></code> ID).
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#TYPEspec">spec</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
The abstract data type of the document model specification.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#TYPEstripping_mode">stripping_mode</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
The different ways how to strip whitespace from a single
data node: <code class="code"><span class="keywordsign">`</span><span class="constructor">Strip_one_lf</span></code>: If there is a linefeed character at the beginning/at
the end, it will be removed. If there are more linefeed characters,
only the first/the last is removed.
(This is the SGML rule to strip whitespace.), <code class="code"><span class="keywordsign">`</span><span class="constructor">Strip_one</span></code>: If there is a whitespace character at the beginning/at
the end, it will be removed. If there are more whitespace characters,
only the first/the last is removed. Whitespace characters are space,
newline, carriage return, and tab., <code class="code"><span class="keywordsign">`</span><span class="constructor">Strip_seq</span></code>: All whitespace characters at the beginning/at the end are
removed., <code class="code"><span class="keywordsign">`</span><span class="constructor">Disabled</span></code>: Do not strip whitespace.
</div>
</td></tr>
<tr><td align="left"><br>W</td></tr>
<tr><td><a href="Pxp_core_types.S.html#TYPEwarning">warning</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Kinds of warnings
</div>
</td></tr>
</table>
</body>
</html>
