documents.h File Reference

#include <libxml/tree.h>
#include "xsltexports.h"
#include "xsltInternals.h"

Include dependency graph for documents.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef xmlDocPtr(*	xsltDocLoaderFunc) (const xmlChar *URI, xmlDictPtr dict, int options, void *ctxt, xsltLoadType type)

Enumerations
enum	xsltLoadType { XSLT_LOAD_START = 0 , XSLT_LOAD_STYLESHEET = 1 , XSLT_LOAD_DOCUMENT = 2 }

Functions
XSLTPUBFUN xsltDocumentPtr XSLTCALL	xsltNewDocument (xsltTransformContextPtr ctxt, xmlDocPtr doc)
XSLTPUBFUN xsltDocumentPtr XSLTCALL	xsltLoadDocument (xsltTransformContextPtr ctxt, const xmlChar *URI)
XSLTPUBFUN xsltDocumentPtr XSLTCALL	xsltFindDocument (xsltTransformContextPtr ctxt, xmlDocPtr doc)
XSLTPUBFUN void XSLTCALL	xsltFreeDocuments (xsltTransformContextPtr ctxt)
XSLTPUBFUN xsltDocumentPtr XSLTCALL	xsltLoadStyleDocument (xsltStylesheetPtr style, const xmlChar *URI)
XSLTPUBFUN xsltDocumentPtr XSLTCALL	xsltNewStyleDocument (xsltStylesheetPtr style, xmlDocPtr doc)
XSLTPUBFUN void XSLTCALL	xsltFreeStyleDocuments (xsltStylesheetPtr style)
XSLTPUBFUN void XSLTCALL	xsltSetLoaderFunc (xsltDocLoaderFunc f)

Variables
XSLTPUBVAR xsltDocLoaderFunc	xsltDocDefaultLoader

Typedef Documentation

xsltDocLoaderFunc

typedef xmlDocPtr(* xsltDocLoaderFunc) (const xmlChar *URI, xmlDictPtr dict, int options, void *ctxt, xsltLoadType type)

xsltDocLoaderFunc: @URI: the URI of the document to load @dict: the dictionary to use when parsing that document @options: parsing options, a set of xmlParserOption @ctxt: the context, either a stylesheet or a transformation context @type: the xsltLoadType indicating the kind of loading required

An xsltDocLoaderFunc is a signature for a function which can be registered to load document not provided by the compilation or transformation API themselve, for example when an xsl:import, xsl:include is found at compilation time or when a document() call is made at runtime.

Returns the pointer to the document (which will be modified and freed by the engine later), or NULL in case of error.

Definition at line 76 of file documents.h.

Enumeration Type Documentation

xsltLoadType

enum xsltLoadType

xsltLoadType:

Enum defining the kind of loader requirement.

Enumerator
XSLT_LOAD_START
XSLT_LOAD_STYLESHEET
XSLT_LOAD_DOCUMENT

Definition at line 53 of file documents.h.

             {
    XSLT_LOAD_START = 0,    /* loading for a top stylesheet */
    XSLT_LOAD_STYLESHEET = 1,   /* loading for a stylesheet include/import */
    XSLT_LOAD_DOCUMENT = 2  /* loading document at transformation time */
} xsltLoadType;

Function Documentation

xsltFindDocument()

XSLTPUBFUN xsltDocumentPtr XSLTCALL xsltFindDocument	(	xsltTransformContextPtr	ctxt,
		xmlDocPtr	doc
	)

xsltFindDocument: @ctxt: an XSLT transformation context @doc: a parsed XML document

Try to find a document within the XSLT transformation context. This will not find document infos for temporary Result Tree Fragments.

Returns the desired xsltDocumentPtr or NULL in case of error

Definition at line 400 of file documents.c.

                                                               {
    xsltDocumentPtr ret;
 
    if ((ctxt == NULL) || (doc == NULL))
    return(NULL);
 
    /*
     * Walk the context list to find the document
     */
    ret = ctxt->docList;
    while (ret != NULL) {
    if (ret->doc == doc)
        return(ret);
    ret = ret->next;
    }
    if (doc == ctxt->style->doc)
    return(ctxt->document);
    return(NULL);
}

Referenced by xsltKeyFunction().

xsltFreeDocuments()

XSLTPUBFUN void XSLTCALL xsltFreeDocuments

(

xsltTransformContextPtr

ctxt

)

xsltFreeDocuments: @ctxt: an XSLT transformation context

Free up all the space used by the loaded documents

Definition at line 234 of file documents.c.

                                                {
    xsltDocumentPtr doc, cur;
 
    cur = ctxt->docList;
    while (cur != NULL) {
    doc = cur;
    cur = cur->next;
    xsltFreeDocumentKeys(doc);
    if (!doc->main)
        xmlFreeDoc(doc->doc);
        xmlFree(doc);
    }
    cur = ctxt->styleList;
    while (cur != NULL) {
    doc = cur;
    cur = cur->next;
    xsltFreeDocumentKeys(doc);
    if (!doc->main)
        xmlFreeDoc(doc->doc);
        xmlFree(doc);
    }
}

Referenced by xsltFreeTransformContext().

xsltFreeStyleDocuments()

XSLTPUBFUN void XSLTCALL xsltFreeStyleDocuments

(

xsltStylesheetPtr

style

)

xsltFreeStyleDocuments: @style: an XSLT stylesheet (representing a stylesheet-level)

Frees the node-trees (and xsltDocument structures) of all stylesheet-modules of the stylesheet-level represented by the given @style.

Definition at line 193 of file documents.c.

                                                {
    xsltDocumentPtr doc, cur;
#ifdef XSLT_REFACTORED_XSLT_NSCOMP
    xsltNsMapPtr nsMap;
#endif
 
    if (style == NULL)
    return;
 
#ifdef XSLT_REFACTORED_XSLT_NSCOMP
    if (XSLT_HAS_INTERNAL_NSMAP(style))
    nsMap = XSLT_GET_INTERNAL_NSMAP(style);
    else
    nsMap = NULL;
#endif
 
    cur = style->docList;
    while (cur != NULL) {
    doc = cur;
    cur = cur->next;
#ifdef XSLT_REFACTORED_XSLT_NSCOMP
    /*
    * Restore all changed namespace URIs of ns-decls.
    */
    if (nsMap)
        xsltRestoreDocumentNamespaces(nsMap, doc->doc);
#endif
    xsltFreeDocumentKeys(doc);
    if (!doc->main)
        xmlFreeDoc(doc->doc);
        xmlFree(doc);
    }
}

Referenced by xsltFreeStylesheet().

xsltLoadDocument()

XSLTPUBFUN xsltDocumentPtr XSLTCALL xsltLoadDocument	(	xsltTransformContextPtr	ctxt,
		const xmlChar *	URI
	)

xsltLoadDocument: @ctxt: an XSLT transformation context @URI: the computed URI of the document

Try to load a document (not a stylesheet) within the XSLT transformation context

Returns the new xsltDocumentPtr or NULL in case of error

Definition at line 268 of file documents.c.

                                                                   {
    xsltDocumentPtr ret;
    xmlDocPtr doc;
 
    if ((ctxt == NULL) || (URI == NULL))
    return(NULL);
 
    /*
     * Security framework check
     */
    if (ctxt->sec != NULL) {
    int res;
 
    res = xsltCheckRead(ctxt->sec, ctxt, URI);
    if (res <= 0) {
            if (res == 0)
                xsltTransformError(ctxt, NULL, NULL,
                     "xsltLoadDocument: read rights for %s denied\n",
                                 URI);
        return(NULL);
    }
    }
 
    /*
     * Walk the context list to find the document if preparsed
     */
    ret = ctxt->docList;
    while (ret != NULL) {
    if ((ret->doc != NULL) && (ret->doc->URL != NULL) &&
        (xmlStrEqual(ret->doc->URL, URI)))
        return(ret);
    ret = ret->next;
    }
 
    doc = xsltDocDefaultLoader(URI, ctxt->dict, ctxt->parserOptions,
                               (void *) ctxt, XSLT_LOAD_DOCUMENT);
 
    if (doc == NULL)
    return(NULL);
 
    if (ctxt->xinclude != 0) {
#ifdef LIBXML_XINCLUDE_ENABLED
#if LIBXML_VERSION >= 20603
    xmlXIncludeProcessFlags(doc, ctxt->parserOptions);
#else
    xmlXIncludeProcess(doc);
#endif
#else
    xsltTransformError(ctxt, NULL, NULL,
        "xsltLoadDocument(%s) : XInclude processing not compiled in\n",
                     URI);
#endif
    }
    /*
     * Apply white-space stripping if asked for
     */
    if (xsltNeedElemSpaceHandling(ctxt))
    xsltApplyStripSpaces(ctxt, xmlDocGetRootElement(doc));
    if (ctxt->debugStatus == XSLT_DEBUG_NONE)
    xmlXPathOrderDocElems(doc);
 
    ret = xsltNewDocument(ctxt, doc);
    return(ret);
}

Referenced by xsltDocumentFunctionLoadDocument().

xsltLoadStyleDocument()

XSLTPUBFUN xsltDocumentPtr XSLTCALL xsltLoadStyleDocument	(	xsltStylesheetPtr	style,
		const xmlChar *	URI
	)

xsltLoadStyleDocument: @style: an XSLT style sheet @URI: the computed URI of the document

Try to load a stylesheet document within the XSLT transformation context

Returns the new xsltDocumentPtr or NULL in case of error

Definition at line 343 of file documents.c.

                                                                   {
    xsltDocumentPtr ret;
    xmlDocPtr doc;
    xsltSecurityPrefsPtr sec;
 
    if ((style == NULL) || (URI == NULL))
    return(NULL);
 
    /*
     * Security framework check
     */
    sec = xsltGetDefaultSecurityPrefs();
    if (sec != NULL) {
    int res;
 
    res = xsltCheckRead(sec, NULL, URI);
    if (res <= 0) {
            if (res == 0)
                xsltTransformError(NULL, NULL, NULL,
                     "xsltLoadStyleDocument: read rights for %s denied\n",
                                 URI);
        return(NULL);
    }
    }
 
    /*
     * Walk the context list to find the document if preparsed
     */
    ret = style->docList;
    while (ret != NULL) {
    if ((ret->doc != NULL) && (ret->doc->URL != NULL) &&
        (xmlStrEqual(ret->doc->URL, URI)))
        return(ret);
    ret = ret->next;
    }
 
    doc = xsltDocDefaultLoader(URI, style->dict, XSLT_PARSE_OPTIONS,
                               (void *) style, XSLT_LOAD_STYLESHEET);
    if (doc == NULL)
    return(NULL);
 
    ret = xsltNewStyleDocument(style, doc);
    return(ret);
}

Referenced by xsltParseStylesheetInclude().

xsltNewDocument()

XSLTPUBFUN xsltDocumentPtr XSLTCALL xsltNewDocument	(	xsltTransformContextPtr	ctxt,
		xmlDocPtr	doc
	)

xsltNewDocument: @ctxt: an XSLT transformation context (or NULL) @doc: a parsed XML document

Register a new document, apply key computations

Returns a handler to the document

Definition at line 127 of file documents.c.

                                                             {
    xsltDocumentPtr cur;
 
    cur = (xsltDocumentPtr) xmlMalloc(sizeof(xsltDocument));
    if (cur == NULL) {
    xsltTransformError(ctxt, NULL, (xmlNodePtr) doc,
        "xsltNewDocument : malloc failed\n");
    return(NULL);
    }
    memset(cur, 0, sizeof(xsltDocument));
    cur->doc = doc;
    if (ctxt != NULL) {
        if (! XSLT_IS_RES_TREE_FRAG(doc)) {
        cur->next = ctxt->docList;
        ctxt->docList = cur;
    }
    /*
    * A key with a specific name for a specific document
    * will only be computed if there's a call to the key()
    * function using that specific name for that specific
    * document. I.e. computation of keys will be done in
    * xsltGetKey() (keys.c) on an on-demand basis.
    *
    * xsltInitCtxtKeys(ctxt, cur); not called here anymore
    */
    }
    return(cur);
}

Referenced by xsltComputeAllKeys(), xsltKeyFunction(), xsltLoadDocument(), and xsltNewTransformContext().

xsltNewStyleDocument()

XSLTPUBFUN xsltDocumentPtr XSLTCALL xsltNewStyleDocument	(	xsltStylesheetPtr	style,
		xmlDocPtr	doc
	)

xsltNewStyleDocument: @style: an XSLT style sheet @doc: a parsed XML document

Register a new document, apply key computations

Returns a handler to the document

Definition at line 166 of file documents.c.

                                                             {
    xsltDocumentPtr cur;
 
    cur = (xsltDocumentPtr) xmlMalloc(sizeof(xsltDocument));
    if (cur == NULL) {
    xsltTransformError(NULL, style, (xmlNodePtr) doc,
        "xsltNewStyleDocument : malloc failed\n");
    return(NULL);
    }
    memset(cur, 0, sizeof(xsltDocument));
    cur->doc = doc;
    if (style != NULL) {
    cur->next = style->docList;
    style->docList = cur;
    }
    return(cur);
}

Referenced by xsltLoadStyleDocument().

xsltSetLoaderFunc()

XSLTPUBFUN void XSLTCALL xsltSetLoaderFunc

(

xsltDocLoaderFunc

f

)

xsltSetLoaderFunc: @f: the new function to handle document loading.

Set the new function to load document, if NULL it resets it to the default function.

Definition at line 104 of file documents.c.

                                       {
    if (f == NULL)
        xsltDocDefaultLoader = xsltDocDefaultLoaderFunc;
    else
        xsltDocDefaultLoader = f;
}

Variable Documentation

xsltDocDefaultLoader

XSLTPUBVAR xsltDocLoaderFunc xsltDocDefaultLoader

Definition at line 86 of file documents.h.