Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / XalanTransformerDefinitions_8hpp.html
blob: 992c19104b37275fa03fd232aaadfb178df75de1 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<h1>XalanTransformerDefinitions.hpp File Reference</h1> </div>
</div>
<div class="contents">
<code>#include &lt;<a class="el" href="PlatformDefinitions_8hpp_source.html">xalanc/Include/PlatformDefinitions.hpp</a>&gt;</code><br/>
<code>#include &lt;stddef.h&gt;</code><br/>
<div class="dynheader">
Include dependency graph for XalanTransformerDefinitions.hpp:</div>
<div class="dyncontent">
<div class="center"><img src="XalanTransformerDefinitions_8hpp__incl.png" border="0" usemap="#XalanTransformerDefinitions_8hpp" alt=""/></div>
<map name="XalanTransformerDefinitions_8hpp" id="XalanTransformerDefinitions_8hpp">
<area shape="rect" id="node3" href="PlatformDefinitions_8hpp.html" title="xalanc/Include/PlatformDefinitions.hpp" alt="" coords="284,83,548,112"/><area shape="rect" id="node9" href="XalanVersion_8hpp.html" title="XalanVersion.hpp" alt="" coords="549,160,683,189"/></map>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="XalanTransformerDefinitions_8hpp__dep__incl.png" border="0" usemap="#XalanTransformerDefinitions_8hppdep" alt=""/></div>
<map name="XalanTransformerDefinitions_8hppdep" id="XalanTransformerDefinitions_8hppdep">
<area shape="rect" id="node3" href="XalanCAPI_8h.html" title="XalanCAPI.h" alt="" coords="5,83,104,112"/><area shape="rect" id="node5" href="XalanCompiledStylesheet_8hpp.html" title="XalanCompiledStylesheet.hpp" alt="" coords="128,83,341,112"/><area shape="rect" id="node7" href="XalanCompiledStylesheetDefault_8hpp.html" title="XalanCompiledStylesheetDefault.hpp" alt="" coords="111,160,372,189"/><area shape="rect" id="node10" href="XalanDefaultDocumentBuilder_8hpp.html" title="XalanDefaultDocumentBuilder.hpp" alt="" coords="369,237,612,267"/><area shape="rect" id="node12" href="XalanDefaultParsedSource_8hpp.html" title="XalanDefaultParsedSource.hpp" alt="" coords="681,160,903,189"/><area shape="rect" id="node14" href="XalanDocumentBuilder_8hpp.html" title="XalanDocumentBuilder.hpp" alt="" coords="460,160,657,189"/><area shape="rect" id="node17" href="XalanParsedSource_8hpp.html" title="XalanParsedSource.hpp" alt="" coords="784,83,960,112"/><area shape="rect" id="node21" href="XalanSourceTreeWrapperParsedSource_8hpp.html" title="XalanSourceTreeWrapperParsedSource.hpp" alt="" coords="927,160,1228,189"/><area shape="rect" id="node23" href="XercesDOMParsedSource_8hpp.html" title="XercesDOMParsedSource.hpp" alt="" coords="1252,160,1465,189"/><area shape="rect" id="node25" href="XercesDOMWrapperParsedSource_8hpp.html" title="XercesDOMWrapperParsedSource.hpp" alt="" coords="1489,160,1756,189"/><area shape="rect" id="node28" href="XalanTransformer_8hpp.html" title="XalanTransformer.hpp" alt="" coords="1136,83,1299,112"/><area shape="rect" id="node30" href="XalanTransformerOutputStream_8hpp.html" title="XalanTransformerOutputStream.hpp" alt="" coords="1323,83,1579,112"/><area shape="rect" id="node32" href="XalanTransformerProblemListener_8hpp.html" title="XalanTransformerProblemListener.hpp" alt="" coords="1603,83,1869,112"/></map>
</div>
<p><a href="XalanTransformerDefinitions_8hpp_source.html">Go to the source code of this file.</a></p>
<h2><a name="define-members"></a>
Defines</h2>
<ul>
<li>#define <a class="el" href="XalanTransformerDefinitions_8hpp.html#abb0a9d8e3ccf047d7e075c163038ee8d">XALAN_TRANSFORMER_EXPORT</a>&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT
<li>#define <a class="el" href="XalanTransformerDefinitions_8hpp.html#a5aa74eeffd2d139d60b0b91fe3ae9318">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(T)&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT_FUNCTION(T)
</ul>
<h2><a name="typedef-members"></a>
Typedefs</h2>
<ul>
<li>typedef size_t <a class="el" href="XalanTransformerDefinitions_8hpp.html#afd4f91ae9e8605677b840deab35d0774">CallbackSizeType</a>
<li>typedef <a class="el" href="XalanTransformerDefinitions_8hpp.html#afd4f91ae9e8605677b840deab35d0774">CallbackSizeType</a>(* <a class="el" href="XalanTransformerDefinitions_8hpp.html#a1dc959aba772c6560c207640b1078029">XalanOutputHandlerType</a> )(const char *, <a class="el" href="XalanTransformerDefinitions_8hpp.html#afd4f91ae9e8605677b840deab35d0774">CallbackSizeType</a>, void *)
<dl class="el"><dd class="mdescRight">Callback function passed to the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> APIs. <a href="#a1dc959aba772c6560c207640b1078029"></a><br/></dl><li>typedef void(* <a class="el" href="XalanTransformerDefinitions_8hpp.html#af9c91954b5abd9dde361ad9631c12295">XalanFlushHandlerType</a> )(void *)
<dl class="el"><dd class="mdescRight">Callback function passed to the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> APIs. <a href="#af9c91954b5abd9dde361ad9631c12295"></a><br/></dl></ul>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="abb0a9d8e3ccf047d7e075c163038ee8d"></a><!-- doxytag: member="XalanTransformerDefinitions.hpp::XALAN_TRANSFORMER_EXPORT" ref="abb0a9d8e3ccf047d7e075c163038ee8d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XALAN_TRANSFORMER_EXPORT&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanTransformerDefinitions_8hpp_source.html#l00039">39</a> of file <a class="el" href="XalanTransformerDefinitions_8hpp_source.html">XalanTransformerDefinitions.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5aa74eeffd2d139d60b0b91fe3ae9318"></a><!-- doxytag: member="XalanTransformerDefinitions.hpp::XALAN_TRANSFORMER_EXPORT_FUNCTION" ref="a5aa74eeffd2d139d60b0b91fe3ae9318" args="(T)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XALAN_TRANSFORMER_EXPORT_FUNCTION</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">T</td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT_FUNCTION(T)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanTransformerDefinitions_8hpp_source.html#l00041">41</a> of file <a class="el" href="XalanTransformerDefinitions_8hpp_source.html">XalanTransformerDefinitions.hpp</a>.</p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="afd4f91ae9e8605677b840deab35d0774"></a><!-- doxytag: member="XalanTransformerDefinitions.hpp::CallbackSizeType" ref="afd4f91ae9e8605677b840deab35d0774" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t <a class="el" href="XalanTransformerDefinitions_8hpp.html#afd4f91ae9e8605677b840deab35d0774">CallbackSizeType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XalanTransformerDefinitions_8hpp_source.html#l00050">50</a> of file <a class="el" href="XalanTransformerDefinitions_8hpp_source.html">XalanTransformerDefinitions.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="af9c91954b5abd9dde361ad9631c12295"></a><!-- doxytag: member="XalanTransformerDefinitions.hpp::XalanFlushHandlerType" ref="af9c91954b5abd9dde361ad9631c12295" args=")(void *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="XalanTransformerDefinitions_8hpp.html#af9c91954b5abd9dde361ad9631c12295">XalanFlushHandlerType</a>)(void *)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Callback function passed to the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> APIs. </p>
<p>Used to flush the buffer once transform is completed.</p>
<p>static void xalanFlushHandler(const void *handle);</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="XalanTransformerDefinitions_8hpp_source.html#l00080">80</a> of file <a class="el" href="XalanTransformerDefinitions_8hpp_source.html">XalanTransformerDefinitions.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1dc959aba772c6560c207640b1078029"></a><!-- doxytag: member="XalanTransformerDefinitions.hpp::XalanOutputHandlerType" ref="a1dc959aba772c6560c207640b1078029" args=")(const char *, CallbackSizeType, void *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="XalanTransformerDefinitions_8hpp.html#afd4f91ae9e8605677b840deab35d0774">CallbackSizeType</a>(* <a class="el" href="XalanTransformerDefinitions_8hpp.html#a1dc959aba772c6560c207640b1078029">XalanOutputHandlerType</a>)(const char *, <a class="el" href="XalanTransformerDefinitions_8hpp.html#afd4f91ae9e8605677b840deab35d0774">CallbackSizeType</a>, void *)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Callback function passed to the <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> APIs. </p>
<p>Used to process transformation output in blocks of data. Caller is responsible for streaming or copying data to a user allocated buffer. Caller should not attempt to write to or free this data.</p>
<p>The callback should return the number of bytes written, and this number should match the length received. Otherwise the XalanTransformToHandler function terminates and returns an error status.</p>
<p>static unsigned long xalanOutputHandler(const void* data, unsigned long length, const void *handle);</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>a block of data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>length of block </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>handle of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes written </dd></dl>
<p>Definition at line <a class="el" href="XalanTransformerDefinitions_8hpp_source.html#l00070">70</a> of file <a class="el" href="XalanTransformerDefinitions_8hpp_source.html">XalanTransformerDefinitions.hpp</a>.</p>
</div>
</div>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>