<!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: unimatch.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">unimatch.h</div> </div> </div><!--header--> <div class="contents"> <a href="unimatch_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">* Copyright (C) 2001-2005, International Business Machines 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">* Date Name Description</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* 07/18/01 aliu Creation.</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">*/</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef UNIMATCH_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define UNIMATCH_H</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></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="keyword">class </span>Replaceable;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">class </span>UnicodeString;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span>UnicodeSet;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0f"> 32</a></span> <span class="keyword">enum</span> <a class="code" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0f">UMatchDegree</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fa2c421fcfe4b305de6f4fc80089d5fffa"> 40</a></span>  <a class="code" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fa2c421fcfe4b305de6f4fc80089d5fffa">U_MISMATCH</a>,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fac69651d3521b10c1b4b4980cc8d69598"> 52</a></span>  <a class="code" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fac69651d3521b10c1b4b4980cc8d69598">U_PARTIAL_MATCH</a>,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fad05ce45bf573b88d340c190d8f25cfe5"> 62</a></span>  <a class="code" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fad05ce45bf573b88d340c190d8f25cfe5">U_MATCH</a></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> };</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classicu_1_1UnicodeMatcher.html"> 70</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_1UnicodeMatcher.html">UnicodeMatcher</a> <span class="comment">/* not : public UObject because this is an interface/mixin class */</span> {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1UnicodeMatcher.html">UnicodeMatcher</a>();</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">virtual</span> <a class="code" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0f">UMatchDegree</a> matches(<span class="keyword">const</span> <a class="code" href="classicu_1_1Replaceable.html">Replaceable</a>& text,</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  int32_t& offset,</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  int32_t limit,</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> incremental) = 0;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& toPattern(<a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> escapeUnprintable = <a class="code" href="umachine_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a>) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> matchesIndexValue(uint8_t v) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> addMatchSetTo(<a class="code" href="classicu_1_1UnicodeSet.html">UnicodeSet</a>& toUnionTo) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> };</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceicu_html_a6b6eaca969662d8185a58bb2e2e68d0fa2c421fcfe4b305de6f4fc80089d5fffa"><div class="ttname"><a href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fa2c421fcfe4b305de6f4fc80089d5fffa">icu::U_MISMATCH</a></div><div class="ttdoc">Constant returned by matches() indicating a mismatch between the text and this matcher. </div><div class="ttdef"><b>Definition:</b> <a href="unimatch_8h_source.html#l00040">unimatch.h:40</a></div></div> <div class="ttc" id="classicu_1_1UnicodeMatcher_html"><div class="ttname"><a href="classicu_1_1UnicodeMatcher.html">icu::UnicodeMatcher</a></div><div class="ttdoc">UnicodeMatcher defines a protocol for objects that can match a range of characters in a Replaceable s...</div><div class="ttdef"><b>Definition:</b> <a href="unimatch_8h_source.html#l00070">unimatch.h:70</a></div></div> <div class="ttc" id="namespaceicu_html_a6b6eaca969662d8185a58bb2e2e68d0fad05ce45bf573b88d340c190d8f25cfe5"><div class="ttname"><a href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fad05ce45bf573b88d340c190d8f25cfe5">icu::U_MATCH</a></div><div class="ttdoc">Constant returned by matches() indicating a complete match between the text and this matcher...</div><div class="ttdef"><b>Definition:</b> <a href="unimatch_8h_source.html#l00062">unimatch.h:62</a></div></div> <div class="ttc" id="namespaceicu_html_a6b6eaca969662d8185a58bb2e2e68d0f"><div class="ttname"><a href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0f">icu::UMatchDegree</a></div><div class="ttdeci">UMatchDegree</div><div class="ttdoc">Constants returned by UnicodeMatcher::matches() indicating the degree of match. </div><div class="ttdef"><b>Definition:</b> <a href="unimatch_8h_source.html#l00032">unimatch.h:32</a></div></div> <div class="ttc" id="namespaceicu_html_a6b6eaca969662d8185a58bb2e2e68d0fac69651d3521b10c1b4b4980cc8d69598"><div class="ttname"><a href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0fac69651d3521b10c1b4b4980cc8d69598">icu::U_PARTIAL_MATCH</a></div><div class="ttdoc">Constant returned by matches() indicating a partial match between the text and this matcher...</div><div class="ttdef"><b>Definition:</b> <a href="unimatch_8h_source.html#l00052">unimatch.h:52</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="classicu_1_1UnicodeSet_html"><div class="ttname"><a href="classicu_1_1UnicodeSet.html">icu::UnicodeSet</a></div><div class="ttdoc">A mutable set of Unicode characters and multicharacter strings. </div><div class="ttdef"><b>Definition:</b> <a href="uniset_8h_source.html#l00278">uniset.h:278</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"><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="umachine_8h_html_aa93f0eb578d23995850d61f7d61c55c1"><div class="ttname"><a href="umachine_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a></div><div class="ttdeci">#define FALSE</div><div class="ttdoc">The FALSE value of a UBool. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00267">umachine.h:267</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_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="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>