keys.h File Reference

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

Include dependency graph for keys.h:

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

Go to the source code of this file.

Macros
#define	NODE_IS_KEYED   (1 >> 15)

Functions
XSLTPUBFUN int XSLTCALL	xsltAddKey (xsltStylesheetPtr style, const xmlChar *name, const xmlChar *nameURI, const xmlChar *match, const xmlChar *use, xmlNodePtr inst)
XSLTPUBFUN xmlNodeSetPtr XSLTCALL	xsltGetKey (xsltTransformContextPtr ctxt, const xmlChar *name, const xmlChar *nameURI, const xmlChar *value)
XSLTPUBFUN void XSLTCALL	xsltInitCtxtKeys (xsltTransformContextPtr ctxt, xsltDocumentPtr doc)
XSLTPUBFUN void XSLTCALL	xsltFreeKeys (xsltStylesheetPtr style)
XSLTPUBFUN void XSLTCALL	xsltFreeDocumentKeys (xsltDocumentPtr doc)

Macro Definition Documentation

NODE_IS_KEYED

#define NODE_IS_KEYED   (1 >> 15)

NODE_IS_KEYED:

check for bit 15 set

Definition at line 26 of file keys.h.

Function Documentation

xsltAddKey()

XSLTPUBFUN int XSLTCALL xsltAddKey	(	xsltStylesheetPtr	style,
		const xmlChar *	name,
		const xmlChar *	nameURI,
		const xmlChar *	match,
		const xmlChar *	use,
		xmlNodePtr	inst
	)

Definition at line 263 of file keys.c.

                                            {
    xsltKeyDefPtr key;
    xmlChar *pattern = NULL;
    int current, end, start, i = 0;
 
    if ((style == NULL) || (name == NULL) || (match == NULL) || (use == NULL))
    return(-1);
 
#ifdef WITH_XSLT_DEBUG_KEYS
    xsltGenericDebug(xsltGenericDebugContext,
    "Add key %s, match %s, use %s\n", name, match, use);
#endif
 
    key = xsltNewKeyDef(name, nameURI);
    key->match = xmlStrdup(match);
    key->use = xmlStrdup(use);
    key->inst = inst;
    key->nsList = xmlGetNsList(inst->doc, inst);
    if (key->nsList != NULL) {
        while (key->nsList[i] != NULL)
        i++;
    }
    key->nsNr = i;
 
    /*
     * Split the | and register it as as many keys
     */
    current = end = 0;
    while (match[current] != 0) {
    start = current;
    while (xmlIsBlank_ch(match[current]))
        current++;
    end = current;
    while ((match[end] != 0) && (match[end] != '|')) {
        if (match[end] == '[') {
            end = skipPredicate(match, end);
        if (end <= 0) {
            xsltTransformError(NULL, style, inst,
                "xsl:key : 'match' pattern is malformed: %s",
                key->match);
            if (style != NULL) style->errors++;
            goto error;
        }
        } else
        end++;
    }
    if (current == end) {
        xsltTransformError(NULL, style, inst,
                   "xsl:key : 'match' pattern is empty\n");
        if (style != NULL) style->errors++;
        goto error;
    }
    if (match[start] != '/') {
        pattern = xmlStrcat(pattern, (xmlChar *)"//");
        if (pattern == NULL) {
        if (style != NULL) style->errors++;
        goto error;
        }
    }
    pattern = xmlStrncat(pattern, &match[start], end - start);
    if (pattern == NULL) {
        if (style != NULL) style->errors++;
        goto error;
    }
 
    if (match[end] == '|') {
        pattern = xmlStrcat(pattern, (xmlChar *)"|");
        end++;
    }
    current = end;
    }
    if (pattern == NULL) {
        xsltTransformError(NULL, style, inst,
                           "xsl:key : 'match' pattern is empty\n");
        if (style != NULL) style->errors++;
        goto error;
    }
#ifdef WITH_XSLT_DEBUG_KEYS
    xsltGenericDebug(xsltGenericDebugContext,
    "   resulting pattern %s\n", pattern);
#endif
    /*
    * XSLT-1: "It is an error for the value of either the use
    *  attribute or the match attribute to contain a
    *  VariableReference."
    * TODO: We should report a variable-reference at compile-time.
    *   Maybe a search for "$", if it occurs outside of quotation
    *   marks, could be sufficient.
    */
#ifdef XML_XPATH_NOVAR
    key->comp = xsltXPathCompileFlags(style, pattern, XML_XPATH_NOVAR);
#else
    key->comp = xsltXPathCompile(style, pattern);
#endif
    if (key->comp == NULL) {
    xsltTransformError(NULL, style, inst,
        "xsl:key : 'match' pattern compilation failed '%s'\n",
                 pattern);
    if (style != NULL) style->errors++;
    }
#ifdef XML_XPATH_NOVAR
    key->usecomp = xsltXPathCompileFlags(style, use, XML_XPATH_NOVAR);
#else
    key->usecomp = xsltXPathCompile(style, use);
#endif
    if (key->usecomp == NULL) {
    xsltTransformError(NULL, style, inst,
        "xsl:key : 'use' expression compilation failed '%s'\n",
                 use);
    if (style != NULL) style->errors++;
    }
 
    /*
     * Sometimes the stylesheet writer use the order to ease the
     * resolution of keys when they are dependant, keep the provided
     * order so add the new one at the end.
     */
    if (style->keys == NULL) {
    style->keys = key;
    } else {
        xsltKeyDefPtr prev = style->keys;
 
    while (prev->next != NULL)
        prev = prev->next;
 
    prev->next = key;
    }
    key->next = NULL;
    key = NULL;
 
error:
    if (pattern != NULL)
    xmlFree(pattern);
    if (key != NULL)
        xsltFreeKeyDef(key);
    return(0);
}

Referenced by xsltParseStylesheetKey().

xsltFreeDocumentKeys()

XSLTPUBFUN void XSLTCALL xsltFreeDocumentKeys

(

xsltDocumentPtr

idoc

)

xsltFreeDocumentKeys: @idoc: a XSLT document

Free the keys associated to a document

Definition at line 925 of file keys.c.

                                           {
    if (idoc != NULL)
        xsltFreeKeyTableList(idoc->keys);
}

Referenced by xsltFreeDocuments(), xsltFreeRVTs(), xsltFreeStyleDocuments(), xsltReleaseRVT(), and xsltTransformCacheFree().

xsltFreeKeys()

XSLTPUBFUN void XSLTCALL xsltFreeKeys

(

xsltStylesheetPtr

style

)

xsltFreeKeys: @style: an XSLT stylesheet

Free up the memory used by XSLT keys in a stylesheet

Definition at line 185 of file keys.c.

                                      {
    if (style->keys)
    xsltFreeKeyDefList((xsltKeyDefPtr) style->keys);
}

Referenced by xsltFreeStylesheet().

xsltGetKey()

XSLTPUBFUN xmlNodeSetPtr XSLTCALL xsltGetKey	(	xsltTransformContextPtr	ctxt,
		const xmlChar *	name,
		const xmlChar *	nameURI,
		const xmlChar *	value
	)

Definition at line 417 of file keys.c.

                                                     {
    xmlNodeSetPtr ret;
    xsltKeyTablePtr table;
    int init_table = 0;
 
    if ((ctxt == NULL) || (name == NULL) || (value == NULL) ||
    (ctxt->document == NULL))
    return(NULL);
 
#ifdef WITH_XSLT_DEBUG_KEYS
    xsltGenericDebug(xsltGenericDebugContext,
    "Get key %s, value %s\n", name, value);
#endif
 
    /*
     * keys are computed only on-demand on first key access for a document
     */
    if ((ctxt->document->nbKeysComputed < ctxt->nbKeys) &&
        (ctxt->keyInitLevel == 0)) {
        /*
     * If non-recursive behaviour, just try to initialize all keys
     */
    if (xsltInitAllDocKeys(ctxt))
        return(NULL);
    }
 
retry:
    table = (xsltKeyTablePtr) ctxt->document->keys;
    while (table != NULL) {
    if (((nameURI != NULL) == (table->nameURI != NULL)) &&
        xmlStrEqual(table->name, name) &&
        xmlStrEqual(table->nameURI, nameURI))
    {
        ret = (xmlNodeSetPtr)xmlHashLookup(table->keys, value);
        return(ret);
    }
    table = table->next;
    }
 
    if ((ctxt->keyInitLevel != 0) && (init_table == 0)) {
        /*
     * Apparently one key is recursive and this one is needed,
     * initialize just it, that time and retry
     */
        xsltInitDocKeyTable(ctxt, name, nameURI);
    init_table = 1;
    goto retry;
    }
 
    return(NULL);
}

Referenced by xsltKeyFunction(), and xsltTestStepMatch().

xsltInitCtxtKeys()

XSLTPUBFUN void XSLTCALL xsltInitCtxtKeys	(	xsltTransformContextPtr	ctxt,
		xsltDocumentPtr	idoc
	)

xsltInitCtxtKeys: @ctxt: an XSLT transformation context @idoc: a document info

Computes all the keys tables for the current input document. Should be done before global varibales are initialized. NOTE: Not used anymore in the refactored code.

Definition at line 884 of file keys.c.

                                                                     {
    xsltStylesheetPtr style;
    xsltKeyDefPtr keyDef;
 
    if ((ctxt == NULL) || (idoc == NULL))
    return;
 
#ifdef KEY_INIT_DEBUG
fprintf(stderr, "xsltInitCtxtKeys on document\n");
#endif
 
#ifdef WITH_XSLT_DEBUG_KEYS
    if ((idoc->doc != NULL) && (idoc->doc->URL != NULL))
    XSLT_TRACE(ctxt,XSLT_TRACE_KEYS,xsltGenericDebug(xsltGenericDebugContext, "Initializing keys on %s\n",
             idoc->doc->URL));
#endif
    style = ctxt->style;
    while (style != NULL) {
    keyDef = (xsltKeyDefPtr) style->keys;
    while (keyDef != NULL) {
        xsltInitCtxtKey(ctxt, idoc, keyDef);
 
        keyDef = keyDef->next;
    }
 
    style = xsltNextImport(style);
    }
 
#ifdef KEY_INIT_DEBUG
fprintf(stderr, "xsltInitCtxtKeys on document: done\n");
#endif
 
}