PXP Reference : Index of values

# Index of values

A
allocate_private_id [Pxp_core_types.S] | Get a new unique private ID
C
close_entities [Pxp_ev_parser] | Closes all entities managed by this entity manager, and frees operating system resources like open files.
concat [Pxp_event] | `let p = concat l`: The pull functions contained in the list `l` are concatenated, and a new pull function `p` 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).
create_dtd [Pxp_dtd] | Preferred way of creating a DTD.
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] | Creates an entity manager that is initialized with the toplevel entity referenced by the source argument.
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_pull_parser [Pxp_ev_parser] | Invoke the event parser using the pull model.
D
default_extension [Pxp_tree_parser] | A "null" extension; an extension that does not extend the functionality
default_namespace_spec [Pxp_tree_parser] | Specifies that you want to use namespace, but not extensions
default_spec [Pxp_tree_parser] | Specifies that you do not want to use extensions.
display_events [Pxp_event] | Writes the events to the `output_stream`.
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.
E
entity_id [Pxp_dtd.Entity] | Returns the abstract entity ID
extract [Pxp_event] | `let next' = extract e next`: Extracts a subexpression from the pull function `next` prepended by `e`.
extract_dtd_from_document_entity [Pxp_dtd_parser] | Parses a closed document, i.e.
extract_prefix [Pxp_event] | Returns the prefix in the name, or `""` if there is no prefix.
F
from_external_source [Pxp_dtd.Entity] | Creates an external entity that reads from the passed `Pxp_types.source`
G
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_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_resolver_id [Pxp_dtd.Entity] | Returns the resolver ID for external entities, and None for other entities.
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
I
iter [Pxp_event] | `iter f p`: The pull function `p` is repeatedly called to get a stream of events `e`.
L
lookup [Pxp_dtd.Entity] | Looks the entity up for an entitiy ID
M
make_probabilistic_pool [Pxp_core_types.S] | 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.
N
namespace_split [Pxp_event] | `let (p,l) = namespace_split name`: Splits `name` into the prefix `p` and the local name `l`.
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.
O
of_list [Pxp_event] | `of_list l`: Create a pull function fetching the events from `l`
P
parse_content_entity [Pxp_tree_parser] | Parse a file representing a well-formed fragment of a document.
parse_document_entity [Pxp_tree_parser] | Parse a closed document, and validate the contents of the document against the DTD contained and/or referenced in the document.
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.
parse_wfdocument_entity [Pxp_tree_parser] | Parse a closed document, but do not validate it.
pfilter [Pxp_event] | Filters an event stream by a predicate
pool_string [Pxp_core_types.S] | Tries to find the passed string in the pool; if the string is in the pool, the pool string is returned.
process_entity [Pxp_ev_parser] | Parses a document or a document fragment in push mode.
process_expr [Pxp_ev_parser] | This is a special parsing function that corresponds to the entry ``Entry_expr`, i.e.
R
replacement_text [Pxp_dtd.Entity] | Return the replacement text of the entity.
resolver_id_of_ext_id [Pxp_core_types.S] | The standard way of converting an ext_id into a resolver ID.
S
string_of_event [Pxp_event] | Returns a string representation of events, for debugging
string_of_exn [Pxp_core_types.S] | Converts a PXP exception into a readable string
string_of_warning [Pxp_core_types.S] | Turn the warning into a human-readable message
T
to_list [Pxp_event] | Fetch all events from the pull function, and return the corresponding list of events.
U
unwrap_document [Pxp_event] | This filter removes the document wrapping from the stream (see The wrapping for closed documents for a definition what this is).
W
warn [Pxp_core_types.S] | Send a warning to the `symbolic_warnings` object, and then to the `collect_warnings` object.
write [Pxp_core_types.S] | `write os s pos len`: Writes the string (portion) to the buffer/channel/stream
write_document [Pxp_codewriter] | Writes O'Caml code to the `out_channel` so that when the code is compiled and executed, a fresh document is created with the same contents as 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` so that when the code is compiled and executed, a fresh tree is created with the same contents as the passed tree: