File: //opt/alt/alt-nodejs22/root/usr/share/doc/alt-nodejs22-libicu-doc/ustringtrie_8h.html
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 77.1: common/unicode/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/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 77.1
 <span id="projectnumber">77.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 class="groupheader"><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">More...</a><br /></td></tr>
<tr class="separator:ad1e3fea7099ad56dfbc6d82d997a15ec"><td class="memSeparator" colspan="2"> </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">More...</a><br /></td></tr>
<tr class="separator:af1bd176224b0d2e692c76d819be185b8"><td class="memSeparator" colspan="2"> </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">More...</a><br /></td></tr>
<tr class="separator:a7e1962396a228f3d0f7d073fef78e2e0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><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 BytesTrie::next(), UCharsTrie::next() and similar methods. <a href="ustringtrie_8h.html#a760046451d48a1551ba71162a31365bd">More...</a><br /></td></tr>
<tr class="separator:a760046451d48a1551ba71162a31365bd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C API: Helper definitions for dictionary trie APIs. </p>
<p class="definition">Definition in file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a7e1962396a228f3d0f7d073fef78e2e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e1962396a228f3d0f7d073fef78e2e0">◆ </a></span>USTRINGTRIE_HAS_NEXT</h2>
<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 BytesTrie::first(), UCharsTrie::next() 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="stable"><dt><b><a class="el" href="stable.html#_stable003332">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ustringtrie_8h_source.html#l00095">95</a> of file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div>
</div>
<a id="af1bd176224b0d2e692c76d819be185b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1bd176224b0d2e692c76d819be185b8">◆ </a></span>USTRINGTRIE_HAS_VALUE</h2>
<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 BytesTrie::first(), UCharsTrie::next() 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>BytesTrie::getValue </dd>
<dd>
UCharsTrie::getValue </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003331">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ustringtrie_8h_source.html#l00086">86</a> of file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div>
</div>
<a id="ad1e3fea7099ad56dfbc6d82d997a15ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1e3fea7099ad56dfbc6d82d997a15ec">◆ </a></span>USTRINGTRIE_MATCHES</h2>
<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 BytesTrie::first(), UCharsTrie::next() 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="stable"><dt><b><a class="el" href="stable.html#_stable003330">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ustringtrie_8h_source.html#l00075">75</a> of file <a class="el" href="ustringtrie_8h_source.html">ustringtrie.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a760046451d48a1551ba71162a31365bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a760046451d48a1551ba71162a31365bd">◆ </a></span>UStringTrieResult</h2>
<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 BytesTrie::next(), UCharsTrie::next() 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="stable"><dt><b><a class="el" href="stable.html#_stable003329">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a760046451d48a1551ba71162a31365bda59cdeb2ea73a75c61684b4ea11ccfb37"></a>USTRINGTRIE_NO_MATCH </td><td class="fielddoc"><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="stable"><dt><b><a class="el" href="stable.html#_stable003333">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a760046451d48a1551ba71162a31365bda686677dbe92d514a0f424b48810fb21c"></a>USTRINGTRIE_NO_VALUE </td><td class="fielddoc"><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="stable"><dt><b><a class="el" href="stable.html#_stable003334">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a760046451d48a1551ba71162a31365bda4474a12ed66e5def252c31cadd0a2663"></a>USTRINGTRIE_FINAL_VALUE </td><td class="fielddoc"><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="stable"><dt><b><a class="el" href="stable.html#_stable003335">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a760046451d48a1551ba71162a31365bda62f2fef78e07bab5f68fa803b581504f"></a>USTRINGTRIE_INTERMEDIATE_VALUE </td><td class="fielddoc"><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="stable"><dt><b><a class="el" href="stable.html#_stable003336">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="ustringtrie_8h_source.html#l00035">35</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.14
</small></address>
</body>
</html>