| 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>functions: interface for the XSLT functions not from XPath</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-extra.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-imports.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">functions</span> |
| 40 |
</h2> |
| 41 |
<p>functions - interface for the XSLT functions not from XPath</p> |
| 42 |
<p>a set of extra functions coming from XSLT but not in XPath </p> |
| 43 |
<p>Author(s): Daniel Veillard and Bjorn Reese <[email protected]> </p> |
| 44 |
<div class="refsynopsisdiv"> |
| 45 |
<h2>Synopsis</h2> |
| 46 |
<pre class="synopsis">#define <a href="#XSLT_REGISTER_FUNCTION_LOOKUP">XSLT_REGISTER_FUNCTION_LOOKUP</a>; |
| 47 |
void <a href="#xsltDocumentFunction">xsltDocumentFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 48 |
void <a href="#xsltElementAvailableFunction">xsltElementAvailableFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 49 |
void <a href="#xsltFormatNumberFunction">xsltFormatNumberFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 50 |
void <a href="#xsltFunctionAvailableFunction">xsltFunctionAvailableFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 51 |
void <a href="#xsltGenerateIdFunction">xsltGenerateIdFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 52 |
void <a href="#xsltKeyFunction">xsltKeyFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 53 |
void <a href="#xsltRegisterAllFunctions">xsltRegisterAllFunctions</a> (xmlXPathContextPtr ctxt); |
| 54 |
void <a href="#xsltSystemPropertyFunction">xsltSystemPropertyFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 55 |
void <a href="#xsltUnparsedEntityURIFunction">xsltUnparsedEntityURIFunction</a> (xmlXPathParserContextPtr ctxt, <br/> int nargs); |
| 56 |
xmlXPathFunction <a href="#xsltXPathFunctionLookup">xsltXPathFunctionLookup</a> (void * vctxt, <br/> const xmlChar * name, <br/> const xmlChar * ns_uri); |
| 57 |
</pre> |
| 58 |
</div> |
| 59 |
<div class="refsect1" lang="en"> |
| 60 |
<h2>Description</h2> |
| 61 |
</div> |
| 62 |
<div class="refsect1" lang="en"> |
| 63 |
<h2>Details</h2> |
| 64 |
<div class="refsect2" lang="en"> |
| 65 |
<div class="refsect2" lang="en"><h3><a name="XSLT_REGISTER_FUNCTION_LOOKUP">Macro </a>XSLT_REGISTER_FUNCTION_LOOKUP</h3><pre class="programlisting">#define <a href="#XSLT_REGISTER_FUNCTION_LOOKUP">XSLT_REGISTER_FUNCTION_LOOKUP</a>; |
| 66 |
</pre><p>Registering macro, not general purpose at all but used in different modules.</p> |
| 67 |
</div> |
| 68 |
<hr/> |
| 69 |
<div class="refsect2" lang="en"><h3><a name="xsltDocumentFunction"/>xsltDocumentFunction ()</h3><pre class="programlisting">void xsltDocumentFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 70 |
</pre><p>Implement the document() XSLT function node-set document(object, node-set?)</p> |
| 71 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 72 |
<hr/> |
| 73 |
<div class="refsect2" lang="en"><h3><a name="xsltElementAvailableFunction"/>xsltElementAvailableFunction ()</h3><pre class="programlisting">void xsltElementAvailableFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 74 |
</pre><p>Implement the element-available() XSLT function boolean element-available(string)</p> |
| 75 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 76 |
<hr/> |
| 77 |
<div class="refsect2" lang="en"><h3><a name="xsltFormatNumberFunction"/>xsltFormatNumberFunction ()</h3><pre class="programlisting">void xsltFormatNumberFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 78 |
</pre><p>Implement the format-number() XSLT function string format-number(number, string, string?)</p> |
| 79 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 80 |
<hr/> |
| 81 |
<div class="refsect2" lang="en"><h3><a name="xsltFunctionAvailableFunction"/>xsltFunctionAvailableFunction ()</h3><pre class="programlisting">void xsltFunctionAvailableFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 82 |
</pre><p>Implement the function-available() XSLT function boolean function-available(string)</p> |
| 83 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 84 |
<hr/> |
| 85 |
<div class="refsect2" lang="en"><h3><a name="xsltGenerateIdFunction"/>xsltGenerateIdFunction ()</h3><pre class="programlisting">void xsltGenerateIdFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 86 |
</pre><p>Implement the generate-id() XSLT function string generate-id(node-set?)</p> |
| 87 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 88 |
<hr/> |
| 89 |
<div class="refsect2" lang="en"><h3><a name="xsltKeyFunction"/>xsltKeyFunction ()</h3><pre class="programlisting">void xsltKeyFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 90 |
</pre><p>Implement the key() XSLT function node-set key(string, object)</p> |
| 91 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 92 |
<hr/> |
| 93 |
<div class="refsect2" lang="en"><h3><a name="xsltRegisterAllFunctions"/>xsltRegisterAllFunctions ()</h3><pre class="programlisting">void xsltRegisterAllFunctions (xmlXPathContextPtr ctxt)<br/> |
| 94 |
</pre><p>Registers all default XSLT functions in this context</p> |
| 95 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath context</td></tr></tbody></table></div></div> |
| 96 |
<hr/> |
| 97 |
<div class="refsect2" lang="en"><h3><a name="xsltSystemPropertyFunction"/>xsltSystemPropertyFunction ()</h3><pre class="programlisting">void xsltSystemPropertyFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 98 |
</pre><p>Implement the system-property() XSLT function object system-property(string)</p> |
| 99 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 100 |
<hr/> |
| 101 |
<div class="refsect2" lang="en"><h3><a name="xsltUnparsedEntityURIFunction"/>xsltUnparsedEntityURIFunction ()</h3><pre class="programlisting">void xsltUnparsedEntityURIFunction (xmlXPathParserContextPtr ctxt, <br/> int nargs)<br/> |
| 102 |
</pre><p>Implement the unparsed-entity-uri() XSLT function string unparsed-entity-uri(string)</p> |
| 103 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XPath Parser context</td></tr><tr><td><span class="term"><i><tt>nargs</tt></i>:</span></td><td>the number of arguments</td></tr></tbody></table></div></div> |
| 104 |
<hr/> |
| 105 |
<div class="refsect2" lang="en"><h3><a name="xsltXPathFunctionLookup"/>xsltXPathFunctionLookup ()</h3><pre class="programlisting">xmlXPathFunction xsltXPathFunctionLookup (void * vctxt, <br/> const xmlChar * name, <br/> const xmlChar * ns_uri)<br/> |
| 106 |
</pre><p>This is the entry point when a function is needed by the XPath interpretor.</p> |
| 107 |
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>vctxt</tt></i>:</span></td><td>a void * but the XSLT transformation context actually</td></tr><tr><td><span class="term"><i><tt>name</tt></i>:</span></td><td>the function name</td></tr><tr><td><span class="term"><i><tt>ns_uri</tt></i>:</span></td><td>the function namespace URI</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the callback function or NULL if not found</td></tr></tbody></table></div></div> |
| 108 |
<hr/> |
| 109 |
</div> |
| 110 |
</div> |
| 111 |
</body> |
| 112 |
</html> |