<!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.11"/> <title>ICU 58.2: region.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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <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_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_3c42bef9a3e7804b3d74ebb2809ebf86.html">i18n</a></li><li class="navelem"><a class="el" href="dir_fa4147b4d9cbc9ae7619e21b25239322.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">region.h</div> </div> </div><!--header--> <div class="contents"> <a href="region_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">// Copyright (C) 2016 and later: Unicode, Inc. and others.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// License & terms of use: http://www.unicode.org/copyright.html</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *******************************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright (C) 2014-2016, International Business Machines Corporation and others.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * All Rights Reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *******************************************************************************</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> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef REGION_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define REGION_H</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="uregion_8h.html">unicode/uregion.h</a>"</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">#if !UCONFIG_NO_FORMATTING</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="uobject_8h.html">unicode/uobject.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="uniset_8h.html">unicode/uniset.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="unistr_8h.html">unicode/unistr.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="strenum_8h.html">unicode/strenum.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classicu_1_1Region.html"> 70</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#ab9d90a30137b6ec046fe59e79b09745a">U_I18N_API</a> <a class="code" href="classicu_1_1Region.html">Region</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1UObject.html">UObject</a> {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1Region.html">Region</a>();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> <a class="code" href="namespaceicu.html#a1c2f6ca43e636f38d1a3291eb851e9f0">operator==</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1Region.html">Region</a> &that) <span class="keyword">const</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> <a class="code" href="namespaceicu.html#ae44c6e373e08014d12f6a4d51ca96b0e">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1Region.html">Region</a> &that) <span class="keyword">const</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classicu_1_1Region.html">Region</a>* U_EXPORT2 getInstance(<span class="keyword">const</span> <span class="keywordtype">char</span> *region_code, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classicu_1_1Region.html">Region</a>* U_EXPORT2 getInstance (int32_t code, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">static</span> <a class="code" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* U_EXPORT2 getAvailable(<a class="code" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> type, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">const</span> <a class="code" href="classicu_1_1Region.html">Region</a>* getContainingRegion() <span class="keyword">const</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">const</span> <a class="code" href="classicu_1_1Region.html">Region</a>* getContainingRegion(<a class="code" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> type) <span class="keyword">const</span>;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* getContainedRegions(<a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) <span class="keyword">const</span>;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* getContainedRegions( <a class="code" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> type, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status ) <span class="keyword">const</span>;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> contains(<span class="keyword">const</span> <a class="code" href="classicu_1_1Region.html">Region</a> &other) <span class="keyword">const</span>;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <a class="code" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* getPreferredValues(<a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) <span class="keyword">const</span>;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* getRegionCode() <span class="keyword">const</span>;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  int32_t getNumericCode() <span class="keyword">const</span>;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <a class="code" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> getType() <span class="keyword">const</span>;</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#ifndef U_HIDE_INTERNAL_API</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> cleanupRegionData();</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#endif </span><span class="comment">/* U_HIDE_INTERNAL_API */</span><span class="preprocessor"></span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">char</span> <span class="keywordtype">id</span>[4];</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a> idStr;</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  int32_t code;</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <a class="code" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> type;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <a class="code" href="classicu_1_1Region.html">Region</a> *containingRegion;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  UVector *containedRegions;</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  UVector *preferredValues;</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <a class="code" href="classicu_1_1Region.html">Region</a>();</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="comment">/*</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * Initializes the region data from the ICU resource bundles. The region data</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * contains the basic relationships such as which regions are known, what the numeric</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * codes are, any known aliases, and the territory containment data.</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * </span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * If the region data has already loaded, then this method simply returns without doing</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * anything meaningful.</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> */</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696">U_CALLCONV</a> loadRegionData(<a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status);</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> };</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="preprocessor">#endif </span><span class="comment">/* #if !UCONFIG_NO_FORMATTING */</span><span class="preprocessor"></span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor">#endif // REGION_H</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment">//eof</span></div><div class="ttc" id="uregion_8h_html_a75fa1508ee8a1321e62b254008acf0d5"><div class="ttname"><a href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a></div><div class="ttdeci">URegionType</div><div class="ttdoc">URegionType is an enumeration defining the different types of regions. </div><div class="ttdef"><b>Definition:</b> <a href="uregion_8h_source.html#l00065">uregion.h:65</a></div></div> <div class="ttc" id="unistr_8h_html"><div class="ttname"><a href="unistr_8h.html">unistr.h</a></div><div class="ttdoc">C++ API: Unicode String. </div></div> <div class="ttc" id="namespaceicu_html_a1c2f6ca43e636f38d1a3291eb851e9f0"><div class="ttname"><a href="namespaceicu.html#a1c2f6ca43e636f38d1a3291eb851e9f0">icu::operator==</a></div><div class="ttdeci">U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)</div><div class="ttdoc">Global operator == for StringPiece. </div></div> <div class="ttc" id="platform_8h_html_a1fae478cb5a46c7e4a0673d267626696"><div class="ttname"><a href="platform_8h.html#a1fae478cb5a46c7e4a0673d267626696">U_CALLCONV</a></div><div class="ttdeci">#define U_CALLCONV</div><div class="ttdoc">Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...</div><div class="ttdef"><b>Definition:</b> <a href="platform_8h_source.html#l00857">platform.h:857</a></div></div> <div class="ttc" id="classicu_1_1Region_html"><div class="ttname"><a href="classicu_1_1Region.html">icu::Region</a></div><div class="ttdoc">Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...</div><div class="ttdef"><b>Definition:</b> <a href="region_8h_source.html#l00070">region.h:70</a></div></div> <div class="ttc" id="classicu_1_1StringEnumeration_html"><div class="ttname"><a href="classicu_1_1StringEnumeration.html">icu::StringEnumeration</a></div><div class="ttdoc">Base class for &#39;pure&#39; C++ implementations of uenum api. </div><div class="ttdef"><b>Definition:</b> <a href="strenum_8h_source.html#l00057">strenum.h:57</a></div></div> <div class="ttc" id="utypes_8h_html_ab9d90a30137b6ec046fe59e79b09745a"><div class="ttname"><a href="utypes_8h.html#ab9d90a30137b6ec046fe59e79b09745a">U_I18N_API</a></div><div class="ttdeci">#define U_I18N_API</div><div class="ttdoc">Set to export library symbols from inside the i18n library, and to import them from outside...</div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00360">utypes.h:360</a></div></div> <div class="ttc" id="uregion_8h_html"><div class="ttname"><a href="uregion_8h.html">uregion.h</a></div><div class="ttdoc">C API: URegion (territory containment and mapping) </div></div> <div class="ttc" id="uversion_8h_html_a7d9374e037299886d4192b763b4c5e8b"><div class="ttname"><a href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define U_NAMESPACE_BEGIN</div><div class="ttdoc">This is used to begin a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00131">uversion.h:131</a></div></div> <div class="ttc" id="namespaceicu_html_ae44c6e373e08014d12f6a4d51ca96b0e"><div class="ttname"><a href="namespaceicu.html#ae44c6e373e08014d12f6a4d51ca96b0e">icu::operator!=</a></div><div class="ttdeci">UBool operator!=(const StringPiece &x, const StringPiece &y)</div><div class="ttdoc">Global operator != for StringPiece. </div><div class="ttdef"><b>Definition:</b> <a href="stringpiece_8h_source.html#l00220">stringpiece.h:220</a></div></div> <div class="ttc" id="uobject_8h_html"><div class="ttname"><a href="uobject_8h.html">uobject.h</a></div><div class="ttdoc">C++ API: Common ICU base class UObject. </div></div> <div class="ttc" id="uversion_8h_html_a3da1f00f3b02976ac53c014a3e4c0933"><div class="ttname"><a href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="ttdeci">#define U_NAMESPACE_END</div><div class="ttdoc">This is used to end a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00132">uversion.h:132</a></div></div> <div class="ttc" id="utypes_8h_html_a3343c1c8a8377277046774691c98d78c"><div class="ttname"><a href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a></div><div class="ttdeci">UErrorCode</div><div class="ttdoc">Error code to replace exception handling, so that the code is compatible with all C++ compilers...</div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00396">utypes.h:396</a></div></div> <div class="ttc" id="strenum_8h_html"><div class="ttname"><a href="strenum_8h.html">strenum.h</a></div><div class="ttdoc">C++ API: String Enumeration. </div></div> <div class="ttc" id="utypes_8h_html"><div class="ttname"><a href="utypes_8h.html">utypes.h</a></div><div class="ttdoc">Basic definitions for ICU, for both C and C++ APIs. </div></div> <div class="ttc" id="classicu_1_1UnicodeString_html"><div class="ttname"><a href="classicu_1_1UnicodeString.html">icu::UnicodeString</a></div><div class="ttdoc">UnicodeString is a string class that stores Unicode characters directly and provides similar function...</div><div class="ttdef"><b>Definition:</b> <a href="unistr_8h_source.html#l00295">unistr.h:295</a></div></div> <div class="ttc" id="classicu_1_1UObject_html"><div class="ttname"><a href="classicu_1_1UObject.html">icu::UObject</a></div><div class="ttdoc">UObject is the common ICU "boilerplate" class. </div><div class="ttdef"><b>Definition:</b> <a href="uobject_8h_source.html#l00223">uobject.h:223</a></div></div> <div class="ttc" id="umachine_8h_html_a349ef00011f20ccd1d3b424445681aa5"><div class="ttname"><a href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a></div><div class="ttdeci">int8_t UBool</div><div class="ttdoc">The ICU boolean type. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00259">umachine.h:259</a></div></div> <div class="ttc" id="uniset_8h_html"><div class="ttname"><a href="uniset_8h.html">uniset.h</a></div><div class="ttdoc">C++ API: Unicode Set. </div></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.11 </small></address> </body> </html>