<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 values</title>
</head>
<body>
<center><h1>Index of values</h1></center>
<table>
<tr><td align="left"><br>A</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALallocate_private_id">allocate_private_id</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Get a new unique private ID
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALattribute_name">attribute_name</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">attribute_name n</code>
Returns the name of the attribute contained in an attribute
node.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALattribute_string_value">attribute_string_value</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">attribute_string_value n</code>:
Returns the string value of the attribute contained in an attribute
node.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALattribute_value">attribute_value</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">attribute_value n</code>:
Returns the value of the attribute contained in an attribute
node.
</div>
</td></tr>
<tr><td align="left"><br>C</td></tr>
<tr><td><a href="Pxp_ev_parser.html#VALclose_entities">close_entities</a> [<a href="Pxp_ev_parser.html">Pxp_ev_parser</a>]</td>
<td><div class="info">
Closes all entities managed by this entity manager, and frees
operating system resources like open files.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcompare">compare</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">compare n1 n2</code>:
Returns -1 if <code class="code">n1</code> occurs before <code class="code">n2</code>, or +1 if <code class="code">n1</code> occurs
after <code class="code">n2</code>, or 0 if both nodes are identical.
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALconcat">concat</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
<code class="code"><span class="keyword">let</span> p = concat l</code>: The pull functions contained in the list <code class="code">l</code> are
concatenated, and a new pull function <code class="code">p</code> is created that pulls from
the functions of the list in turn (when one function indicates
the end of the events, it is continued with the next function in the
list).
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcreate_comment_node">create_comment_node</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">create_comment_node ~position spec dtd commentstring</code>:
Creates a new comment node from the exemplar contained in
<code class="code">spec</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcreate_data_node">create_data_node</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">create_data_node spec dtd datastring</code>:
Creates a new data node from the exemplar contained in <code class="code">spec</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.html#VALcreate_dtd">create_dtd</a> [<a href="Pxp_dtd.html">Pxp_dtd</a>]</td>
<td><div class="info">
Preferred way of creating a DTD.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcreate_element_node">create_element_node</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">create_element_node ~name_pool_for_attribute_values
~position ~valcheck ~att_values spec dtd eltype
att_list</code>:
Creates a new element node from the exemplar(s) contained in
<code class="code">spec</code>: The new node will be connected to the passed <code class="code">dtd</code>., The new node will have the element type <code class="code">eltype</code>., The attributes of the new node will be the concatenation of
<code class="code">att_list</code> and <code class="code">att_values</code>; <code class="code">att_list</code> passes attribute values
as strings while <code class="code">att_values</code> passes attribute values as
type <code class="code">att_value</code>, The source position is set to <code class="code">~position</code> (if passed), The <code class="code">~name_pool_for_attribute_values</code> will be used, if passed., If <code class="code">~valcheck = <span class="keyword">true</span></code> (the default), the attribute list is
immediately validated. If <code class="code">~valcheck = <span class="keyword">false</span></code>, the validation
is left out; in this case you can pass any element type and
and any attributes, and it does not matter whether and how
they are declared.
Even in well-formedness mode, it is ok to pass <code class="code">valcheck=<span class="keyword">true</span></code>
as this mode is implemented by weakening the validation
constraints in the DTD object.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd_parser.html#VALcreate_empty_dtd">create_empty_dtd</a> [<a href="Pxp_dtd_parser.html">Pxp_dtd_parser</a>]</td>
<td><div class="info">
Create an empty DTD.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALcreate_entity_id">create_entity_id</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Create a new abstract entity ID.
</div>
</td></tr>
<tr><td><a href="Pxp_ev_parser.html#VALcreate_entity_manager">create_entity_manager</a> [<a href="Pxp_ev_parser.html">Pxp_ev_parser</a>]</td>
<td><div class="info">
Creates an entity manager that is initialized with the toplevel
entity referenced by the source argument.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALcreate_external_entity">create_external_entity</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Creates a reference to an external entity.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALcreate_internal_entity">create_internal_entity</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Creates an internal entity.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.html#VALcreate_namespace_manager">create_namespace_manager</a> [<a href="Pxp_dtd.html">Pxp_dtd</a>]</td>
<td><div class="info">
Preferred way of creating a <code class="code">namespace_manager</code>
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.html#VALcreate_namespace_scope">create_namespace_scope</a> [<a href="Pxp_dtd.html">Pxp_dtd</a>]</td>
<td><div class="info">
Preferred way of creating a <code class="code">namespace_scope</code>
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALcreate_ndata_entity">create_ndata_entity</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Creates an NDATA entity.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcreate_no_node">create_no_node</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Creates a T_none node with limited functionality.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcreate_ord_index">create_ord_index</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">create_ord_index startnode</code>:
Creates an ordinal index for the subtree starting at <code class="code">startnode</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcreate_pinstr_node">create_pinstr_node</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">create_pinstr_node ~position spec dtd pi</code>:
Creates a new processing instruction node from the exemplar
contained in <code class="code">spec</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_ev_parser.html#VALcreate_pull_parser">create_pull_parser</a> [<a href="Pxp_ev_parser.html">Pxp_ev_parser</a>]</td>
<td><div class="info">
Invoke the event parser using the pull model.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALcreate_super_root_node">create_super_root_node</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">create_super_root_node ~position spec dtd</code>:
Creates a new super root node from the exemplar contained in
<code class="code">spec</code>.
</div>
</td></tr>
<tr><td align="left"><br>D</td></tr>
<tr><td><a href="Pxp_yacc.html#VALdefault_config">default_config</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#VALdefault_config"><code class="code"><span class="constructor">Pxp_types</span>.default_config</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#VALdefault_config">default_config</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
Default configuration.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALdefault_extension">default_extension</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_tree_parser.html#VALdefault_extension"><code class="code"><span class="constructor">Pxp_tree_parser</span>.default_extension</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_tree_parser.html#VALdefault_extension">default_extension</a> [<a href="Pxp_tree_parser.html">Pxp_tree_parser</a>]</td>
<td><div class="info">
A "null" extension; an extension that does not extend the functionality
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALdefault_namespace_config">default_namespace_config</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#VALdefault_namespace_config"><code class="code"><span class="constructor">Pxp_types</span>.default_namespace_config</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#VALdefault_namespace_config">default_namespace_config</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
<b>Deprecated.</b>
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALdefault_namespace_spec">default_namespace_spec</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_tree_parser.html#VALdefault_namespace_spec"><code class="code"><span class="constructor">Pxp_tree_parser</span>.default_namespace_spec</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_tree_parser.html#VALdefault_namespace_spec">default_namespace_spec</a> [<a href="Pxp_tree_parser.html">Pxp_tree_parser</a>]</td>
<td><div class="info">
Specifies that you want to use namespace, but not extensions
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALdefault_spec">default_spec</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_tree_parser.html#VALdefault_spec"><code class="code"><span class="constructor">Pxp_tree_parser</span>.default_spec</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_tree_parser.html#VALdefault_spec">default_spec</a> [<a href="Pxp_tree_parser.html">Pxp_tree_parser</a>]</td>
<td><div class="info">
Specifies that you do not want to use extensions.
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALdisplay_events">display_events</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
Writes the events to the <code class="code">output_stream</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALdocument_from_channel">document_from_channel</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
The same for documents.
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALdocument_from_cmd_sequence">document_from_cmd_sequence</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
The same for documents
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALdocument_to_channel">document_to_channel</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
The same for documents.
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALdocument_to_cmd_sequence">document_to_cmd_sequence</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
The same for documents
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALdrop_ignorable_whitespace_filter">drop_ignorable_whitespace_filter</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
This filter checks whether character data between elements in a
"regexp" or "non-PCDATA mixed" content model consists
only of whitespace, and, removes these whitespace characters from the event stream.
If the check fails, a <code class="code"><span class="constructor">WF_Error</span></code> will be raised.
</div>
</td></tr>
<tr><td align="left"><br>E</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALentity_id">entity_id</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Returns the abstract entity ID
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALextract">extract</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
<code class="code"><span class="keyword">let</span> next' = extract e next</code>:
Extracts a subexpression from the pull function <code class="code">next</code> prepended by <code class="code">e</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALextract_dtd_from_document_entity">extract_dtd_from_document_entity</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_dtd_parser.html#VALextract_dtd_from_document_entity"><code class="code"><span class="constructor">Pxp_dtd_parser</span>.extract_dtd_from_document_entity</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_dtd_parser.html#VALextract_dtd_from_document_entity">extract_dtd_from_document_entity</a> [<a href="Pxp_dtd_parser.html">Pxp_dtd_parser</a>]</td>
<td><div class="info">
Parses a closed document, i.e.
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALextract_prefix">extract_prefix</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
Returns the prefix in the name, or <code class="code"><span class="string">""</span></code> if there is no prefix.
</div>
</td></tr>
<tr><td align="left"><br>F</td></tr>
<tr><td><a href="Pxp_document.html#VALfind">find</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">find ~deeply f startnode</code>
Searches the first node in the tree below <code class="code">startnode</code> for which
the predicate f is true, and returns it.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALfind_all">find_all</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">find_all ~deeply f startnode</code>:
Searches all nodes in the tree below <code class="code">startnode</code> for which
the predicate f is true, and returns them.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALfind_all_elements">find_all_elements</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">find_all_elements ~deeply eltype startnode</code>:
Searches all elements in the tree below <code class="code">startnode</code>
having the element type <code class="code">eltype</code>, and returns them.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALfind_element">find_element</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">find_element ~deeply eltype startnode</code>:
Searches the first element in the tree below <code class="code">startnode</code>
that has the element type <code class="code">eltype</code>, and returns it.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALfrom_channel">from_channel</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#VALfrom_channel"><code class="code"><span class="constructor">Pxp_types</span>.from_channel</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#VALfrom_channel">from_channel</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
This function creates a source that reads the XML text from the
passed <code class="code">in_channel</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALfrom_external_source">from_external_source</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Creates an external entity that reads from the passed
<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_yacc.html#VALfrom_file">from_file</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#VALfrom_file"><code class="code"><span class="constructor">Pxp_types</span>.from_file</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#VALfrom_file">from_file</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
This source reads initially from the file whose name is passed as
string argument.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALfrom_obj_channel">from_obj_channel</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#VALfrom_obj_channel"><code class="code"><span class="constructor">Pxp_types</span>.from_obj_channel</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#VALfrom_obj_channel">from_obj_channel</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
Similar to <code class="code">from_channel</code>, but reads from an Ocamlnet netchannel
instead.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALfrom_string">from_string</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_types.html#VALfrom_string"><code class="code"><span class="constructor">Pxp_types</span>.from_string</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#VALfrom_string">from_string</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
Similar to <code class="code">from_channel</code>, but reads from a string.
</div>
</td></tr>
<tr><td align="left"><br>G</td></tr>
<tr><td><a href="Pxp_document.html#VALget_comment_exemplar">get_comment_exemplar</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_document.html#VALget_data_exemplar">get_data_exemplar</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_document.html#VALget_element_exemplar">get_element_exemplar</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALget_encoding">get_encoding</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Return the encoding of the internal representation of the entity
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALget_full_name">get_full_name</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
The full name includes the ID, too (for diagnostics messages)
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALget_name">get_name</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Return the name of the entity.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALget_notation">get_notation</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Returns the notation of NDATA entities, and None for the other
entity types
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALget_pinstr_exemplar">get_pinstr_exemplar</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
These functions just return the exemplars (or raise <code class="code"><span class="constructor">Not_found</span></code>).
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALget_resolver_id">get_resolver_id</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Returns the resolver ID for external entities, and None for other
entities.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALget_super_root_exemplar">get_super_root_exemplar</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALget_type">get_type</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Returns the type of the entity.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALget_xid">get_xid</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Returns the external ID for external and NDATA entities, and None
for internal entities
</div>
</td></tr>
<tr><td align="left"><br>I</td></tr>
<tr><td><a href="Pxp_event.html#VALiter">iter</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
<code class="code">iter f p</code>: The pull function <code class="code">p</code> is repeatedly called to get a
stream of events <code class="code">e</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALiter_tree">iter_tree</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">iter_tree ~pre ~post startnode</code>:
Iterates over the tree beginning at <code class="code">startnode</code>
using the following algorithm.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALiter_tree_sibl">iter_tree_sibl</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">iter_tree_sibl ~pre ~post startnode</code>:
Iterates over the tree beginning at <code class="code">startnode</code>
using the following algorithm.
</div>
</td></tr>
<tr><td align="left"><br>L</td></tr>
<tr><td><a href="Pxp_document.html#VALliquefy">liquefy</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
The converse of <code class="code">solidify</code>: The passed node or document is transformed
into an event stream.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALlookup">lookup</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Looks the entity up for an entitiy ID
</div>
</td></tr>
<tr><td align="left"><br>M</td></tr>
<tr><td><a href="Pxp_reader.html#VALmake_file_url">make_file_url</a> [<a href="Pxp_reader.html">Pxp_reader</a>]</td>
<td><div class="info">
This is a convenience function to create a file URL (for localhost).
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALmake_probabilistic_pool">make_probabilistic_pool</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><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.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALmake_spec_from_alist">make_spec_from_alist</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">make_spec_from_alist
~super_root_exemplar ~comment_exemplar ~default_pinstr_exemplar
~pinstr_alist ~data_exemplar ~default_element_exemplar
~element_alist
()</code>:
Creates a <code class="code">spec</code> from the arguments.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALmake_spec_from_mapping">make_spec_from_mapping</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">make_spec_from_mapping
~super_root_exemplar ~comment_exemplar ~default_pinstr_exemplar
~pinstr_mapping ~data_exemplar ~default_element_exemplar
~element_mapping
()</code>:
Creates a <code class="code">spec</code> from the arguments.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALmap_tree">map_tree</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">map_tree ~pre ~post startnode</code>
Maps the tree beginning at <code class="code">startnode</code> to a second tree
using the following algorithm.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALmap_tree_sibl">map_tree_sibl</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">map_tree_sibl ~pre ~post startnode</code>:
Maps the tree beginning at <code class="code">startnode</code> to a second tree
using the following algorithm.
</div>
</td></tr>
<tr><td align="left"><br>N</td></tr>
<tr><td><a href="Pxp_document.html#VALnamespace_display_prefix">namespace_display_prefix</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Returns the display prefix of a namespace node .
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALnamespace_normprefix">namespace_normprefix</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Returns the normprefix of a namespace node.
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALnamespace_split">namespace_split</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
<code class="code"><span class="keyword">let</span> (p,l) = namespace_split name</code>: Splits <code class="code">name</code> into the prefix
<code class="code">p</code> and the local name <code class="code">l</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALnamespace_uri">namespace_uri</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Retruns the namespace URI of a namespace node .
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALnorm_cdata_filter">norm_cdata_filter</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
This filter removes empty <code class="code"><span class="constructor">E_char_data</span></code> events, concatenates adjacent <code class="code"><span class="constructor">E_char_data</span></code> events
but does not touch any other parts of the event stream.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALnormalize">normalize</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Normalizes the tree denoted by <code class="code">startnode</code> such that
neither empty data nodes nor adjacent data nodes exist.
</div>
</td></tr>
<tr><td align="left"><br>O</td></tr>
<tr><td><a href="Pxp_event.html#VALof_list">of_list</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
<code class="code">of_list l</code>: Create a pull function fetching the events from <code class="code">l</code>
</div>
</td></tr>
<tr><td><a href="Pxp_types.html#VALopen_source">open_source</a> [<a href="Pxp_types.html">Pxp_types</a>]</td>
<td><div class="info">
Returns the resolver and the entity for a source.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALord_compare">ord_compare</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">ord_compare idx n1 n2</code>:
Compares two nodes like <code class="code">compare</code>:
Returns -1 if <code class="code">n1</code> occurs before <code class="code">n2</code>, or +1 if <code class="code">n1</code> occurs
after <code class="code">n2</code>, or 0 if both nodes are identical.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALord_number">ord_number</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Returns the ordinal number of the node, or raises <code class="code"><span class="constructor">Not_found</span></code>.
</div>
</td></tr>
<tr><td align="left"><br>P</td></tr>
<tr><td><a href="Pxp_yacc.html#VALparse_content_entity">parse_content_entity</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_tree_parser.html#VALparse_content_entity"><code class="code"><span class="constructor">Pxp_tree_parser</span>.parse_content_entity</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_tree_parser.html#VALparse_content_entity">parse_content_entity</a> [<a href="Pxp_tree_parser.html">Pxp_tree_parser</a>]</td>
<td><div class="info">
Parse a file representing a well-formed fragment of a document.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALparse_document_entity">parse_document_entity</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_tree_parser.html#VALparse_document_entity"><code class="code"><span class="constructor">Pxp_tree_parser</span>.parse_document_entity</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_tree_parser.html#VALparse_document_entity">parse_document_entity</a> [<a href="Pxp_tree_parser.html">Pxp_tree_parser</a>]</td>
<td><div class="info">
Parse a closed document,
and validate the contents of the document against the DTD contained
and/or referenced in the document.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALparse_dtd_entity">parse_dtd_entity</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_dtd_parser.html#VALparse_dtd_entity"><code class="code"><span class="constructor">Pxp_dtd_parser</span>.parse_dtd_entity</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_dtd_parser.html#VALparse_dtd_entity">parse_dtd_entity</a> [<a href="Pxp_dtd_parser.html">Pxp_dtd_parser</a>]</td>
<td><div class="info">
Parse an entity containing a DTD (external subset), and return this DTD.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALparse_wfcontent_entity">parse_wfcontent_entity</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_tree_parser.html#VALparse_wfcontent_entity"><code class="code"><span class="constructor">Pxp_tree_parser</span>.parse_wfcontent_entity</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_tree_parser.html#VALparse_wfcontent_entity">parse_wfcontent_entity</a> [<a href="Pxp_tree_parser.html">Pxp_tree_parser</a>]</td>
<td><div class="info">
Parse a file representing a well-formed fragment of a document.
</div>
</td></tr>
<tr><td><a href="Pxp_yacc.html#VALparse_wfdocument_entity">parse_wfdocument_entity</a> [<a href="Pxp_yacc.html">Pxp_yacc</a>]</td>
<td><div class="info">
Same as <a href="Pxp_tree_parser.html#VALparse_wfdocument_entity"><code class="code"><span class="constructor">Pxp_tree_parser</span>.parse_wfdocument_entity</code></a>
</div>
</td></tr>
<tr><td><a href="Pxp_tree_parser.html#VALparse_wfdocument_entity">parse_wfdocument_entity</a> [<a href="Pxp_tree_parser.html">Pxp_tree_parser</a>]</td>
<td><div class="info">
Parse a closed document, but do not
validate it.
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALpfilter">pfilter</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
Filters an event stream by a predicate
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALpinstr">pinstr</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">pinstr n</code>:
Returns the processing instruction contained in a
processing instruction node.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALpool_string">pool_string</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Tries to find the passed string in the pool; if the string is in the
pool, the pool string is returned.
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALprint_doc">print_doc</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_document.html#VALprint_node">print_node</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td></td></tr>
<tr><td><a href="Pxp_ev_parser.html#VALprocess_entity">process_entity</a> [<a href="Pxp_ev_parser.html">Pxp_ev_parser</a>]</td>
<td><div class="info">
Parses a document or a document fragment in push mode.
</div>
</td></tr>
<tr><td><a href="Pxp_ev_parser.html#VALprocess_expr">process_expr</a> [<a href="Pxp_ev_parser.html">Pxp_ev_parser</a>]</td>
<td><div class="info">
This is a special parsing function that corresponds to the entry
<code class="code"><span class="keywordsign">`</span><span class="constructor">Entry_expr</span></code>, i.e.
</div>
</td></tr>
<tr><td align="left"><br>R</td></tr>
<tr><td><a href="Pxp_marshal.html#VALrelocate_document">relocate_document</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
Creates a copy of the passed document by marshalling it, and
restoring the document.
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALrelocate_subtree">relocate_subtree</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
Creates a copy of the passed subtree by marshalling the tree, and
restoring the marshaled tree.
</div>
</td></tr>
<tr><td><a href="Pxp_dtd.Entity.html#VALreplacement_text">replacement_text</a> [<a href="Pxp_dtd.Entity.html">Pxp_dtd.Entity</a>]</td>
<td><div class="info">
Return the replacement text of the entity.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALresolver_id_of_ext_id">resolver_id_of_ext_id</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
The standard way of converting an ext_id into a resolver ID.
</div>
</td></tr>
<tr><td align="left"><br>S</td></tr>
<tr><td><a href="Pxp_document.html#VALsolidify">solidify</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
Reads the event stream by calling the <code class="code">unit<span class="keywordsign">-></span>event</code> function, and
creates a node tree according to config, dtd, spec.
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALstring_of_event">string_of_event</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
Returns a string representation of events, for debugging
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALstring_of_exn">string_of_exn</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Converts a PXP exception into a readable string
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALstring_of_warning">string_of_warning</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
Turn the warning into a human-readable message
</div>
</td></tr>
<tr><td><a href="Pxp_document.html#VALstrip_whitespace">strip_whitespace</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">strip_whitespace ~force ~left ~right ~delete_empty_nodes startnode</code>:
Modifies the passed tree in-place by the following rules: In general, whitespace stripping is not applied to nodes inside
an <code class="code">xml:space=<span class="string">"preserve"</span></code> region, unless <code class="code">~force:<span class="keyword">true</span></code> is passed
to the function (default is <code class="code">~force:<span class="keyword">false</span></code>). Only if whitespace
stripping is allowed, the following rules are carried out.
Note that the detection of regions with preserved whitespace takes
the parent nodes of the passed <code class="code">startnode</code> into account., If applied to a data node, whitespace at the beginning of the node
is removed according to <code class="code">~left</code>, and whitespace at the end of the node
is removed according to <code class="code">~right</code>., If applied to an element, whitespace at the beginning of the first
data subnode is removed according to <code class="code">~left</code>, and whitespace at the end
of the last data subnode is removed according to <code class="code">~right</code>. Furthermore,
these rules are recursively applied to all subelements (but not to
other node types)., If applied to the super root node, this node is treated as if it
were an element., Whitespace of other node types is left as-is, as whitespace occuring
in attributes., Option <code class="code">~delete_empty_nodes</code> (default true):
If data nodes become empty after removal of whitespace, they are
deleted from the XML tree.
Defaults: <code class="code">~force:<span class="keyword">false</span></code>, <code class="code">~left:<span class="keywordsign">`</span><span class="constructor">Disabled</span></code>, <code class="code">~right:<span class="keywordsign">`</span><span class="constructor">Disabled</span></code>
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALsubtree_from_channel">subtree_from_channel</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
Reconstructs the subtree from an <code class="code">in_channel</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALsubtree_from_cmd_sequence">subtree_from_cmd_sequence</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
Reconstructs the subtree from a sequence of <code class="code">reconstruction_cmd</code> values.
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALsubtree_to_channel">subtree_to_channel</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
<code class="code">subtree_to_channel ch n</code>:
The node <code class="code">n</code> is the root of the subtree to be marshaled; the external
representation is written to <code class="code">ch</code> (which must have been opened
in binary mode).
</div>
</td></tr>
<tr><td><a href="Pxp_marshal.html#VALsubtree_to_cmd_sequence">subtree_to_cmd_sequence</a> [<a href="Pxp_marshal.html">Pxp_marshal</a>]</td>
<td><div class="info">
<code class="code">subtree_to_cmd_sequence f n</code>:
The passed node <code class="code">n</code> is the root of the subtree to be marshaled.
</div>
</td></tr>
<tr><td align="left"><br>T</td></tr>
<tr><td><a href="Pxp_event.html#VALto_list">to_list</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
Fetch all events from the pull function, and return the corresponding
list of events.
</div>
</td></tr>
<tr><td align="left"><br>U</td></tr>
<tr><td><a href="Pxp_event.html#VALunwrap_document">unwrap_document</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
This filter removes the document wrapping from the stream
(see <a href="Intro_events.html#docs"><i>The wrapping for closed documents</i></a> for a definition what this is).
</div>
</td></tr>
<tr><td align="left"><br>V</td></tr>
<tr><td><a href="Pxp_document.html#VALvalidate">validate</a> [<a href="Pxp_document.html">Pxp_document</a>]</td>
<td><div class="info">
<code class="code">validate startnode</code>:
Validates the tree denoted by <code class="code">startnode</code>.
</div>
</td></tr>
<tr><td align="left"><br>W</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALwarn">warn</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><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.
</div>
</td></tr>
<tr><td><a href="Pxp_core_types.S.html#VALwrite">write</a> [<a href="Pxp_core_types.S.html">Pxp_core_types.S</a>]</td>
<td><div class="info">
<code class="code">write os s pos len</code>: Writes the string (portion) to the
buffer/channel/stream
</div>
</td></tr>
<tr><td><a href="Pxp_codewriter.html#VALwrite_document">write_document</a> [<a href="Pxp_codewriter.html">Pxp_codewriter</a>]</td>
<td><div class="info">
Writes O'Caml code to the <code class="code">out_channel</code> so that when the code
is compiled and executed, a fresh document is created with the
same contents as the passed document:
</div>
</td></tr>
<tr><td><a href="Pxp_event.html#VALwrite_events">write_events</a> [<a href="Pxp_event.html">Pxp_event</a>]</td>
<td><div class="info">
Writes the events to the <code class="code">output_stream</code>.
</div>
</td></tr>
<tr><td><a href="Pxp_codewriter.html#VALwrite_subtree">write_subtree</a> [<a href="Pxp_codewriter.html">Pxp_codewriter</a>]</td>
<td><div class="info">
Writes O'Caml code to the <code class="code">out_channel</code> so that when the code
is compiled and executed, a fresh tree is created with the
same contents as the passed tree:
</div>
</td></tr>
</table><br>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
d9c1887ff364dc87e282490223567c41
>
files
>
199
