blob: 0c885ff79d7f4629348df588d357c504bab896ab [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>StringTokenizer Class Reference</h1><code>#include &lt;<a class="el" href="StringTokenizer_8hpp-source.html">StringTokenizer.hpp</a>&gt;</code>
<p>
<a href="classStringTokenizer-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef size_t <a class="el" href="classStringTokenizer.html#s0">size_type</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classStringTokenizer.html#a0">StringTokenizer</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theString, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theTokens, bool fReturnTokens=false)
<dl class="el"><dd><font size=-1><em>Constructs a tokenizer for the target string.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li><a class="el" href="classStringTokenizer.html#a1">StringTokenizer</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theString, const XalanDOMChar *theTokens=<a class="el" href="classStringTokenizer.html#p0">s_defaultTokens</a>, bool fReturnTokens=false)
<dl class="el"><dd><font size=-1><em>Constructs a tokenizer for the target string.</em> <a href="#a1">More...</a><em><br><br></em></font></dl><li><a class="el" href="classStringTokenizer.html#a2">StringTokenizer</a> (const XalanDOMChar *theString, const XalanDOMChar *theTokens=<a class="el" href="classStringTokenizer.html#p0">s_defaultTokens</a>, bool fReturnTokens=false)
<dl class="el"><dd><font size=-1><em>Constructs a tokenizer for the target string.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li><a class="el" href="classStringTokenizer.html#a3">StringTokenizer</a> (const XalanDOMChar *theString, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theTokens, bool fReturnTokens=false)
<dl class="el"><dd><font size=-1><em>Constructs a tokenizer for the target string.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li><a class="el" href="classStringTokenizer.html#a4">~StringTokenizer</a> ()
<li>bool <a class="el" href="classStringTokenizer.html#a5">hasMoreTokens</a> () const
<dl class="el"><dd><font size=-1><em>Determine if there are tokens remaining.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classStringTokenizer.html#a6">nextToken</a> (<a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theToken)
<dl class="el"><dd><font size=-1><em>Retrieve the next token to be parsed; behavior is undefined if there are no more tokens.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li><a class="el" href="classStringTokenizer.html#s0">size_type</a> <a class="el" href="classStringTokenizer.html#a7">countTokens</a> () const
<dl class="el"><dd><font size=-1><em>Count the number of tokens yet to be parsed.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classStringTokenizer.html#a8">reset</a> ()
</ul>
<h2>Static Public Attributes</h2>
<ul>
<li>const XalanDOMChar <a class="el" href="classStringTokenizer.html#p0">s_defaultTokens</a> []
</ul>
<h2>Protected Methods</h2>
<ul>
<li><a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <a class="el" href="classStringTokenizer.html#b0">FindNextDelimiterIndex</a> (<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> theStartIndex) const
</ul>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="StringTokenizer::size_type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef size_t StringTokenizer::size_type
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="StringTokenizer::StringTokenizer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
StringTokenizer::StringTokenizer (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theString</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theTokens</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>fReturnTokens</em> = false&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructs a tokenizer for the target string.
<p>
No copies of any input strings are made.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theString</em>
&nbsp;</td><td>
string to tokenize </td></tr>
<tr><td valign=top><em>theTokens</em>
&nbsp;</td><td>
string of delimiters used to parse target, default is " \t<br>
\r" </td></tr>
<tr><td valign=top><em>fReturnTokens</em>
&nbsp;</td><td>
if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="StringTokenizer::StringTokenizer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
StringTokenizer::StringTokenizer (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theString</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const XalanDOMChar * <em>theTokens</em> = <a class="el" href="classStringTokenizer.html#p0">s_defaultTokens</a>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>fReturnTokens</em> = false&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructs a tokenizer for the target string.
<p>
No copies of any input strings are made.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theString</em>
&nbsp;</td><td>
string to tokenize </td></tr>
<tr><td valign=top><em>theTokens</em>
&nbsp;</td><td>
string of delimiters used to parse target, default is " \t<br>
\r" </td></tr>
<tr><td valign=top><em>fReturnTokens</em>
&nbsp;</td><td>
if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="StringTokenizer::StringTokenizer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
StringTokenizer::StringTokenizer (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theString</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const XalanDOMChar * <em>theTokens</em> = <a class="el" href="classStringTokenizer.html#p0">s_defaultTokens</a>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>fReturnTokens</em> = false&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructs a tokenizer for the target string.
<p>
No copies of any input strings are made.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theString</em>
&nbsp;</td><td>
string to tokenize </td></tr>
<tr><td valign=top><em>theTokens</em>
&nbsp;</td><td>
string of delimiters used to parse target. </td></tr>
<tr><td valign=top><em>fReturnTokens</em>
&nbsp;</td><td>
if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="StringTokenizer::StringTokenizer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
StringTokenizer::StringTokenizer (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theString</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theTokens</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>fReturnTokens</em> = false&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructs a tokenizer for the target string.
<p>
No copies of any input strings are made.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theString</em>
&nbsp;</td><td>
string to tokenize </td></tr>
<tr><td valign=top><em>theTokens</em>
&nbsp;</td><td>
string of delimiters used to parse target. </td></tr>
<tr><td valign=top><em>fReturnTokens</em>
&nbsp;</td><td>
if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="StringTokenizer::~StringTokenizer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
StringTokenizer::~StringTokenizer (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b0" doxytag="StringTokenizer::FindNextDelimiterIndex"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> StringTokenizer::FindNextDelimiterIndex (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <em>theStartIndex</em>&nbsp;) const<code> [protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="StringTokenizer::countTokens"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classStringTokenizer.html#s0">size_type</a> StringTokenizer::countTokens (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Count the number of tokens yet to be parsed.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
number of remaining tokens </dl> </td>
</tr>
</table>
<a name="a5" doxytag="StringTokenizer::hasMoreTokens"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool StringTokenizer::hasMoreTokens (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Determine if there are tokens remaining.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if there are more tokens </dl> </td>
</tr>
</table>
<a name="a6" doxytag="StringTokenizer::nextToken"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void StringTokenizer::nextToken (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theToken</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Retrieve the next token to be parsed; behavior is undefined if there are no more tokens.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theToken</em>
&nbsp;</td><td>
next token string </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a8" doxytag="StringTokenizer::reset"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void StringTokenizer::reset (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="StringTokenizer::s_defaultTokens"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const XalanDOMChar StringTokenizer::s_defaultTokens<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="StringTokenizer_8hpp-source.html">StringTokenizer.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">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="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<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.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>