xsltutils

XSLT_TODO

#define     XSLT_TODO

Macro to flag unimplemented blocks.

XSLT_STRANGE

#define     XSLT_STRANGE

Macro to flag that a problem was detected internally.

IS_XSLT_ELEM()

#define     IS_XSLT_ELEM(n)

Checks that the element pertains to XSLT namespace.

IS_XSLT_NAME()

#define     IS_XSLT_NAME(n, val)

Checks the value of an element in XSLT namespace.

IS_XSLT_REAL_NODE()

#define     IS_XSLT_REAL_NODE(n)

Check that a node is a 'real' one: document, element, text or attribute.

xsltGetNsProp ()

xmlChar*    xsltGetNsProp                   (xmlNodePtr node,
                                             const xmlChar *name,
                                             const xmlChar *nameSpace);

Similar to xmlGetNsProp() but with a slightly different semantic

Search and get the value of an attribute associated to a node This attribute has to be anchored in the namespace specified, or has no namespace and the element is in that namespace.

This does the entity substitution. This function looks in DTD attribute declaration for FIXED or default declaration values unless DTD use has been turned off.

xsltGetUTF8Char ()

int         xsltGetUTF8Char                 (unsigned char *utf,
                                             int *len);

Read one UTF8 Char from utf Function copied from libxml2 xmlGetUTF8Char() ... to discard ultimately and use the original API

xsltPrintErrorContext ()

void        xsltPrintErrorContext           (xsltTransformContextPtr ctxt,
                                             xsltStylesheetPtr style,
                                             xmlNodePtr node);

Display the context of an error.

xsltMessage ()

void        xsltMessage                     (xsltTransformContextPtr ctxt,
                                             xmlNodePtr node,
                                             xmlNodePtr inst);

Process and xsl:message construct

xsltSetGenericErrorFunc ()

void        xsltSetGenericErrorFunc         (void *ctx,
                                             xmlGenericErrorFunc handler);

Function to reset the handler and the error context for out of context error messages. This simply means that handler will be called for subsequent error messages while not parsing nor validating. And ctx will be passed as first argument to handler One can simply force messages to be emitted to another FILE * than stderr by setting ctx to this file handle and handler to NULL.

xsltSetGenericDebugFunc ()

void        xsltSetGenericDebugFunc         (void *ctx,
                                             xmlGenericErrorFunc handler);

Function to reset the handler and the error context for out of context error messages. This simply means that handler will be called for subsequent error messages while not parsing or validating. And ctx will be passed as first argument to handler One can simply force messages to be emitted to another FILE * than stderr by setting ctx to this file handle and handler to NULL.

xsltSetTransformErrorFunc ()

void        xsltSetTransformErrorFunc       (xsltTransformContextPtr ctxt,
                                             void *ctx,
                                             xmlGenericErrorFunc handler);

Function to reset the handler and the error context for out of context error messages specific to a given XSLT transromation.

This simply means that handler will be called for subsequent error messages while running the transformation.

xsltTransformError ()

void        xsltTransformError              (xsltTransformContextPtr ctxt,
                                             xsltStylesheetPtr style,
                                             xmlNodePtr node,
                                             const char *msg,
                                             ...);

Display and format an error messages, gives file, line, position and extra parameters, will use the specific transformation context if available

xsltDocumentSortFunction ()

void        xsltDocumentSortFunction        (xmlNodeSetPtr list);

reorder the current node list list accordingly to the document order

xsltSetSortFunc ()

void        xsltSetSortFunc                 (xsltSortFunc handler);

Function to reset the global handler for XSLT sorting. If the handler is NULL, the default sort function will be used.

xsltSetCtxtSortFunc ()

void        xsltSetCtxtSortFunc             (xsltTransformContextPtr ctxt,
                                             xsltSortFunc handler);

Function to set the handler for XSLT sorting for the specified context. If the handler is NULL, then the global sort function will be called

xsltDefaultSortFunction ()

void        xsltDefaultSortFunction         (xsltTransformContextPtr ctxt,
                                             xmlNodePtr *sorts,
                                             int nbsorts);

reorder the current node list accordingly to the set of sorting requirement provided by the arry of nodes.

xsltDoSortFunction ()

void        xsltDoSortFunction              (xsltTransformContextPtr ctxt,
                                             xmlNodePtr *sorts,
                                             int nbsorts);

reorder the current node list accordingly to the set of sorting requirement provided by the arry of nodes. This is a wrapper function, the actual function used is specified using xsltSetCtxtSortFunc() to set the context specific sort function, or xsltSetSortFunc() to set the global sort function. If a sort function is set on the context, this will get called. Otherwise the global sort function is called.

xsltComputeSortResult ()

xmlXPathObjectPtr* xsltComputeSortResult    (xsltTransformContextPtr ctxt,
                                             xmlNodePtr sort);

reorder the current node list accordingly to the set of sorting requirement provided by the array of nodes.

xsltGetQNameURI ()

const xmlChar* xsltGetQNameURI              (xmlNodePtr node,
                                             xmlChar **name);

This function analyzes name, if the name contains a prefix, the function seaches the associated namespace in scope for it. It will also replace name value with the NCName, the old value being freed. Errors in the prefix lookup are signalled by setting name to NULL.

NOTE: the namespace returned is a pointer to the place where it is defined and hence has the same lifespan as the document holding it.

xsltSaveResultTo ()

int         xsltSaveResultTo                (xmlOutputBufferPtr buf,
                                             xmlDocPtr result,
                                             xsltStylesheetPtr style);

Save the result result obtained by applying the style stylesheet to an I/O output channel buf

xsltSaveResultToFilename ()

int         xsltSaveResultToFilename        (const char *URI,
                                             xmlDocPtr result,
                                             xsltStylesheetPtr style,
                                             int compression);

Save the result result obtained by applying the style stylesheet to a file or URL

xsltSaveResultToFile ()

int         xsltSaveResultToFile            (FILE *file,
                                             xmlDocPtr result,
                                             xsltStylesheetPtr style);

Save the result result obtained by applying the style stylesheet to an open FILE * I/O. This does not close the FILE file

xsltSaveResultToFd ()

int         xsltSaveResultToFd              (int fd,
                                             xmlDocPtr result,
                                             xsltStylesheetPtr style);

Save the result result obtained by applying the style stylesheet to an open file descriptor This does not close the descriptor.

xsltSaveResultToString ()

int         xsltSaveResultToString          (xmlChar **doc_txt_ptr,
                                             int *doc_txt_len,
                                             xmlDocPtr result,
                                             xsltStylesheetPtr style);

Save the result result obtained by applying the style stylesheet to a file or URL

xsltSaveProfiling ()

void        xsltSaveProfiling               (xsltTransformContextPtr ctxt,
                                             FILE *output);

Save the profiling informations on output

xsltGetProfileInformation ()

xmlDocPtr   xsltGetProfileInformation       (xsltTransformContextPtr ctxt);

This function should be called after the transformation completed to extract template processing profiling informations if availble. The informations are returned as an XML document tree like <?xml version="1.0"?> <profile> <template rank="1" match="*" name="" mode="" calls="6" time="48" average="8"/> <template rank="2" match="item2|item3" name="" mode="" calls="10" time="30" average="3"/> <template rank="3" match="item1" name="" mode="" calls="5" time="17" average="3"/> </profile> The caller will need to free up the returned tree with xmlFreeDoc()

xsltTimestamp ()

long        xsltTimestamp                   (void);

Used for gathering profiling data

xsltCalibrateAdjust ()

void        xsltCalibrateAdjust             (long delta);

Used for to correct the calibration for xsltTimestamp()

XSLT_TIMESTAMP_TICS_PER_SEC

#define XSLT_TIMESTAMP_TICS_PER_SEC 100000l

Sampling precision for profiling

enum xsltDebugStatusCodes

typedef enum {
    XSLT_DEBUG_NONE = 0, /* no debugging allowed */
    XSLT_DEBUG_INIT,
    XSLT_DEBUG_STEP,
    XSLT_DEBUG_STEPOUT,
    XSLT_DEBUG_NEXT,
    XSLT_DEBUG_STOP,
    XSLT_DEBUG_CONT,
    XSLT_DEBUG_RUN,
    XSLT_DEBUG_RUN_RESTART,
    XSLT_DEBUG_QUIT
} xsltDebugStatusCodes;

xsltHandleDebuggerCallback ()

void        (*xsltHandleDebuggerCallback)   (xmlNodePtr cur,
                                             xmlNodePtr node,
                                             xsltTemplatePtr templ,
                                             xsltTransformContextPtr ctxt);

xsltAddCallCallback ()

int         (*xsltAddCallCallback)          (xsltTemplatePtr templ,
                                             xmlNodePtr source);

xsltDropCallCallback ()

void        (*xsltDropCallCallback)         (void);

xsltSetDebuggerCallbacks ()

int         xsltSetDebuggerCallbacks        (int no,
                                             void *block);

This function allow to plug a debugger into the XSLT library block points to a block of memory containing the address of no callback routines.

xslAddCall ()

int         xslAddCall                      (xsltTemplatePtr templ,
                                             xmlNodePtr source);

Add template "call" to call stack

xslDropCall ()

void        xslDropCall                     (void);

Drop the topmost item off the call stack