XSLTVM Interface

Table 13-2 summarizes the methods of available through the XSLTVM Interface.

XMLXVM_DEBUG_F

Debug callback function for XSLT VM

#define XMLXVM_DEBUG_F(func, line, file, obj, n)
void func(
   ub2 line,
   oratext *file,
   xvmobj *obj,
   ub4 n)

line

IN

file

IN

obj

IN

n

IN

XmlXvmCreate

Create an XSLT virtual machine. Zero or more of the following XSLTVM properties could be set by using this API:

• "VMStack", size sets the size[Kbyte] of the main VM stack; default size is 4K.

• "NodeStack", size sets the size[Kbyte] of the node-stack; default size is 16K.

• "StringStack", size sets the size[Kbyte] of the string-stack; default size is 64K.

If the stack size is not specified the default size is used. The explicit stack size setting is needed when XSLTVM terminates with "Stack Overflow" message or when smaller memory footprints are required.

xmlxvm *XmlXvmCreate(
   xmlctx *xctx, 
list);

xctx

IN

list

IN

(xmlxvm *) XSLT virtual machine object, or NULL on error

XmlXvmDestroy

Destroys an XSLT virtual machine

void XmlXvmDestroy(
   xmlxvm *vm);

vm

IN

XmlXvmEvaluateXPath

Evaluate already-compiled XPath expression

xvmobj *XmlXvmEvaluateXPath(
   xmlxvm *vm, 
   ub2 *bytecode, 
   ub4 ctxpos,
   ub4 ctxsize,
   xmlnode *ctxnode);

vm

IN

bytecode

IN

ctxpos

IN

ctxsize

IN

ctxnode

IN

(xvmobj *) XPath object

XmlXvmGetObjectBoolean

Get boolean value of XPath object

boolean XmlXvmGetObjectBoolean(
   xvmobj *obj);

obj

IN

(boolean) value of an XPath object

XmlXvmGetObjectNSetNode

Get node from nodeset-type XPath object

xmlnode *XmlXvmGetObjectNSetNode(
   xvmobj *obj,
   ub4 i);

obj

IN

i

IN

(xmlnode *) The object type or values.

XmlXvmGetObjectNSetNum

Get number of nodes in nodeset-type XPath object

ub4 XmlXvmGetObjectNSetNum(
   xvmobj *obj);

obj

IN

(ub4) number of nodes in nodeset

XmlXvmGetObjectNumber

Get number from XPath object.

double XmlXvmGetObjectNumber(
   xvmobj *obj);

obj

IN

(double) number

XmlXvmGetObjectString

Get string from XPath object.

oratext *XmlXvmGetObjectString(
   xvmobj *obj);

obj

IN

(oratext *) string

XmlXvmGetObjectType

Get XPath object type

xmlxvmobjtype XmlXvmGetObjectType(
   xvmobj *obj);

obj

IN

(xmlxvmobjtype) type-code for object

XmlXvmGetOutputDom

Returns the root node of the result DOM tree (if any). XmlXvmSetOutputDom has to be used before transformation to set the VM to output a DOM tree (the default VM output is a stream).

xmlfragnode *XmlXvmGetOutputDom(
   xmlxvm *vm);

vm

IN

(xmlfragnode *) output DOM, or NULL in a case of SAX or Stream output.

XmlXvmResetParams

Resets the stylesheet top-level parameters with their default values.

void XmlXvmResetParams(
   xmlxvm *vm);

vm

IN

XmlXvmSetBaseURI

Sets the base URI for the XSLTVM. The baseuri is used by VM to the compose the path XML documents to be loaded for transformation using document or XmlXvmTransformFile.

xmlerr XmlXvmSetBaseURI(
   xmlxvm *vm, 
   oratext *baseuri);

vm

IN

baseuri

IN

(xmlerr) error code.

XmlXvmSetBytecodeBuffer

Set the compiled bytecode from buffer. Any previously set bytecode is replaced. An XML transformation can't be performed if the stylesheet bytecode is not set. The VM doesn't copy the bytecode into internal buffer, hence the it shouldn't be freed before VM finishes using it.

xmlerr XmlXvmSetBytecodeBuffer(
   xmlxvm *vm, 
   ub2 *buffer, 
   size_t buflen);

vm

IN

buffer

IN

buflen

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlXvmSetBytecodeFile

Set the compiled bytecode from file. Any previously set bytecode is replaced. An XML transformation can't be performed if the stylesheet bytecode is not set.

xmlerr XmlXvmSetBytecodeFile(
   xmlxvm *vm,
   oratext *path);

vm

IN

path

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlXvmSetBytecodeURI

Set the compiled bytecode from URI. Any previously set bytecode is replaced. An XML transformation can't be performed if the stylesheet bytecode is not set.

xmlerr XmlXvmSetBytecodeURI(
   xmlxvm *vm,
   oratext *uri);

vm

IN

uri

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlXvmSetDebugFunc

The user callback function is invoked by VM every time the execution reaches a new line in the XSLT stylesheet. The VM passes to the user the stylesheet file name, the line number, the current context nodes-set and the current node index in the node-set. IMPORTANT - the stylesheet has to be compiled with flag XMLXVM_DEBUG.

#define XMLXVM_DEBUG_FUNC(func)
void func (ub2 line, oratext *filename, xvmobj *obj, ub4 n)
xmlerr XmlXvmSetDebugFunc(
   xmlxvm *vm,
   XMLXVM_DEBUG_FUNC(debugcallback));

vm

IN

func

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlXvmSetOutputDom

Sets the XSLTVM to output DOM. If xmldocnode==NULL, then the result DOM tree belongs to the VM object and is deleted when a new transformation is performed or when the VM object is deleted. If the result DOM tree is to be used for longer period of time then an xmldocnode has to be created and set to the VM object.

xmlerr XmlXvmSetOutputDom(
   xmlxvm *vm,
   xmldocnode *doc);

vm

IN

doc

IN

(xmlerr) error code

XmlXvmSetOutputEncoding

Sets the encoding for the XSLTVM stream output. If the input (data) encoding is different from the one set by this APIs then encoding conversion is performed. This APIs overrides the encoding set in the XSLT stylesheet (if any).

xmlerr XmlXvmSetOutputEncoding(
   xmlxvm *vm, 
   oratext *encoding);

vm

IN

encoding

IN

(xmlerr) error code.

XmlXvmSetOutputSax

Set XSLTVM to output SAX. If the SAX callback interface object is provided the VM outputs the result document in a form of SAX events using the user specified callback functions.

xmlerr XmlXvmSetOutputSax(
   xmlxvm *vm,
   xmlsaxcb *saxcb, 
   void *saxctx);

vm

IN

saxcb

IN

saxctx

IN

(xmlerr) error code

XmlXvmSetOutputStream

Set the XSLTVM output to a user-defined stream. The default XSLTVM output is a stream. This APIs overrides the default stream with user specified APIs for writing.

xmlerr XmlXvmSetOutputStream(
   xmlxvm *vm,
   xmlostream *ostream);

vm

IN

ostream

IN

(xmlerr) error code.

XmlXvmSetTextParam

Set the stylesheet top-level text parameter. The parameter value set in the XSLT stylesheet is overwritten. Since the top-level parameters are reset with stylesheet values after each transformation, this APIs has to be called again.

xmlerr XmlXvmSetTextParam(
   xmlxvm *vm,
   oratext *name,
   oratext *value);

vm

IN

name

IN

value

IN

(xmlerr) error code, XMLERR_SUCC [0] on success.

XmlXvmTransformBuffer

Run compiled XSLT stylesheet on XML document in memory. The compiled XSLT stylesheet (bytecode) should be set using XmlXvmSetBytecodeXXX prior to this call.

xmlerr XmlXvmTransformBuffer(
   xmlxvm *vm,
   oratext *buffer,
   ub4 length,
   oratext *baseURI);

vm

IN

buffer

IN

length

IN

baseURI

IN

(xmlerr) error code.

XmlXvmTransformDom

Run compiled XSLT stylesheet on XML document as DOM. The compiled XSLT stylesheet (bytecode) should be set using XmlXvmSetBytecodeXXX prior to this call.

xmlerr XmlXvmTransformDom(
   xmlxvm *vm,
   xmldocnode *root);

vm

IN

root

IN

(xmlerr) error code.

XmlXvmTransformFile

Run compiled XSLT stylesheet on XML document in file. The compiled XSLT stylesheet (bytecode) should be set using XmlXvmSetBytecodeXXX prior to this call.

xmlerr XmlXvmTransformFile(
   xmlxvm *vm,
   oratext *path,
   oratext *baseURI);

vm

IN

path

IN

baseURI

IN

(xmlerr) error code

XmlXvmTransformURI

Run compiled XSLT stylesheet on XML document from URI. The compiled XSLT stylesheet (bytecode) should be set using XmlXvmSetBytecodeXXX prior to this call.

xmlerr XmlXvmTransformURI(
   xmlxvm *vm, 
   oratext *uri);

vm

IN

uri

IN

(xmlerr) error code.