<!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"/>
<title>ICU 4.8.1.1: ustringtrie.h File 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="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 4.8.1.1
 <span id="projectnumber">4.8.1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<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="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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><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_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_f59c6450ff718ff1b085cfd1c36acbd7.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">ustringtrie.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: Helper definitions for dictionary trie APIs.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/>
</div>
<p><a href="ustringtrie_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad1e3fea7099ad56dfbc6d82d997a15ec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ustringtrie_8h.html#ad1e3fea7099ad56dfbc6d82d997a15ec">USTRINGTRIE_MATCHES</a>(result)   ((result)!=<a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda59cdeb2ea73a75c61684b4ea11ccfb37">USTRINGTRIE_NO_MATCH</a>)</td></tr>
<tr class="memdesc:ad1e3fea7099ad56dfbc6d82d997a15ec"><td class="mdescLeft"> </td><td class="mdescRight">Same as (result!=USTRINGTRIE_NO_MATCH). <a href="#ad1e3fea7099ad56dfbc6d82d997a15ec"></a><br/></td></tr>
<tr class="memitem:af1bd176224b0d2e692c76d819be185b8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ustringtrie_8h.html#af1bd176224b0d2e692c76d819be185b8">USTRINGTRIE_HAS_VALUE</a>(result)   ((result)>=<a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda4474a12ed66e5def252c31cadd0a2663">USTRINGTRIE_FINAL_VALUE</a>)</td></tr>
<tr class="memdesc:af1bd176224b0d2e692c76d819be185b8"><td class="mdescLeft"> </td><td class="mdescRight">Equivalent to (result==USTRINGTRIE_INTERMEDIATE_VALUE || result==USTRINGTRIE_FINAL_VALUE) but this macro evaluates result exactly once. <a href="#af1bd176224b0d2e692c76d819be185b8"></a><br/></td></tr>
<tr class="memitem:a7e1962396a228f3d0f7d073fef78e2e0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ustringtrie_8h.html#a7e1962396a228f3d0f7d073fef78e2e0">USTRINGTRIE_HAS_NEXT</a>(result)   ((result)&1)</td></tr>
<tr class="memdesc:a7e1962396a228f3d0f7d073fef78e2e0"><td class="mdescLeft"> </td><td class="mdescRight">Equivalent to (result==USTRINGTRIE_NO_VALUE || result==USTRINGTRIE_INTERMEDIATE_VALUE) but this macro evaluates result exactly once. <a href="#a7e1962396a228f3d0f7d073fef78e2e0"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a760046451d48a1551ba71162a31365bd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bd">UStringTrieResult</a> { <a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda59cdeb2ea73a75c61684b4ea11ccfb37">USTRINGTRIE_NO_MATCH</a>,
<a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda686677dbe92d514a0f424b48810fb21c">USTRINGTRIE_NO_VALUE</a>,
<a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda4474a12ed66e5def252c31cadd0a2663">USTRINGTRIE_FINAL_VALUE</a>,
<a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda62f2fef78e07bab5f68fa803b581504f">USTRINGTRIE_INTERMEDIATE_VALUE</a>
}</td></tr>
<tr class="memdesc:a760046451d48a1551ba71162a31365bd"><td class="mdescLeft"> </td><td class="mdescRight">Return values for <a class="el" href="classBytesTrie.html#ae308908b07a9fd9037585b4a68298eb9" title="Traverses the trie from the current state for this input byte.">BytesTrie::next()</a>, <a class="el" href="classUCharsTrie.html#af5a9db16403230639f64db0841f75afd" title="Traverses the trie from the current state for this input UChar.">UCharsTrie::next()</a> and similar methods. <a href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bd">More...</a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>C API: Helper definitions for dictionary trie APIs. </p>
<p>Definition in file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div><hr/><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a7e1962396a228f3d0f7d073fef78e2e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USTRINGTRIE_HAS_NEXT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">result</td><td>)</td>
<td>   ((result)&1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equivalent to (result==USTRINGTRIE_NO_VALUE || result==USTRINGTRIE_INTERMEDIATE_VALUE) but this macro evaluates result exactly once. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>A result from <a class="el" href="classBytesTrie.html#a0e04ba3a56c62cb8e3c0922c6f403a95" title="Traverses the trie from the initial state for this input byte.">BytesTrie::first()</a>, <a class="el" href="classUCharsTrie.html#af5a9db16403230639f64db0841f75afd" title="Traverses the trie from the current state for this input UChar.">UCharsTrie::next()</a> etc. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true if another input byte/unit can continue a matching string. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000243">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="ustringtrie_8h_source.html#l00092">92</a> of file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
<p>Referenced by <a class="el" href="ucharstrie_8h_source.html#l00175">UCharsTrie::firstForCodePoint()</a>, and <a class="el" href="ucharstrie_8h_source.html#l00198">UCharsTrie::nextForCodePoint()</a>.</p>
</div>
</div>
<a class="anchor" id="af1bd176224b0d2e692c76d819be185b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USTRINGTRIE_HAS_VALUE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">result</td><td>)</td>
<td>   ((result)>=<a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda4474a12ed66e5def252c31cadd0a2663">USTRINGTRIE_FINAL_VALUE</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equivalent to (result==USTRINGTRIE_INTERMEDIATE_VALUE || result==USTRINGTRIE_FINAL_VALUE) but this macro evaluates result exactly once. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>A result from <a class="el" href="classBytesTrie.html#a0e04ba3a56c62cb8e3c0922c6f403a95" title="Traverses the trie from the initial state for this input byte.">BytesTrie::first()</a>, <a class="el" href="classUCharsTrie.html#af5a9db16403230639f64db0841f75afd" title="Traverses the trie from the current state for this input UChar.">UCharsTrie::next()</a> etc. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true if there is a value for the input bytes/units so far. </dd></dl>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="classBytesTrie.html#ad85fe71943d42f9081ffdf469819e143" title="Returns a matching byte sequence's value if called immediately after current()/first()/next() returne...">BytesTrie::getValue</a> </dd>
<dd>
<a class="el" href="classUCharsTrie.html#a026797cbfaf7e09a831cd4461a852542" title="Returns a matching string's value if called immediately after current()/first()/next() returned USTRI...">UCharsTrie::getValue</a> </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000242">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="ustringtrie_8h_source.html#l00083">83</a> of file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad1e3fea7099ad56dfbc6d82d997a15ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USTRINGTRIE_MATCHES</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">result</td><td>)</td>
<td>   ((result)!=<a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bda59cdeb2ea73a75c61684b4ea11ccfb37">USTRINGTRIE_NO_MATCH</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as (result!=USTRINGTRIE_NO_MATCH). </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>A result from <a class="el" href="classBytesTrie.html#a0e04ba3a56c62cb8e3c0922c6f403a95" title="Traverses the trie from the initial state for this input byte.">BytesTrie::first()</a>, <a class="el" href="classUCharsTrie.html#af5a9db16403230639f64db0841f75afd" title="Traverses the trie from the current state for this input UChar.">UCharsTrie::next()</a> etc. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>true if the input bytes/units so far are part of a matching string/byte sequence. </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000241">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="ustringtrie_8h_source.html#l00072">72</a> of file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a760046451d48a1551ba71162a31365bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bd">UStringTrieResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return values for <a class="el" href="classBytesTrie.html#ae308908b07a9fd9037585b4a68298eb9" title="Traverses the trie from the current state for this input byte.">BytesTrie::next()</a>, <a class="el" href="classUCharsTrie.html#af5a9db16403230639f64db0841f75afd" title="Traverses the trie from the current state for this input UChar.">UCharsTrie::next()</a> and similar methods. </p>
<dl class="section see"><dt>See also:</dt><dd><a class="el" href="ustringtrie_8h.html#ad1e3fea7099ad56dfbc6d82d997a15ec" title="Same as (result!=USTRINGTRIE_NO_MATCH).">USTRINGTRIE_MATCHES</a> </dd>
<dd>
<a class="el" href="ustringtrie_8h.html#af1bd176224b0d2e692c76d819be185b8" title="Equivalent to (result==USTRINGTRIE_INTERMEDIATE_VALUE || result==USTRINGTRIE_FINAL_VALUE) but this ma...">USTRINGTRIE_HAS_VALUE</a> </dd>
<dd>
<a class="el" href="ustringtrie_8h.html#a7e1962396a228f3d0f7d073fef78e2e0" title="Equivalent to (result==USTRINGTRIE_NO_VALUE || result==USTRINGTRIE_INTERMEDIATE_VALUE) but this macro...">USTRINGTRIE_HAS_NEXT</a> </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000240">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a760046451d48a1551ba71162a31365bda59cdeb2ea73a75c61684b4ea11ccfb37"></a>USTRINGTRIE_NO_MATCH</em> </td><td>
<p>The input unit(s) did not continue a matching string. </p>
<p>Once current()/next() return USTRINGTRIE_NO_MATCH, all further calls to current()/next() will also return USTRINGTRIE_NO_MATCH, until the trie is reset to its original state or to a saved state. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000244">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a760046451d48a1551ba71162a31365bda686677dbe92d514a0f424b48810fb21c"></a>USTRINGTRIE_NO_VALUE</em> </td><td>
<p>The input unit(s) continued a matching string but there is no value for the string so far. </p>
<p>(It is a prefix of a longer string.) </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000245">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a760046451d48a1551ba71162a31365bda4474a12ed66e5def252c31cadd0a2663"></a>USTRINGTRIE_FINAL_VALUE</em> </td><td>
<p>The input unit(s) continued a matching string and there is a value for the string so far. </p>
<p>This value will be returned by getValue(). No further input byte/unit can continue a matching string. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000246">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a760046451d48a1551ba71162a31365bda62f2fef78e07bab5f68fa803b581504f"></a>USTRINGTRIE_INTERMEDIATE_VALUE</em> </td><td>
<p>The input unit(s) continued a matching string and there is a value for the string so far. </p>
<p>This value will be returned by getValue(). Another input byte/unit can continue a matching string. </p>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000247">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 4.8 </dd></dl>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="ustringtrie_8h_source.html#l00032">32</a> of file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div>
</div>
</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.1.1
</small></address>
</body>
</html>
