Module vtd_xml::sys

Handmade FFI bindings to the C library (https://github.com/dlo9/vtd-xml-c).

Structs

VtdException

Enums

AutoPilot
Bool
Direction
ExceptionType
VTDGen
VTDNav	The VTD Navigator allows one to navigate XML document represented in VTD records and Location caches. There is one and only one cursor that you can navigate to any part of the tree.

Functions

apBind⚠
cloneNav_shim⚠	Clones the cursor. With ximpleware-2.12-c it doesn't seem to work (the cloned cursor isn't navigable). Use getCurrentIndex_shim and recoverNode_shim instead. Or duplicateNav_shim with recoverNode_shim.
createAutoPilot⚠
createAutoPilot2⚠
createVTDGen⚠
declareXPathNameSpace⚠	Declare prefix/URL binding. NB: prefix and url aren't copied, so they must live as long as AutoPilot lives.
duplicateNav_shim⚠
evalXPath⚠
freeAutoPilot⚠
freeVTDGen⚠
freeVTDNav_shim⚠
getAttrCount⚠	Return the attribute count of the element at the cursor position.
getAttrVal⚠	Get the token index of the attribute value given an attribute name. Returns -1 if the attribute wasn't found.
getCurrentDepth⚠	Get the depth (>=0) of the current element.
getCurrentIndex_shim⚠	The index of the element under the cursor. Can be used with toString to fetch the element name.
getNav⚠	Returns the VTDNav object after parsing, it also cleans internal state so VTDGen can process the next file.
getText⚠	This function returns of the token index of the type character data or CDATA. Notice that it is intended to support data orient XML (not mixed-content XML).
hasAttr⚠	Test whether current element has an attribute with the matching name.
iconv_close_shim⚠
iconv_open_shim⚠
iconv_shim⚠	Convert at most *INBYTESLEFT bytes from *INBUF according to the code conversion algorithm specified by CD and place up to OUTBYTESLEFT bytes in buffer at *OUTBUF.
is_errno_e2big⚠
is_errno_einval⚠
matchElement⚠	Test if the current element matches the given name.
parse⚠	Generating VTD tokens and Location cache info. One specifies whether the parsing is namespace aware or not.
parseFile⚠	Generating VTD tokens and Location cache info for an XML file.
recoverNode_shim⚠	This method takes a vtd index, and recover its correspondin node position, the index can only be of node type element, document, attribute name, attribute value or character data, or CDATA. */
selectLcDepth⚠
selectXPath⚠	This function selects the string representing XPath expression. Usually evalXPath is called afterwards. Return True is the XPath is valid.
setDoc⚠	Set the XMLDoc container.
toElement2_shim⚠	Move the cursor to the element according to the direction constants and the element name. If no such element, no position change and return false. "*" matches any element.
toElement_shim⚠	Move the cursor to the element according to the direction constants If no such element, no position change and return false.
toNormalizedString⚠	This method normalizes a token into a string in a way that resembles DOM. The leading and trailing white space characters will be stripped. The entity and character references will be resolved. Multiple whitespaces char will be collapsed into one.
toRawString⚠	Convert a token at the given index to a String. Built-in entity and char references not resolved. Entities and char references not expanded.
toString⚠	Convert a token at the given index to a String, (entities and char references resolved). An attribute name or an element name will get the UCS2 string of qualified name.
vtd_try_catch_shim⚠	Returns 0 on success and 1 if VTD exception was raised.

Type Definitions

Boolean
Iconv
UByte
UCSChar