Index of values


A
allocate_private_id [Pxp_type_anchor]
allocate_private_id [Pxp_core_types_type.CORE_TYPES]
Get a new unique private ID
attribute_name [Pxp_document]
<ID:val-attribute-name> <TYPE:fun> <CALL> attribute_name n <SIG> AUTO <DESCR> Returns the name of the attribute contained in an attribute node.
attribute_string_value [Pxp_document]
<ID:val-attribute-string-value> <TYPE:fun> <CALL> attribute_string_value n <SIG> AUTO <DESCR> Returns the string value of the attribute contained in an attribute node.
attribute_value [Pxp_document]
<ID:val-attribute-value> <TYPE:fun> <CALL> attribute_value n <SIG> AUTO <DESCR> Returns the value of the attribute contained in an attribute node.

C
compare [Pxp_document]
<ID:val-compare> <TYPE:fun> <CALL> compare n1 n2 <SIG> AUTO <DESCR> Returns -1 if n1 occurs before n2, or +1 if n1 occurs after n2, or 0 if both nodes are identical.
concat [Pxp_event]
Pull the events from the streams in turn
create [Pxp_dfa.Graph]
Creates an empty graph
create_comment_node [Pxp_document]
<ID:val-create-comment-node> <CALL> create_comment_node ~position spec dtd commentstring <SIG> AUTO <DESCR> Creates a new comment node from the exemplar contained in spec.
create_data_node [Pxp_document]
<ID:val-create-data-node> <TYPE:fun> <CALL> create_data_node spec dtd datastring <SIG> AUTO <DESCR> Creates a new data node from the exemplar contained in spec.
create_dtd [Pxp_dtd]
Preferred way of creating a DTD.
create_element_node [Pxp_document]
<ID:val-create-element-node> <CALL> create_element_node ~name_pool_for_attribute_values ~position ~valcheck ~att_values spec dtd eltype att_list <SIG> AUTO <DESCR> Creates a new element node from the exemplar(s) contained in spec: The new node will be connected to the passed dtd., The new node will have the element type eltype., The attributes of the new node will be the concatenation of att_list and att_values; att_list passes attribute values as strings while att_values passes attribute values as type att_value, The source position is set to ~position (if passed), The ~name_pool_for_attribute_values will be used, if passed., If ~valcheck = true (the default), the attribute list is immediately validated. If ~valcheck = false, 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. -- </ID>
create_empty_dtd [Pxp_dtd_parser]
Create an empty DTD
create_entity_id [Pxp_dtd.Entity]
Create a new abstract entity ID.
create_entity_manager [Pxp_ev_parser]
create_external_entity [Pxp_dtd.Entity]
Creates a reference to an external entity.
create_internal_entity [Pxp_dtd.Entity]
Creates an internal entity.
create_namespace_manager [Pxp_dtd]
Preferred way of creating a namespace_manager
create_namespace_scope [Pxp_dtd]
Preferred way of creating a namespace_scope
create_ndata_entity [Pxp_dtd.Entity]
Creates an NDATA entity.
create_no_node [Pxp_document]
Creates a T_none node with limited functionality NOTE: This function is conceptually broken and may be dropped in the future.
create_ord_index [Pxp_document]
<ID:val-create-ord-index> <TYPE:fun> <CALL> create_ord_index startnode <SIG> AUTO <DESCR> Creates an ordinal index for the subtree starting at startnode.
create_pinstr_node [Pxp_document]
<ID:val-create-pinstr-node> <CALL> create_pinstr_node ~position spec dtd pi <SIG> AUTO <DESCR> Creates a new processing instruction node from the exemplar contained in spec.
create_pull_parser [Pxp_ev_parser]
let next_event = create_pull_parser cfg entry mng in let ev = next_event()
create_super_root_node [Pxp_document]
<ID:val-create-super-root-node> <CALL> create_super_root_node ~position spec dtd <SIG> AUTO <DESCR> Creates a new super root node from the exemplar contained in spec.
crlf_index_from [Pxp_lib]
Returns the leftmost position >= i in the string of either a CR or a LF character.

D
default_config [Pxp_yacc]
now defined in Pxp_types
default_config [Pxp_types]
- Warnings are thrown away Error messages will contain line numbers, Neither T_super_root nor T_pinstr nor T_comment nodes are generated, The internal encoding is ISO-8859-1, The standalone declaration is checked, Element positions are stored, The IDREF pass is left out, If available, DFAs are used for validation, Only deterministic content models are accepted, Namespace processing is turned off
default_extension [Pxp_tree_parser]
A "null" extension; an extension that does not extend the functionality
default_extension [Pxp_yacc]
now defined in Pxp_tree_parser
default_namespace_config [Pxp_yacc]
now defined in Pxp_types
default_namespace_config [Pxp_types]
Same as default_config, but namespace processing is turned on
default_namespace_spec [Pxp_tree_parser]
Specifies that you want to use namespace, but not extensions
default_namespace_spec [Pxp_yacc]
now defined in Pxp_tree_parser
default_spec [Pxp_tree_parser]
Specifies that you do not want to use extensions.
default_spec [Pxp_yacc]
now defined in Pxp_tree_parser
dfa_of_regexp_content_model [Pxp_dfa]
Computes the DFA or raises Not_found if it does not exist
display_events [Pxp_event]
Writes the events to the output_stream.
document_from_channel [Pxp_marshal]
The same for documents.
document_from_cmd_sequence [Pxp_marshal]
document_to_channel [Pxp_marshal]
The same for documents.
document_to_cmd_sequence [Pxp_marshal]
drop_ignorable_whitespace_filter [Pxp_event]
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 WF_Error will be raised. This filter works only if the DTD found in the event stream actually contains element declarations.

E
entity_id [Pxp_dtd.Entity]
Returns the abstract entity ID
extract [Pxp_event]
let next' = extract e next: Extracts a subexpression from the stream next prepended by e.
extract_dtd_from_document_entity [Pxp_yacc]
now defined in Pxp_dtd_parser
extract_dtd_from_document_entity [Pxp_dtd_parser]
Parses a closed document, i.e.

F
find [Pxp_document]
<ID:val-find> <TYPE:fun> <CALL> find ~deeply f startnode <SIG> AUTO <DESCR> Searches the first node in the tree below startnode for which the predicate f is true, and returns it.
find_all [Pxp_document]
<ID:val-find-all> <CALL> find_all ~deeply f startnode <SIG> AUTO <DESCR> Searches all nodes in the tree below startnode for which the predicate f is true, and returns them.
find_all_elements [Pxp_document]
<ID:val-find-all-elements> <TYPE:fun> <CALL> find_all_elements ~deeply eltype startnode <SIG> AUTO <DESCR> Searches all elements in the tree below startnode having the element type eltype, and returns them.
find_element [Pxp_document]
<ID:val-find-element> <TYPE:fun> <CALL> find_element ~deeply eltype startnode <SIG> AUTO <DESCR> Searches the first element in the tree below startnode that has the element type eltype, and returns it.
follow_edge [Pxp_dfa.Graph]
Follows the edge starting in the passed vertex which is marked with the passed element type.
from_another_string_inplace [Pxp_lexing]
lexbuf: a buffer from a previous Lexing.from_string (or from_string_inplace).
from_channel [Pxp_yacc]
now defined in Pxp_types
from_channel [Pxp_types]
This function creates a source that reads the XML text from the passed in_channel.
from_channel [Pxp_lexing]
from_external_source [Pxp_dtd.Entity]
Creates an external entity that reads from the passed source
from_file [Pxp_yacc]
now defined in Pxp_types
from_file [Pxp_types]
The source is the file whose name is passed as string argument.
from_function [Pxp_lexing]
from_obj_channel [Pxp_yacc]
now defined in Pxp_types
from_obj_channel [Pxp_types]
Similar to from_channel, but reads from a netchannel instead.
from_string [Pxp_yacc]
now defined in Pxp_types
from_string [Pxp_types]
Similar to from_channel, but reads from a string.
from_string [Pxp_lexing]
from_string_inplace [Pxp_lexing]
Similar to Lexing.from_string, but does not copy the passed string intially

G
get_comment_exemplar [Pxp_document]
get_data_exemplar [Pxp_document]
get_element_exemplar [Pxp_document]
get_encoding [Pxp_dtd.Entity]
Return the encoding of the internal representation of the entity
get_full_name [Pxp_dtd.Entity]
The full name includes the ID, too (for diagnostics messages)
get_lexer_factory [Pxp_lexers]
Return the lexer factory that is able to handle the passed encoding.
get_lexer_set [Pxp_lexers]
DEPRECATED.
get_name [Pxp_dtd.Entity]
Return the name of the entity.
get_notation [Pxp_dtd.Entity]
Returns the notation of NDATA entities, and None for the other entity types
get_pinstr_exemplar [Pxp_document]
These functions just return the exemplars (or raise Not_found).
get_resolver_id [Pxp_dtd.Entity]
Returns the resolver ID for external entities, and None for other entities.
get_super_root_exemplar [Pxp_document]
get_type [Pxp_dtd.Entity]
Returns the type of the entity.
get_xid [Pxp_dtd.Entity]
Returns the external ID for external and NDATA entities, and None for internal entities TRAP: The external ID may be a relative SYSTEM ID, and it is not known to which base ID the relative ID must be resolved.

I
ingoing_edges [Pxp_dfa.Graph]
Returns the list of ingoing edges ending in the passed vertex
init [Pxp_lexers]
Add a new factory to the set of known factories
iter [Pxp_event]
Iterates over the events of the stream and calls the function
iter_tree [Pxp_document]
<ID:val-iter-tree> <TYPE:fun> <CALL> iter_tree ~pre ~post startnode <SIG> AUTO <DESCR> Iterates over the tree beginning at startnode using the following algorithm.
iter_tree_sibl [Pxp_document]
<ID:val-iter-tree-sibl> <TYPE:fun> <CALL> iter_tree_sibl ~pre ~post startnode <SIG> AUTO <DESCR> Iterates over the tree beginning at startnode using the following algorithm.

L
lexeme [Pxp_lexing]
lexeme_char [Pxp_lexing]
lexeme_len [Pxp_lexing]
liquefy [Pxp_document]
The converse of solidify: The passed node or document is transformed into an event stream.
lookup_public_id_as_file [Pxp_reader]
Same as the equally named class
lookup_public_id_as_string [Pxp_reader]
Same as the equally named class
lookup_system_id_as_file [Pxp_reader]
Same as the equally named class
lookup_system_id_as_string [Pxp_reader]
Same as the equally named class

M
make_context [Pxp_core_parser]
make_file_url [Pxp_reader]
make_probabilistic_pool [Pxp_type_anchor]
make_probabilistic_pool [Pxp_core_types_type.CORE_TYPES]
make_spec_from_alist [Pxp_document]
<ID:val-make-spec-from-alist> <TYPE:fun> <CALL> make_spec_from_alist ~super_root_exemplar ~comment_exemplar ~default_pinstr_exemplar ~pinstr_alist ~data_exemplar ~default_element_exemplar ~element_alist () <SIG> AUTO <DESCR> Creates a spec from the arguments.
make_spec_from_mapping [Pxp_document]
<ID:val-make-spec-from-mapping> <TYPE:fun> <CALL> make_spec_from_mapping ~super_root_exemplar ~comment_exemplar ~default_pinstr_exemplar ~pinstr_mapping ~data_exemplar ~default_element_exemplar ~element_mapping () <SIG> AUTO <DESCR> Creates a spec from the arguments.
map_tree [Pxp_document]
<ID:val-map-tree> <TYPE:fun> <CALL> map_tree ~pre ~post startnode <SIG> AUTO <DESCR> Maps the tree beginning at startnode to a second tree using the following algorithm.
map_tree_sibl [Pxp_document]
<ID:val-map-tree-sibl> <TYPE:fun> <CALL> map_tree_sibl ~pre ~post startnode <SIG> AUTO <DESCR> Maps the tree beginning at startnode to a second tree using the following algorithm.

N
namespace_display_prefix [Pxp_document]
namespace_normprefix [Pxp_document]
namespace_uri [Pxp_document]
These functions return the normprefix, the display prefix, and the URI stored in a namespace object.
new_edge [Pxp_dfa.Graph]
new_edge v_from etype v_to: Adds a new edge from vertex v_from to vertex v_to, marked with etype.
new_vertex [Pxp_dfa.Graph]
Adds a new vertex to the graph, and returns the vertex
norm_cdata_filter [Pxp_event]
This filter removes empty E_char_data events, concatenates adjacent E_char_data events but does not touch any other parts of the event stream.
normalize [Pxp_document]
<ID:val-normalize> <TYPE:fun> <CALL> normalize startnode <SIG> AUTO <DESCR> Normalizes the tree denoted by startnode such that neither empty data nodes nor adjacent data nodes exist.

O
of_list [Pxp_event]
Pull the events from the input list
only_whitespace [Pxp_lib]
Returns true if the string consists only of whitespace characters (space, tab, CR, LF)
open_source [Pxp_types]
Returns the resolver and the entity for a source.
ord_compare [Pxp_document]
<ID:val-ord-compare> <TYPE:fun> <CALL> ord_compare idx n1 n2 <SIG> AUTO <DESCR> Compares two nodes like compare: Returns -1 if n1 occurs before n2, or +1 if n1 occurs after n2, or 0 if both nodes are identical.
ord_number [Pxp_document]
Returns the ordinal number of the node, or raises Not_found.
outgoing_edges [Pxp_dfa.Graph]
Returns the list of outgoing edges starting in the passed vertex

P
parse_content_entity [Pxp_tree_parser]
Parse a file representing a well-formed fragment of a document.
parse_content_entity [Pxp_yacc]
now defined in Pxp_tree_parser
parse_document_entity [Pxp_tree_parser]
Parse a closed document, i.e.
parse_document_entity [Pxp_yacc]
now defined in Pxp_tree_parser
parse_dtd_entity [Pxp_yacc]
now defined in Pxp_dtd_parser
parse_dtd_entity [Pxp_dtd_parser]
Parse an entity containing a DTD (external subset), and return this DTD.
parse_wfcontent_entity [Pxp_tree_parser]
Parse a file representing a well-formed fragment of a document (see parse_content_entity).
parse_wfcontent_entity [Pxp_yacc]
now defined in Pxp_tree_parser
parse_wfdocument_entity [Pxp_tree_parser]
Parse a closed document (see parse_document_entity), but do not validate it.
parse_wfdocument_entity [Pxp_yacc]
now defined in Pxp_tree_parser
pfilter [Pxp_event]
Filters an event stream by a predicate
pinstr [Pxp_document]
<ID:val-pinstr> <TYPE:fun> <CALL> pinstr n <SIG> AUTO <DESCR> Returns the processing instruction contained in a processing instruction node.
pool_string [Pxp_type_anchor]
pool_string [Pxp_core_types_type.CORE_TYPES]
print_doc [Pxp_document]
print_node [Pxp_document]
process_entity [Pxp_ev_parser]
Parses a document or a document fragment.
process_expr [Pxp_ev_parser]
This is a special parsing function that corresponds to the entry Entry_expr, i.e.

R
relocate_document [Pxp_marshal]
Creates a copy of the passed document by marshalling it, and restoring the document.
relocate_subtree [Pxp_marshal]
Creates a copy of the passed subtree by marshalling the tree, and restoring the marshaled tree.
replacement_text [Pxp_dtd.Entity]
Return the replacement text of the entity.
resolver_id_of_ext_id [Pxp_core_types_type.CORE_TYPES]
The standard method of converting an ext_id into a resolver ID.

S
solidify [Pxp_document]
stack_create [Pxp_core_parser]
stack_pop [Pxp_core_parser]
stack_push [Pxp_core_parser]
stack_top [Pxp_core_parser]
string_of_exn [Pxp_core_types_type.CORE_TYPES]
string_of_lexers [Pxp_lexer_types]
string_of_tok [Pxp_lexer_types]
string_of_warning [Pxp_core_types_type.CORE_TYPES]
Turn the warning into a human-readable message
strip_whitespace [Pxp_document]
<ID:val-strip-whitespace> <TYPE:fun> <CALL> strip_whitespace ~force ~left ~right ~delete_empty_nodes startnode <SIG> AUTO <DESCR> Modifies the passed tree in-place by the following rules: In general, whitespace stripping is not applied to nodes inside an xml:space="preserve" region, unless ~force:true is passed to the function (default is ~force:false). 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 startnode into account., If applied to a data node, whitespace at the beginning of the node is removed according to ~left, and whitespace at the end of the node is removed according to ~right., If applied to an element, whitespace at the beginning of the first data subnode is removed according to ~left, and whitespace at the end of the last data subnode is removed according to ~right. 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 ~delete_empty_nodes (default true): If data nodes become empty after removal of whitespace, they are deleted from the XML tree. -- Defaults: ~force:false, ~left:`Disabled, ~right:`Disabled </ID>
sub_lexeme [Pxp_lexing]
Same as String.sub (Lexing.lexeme lexbuf) k l, but avoids one string allocation
subtree_from_channel [Pxp_marshal]
Reconstructs the subtree from an in_channel.
subtree_from_cmd_sequence [Pxp_marshal]
Reconstructs the subtree from a sequence of reconstruction_cmd values.
subtree_to_channel [Pxp_marshal]
The passed node is the root of the subtree to be marshaled; the external representation is written to the out_channel (which must have been opened in binary mode).
subtree_to_cmd_sequence [Pxp_marshal]
The passed node is the root of the subtree to be marshaled.

T
to_list [Pxp_event]
Fetch all events from the event stream, and return the corresponding list of events.

U
union [Pxp_dfa.Graph]
union g1 g2: Moves the vertexes and edged found in g2 to g1.

V
validate [Pxp_document]
<ID:val-validate> <TYPE:fun> <CALL> validate startnode <SIG> AUTO <DESCR> Validates the tree denoted by startnode.

W
warn [Pxp_core_types_type.CORE_TYPES]
Send a warning to the symbolic_warnings object, and then to the collect_warnings object.
write [Pxp_core_types_type.CORE_TYPES]
write_document [Pxp_codewriter]
Writes O'Caml code to the out_channel that is a top-level function creating a fresh document which is equal to the passed document:
write_events [Pxp_event]
Writes the events to the output_stream.
write_subtree [Pxp_codewriter]
Writes O'Caml code to the out_channel that is a top-level function creating a fresh node tree which is equal to the passed tree: