<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ICU 52.1: usetiter.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ICU 52.1
 <span id="projectnumber">52.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_f59c6450ff718ff1b085cfd1c36acbd7.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">usetiter.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="usetiter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">**********************************************************************</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Copyright (c) 2002-2008, International Business Machines</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">**********************************************************************</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef USETITER_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span><span class="preprocessor">#define USETITER_H</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">unicode/utypes.h</a>"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="uobject_8h.html" title="C++ API: Common ICU base class UObject.">unicode/uobject.h</a>"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="unistr_8h.html" title="C++ API: Unicode String.">unicode/unistr.h</a>"</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b" title="This is used to begin a declaration of a public ICU C++ API.">U_NAMESPACE_BEGIN</a></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">class </span>UnicodeSet;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">class </span>UnicodeString;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html"> 61</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334" title="Set to export library symbols from inside the common library, and to import them from outside...">U_COMMON_API</a> <a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">enum</span> { IS_STRING = -1 };</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#ac3ecdc87ac4b97965c5d9665f86ca7ea"> 78</a></span>  <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> <a class="code" href="classicu_1_1UnicodeSetIterator.html#ac3ecdc87ac4b97965c5d9665f86ca7ea" title="Current code point, or the special value IS_STRING, if the iterator points to a string.">codepoint</a>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#a54cd2da6a4d79c5931807574a574c7a5"> 89</a></span>  <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> <a class="code" href="classicu_1_1UnicodeSetIterator.html#a54cd2da6a4d79c5931807574a574c7a5" title="When iterating over ranges using nextRange(), codepointEnd contains the inclusive end of the iteratio...">codepointEnd</a>;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#acc62a588e645c1af9dff1762b8f7010e"> 97</a></span>  <span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>* <a class="code" href="classicu_1_1UnicodeSetIterator.html#acc62a588e645c1af9dff1762b8f7010e" title="If codepoint == IS_STRING, then string points to the current string.">string</a>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>& <span class="keyword">set</span>);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>();</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>();</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> isString() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> getCodepoint() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> getCodepointEnd() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>& getString();</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> next();</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> nextRange();</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">void</span> reset(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>& <span class="keyword">set</span>);</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordtype">void</span> reset();</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">static</span> <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using the compiler's RTTI.">UClassID</a> U_EXPORT2 getStaticClassID();</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keyword">virtual</span> <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using the compiler's RTTI.">UClassID</a> <a class="code" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc" title="ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.">getDynamicClassID</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> </div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="comment">// ======================= PRIVATES ===========================</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="comment">// endElement and nextElements are really UChar32's, but we keep</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="comment">// them as signed int32_t's so we can do comparisons with</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="comment">// endElement set to -1. Leave them as int32_t's.</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#a61d0b62fb724949b50c2544763a59218"> 252</a></span> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>* <span class="keyword">set</span>;</div>
<div class="line"><a name="l00256"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#a743c73fd1bae46b5564b639e24bd6772"> 256</a></span>  int32_t <a class="code" href="classicu_1_1UnicodeSetIterator.html#a743c73fd1bae46b5564b639e24bd6772" title="End range.">endRange</a>;</div>
<div class="line"><a name="l00260"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#aa58ed06688ded3af156d4441d7650d9f"> 260</a></span>  int32_t <a class="code" href="classicu_1_1UnicodeSetIterator.html#aa58ed06688ded3af156d4441d7650d9f" title="Range.">range</a>;</div>
<div class="line"><a name="l00264"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#af2d4483a147f1d88872aa94b838163bd"> 264</a></span>  int32_t <a class="code" href="classicu_1_1UnicodeSetIterator.html#af2d4483a147f1d88872aa94b838163bd" title="End element.">endElement</a>;</div>
<div class="line"><a name="l00268"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#a24d181b411e85ca10063a474b7465781"> 268</a></span>  int32_t <a class="code" href="classicu_1_1UnicodeSetIterator.html#a24d181b411e85ca10063a474b7465781" title="Next element.">nextElement</a>;</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  <span class="comment">//UBool abbreviated;</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#aa9bee5cb302fd903a261030504e715c7"> 273</a></span> <span class="comment"></span> int32_t <a class="code" href="classicu_1_1UnicodeSetIterator.html#aa9bee5cb302fd903a261030504e715c7" title="Next string.">nextString</a>;</div>
<div class="line"><a name="l00277"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#ae333ca8987cb40f7556ac7ecc932f313"> 277</a></span>  int32_t <a class="code" href="classicu_1_1UnicodeSetIterator.html#ae333ca8987cb40f7556ac7ecc932f313" title="String count.">stringCount</a>;</div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div>
<div class="line"><a name="l00284"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#a9004ec1ce4aab111228a5ab68824dc9b"> 284</a></span>  <a class="code" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> *<a class="code" href="classicu_1_1UnicodeSetIterator.html#a9004ec1ce4aab111228a5ab68824dc9b" title="Points to the string to use when the caller asks for a string and the current iteration item is a cod...">cpString</a>;</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>&); <span class="comment">// disallow</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>& operator=(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>&); <span class="comment">// disallow</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> </div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> loadRange(int32_t range);</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> };</div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> </div>
<div class="line"><a name="l00303"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#adb61b31e62a5ddea5b8271de06637989"> 303</a></span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> UnicodeSetIterator::isString()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  <span class="keywordflow">return</span> codepoint == (<a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a>)IS_STRING;</div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> }</div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> </div>
<div class="line"><a name="l00307"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#af01d437c6fbabcff8f2d34f40edd5c7e"> 307</a></span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> UnicodeSetIterator::getCodepoint()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keywordflow">return</span> codepoint;</div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> }</div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> </div>
<div class="line"><a name="l00311"></a><span class="lineno"><a class="code" href="classicu_1_1UnicodeSetIterator.html#a2691946e4ed201d5185059f49be3f04d"> 311</a></span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> UnicodeSetIterator::getCodepointEnd()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  <span class="keywordflow">return</span> codepointEnd;</div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> }</div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> </div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933" title="This is used to end a declaration of a public ICU C++ API.">U_NAMESPACE_END</a></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 4 2013 14:10:22 for ICU 52.1 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
