<!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: icu::UnicodeMatcher Class Reference</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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1UnicodeMatcher.html">UnicodeMatcher</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">icu::UnicodeMatcher Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code><a class="el" href="classicu_1_1UnicodeMatcher.html" title="UnicodeMatcher defines a protocol for objects that can match a range of characters in a Replaceable s...">UnicodeMatcher</a></code> defines a protocol for objects that can match a range of characters in a <a class="el" href="classicu_1_1Replaceable.html" title="Replaceable is an abstract base class representing a string of characters that supports the replaceme...">Replaceable</a> string.
<a href="classicu_1_1UnicodeMatcher.html#details">More...</a></p>
<p><code>#include <<a class="el" href="unimatch_8h_source.html">unimatch.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::UnicodeMatcher:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1UnicodeMatcher.png" usemap="#icu::UnicodeMatcher_map" alt=""/>
<map id="icu::UnicodeMatcher_map" name="icu::UnicodeMatcher_map">
<area href="classicu_1_1UnicodeFilter.html" title="UnicodeFilter defines a protocol for selecting a subset of the full range (U+0000 to U+10FFFF) of Uni..." alt="icu::UnicodeFilter" shape="rect" coords="0,56,128,80"/>
<area href="classicu_1_1UnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings. " alt="icu::UnicodeSet" shape="rect" coords="0,112,128,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa8f85acabf8b08b52518b10eb2bdc952"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UnicodeMatcher.html#aa8f85acabf8b08b52518b10eb2bdc952">~UnicodeMatcher</a> ()</td></tr>
<tr class="memdesc:aa8f85acabf8b08b52518b10eb2bdc952"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa8f85acabf8b08b52518b10eb2bdc952">More...</a><br /></td></tr>
<tr class="separator:aa8f85acabf8b08b52518b10eb2bdc952"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1d65bb8ecea90bb500c8cbaf4d9f0ae"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0f">UMatchDegree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UnicodeMatcher.html#ab1d65bb8ecea90bb500c8cbaf4d9f0ae">matches</a> (const <a class="el" href="classicu_1_1Replaceable.html">Replaceable</a> &text, int32_t &offset, int32_t limit, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> incremental)=0</td></tr>
<tr class="memdesc:ab1d65bb8ecea90bb500c8cbaf4d9f0ae"><td class="mdescLeft"> </td><td class="mdescRight">Return a UMatchDegree value indicating the degree of match for the given text at the given offset. <a href="#ab1d65bb8ecea90bb500c8cbaf4d9f0ae">More...</a><br /></td></tr>
<tr class="separator:ab1d65bb8ecea90bb500c8cbaf4d9f0ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe1c5de1a8d4ebeedff487324f354cd3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UnicodeMatcher.html#abe1c5de1a8d4ebeedff487324f354cd3">toPattern</a> (<a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &result, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> escapeUnprintable=<a class="el" href="umachine_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a>) const =0</td></tr>
<tr class="memdesc:abe1c5de1a8d4ebeedff487324f354cd3"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representation of this matcher. <a href="#abe1c5de1a8d4ebeedff487324f354cd3">More...</a><br /></td></tr>
<tr class="separator:abe1c5de1a8d4ebeedff487324f354cd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6c02c180dcb3332a4b2ece814ce9f9a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UnicodeMatcher.html#ae6c02c180dcb3332a4b2ece814ce9f9a">matchesIndexValue</a> (uint8_t v) const =0</td></tr>
<tr class="memdesc:ae6c02c180dcb3332a4b2ece814ce9f9a"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if this matcher will match a character c, where c & 0xFF == v, at offset, in the forward direction (with limit > offset). <a href="#ae6c02c180dcb3332a4b2ece814ce9f9a">More...</a><br /></td></tr>
<tr class="separator:ae6c02c180dcb3332a4b2ece814ce9f9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2ff342d41851f6f845070cdfc6b1da0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UnicodeMatcher.html#ad2ff342d41851f6f845070cdfc6b1da0">addMatchSetTo</a> (<a class="el" href="classicu_1_1UnicodeSet.html">UnicodeSet</a> &toUnionTo) const =0</td></tr>
<tr class="memdesc:ad2ff342d41851f6f845070cdfc6b1da0"><td class="mdescLeft"> </td><td class="mdescRight">Union the set of all characters that may be matched by this object into the given set. <a href="#ad2ff342d41851f6f845070cdfc6b1da0">More...</a><br /></td></tr>
<tr class="separator:ad2ff342d41851f6f845070cdfc6b1da0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><code><a class="el" href="classicu_1_1UnicodeMatcher.html" title="UnicodeMatcher defines a protocol for objects that can match a range of characters in a Replaceable s...">UnicodeMatcher</a></code> defines a protocol for objects that can match a range of characters in a <a class="el" href="classicu_1_1Replaceable.html" title="Replaceable is an abstract base class representing a string of characters that supports the replaceme...">Replaceable</a> string. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001967">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Definition at line <a class="el" href="unimatch_8h_source.html#l00070">70</a> of file <a class="el" href="unimatch_8h_source.html">unimatch.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa8f85acabf8b08b52518b10eb2bdc952"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::UnicodeMatcher::~UnicodeMatcher </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001971">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad2ff342d41851f6f845070cdfc6b1da0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::UnicodeMatcher::addMatchSetTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeSet.html">UnicodeSet</a> & </td>
<td class="paramname"><em>toUnionTo</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Union the set of all characters that may be matched by this object into the given set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">toUnionTo</td><td>the set into which to union the source characters </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001975">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1UnicodeSet.html#ac2574f161d9f31ce2f5cc84f76b862a1">icu::UnicodeSet</a>.</p>
</div>
</div>
<a class="anchor" id="ab1d65bb8ecea90bb500c8cbaf4d9f0ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespaceicu.html#a6b6eaca969662d8185a58bb2e2e68d0f">UMatchDegree</a> icu::UnicodeMatcher::matches </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Replaceable.html">Replaceable</a> & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t & </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>limit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>incremental</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a UMatchDegree value indicating the degree of match for the given text at the given offset. </p>
<p>Zero, one, or more characters may be matched.</p>
<p>Matching in the forward direction is indicated by limit > offset. Characters from offset forwards to limit-1 will be considered for matching.</p>
<p>Matching in the reverse direction is indicated by limit < offset. Characters from offset backwards to limit+1 will be considered for matching.</p>
<p>If limit == offset then the only match possible is a zero character match (which subclasses may implement if desired).</p>
<p>As a side effect, advance the offset parameter to the limit of the matched substring. In the forward direction, this will be the index of the last matched character plus one. In the reverse direction, this will be the index of the last matched character minus one.</p>
<p>Note: This method is not const because some classes may modify their state as the result of a match.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>the text to be matched </td></tr>
<tr><td class="paramname">offset</td><td>on input, the index into text at which to begin matching. On output, the limit of the matched text. The number of matched characters is the output value of offset minus the input value. Offset should always point to the HIGH SURROGATE (leading code unit) of a pair of surrogates, both on entry and upon return. </td></tr>
<tr><td class="paramname">limit</td><td>the limit index of text to be matched. Greater than offset for a forward direction match, less than offset for a backward direction match. The last character to be considered for matching will be text.charAt(limit-1) in the forward direction or text.charAt(limit+1) in the backward direction. </td></tr>
<tr><td class="paramname">incremental</td><td>if TRUE, then assume further characters may be inserted at limit and check for partial matching. Otherwise assume the text as given is complete. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a match degree value indicating a full match, a partial match, or a mismatch. If incremental is FALSE then U_PARTIAL_MATCH should never be returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001972">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1UnicodeSet.html#a67b273e78bfb73a10c77f773d3d85b43">icu::UnicodeSet</a>, and <a class="el" href="classicu_1_1UnicodeFilter.html#a6adc34f85a255be11264e073435e449b">icu::UnicodeFilter</a>.</p>
</div>
</div>
<a class="anchor" id="ae6c02c180dcb3332a4b2ece814ce9f9a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::UnicodeMatcher::matchesIndexValue </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns TRUE if this matcher will match a character c, where c & 0xFF == v, at offset, in the forward direction (with limit > offset). </p>
<p>This is used by <code>RuleBasedTransliterator</code> for indexing. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001974">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="abe1c5de1a8d4ebeedff487324f354cd3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::UnicodeMatcher::toPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>escapeUnprintable</em> = <code><a class="el" href="umachine_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a></code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of this matcher. </p>
<p>If the result of calling this function is passed to the appropriate parser, it will produce another matcher that is equal to this one. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>the string to receive the pattern. Previous contents will be deleted. </td></tr>
<tr><td class="paramname">escapeUnprintable</td><td>if TRUE then convert unprintable character to their hex escape representations, \uxxxx or \Uxxxxxxxx. Unprintable characters are those other than U+000A, U+0020..U+007E. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001973">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1UnicodeSet.html#af0e3df521a64547566aeb6a0ef1e05d5">icu::UnicodeSet</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="unimatch_8h_source.html">unimatch.h</a></li>
</ul>
</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>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
597
