Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classStringTokenizer.html
blob: 2646fd924ccb278e47f246633a01acc4e18230db [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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>StringTokenizer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="StringTokenizer" -->
<p><code>#include &lt;<a class="el" href="StringTokenizer_8hpp_source.html">StringTokenizer.hpp</a>&gt;</code></p>
<p><a href="classStringTokenizer-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef size_t <a class="el" href="classStringTokenizer.html#a5a7d346fff7b5beb0ef0aa4e0d09a50b">size_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classStringTokenizer.html#a89555e26dfc4429d2c855a8aa317d208">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 class="mdescRight">Constructs a tokenizer for the target string. <a href="#a89555e26dfc4429d2c855a8aa317d208"></a><br/></dl><li><a class="el" href="classStringTokenizer.html#a7af341f88b9f894bcca74a4ad61d08db">StringTokenizer</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theString, const XalanDOMChar *theTokens=<a class="el" href="classStringTokenizer.html#aea113a60f41b3a554b157ef42ef100e9">s_defaultTokens</a>, bool fReturnTokens=false)
<dl class="el"><dd class="mdescRight">Constructs a tokenizer for the target string. <a href="#a7af341f88b9f894bcca74a4ad61d08db"></a><br/></dl><li><a class="el" href="classStringTokenizer.html#ac1a0da945bd0b67b0ef9ff9c4fab7e9e">StringTokenizer</a> (const XalanDOMChar *theString, const XalanDOMChar *theTokens=<a class="el" href="classStringTokenizer.html#aea113a60f41b3a554b157ef42ef100e9">s_defaultTokens</a>, bool fReturnTokens=false)
<dl class="el"><dd class="mdescRight">Constructs a tokenizer for the target string. <a href="#ac1a0da945bd0b67b0ef9ff9c4fab7e9e"></a><br/></dl><li><a class="el" href="classStringTokenizer.html#a58eb264d4756b42415dfbebdccaae25c">StringTokenizer</a> (const XalanDOMChar *theString, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theTokens, bool fReturnTokens=false)
<dl class="el"><dd class="mdescRight">Constructs a tokenizer for the target string. <a href="#a58eb264d4756b42415dfbebdccaae25c"></a><br/></dl><li><a class="el" href="classStringTokenizer.html#a26a59cd69f871ace17ec831e1508b377">~StringTokenizer</a> ()
<li>bool <a class="el" href="classStringTokenizer.html#aae2b0616e31bf6342f3417677f2a2c83">hasMoreTokens</a> () const
<dl class="el"><dd class="mdescRight">Determine if there are tokens remaining. <a href="#aae2b0616e31bf6342f3417677f2a2c83"></a><br/></dl><li>void <a class="el" href="classStringTokenizer.html#a5e0eddb7f69411c7b36e92ea1027acd1">nextToken</a> (<a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theToken)
<dl class="el"><dd class="mdescRight">Retrieve the next token to be parsed; behavior is undefined if there are no more tokens. <a href="#a5e0eddb7f69411c7b36e92ea1027acd1"></a><br/></dl><li><a class="el" href="classStringTokenizer.html#a5a7d346fff7b5beb0ef0aa4e0d09a50b">size_type</a> <a class="el" href="classStringTokenizer.html#a0ecda10a892a98ce62f0cfabf15e8fba">countTokens</a> () const
<dl class="el"><dd class="mdescRight">Count the number of tokens yet to be parsed. <a href="#a0ecda10a892a98ce62f0cfabf15e8fba"></a><br/></dl><li>void <a class="el" href="classStringTokenizer.html#a970150b7f574ffe0d09b47c4ad3d06da">reset</a> ()
</ul>
<h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2>
<ul>
<li>static const XalanDOMChar <a class="el" href="classStringTokenizer.html#aea113a60f41b3a554b157ef42ef100e9">s_defaultTokens</a> []
</ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li><a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> <a class="el" href="classStringTokenizer.html#a6ce25429a21726bc9de4c9282dd506e2">FindNextDelimiterIndex</a> (<a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theStartIndex) const
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="StringTokenizer_8hpp_source.html#l00040">40</a> of file <a class="el" href="StringTokenizer_8hpp_source.html">StringTokenizer.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a5a7d346fff7b5beb0ef0aa4e0d09a50b"></a><!-- doxytag: member="StringTokenizer::size_type" ref="a5a7d346fff7b5beb0ef0aa4e0d09a50b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t <a class="el" href="classStringTokenizer.html#a5a7d346fff7b5beb0ef0aa4e0d09a50b">StringTokenizer::size_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="StringTokenizer_8hpp_source.html#l00046">46</a> of file <a class="el" href="StringTokenizer_8hpp_source.html">StringTokenizer.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a89555e26dfc4429d2c855a8aa317d208"></a><!-- doxytag: member="StringTokenizer::StringTokenizer" ref="a89555e26dfc4429d2c855a8aa317d208" args="(const XalanDOMString &amp;theString, const XalanDOMString &amp;theTokens, bool fReturnTokens=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringTokenizer::StringTokenizer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theTokens</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fReturnTokens</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a tokenizer for the target string. </p>
<p>No copies of any input strings are made.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theString</em>&nbsp;</td><td>string to tokenize </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTokens</em>&nbsp;</td><td>string of delimiters used to parse target, default is " \t\n\r" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fReturnTokens</em>&nbsp;</td><td>if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7af341f88b9f894bcca74a4ad61d08db"></a><!-- doxytag: member="StringTokenizer::StringTokenizer" ref="a7af341f88b9f894bcca74a4ad61d08db" args="(const XalanDOMString &amp;theString, const XalanDOMChar *theTokens=s_defaultTokens, bool fReturnTokens=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringTokenizer::StringTokenizer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>theTokens</em> = <code><a class="el" href="classStringTokenizer.html#aea113a60f41b3a554b157ef42ef100e9">s_defaultTokens</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fReturnTokens</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a tokenizer for the target string. </p>
<p>No copies of any input strings are made.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theString</em>&nbsp;</td><td>string to tokenize </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTokens</em>&nbsp;</td><td>string of delimiters used to parse target, default is " \t\n\r" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fReturnTokens</em>&nbsp;</td><td>if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac1a0da945bd0b67b0ef9ff9c4fab7e9e"></a><!-- doxytag: member="StringTokenizer::StringTokenizer" ref="ac1a0da945bd0b67b0ef9ff9c4fab7e9e" args="(const XalanDOMChar *theString, const XalanDOMChar *theTokens=s_defaultTokens, bool fReturnTokens=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringTokenizer::StringTokenizer </td>
<td>(</td>
<td class="paramtype">const XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>theString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>theTokens</em> = <code><a class="el" href="classStringTokenizer.html#aea113a60f41b3a554b157ef42ef100e9">s_defaultTokens</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fReturnTokens</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a tokenizer for the target string. </p>
<p>No copies of any input strings are made.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theString</em>&nbsp;</td><td>string to tokenize </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTokens</em>&nbsp;</td><td>string of delimiters used to parse target. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fReturnTokens</em>&nbsp;</td><td>if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a58eb264d4756b42415dfbebdccaae25c"></a><!-- doxytag: member="StringTokenizer::StringTokenizer" ref="a58eb264d4756b42415dfbebdccaae25c" args="(const XalanDOMChar *theString, const XalanDOMString &amp;theTokens, bool fReturnTokens=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringTokenizer::StringTokenizer </td>
<td>(</td>
<td class="paramtype">const XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>theString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theTokens</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fReturnTokens</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a tokenizer for the target string. </p>
<p>No copies of any input strings are made.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theString</em>&nbsp;</td><td>string to tokenize </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theTokens</em>&nbsp;</td><td>string of delimiters used to parse target. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fReturnTokens</em>&nbsp;</td><td>if true, delimiter characters are also returned as tokens, default is false </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a26a59cd69f871ace17ec831e1508b377"></a><!-- doxytag: member="StringTokenizer::~StringTokenizer" ref="a26a59cd69f871ace17ec831e1508b377" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringTokenizer::~StringTokenizer </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0ecda10a892a98ce62f0cfabf15e8fba"></a><!-- doxytag: member="StringTokenizer::countTokens" ref="a0ecda10a892a98ce62f0cfabf15e8fba" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStringTokenizer.html#a5a7d346fff7b5beb0ef0aa4e0d09a50b">size_type</a> StringTokenizer::countTokens </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Count the number of tokens yet to be parsed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of remaining tokens </dd></dl>
</div>
</div>
<a class="anchor" id="a6ce25429a21726bc9de4c9282dd506e2"></a><!-- doxytag: member="StringTokenizer::FindNextDelimiterIndex" ref="a6ce25429a21726bc9de4c9282dd506e2" args="(XalanDOMString::size_type theStartIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> StringTokenizer::FindNextDelimiterIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a>&nbsp;</td>
<td class="paramname"> <em>theStartIndex</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aae2b0616e31bf6342f3417677f2a2c83"></a><!-- doxytag: member="StringTokenizer::hasMoreTokens" ref="aae2b0616e31bf6342f3417677f2a2c83" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool StringTokenizer::hasMoreTokens </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if there are tokens remaining. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if there are more tokens </dd></dl>
</div>
</div>
<a class="anchor" id="a5e0eddb7f69411c7b36e92ea1027acd1"></a><!-- doxytag: member="StringTokenizer::nextToken" ref="a5e0eddb7f69411c7b36e92ea1027acd1" args="(XalanDOMString &amp;theToken)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringTokenizer::nextToken </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theToken</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the next token to be parsed; behavior is undefined if there are no more tokens. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theToken</em>&nbsp;</td><td>next token string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a970150b7f574ffe0d09b47c4ad3d06da"></a><!-- doxytag: member="StringTokenizer::reset" ref="a970150b7f574ffe0d09b47c4ad3d06da" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringTokenizer::reset </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="StringTokenizer_8hpp_source.html#l00131">131</a> of file <a class="el" href="StringTokenizer_8hpp_source.html">StringTokenizer.hpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aea113a60f41b3a554b157ef42ef100e9"></a><!-- doxytag: member="StringTokenizer::s_defaultTokens" ref="aea113a60f41b3a554b157ef42ef100e9" args="[]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XalanDOMChar <a class="el" href="classStringTokenizer.html#aea113a60f41b3a554b157ef42ef100e9">StringTokenizer::s_defaultTokens</a>[]<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="StringTokenizer_8hpp_source.html#l00044">44</a> of file <a class="el" href="StringTokenizer_8hpp_source.html">StringTokenizer.hpp</a>.</p>
</div>
</div>
<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></li>
</ul>
</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>