| 1 |
<?xml version="1.0" encoding="UTF-8"?> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
| 5 |
<title>keys: interface for the key matching used in key() and template matches.</title> |
| 6 |
<meta name="generator" content="Libxml2 devhelp stylesheet"/> |
| 7 |
<link rel="start" href="index.html" title="libxslt Reference Manual"/> |
| 8 |
<link rel="up" href="general.html" title="API"/> |
| 9 |
<link rel="stylesheet" href="style.css" type="text/css"/> |
| 10 |
<link rel="chapter" href="general.html" title="API"/> |
| 11 |
</head> |
| 12 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 13 |
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> |
| 14 |
<tr valign="middle"> |
| 15 |
<td> |
| 16 |
<a accesskey="p" href="libxslt-imports.html"> |
| 17 |
<img src="left.png" width="24" height="24" border="0" alt="Prev"/> |
| 18 |
</a> |
| 19 |
</td> |
| 20 |
<td> |
| 21 |
<a accesskey="u" href="general.html"> |
| 22 |
<img src="up.png" width="24" height="24" border="0" alt="Up"/> |
| 23 |
</a> |
| 24 |
</td> |
| 25 |
<td> |
| 26 |
<a accesskey="h" href="index.html"> |
| 27 |
<img src="home.png" width="24" height="24" border="0" alt="Home"/> |
| 28 |
</a> |
| 29 |
</td> |
| 30 |
<td> |
| 31 |
<a accesskey="n" href="libxslt-namespaces.html"> |
| 32 |
<img src="right.png" width="24" height="24" border="0" alt="Next"/> |
| 33 |
</a> |
| 34 |
</td> |
| 35 |
<th width="100%" align="center">libxslt Reference Manual</th> |
| 36 |
</tr> |
| 37 |
</table> |
| 38 |
<h2> |
| 39 |
<span class="refentrytitle">keys</span> |
| 40 |
</h2> |
| 41 |
<p>keys - interface for the key matching used in key() and template matches.</p> |
| 42 |
<p>implementation of the key mechanims. </p> |
| 43 |
<p>Author(s): Daniel Veillard </p> |
| 44 |
<div class="refsynopsisdiv"> |
| 45 |
<h2>Synopsis</h2> |
| 46 |
<pre class="synopsis">#define <a href="#NODE_IS_KEYED">NODE_IS_KEYED</a>; |
| 47 |
int <a href="#xsltAddKey">xsltAddKey</a> (<a href="libxslt-xsltInternals.html#xsltStylesheetPtr">xsltStylesheetPtr</a> style, <br/> const xmlChar * name, <br/> const xmlChar * nameURI, <br/> const xmlChar * match, <br/> const xmlChar * use, <br/> xmlNodePtr inst); |
| 48 |
void <a href="#xsltFreeDocumentKeys">xsltFreeDocumentKeys</a> (<a href="libxslt-xsltInternals.html#xsltDocumentPtr">xsltDocumentPtr</a> idoc); |
| 49 |
void <a href="#xsltFreeKeys">xsltFreeKeys</a> (<a href="libxslt-xsltInternals.html#xsltStylesheetPtr">xsltStylesheetPtr</a> style); |
| 50 |
xmlNodeSetPtr <a href="#xsltGetKey">xsltGetKey</a> (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt, <br/> const xmlChar * name, <br/> const xmlChar * nameURI, <br/> const xmlChar * value); |
| 51 |
void <a href="#xsltInitCtxtKeys">xsltInitCtxtKeys</a> (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt, <br/> <a href="libxslt-xsltInternals.html#xsltDocumentPtr">xsltDocumentPtr</a> idoc); |
| 52 |
</pre> |
| 53 |
</div> |
| 54 |
<div class="refsect1" lang="en"> |
| 55 |
<h2>Description</h2> |
| 56 |
</div> |
| 57 |
<div class="refsect1" lang="en"> |
| 58 |
<h2>Details</h2> |
| 59 |
<div class="refsect2" lang="en"> |
| 60 |
<div class="refsect2" lang="en"><h3><a name="NODE_IS_KEYED">Macro </a>NODE_IS_KEYED</h3><pre class="programlisting">#define <a href="#NODE_IS_KEYED">NODE_IS_KEYED</a>; |
| 61 |
</pre><p>check for bit 15 set</p> |
| 62 |
</div> |
| 63 |
<hr/> |
| 64 |
<div class="refsect2" lang="en"><h3><a name="xsltAddKey"/>xsltAddKey ()</h3><pre class="programlisting">int xsltAddKey (<a href="libxslt-xsltInternals.html#xsltStylesheetPtr">xsltStylesheetPtr</a> style, <br/> const xmlChar * name, <br/> const xmlChar * nameURI, <br/> const xmlChar * match, <br/> const xmlChar * use, <br/> xmlNodePtr inst)<br/> |
| 65 |
</pre><p>add a key definition to a stylesheet</p> |
| 66 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>style</tt></i>:</span></td><td>an XSLT stylesheet</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the key name or NULL</td></tr><tr><td><span class="term"><i><tt>nameURI</tt></i>:</span></td><td>the name URI or NULL</td></tr><tr><td><span class="term"><i><tt>match</tt></i>:</span></td><td>the match value</td></tr><tr><td><span class="term"><i><tt>use</tt></i>:</span></td><td>the use value</td></tr><tr><td><span class="term"><i><tt>inst</tt></i>:</span></td><td>the key instruction</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, and -1 in case of failure.</td></tr></tbody></table></div></div> |
| 67 |
<hr/> |
| 68 |
<div class="refsect2" lang="en"><h3><a name="xsltFreeDocumentKeys"/>xsltFreeDocumentKeys ()</h3><pre class="programlisting">void xsltFreeDocumentKeys (<a href="libxslt-xsltInternals.html#xsltDocumentPtr">xsltDocumentPtr</a> idoc)<br/> |
| 69 |
</pre><p>Free the keys associated to a document</p> |
| 70 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>idoc</tt></i>:</span></td><td>a XSLT document</td></tr></tbody></table></div></div> |
| 71 |
<hr/> |
| 72 |
<div class="refsect2" lang="en"><h3><a name="xsltFreeKeys"/>xsltFreeKeys ()</h3><pre class="programlisting">void xsltFreeKeys (<a href="libxslt-xsltInternals.html#xsltStylesheetPtr">xsltStylesheetPtr</a> style)<br/> |
| 73 |
</pre><p>Free up the memory used by XSLT keys in a stylesheet</p> |
| 74 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>style</tt></i>:</span></td><td>an XSLT stylesheet</td></tr></tbody></table></div></div> |
| 75 |
<hr/> |
| 76 |
<div class="refsect2" lang="en"><h3><a name="xsltGetKey"/>xsltGetKey ()</h3><pre class="programlisting">xmlNodeSetPtr xsltGetKey (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt, <br/> const xmlChar * name, <br/> const xmlChar * nameURI, <br/> const xmlChar * value)<br/> |
| 77 |
</pre><p>Looks up a key of the in current source doc (the document info on @ctxt->document). Computes the key if not already done for the current source doc.</p> |
| 78 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>an XSLT transformation context</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the key name or NULL</td></tr><tr><td><span class="term"><i><tt>nameURI</tt></i>:</span></td><td>the name URI or NULL</td></tr><tr><td><span class="term"><i><tt>value</tt></i>:</span></td><td>the key value to look for</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the nodeset resulting from the query or NULL</td></tr></tbody></table></div></div> |
| 79 |
<hr/> |
| 80 |
<div class="refsect2" lang="en"><h3><a name="xsltInitCtxtKeys"/>xsltInitCtxtKeys ()</h3><pre class="programlisting">void xsltInitCtxtKeys (<a href="libxslt-xsltInternals.html#xsltTransformContextPtr">xsltTransformContextPtr</a> ctxt, <br/> <a href="libxslt-xsltInternals.html#xsltDocumentPtr">xsltDocumentPtr</a> idoc)<br/> |
| 81 |
</pre><p>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.</p> |
| 82 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>an XSLT transformation context</td></tr><tr><td><span class="term"><i><tt>idoc</tt></i>:</span></td><td>a document info</td></tr></tbody></table></div></div> |
| 83 |
<hr/> |
| 84 |
</div> |
| 85 |
</div> |
| 86 |
</body> |
| 87 |
</html> |