<!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: rep.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_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">rep.h</div> </div> </div><!--header--> <div class="contents"> <a href="rep_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) 1999-2012, International Business Machines Corporation and</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* others. 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">* Date Name Description</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* 11/17/99 aliu Creation. Ported from java. Modified to</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* match current UnicodeString API. Forced</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* to use name "handleReplaceBetween" because</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* of existing methods in UnicodeString.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">**************************************************************************</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> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifndef REP_H</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define REP_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="uobject_8h.html">unicode/uobject.h</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></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> <span class="keyword">class </span>UnicodeString;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classicu_1_1Replaceable.html"> 73</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a> <a class="code" href="classicu_1_1Replaceable.html">Replaceable</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1UObject.html">UObject</a> {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1Replaceable.html">Replaceable</a>();</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">inline</span> int32_t length() <span class="keyword">const</span>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> charAt(int32_t offset) <span class="keyword">const</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> char32At(int32_t offset) <span class="keyword">const</span>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> extractBetween(int32_t start,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  int32_t limit,</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& target) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> handleReplaceBetween(int32_t start,</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  int32_t limit,</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& text) = 0;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// Note: All other methods in this class take the names of</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="comment">// existing UnicodeString methods. This method is the exception.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">// It is named differently because all replace methods of</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="comment">// UnicodeString return a UnicodeString&. The 'between' is</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="comment">// required in order to conform to the UnicodeString naming</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="comment">// convention; API taking start/length are named <operation>, and</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="comment">// those taking start/limit are named <operationBetween>. The</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// 'handle' is added because 'replaceBetween' and</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="comment">// 'doReplaceBetween' are already taken.</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> copy(int32_t start, int32_t limit, int32_t dest) = 0;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> hasMetaData() <span class="keyword">const</span>;</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1Replaceable.html">Replaceable</a> *clone() <span class="keyword">const</span>;</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keyword">inline</span> <a class="code" href="classicu_1_1Replaceable.html">Replaceable</a>();</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="comment">/*</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * Assignment operator not declared. The compiler will provide one</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * which does nothing since this class does not contain any data members.</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * API/code coverage may show the assignment operator as present and</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * untested - ignore.</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * Subclasses need this assignment operator if they use compiler-provided</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * assignment operators of their own. An alternative to not declaring one</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * here would be to declare and empty-implement a protected or public one.</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> Replaceable &Replaceable::operator=(const Replaceable &);</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> */</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keyword">virtual</span> int32_t getLength() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> getCharAt(int32_t offset) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> getChar32At(int32_t offset) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</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"><a class="line" href="classicu_1_1Replaceable.html#ade8a3f93d1e3fc79741a837d6f3d4710"> 242</a></span> <span class="keyword">inline</span> <a class="code" href="classicu_1_1Replaceable.html#ade8a3f93d1e3fc79741a837d6f3d4710">Replaceable::Replaceable</a>() {}</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">inline</span> int32_t</div><div class="line"><a name="l00245"></a><span class="lineno"><a class="line" href="classicu_1_1Replaceable.html#a211e81826a4d281e3206b87a17f37410"> 245</a></span> <a class="code" href="classicu_1_1Replaceable.html#a211e81826a4d281e3206b87a17f37410">Replaceable::length</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="keywordflow">return</span> getLength();</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> }</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a></div><div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="classicu_1_1Replaceable.html#aaaf1952118166c577ce3109081978528"> 250</a></span> <a class="code" href="classicu_1_1Replaceable.html#aaaf1952118166c577ce3109081978528">Replaceable::charAt</a>(int32_t offset)<span class="keyword"> const </span>{</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keywordflow">return</span> getCharAt(offset);</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> }</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a></div><div class="line"><a name="l00255"></a><span class="lineno"><a class="line" href="classicu_1_1Replaceable.html#ac81319995a4ca8136ff2f618e8b9147e"> 255</a></span> <a class="code" href="classicu_1_1Replaceable.html#ac81319995a4ca8136ff2f618e8b9147e">Replaceable::char32At</a>(int32_t offset)<span class="keyword"> const </span>{</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keywordflow">return</span> getChar32At(offset);</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> }</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment">// There is no rep.cpp, see unistr.cpp for Replaceable function implementations.</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classicu_1_1Replaceable_html_aaaf1952118166c577ce3109081978528"><div class="ttname"><a href="classicu_1_1Replaceable.html#aaaf1952118166c577ce3109081978528">icu::Replaceable::charAt</a></div><div class="ttdeci">UChar charAt(int32_t offset) const </div><div class="ttdoc">Returns the 16-bit code unit at the given offset into the text. </div><div class="ttdef"><b>Definition:</b> <a href="rep_8h_source.html#l00250">rep.h:250</a></div></div> <div class="ttc" id="classicu_1_1Replaceable_html_ac81319995a4ca8136ff2f618e8b9147e"><div class="ttname"><a href="classicu_1_1Replaceable.html#ac81319995a4ca8136ff2f618e8b9147e">icu::Replaceable::char32At</a></div><div class="ttdeci">UChar32 char32At(int32_t offset) const </div><div class="ttdoc">Returns the 32-bit code point at the given 16-bit offset into the text. </div><div class="ttdef"><b>Definition:</b> <a href="rep_8h_source.html#l00255">rep.h:255</a></div></div> <div class="ttc" id="classicu_1_1Replaceable_html_ade8a3f93d1e3fc79741a837d6f3d4710"><div class="ttname"><a href="classicu_1_1Replaceable.html#ade8a3f93d1e3fc79741a837d6f3d4710">icu::Replaceable::Replaceable</a></div><div class="ttdeci">Replaceable()</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> <a href="rep_8h_source.html#l00242">rep.h:242</a></div></div> <div class="ttc" id="classicu_1_1Replaceable_html"><div class="ttname"><a href="classicu_1_1Replaceable.html">icu::Replaceable</a></div><div class="ttdoc">Replaceable is an abstract base class representing a string of characters that supports the replaceme...</div><div class="ttdef"><b>Definition:</b> <a href="rep_8h_source.html#l00073">rep.h:73</a></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="umachine_8h_html_a09fff5c3b5a5b015324dc3ec3cf92809"><div class="ttname"><a href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a></div><div class="ttdeci">int32_t UChar32</div><div class="ttdoc">Define UChar32 as a type for single Unicode code points. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00357">umachine.h:357</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="umachine_8h_html_a6bb9fad572d65b305324ef288165e2ac"><div class="ttname"><a href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a></div><div class="ttdeci">uint16_t UChar</div><div class="ttdoc">Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...</div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00337">umachine.h:337</a></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_a559955ec3bc692657c5d8b1c6de8e334"><div class="ttname"><a href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a></div><div class="ttdeci">#define U_COMMON_API</div><div class="ttdoc">Set to export library symbols from inside the common library, and to import them from outside...</div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00359">utypes.h:359</a></div></div> <div class="ttc" id="classicu_1_1Replaceable_html_a211e81826a4d281e3206b87a17f37410"><div class="ttname"><a href="classicu_1_1Replaceable.html#a211e81826a4d281e3206b87a17f37410">icu::Replaceable::length</a></div><div class="ttdeci">int32_t length() const </div><div class="ttdoc">Returns the number of 16-bit code units in the text. </div><div class="ttdef"><b>Definition:</b> <a href="rep_8h_source.html#l00245">rep.h:245</a></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><!-- 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>