<!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.6"/> <title>ICU 53.1: unifilt.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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 53.1  <span id="projectnumber">53.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <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> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_55bf5c6bcedc2c5705af95fc7596ac50.html">icu</a></li><li class="navelem"><a class="el" href="dir_17c4e3d278dd0be6889e0e8c41145d45.html">source</a></li><li class="navelem"><a class="el" href="dir_9d30126de01c6acabed440c3eefed2e6.html">common</a></li><li class="navelem"><a class="el" href="dir_09927d28e4089b088d7b70dcc744d58d.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">unifilt.h</div> </div> </div><!--header--> <div class="contents"> <a href="unifilt_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) 1999-2010, 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">* Date Name Description</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* 11/17/99 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 UNIFILT_H</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define UNIFILT_H</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="unifunct_8h.html">unicode/unifunct.h</a>"</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "<a class="code" href="unimatch_8h.html">unicode/unimatch.h</a>"</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</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="l00031"></a><span class="lineno"><a class="line" href="unifilt_8h.html#af8c471e1f0eb63cb628be3f7c9e33f55"> 31</a></span> <span class="preprocessor">#define U_ETHER ((UChar)0xFFFF)</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classicu_1_1UnicodeFilter.html"> 59</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_1UnicodeFilter.html">UnicodeFilter</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1UnicodeFunctor.html">UnicodeFunctor</a>, <span class="keyword">public</span> <a class="code" href="classicu_1_1UnicodeMatcher.html">UnicodeMatcher</a> {</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1UnicodeFilter.html">UnicodeFilter</a>();</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> contains(<a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c) <span class="keyword">const</span> = 0;</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1UnicodeMatcher.html">UnicodeMatcher</a>* <a class="code" href="classicu_1_1UnicodeFunctor.html#a2cb79731edcd6cdb6f09e36b16c0436e">toMatcher</a>() <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>  <span class="keyword">virtual</span> <a class="code" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0f">UMatchDegree</a> <a class="code" href="classicu_1_1UnicodeMatcher.html#ab1d65bb8ecea90bb500c8cbaf4d9f0ae">matches</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1Replaceable.html">Replaceable</a>& text,</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  int32_t& offset,</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  int32_t limit,</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> incremental);</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classicu_1_1UnicodeFunctor.html#abb6d8317d16a1ed627fd7b705fc7b831">setData</a>(<span class="keyword">const</span> TransliterationRuleData*);</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> <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> U_EXPORT2 <a class="code" href="classicu_1_1UnicodeFunctor.html#a3c3bbe97b670081256aba32ea4de6a66">getStaticClassID</a>();</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keyword">protected</span>:</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>  <span class="comment">/*</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * Since this class has pure virtual functions,</span></div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * a constructor can't be used.</span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @stable ICU 2.0</span></div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> */</span></div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">/* UnicodeFilter();*/</span></div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> };</div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/*inline UnicodeFilter::UnicodeFilter() {}*/</span></div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#endif</span></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#l00068">unimatch.h:68</a></div></div> <div class="ttc" id="classicu_1_1UnicodeFunctor_html_a2cb79731edcd6cdb6f09e36b16c0436e"><div class="ttname"><a href="classicu_1_1UnicodeFunctor.html#a2cb79731edcd6cdb6f09e36b16c0436e">icu::UnicodeFunctor::toMatcher</a></div><div class="ttdeci">virtual UnicodeMatcher * toMatcher() const </div><div class="ttdoc">Cast 'this' to a UnicodeMatcher* pointer and return the pointer, or null if this is not a UnicodeMatc...</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#l00030">unimatch.h:30</a></div></div> <div class="ttc" id="uobject_8h_html_a22af10545208a455a6e884008df48e9f"><div class="ttname"><a href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a></div><div class="ttdeci">void * UClassID</div><div class="ttdoc">UClassID is used to identify classes without using the compiler's RTTI. </div><div class="ttdef"><b>Definition:</b> <a href="uobject_8h_source.html#l00091">uobject.h:91</a></div></div> <div class="ttc" id="unifunct_8h_html"><div class="ttname"><a href="unifunct_8h.html">unifunct.h</a></div><div class="ttdoc">C++ API: Unicode Functor. </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#l00071">rep.h:71</a></div></div> <div class="ttc" id="unimatch_8h_html"><div class="ttname"><a href="unimatch_8h.html">unimatch.h</a></div><div class="ttdoc">C++ API: Unicode Matcher. </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#l00129">uversion.h:129</a></div></div> <div class="ttc" id="classicu_1_1UnicodeFilter_html"><div class="ttname"><a href="classicu_1_1UnicodeFilter.html">icu::UnicodeFilter</a></div><div class="ttdoc">UnicodeFilter defines a protocol for selecting a subset of the full range (U+0000 to U+10FFFF) of Uni...</div><div class="ttdef"><b>Definition:</b> <a href="unifilt_8h_source.html#l00059">unifilt.h:59</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#l00298">umachine.h:298</a></div></div> <div class="ttc" id="classicu_1_1UnicodeFunctor_html_abb6d8317d16a1ed627fd7b705fc7b831"><div class="ttname"><a href="classicu_1_1UnicodeFunctor.html#abb6d8317d16a1ed627fd7b705fc7b831">icu::UnicodeFunctor::setData</a></div><div class="ttdeci">virtual void setData(const TransliterationRuleData *)=0</div><div class="ttdoc">Set the data object associated with this functor. </div></div> <div class="ttc" id="classicu_1_1UnicodeFunctor_html"><div class="ttname"><a href="classicu_1_1UnicodeFunctor.html">icu::UnicodeFunctor</a></div><div class="ttdoc">UnicodeFunctor is an abstract base class for objects that perform match and/or replace operations on ...</div><div class="ttdef"><b>Definition:</b> <a href="unifunct_8h_source.html#l00033">unifunct.h:33</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#l00130">uversion.h:130</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#l00357">utypes.h:357</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#l00200">umachine.h:200</a></div></div> <div class="ttc" id="classicu_1_1UnicodeMatcher_html_ab1d65bb8ecea90bb500c8cbaf4d9f0ae"><div class="ttname"><a href="classicu_1_1UnicodeMatcher.html#ab1d65bb8ecea90bb500c8cbaf4d9f0ae">icu::UnicodeMatcher::matches</a></div><div class="ttdeci">virtual UMatchDegree matches(const Replaceable &text, int32_t &offset, int32_t limit, UBool incremental)=0</div><div class="ttdoc">Return a UMatchDegree value indicating the degree of match for the given text at the given offset...</div></div> <div class="ttc" id="classicu_1_1UnicodeFunctor_html_a3c3bbe97b670081256aba32ea4de6a66"><div class="ttname"><a href="classicu_1_1UnicodeFunctor.html#a3c3bbe97b670081256aba32ea4de6a66">icu::UnicodeFunctor::getStaticClassID</a></div><div class="ttdeci">static UClassID getStaticClassID(void)</div><div class="ttdoc">Return the class ID for this class. </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.6 </small></address> </body> </html>