<!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"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>ICU 49.1.1: sortkey.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 49.1.1  <span id="projectnumber">49.1.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <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="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_73bc6a9bb617ea1bc89a10aa59ce84e4.html">i18n</a></li><li class="navelem"><a class="el" href="dir_0119ce638985e8a1561a00fdb5f76ff6.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">sortkey.h</div> </div> </div><!--header--> <div class="contents"> <a href="sortkey_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) 1996-2011, International Business Machines Corporation and others.</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * 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="comment"> * File sortkey.h</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Created by: Helena Shih</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Modification History:</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Date Name Description</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * 6/20/97 helena Java class name change.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * 8/18/97 helena Added internal API documentation.</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 6/26/98 erm Changed to use byte arrays and memcmp.</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *****************************************************************************</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> */</span></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="preprocessor">#ifndef SORTKEY_H</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="preprocessor">#define SORTKEY_H</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</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="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#if !UCONFIG_NO_COLLATION</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="preprocessor">#ifndef U_HIDE_DEPRECATED_API</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</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="l00035"></a><span class="lineno"> 35</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="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "<a class="code" href="coll_8h.html" title="C++ API: Collation Service.">unicode/coll.h</a>"</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</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="l00039"></a><span class="lineno"> 39</span> </div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/* forward declaration */</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span><a class="code" href="classRuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a>;</div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> <div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="classCollationKey.html"> 97</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#ab9d90a30137b6ec046fe59e79b09745a" title="Set to export library symbols from inside the i18n library, and to import them from outside...">U_I18N_API</a> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> : <span class="keyword">public</span> <a class="code" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> {</div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>();</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</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="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>(<span class="keyword">const</span> uint8_t* values,</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  int32_t count);</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>(<span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& other);</div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">virtual</span> ~<a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>();</div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& operator=(<span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& other);</div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> <a class="code" href="stringpiece_8h.html#a7652049cbac0bfeae2cd2aa4514a3352" title="Global operator == for StringPiece.">operator==</a>(<span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& source) <span class="keyword">const</span>;</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> <a class="code" href="stringpiece_8h.html#abf0ccab9536bab551afc07de65eb5d95" title="Global operator != for StringPiece.">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& source) <span class="keyword">const</span>;</div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> isBogus(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keyword">const</span> uint8_t* getByteArray(int32_t& count) <span class="keyword">const</span>;</div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor">#ifdef U_USE_COLLATION_KEY_DEPRECATES</span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  uint8_t* toByteArray(int32_t& count) <span class="keyword">const</span>;</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <a class="code" href="classCollator.html#a05f22f81363f2613bea18a632b67686f" title="LESS is returned if source string is compared to be less than target string in the compare() method...">Collator::EComparisonResult</a> compareTo(<span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& target) <span class="keyword">const</span>;</div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <a class="code" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d" title="UCOL_LESS is returned if source string is compared to be less than target string in the u_strcoll() m...">UCollationResult</a> compareTo(<span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& target, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> &status) <span class="keyword">const</span>;</div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div> <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  int32_t hashCode(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</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="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262" 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="l00235"></a><span class="lineno"> 235</span> </div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</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="l00241"></a><span class="lineno"> 241</span> </div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keywordtype">void</span> adopt(uint8_t *values, int32_t capacity, int32_t count);</div> <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordtype">void</span> setLength(int32_t newLength);</div> <div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div> <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="comment">/*</span></div> <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * Creates a collation key with a string.</span></div> <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> */</span></div> <div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div> <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& ensureCapacity(int32_t newSize);</div> <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& setToBogus(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& reset(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  </div> <div class="line"><a name="l00282"></a><span class="lineno"><a class="code" href="classCollationKey.html#a1918e53ed4bb8208fdd6df3ed4ec2548"> 282</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classRuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a>;</div> <div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> fBogus;</div> <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  int32_t fCount;</div> <div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  int32_t fCapacity;</div> <div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  int32_t fHashCode;</div> <div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  uint8_t* fBytes;</div> <div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </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"> 307</span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a></div> <div class="line"><a name="l00308"></a><span class="lineno"><a class="code" href="classCollationKey.html#a85bb52c50f3baf2aad76282f719d6193"> 308</a></span> <a class="code" href="classCollationKey.html#a85bb52c50f3baf2aad76282f719d6193" title="Compare if two collation keys are not the same.">CollationKey::operator!=</a>(<span class="keyword">const</span> <a class="code" href="classCollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a>& other)<span class="keyword"> const</span></div> <div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="keyword"></span>{</div> <div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <span class="keywordflow">return</span> !(*<span class="keyword">this</span> == other);</div> <div class="line"><a name="l00311"></a><span class="lineno"> 311</span> }</div> <div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div> <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a></div> <div class="line"><a name="l00314"></a><span class="lineno"><a class="code" href="classCollationKey.html#a2b5cbecf80d0c583ec608eb88628f4bd"> 314</a></span> <a class="code" href="classCollationKey.html#a2b5cbecf80d0c583ec608eb88628f4bd" title="Test to see if the key is in an invalid state.">CollationKey::isBogus</a>()<span class="keyword"> const</span></div> <div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="keyword"></span>{</div> <div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="keywordflow">return</span> fBogus;</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> </div> <div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="keyword">inline</span> <span class="keyword">const</span> uint8_t*</div> <div class="line"><a name="l00320"></a><span class="lineno"><a class="code" href="classCollationKey.html#aba4102f9d534cdf6c0ed52e1b5a7578e"> 320</a></span> <a class="code" href="classCollationKey.html#aba4102f9d534cdf6c0ed52e1b5a7578e" title="Returns a pointer to the collation key values.">CollationKey::getByteArray</a>(int32_t &count)<span class="keyword"> const</span></div> <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="keyword"></span>{</div> <div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  count = fCount;</div> <div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  <span class="keywordflow">return</span> fBytes;</div> <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> }</div> <div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div> <div class="line"><a name="l00326"></a><span class="lineno"> 326</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="l00327"></a><span class="lineno"> 327</span> </div> <div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="preprocessor">#endif </span><span class="comment">/* U_HIDE_DEPRECATED_API */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* #if !UCONFIG_NO_COLLATION */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>