# The XSLT C library for Gnome

## Module transform from libxslt

API Menu

- Main Menu
- Developer Menu
- API Menu
- ChangeLog

Related links

- Mail archive
- XML libxml
- DOM gdome2
- FTP
- Windows binaries
- Solaris binaries
- MacOsX binaries
- Pascal bindings
- Bug Tracker
- Xsldbg Debugger
- Apache module

API Indexes

- Alphabetic
- Constructors
- Functions/Types
- Modules
- Symbols

This module implements the bulk of the actual

## Table of Contents

    void	xslHandleDebugger		(xmlNodePtr cur,
    					 xmlNodePtr node,
    					 xsltTemplatePtr templ,
    					 xsltTransformContextPtr ctxt)

    void	xsltApplyImports		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltApplyOneTemplate		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr list,
    					 xsltTemplatePtr templ,
    					 xsltStackElemPtr params)

    void	xsltApplyStripSpaces		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node)

    xmlDocPtr	xsltApplyStylesheet	(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params)

    xmlDocPtr	xsltApplyStylesheetUser	(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 const char * output,
    					 FILE * profile,
    					 xsltTransformContextPtr userCtxt)

    void	xsltApplyTemplates		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltAttribute			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltCallTemplate		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltChoose			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltComment			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltCopy			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltCopyOf			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    xmlNodePtr	xsltCopyTextString	(xsltTransformContextPtr ctxt,
    					 xmlNodePtr target,
    					 const xmlChar * string,
    					 int noescape)

    void	xsltDocumentElem		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltElement			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltForEach			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltFreeTransformContext	(xsltTransformContextPtr ctxt)

    int	xsltGetXIncludeDefault		(void)

    void	xsltIf			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    xsltTransformContextPtr	xsltNewTransformContext	(xsltStylesheetPtr style,
    						 xmlDocPtr doc)

    void	xsltNumber			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltProcessingInstruction	(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    xmlDocPtr	xsltProfileStylesheet	(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 FILE * output)

    void	xsltRegisterAllElement		(xsltTransformContextPtr ctxt)

    int	xsltRunStylesheet		(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 const char * output,
    					 xmlSAXHandlerPtr SAX,
    					 xmlOutputBufferPtr IObuf)

    int	xsltRunStylesheetUser		(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 const char * output,
    					 xmlSAXHandlerPtr SAX,
    					 xmlOutputBufferPtr IObuf,
    					 FILE * profile,
    					 xsltTransformContextPtr userCtxt)

    void	xsltSetXIncludeDefault		(int xinclude)

    void	xsltSort			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltText			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

    void	xsltValueOf			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

## Description

### Function: xslHandleDebugger

    void	xslHandleDebugger		(xmlNodePtr cur,
    					 xmlNodePtr node,
    					 xsltTemplatePtr templ,
    					 xsltTransformContextPtr ctxt)

If either cur or node are a breakpoint, or xslDebugStatus in state where debugging must occcur at this time then transfer control to the xslDebugBreak function

`cur`: | source node being executed
`node`: | data node being processed
`templ`: | temlate that applies to node
`ctxt`: | the xslt transform context

### Function: xsltApplyImports

    void	xsltApplyImports		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt apply-imports node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt apply-imports node
`comp`: | precomputed information

### Function: xsltApplyOneTemplate

    void	xsltApplyOneTemplate		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr list,
    					 xsltTemplatePtr templ,
    					 xsltStackElemPtr params)

Process the apply-templates node on the source node, if params are passed they are pushed on the variable stack but not popped, it's left to the caller to handle them after return (they may be reused).

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`list`: | the template replacement nodelist
`templ`: | if is this a real template processing, the template processed
`params`: | a set of parameters for the template or NULL

### Function: xsltApplyStripSpaces

    void	xsltApplyStripSpaces		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node)

Strip the unwanted ignorable spaces from the input tree

`ctxt`: | a XSLT process context
`node`: | the root of the XML tree

### Function: xsltApplyStylesheet

    xmlDocPtr	xsltApplyStylesheet	(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params)

Apply the stylesheet to the document NOTE: This may lead to a non-wellformed output XML wise !

`style`: | a parsed XSLT stylesheet
`doc`: | a parsed XML document
`params`: | a NULL terminated arry of parameters names/values tuples
`Returns`: | the result document or NULL in case of error

### Function: xsltApplyStylesheetUser

    xmlDocPtr	xsltApplyStylesheetUser	(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 const char * output,
    					 FILE * profile,
    					 xsltTransformContextPtr userCtxt)

Apply the stylesheet to the document and allow the user to provide its own transformation context.

`style`: | a parsed XSLT stylesheet
`doc`: | a parsed XML document
`params`: | a NULL terminated array of parameters names/values tuples
`output`: | the targetted output
`profile`: | profile FILE * output or NULL
`userCtxt`: | user provided transform context
`Returns`: | the result document or NULL in case of error

### Function: xsltApplyTemplates

    void	xsltApplyTemplates		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the apply-templates node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the apply-templates node
`comp`: | precomputed information

### Function: xsltAttribute

    void	xsltAttribute			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt attribute node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt attribute node
`comp`: | precomputed information

### Function: xsltCallTemplate

    void	xsltCallTemplate		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt call-template node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt call-template node
`comp`: | precomputed information

### Function: xsltChoose

    void	xsltChoose			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt choose node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt choose node
`comp`: | precomputed information

### Function: xsltComment

    void	xsltComment			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt comment node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt comment node
`comp`: | precomputed information

### Function: xsltCopy

    void	xsltCopy			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt copy node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt copy node
`comp`: | precomputed information

### Function: xsltCopyOf

    void	xsltCopyOf			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt copy-of node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt copy-of node
`comp`: | precomputed information

### Function: xsltCopyTextString

    xmlNodePtr	xsltCopyTextString	(xsltTransformContextPtr ctxt,
    					 xmlNodePtr target,
    					 const xmlChar * string,
    					 int noescape)

Create a text node

`ctxt`: | a XSLT process context
`target`: | the element where the text will be attached
`string`: | the text string
`noescape`: | should disable-escaping be activated for this text node.
`Returns`: | a new xmlNodePtr, or NULL in case of error.

### Function: xsltDocumentElem

    void	xsltDocumentElem		(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process an EXSLT/XSLT-1.1 document element

`ctxt`: | an XSLT processing context
`node`: | The current node
`inst`: | the instruction in the stylesheet
`comp`: | precomputed information

### Function: xsltElement

    void	xsltElement			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt element node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt element node
`comp`: | precomputed information

### Function: xsltForEach

    void	xsltForEach			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt for-each node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt for-each node
`comp`: | precomputed information

### Function: xsltFreeTransformContext

    void	xsltFreeTransformContext	(xsltTransformContextPtr ctxt)

Free up the memory allocated by @ctxt

`ctxt`: | an XSLT parser context

### Function: xsltGetXIncludeDefault

    int	xsltGetXIncludeDefault		(void)

Provides the default state for XInclude processing

`Returns`: | 0 if there is no processing 1 otherwise

### Function: xsltIf

    void	xsltIf			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt if node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt if node
`comp`: | precomputed information

### Function: xsltNewTransformContext

    xsltTransformContextPtr	xsltNewTransformContext	(xsltStylesheetPtr style,
    						 xmlDocPtr doc)

Create a new XSLT TransformContext

`style`: | a parsed XSLT stylesheet
`doc`: | the input document
`Returns`: | the newly allocated xsltTransformContextPtr or NULL in case of error

### Function: xsltNumber

    void	xsltNumber			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt number node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt number node
`comp`: | precomputed information

### Function: xsltProcessingInstruction

    void	xsltProcessingInstruction	(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt processing-instruction node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt processing-instruction node
`comp`: | precomputed information

### Function: xsltProfileStylesheet

    xmlDocPtr	xsltProfileStylesheet	(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 FILE * output)

Apply the stylesheet to the document and dump the profiling to the given output.

`style`: | a parsed XSLT stylesheet
`doc`: | a parsed XML document
`params`: | a NULL terminated arry of parameters names/values tuples
`output`: | a FILE * for the profiling output
`Returns`: | the result document or NULL in case of error

### Function: xsltRegisterAllElement

    void	xsltRegisterAllElement		(xsltTransformContextPtr ctxt)

Registers all default XSLT elements in this context

`ctxt`: | the XPath context

### Function: xsltRunStylesheet

    int	xsltRunStylesheet		(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 const char * output,
    					 xmlSAXHandlerPtr SAX,
    					 xmlOutputBufferPtr IObuf)

Apply the stylesheet to the document and generate the output according to @output @SAX and @IObuf. It's an error to specify both @SAX and @IObuf. NOTE: This may lead to a non-wellformed output XML wise ! NOTE: This may also result in multiple files being generated NOTE: using IObuf, the result encoding used will be the one used for creating the output buffer, use the following macro to read it from the stylesheet XSLT_GET_IMPORT_PTR(encoding, style, encoding) NOTE: using SAX, any encoding specified in the stylesheet will be lost since the interface uses only UTF8

`style`: | a parsed XSLT stylesheet
`doc`: | a parsed XML document
`params`: | a NULL terminated array of parameters names/values tuples
`output`: | the URL/filename ot the generated resource if available
`SAX`: | a SAX handler for progressive callback output (not implemented yet)
`IObuf`: | an output buffer for progressive output (not implemented yet)
`Returns`: | the number of bytes written to the main resource or -1 in case of error.

### Function: xsltRunStylesheetUser

    int	xsltRunStylesheetUser		(xsltStylesheetPtr style,
    					 xmlDocPtr doc,
    					 const char ** params,
    					 const char * output,
    					 xmlSAXHandlerPtr SAX,
    					 xmlOutputBufferPtr IObuf,
    					 FILE * profile,
    					 xsltTransformContextPtr userCtxt)

Apply the stylesheet to the document and generate the output according to @output @SAX and @IObuf. It's an error to specify both @SAX and @IObuf. NOTE: This may lead to a non-wellformed output XML wise ! NOTE: This may also result in multiple files being generated NOTE: using IObuf, the result encoding used will be the one used for creating the output buffer, use the following macro to read it from the stylesheet XSLT_GET_IMPORT_PTR(encoding, style, encoding) NOTE: using SAX, any encoding specified in the stylesheet will be lost since the interface uses only UTF8

`style`: | a parsed XSLT stylesheet
`doc`: | a parsed XML document
`params`: | a NULL terminated array of parameters names/values tuples
`output`: | the URL/filename ot the generated resource if available
`SAX`: | a SAX handler for progressive callback output (not implemented yet)
`IObuf`: | an output buffer for progressive output (not implemented yet)
`profile`: | profile FILE * output or NULL
`userCtxt`: | user provided transform context
`Returns`: | the number of by written to the main resource or -1 in case of error.

### Function: xsltSetXIncludeDefault

    void	xsltSetXIncludeDefault		(int xinclude)

Set whether XInclude should be processed on document being loaded by default

`xinclude`: | whether to do XInclude processing

### Function: xsltSort

    void	xsltSort			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

function attached to xsl:sort nodes, but this should not be called directly

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt sort node
`comp`: | precomputed information

### Function: xsltText

    void	xsltText			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt text node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt text node
`comp`: | precomputed information

### Function: xsltValueOf

    void	xsltValueOf			(xsltTransformContextPtr ctxt,
    					 xmlNodePtr node,
    					 xmlNodePtr inst,
    					 xsltStylePreCompPtr comp)

Process the xslt value-of node on the source node

`ctxt`: | a XSLT process context
`node`: | the node in the source tree.
`inst`: | the xslt value-of node
`comp`: | precomputed information

Daniel Veillard