File: //opt/alt/alt-nodejs24/root/usr/share/doc/alt-nodejs24-libicu-doc/ucptrie_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/ucptrie.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="#nested-classes">Data Structures</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ucptrie.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: This file defines an immutable Unicode code point trie.
<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 />
<code>#include "<a class="el" href="ucpmap_8h_source.html">unicode/ucpmap.h</a>"</code><br />
<code>#include "<a class="el" href="utf8_8h_source.html">unicode/utf8.h</a>"</code><br />
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br />
</div>
<p><a href="ucptrie_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCPTrie.html">UCPTrie</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Immutable Unicode code point trie structure. <a href="structUCPTrie.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft"> </td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad8a8583a1ba1f1d43049d11c24be45ca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#ad8a8583a1ba1f1d43049d11c24be45ca">UCPTRIE_16</a>(trie, i)   ((trie)->data.ptr16[i])</td></tr>
<tr class="memdesc:ad8a8583a1ba1f1d43049d11c24be45ca"><td class="mdescLeft"> </td><td class="mdescRight">Macro parameter value for a trie with 16-bit data values. <a href="#ad8a8583a1ba1f1d43049d11c24be45ca">More...</a><br /></td></tr>
<tr class="separator:ad8a8583a1ba1f1d43049d11c24be45ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac483af4cb261ba7d72e5d64f0e121d6a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#ac483af4cb261ba7d72e5d64f0e121d6a">UCPTRIE_32</a>(trie, i)   ((trie)->data.ptr32[i])</td></tr>
<tr class="memdesc:ac483af4cb261ba7d72e5d64f0e121d6a"><td class="mdescLeft"> </td><td class="mdescRight">Macro parameter value for a trie with 32-bit data values. <a href="#ac483af4cb261ba7d72e5d64f0e121d6a">More...</a><br /></td></tr>
<tr class="separator:ac483af4cb261ba7d72e5d64f0e121d6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21da8c1396f9ebbd3f612c8cc222d240"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a21da8c1396f9ebbd3f612c8cc222d240">UCPTRIE_8</a>(trie, i)   ((trie)->data.ptr8[i])</td></tr>
<tr class="memdesc:a21da8c1396f9ebbd3f612c8cc222d240"><td class="mdescLeft"> </td><td class="mdescRight">Macro parameter value for a trie with 8-bit data values. <a href="#a21da8c1396f9ebbd3f612c8cc222d240">More...</a><br /></td></tr>
<tr class="separator:a21da8c1396f9ebbd3f612c8cc222d240"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46017f54183600938e79ba84b9bcd178"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a46017f54183600938e79ba84b9bcd178">UCPTRIE_FAST_GET</a>(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_CP_INDEX(trie, 0xffff, c))</td></tr>
<tr class="memdesc:a46017f54183600938e79ba84b9bcd178"><td class="mdescLeft"> </td><td class="mdescRight">Returns a trie value for a code point, with range checking. <a href="#a46017f54183600938e79ba84b9bcd178">More...</a><br /></td></tr>
<tr class="separator:a46017f54183600938e79ba84b9bcd178"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a87c5c6cb0b1233e10f063413f9d003"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a7a87c5c6cb0b1233e10f063413f9d003">UCPTRIE_SMALL_GET</a>(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_CP_INDEX(trie, UCPTRIE_SMALL_MAX, c))</td></tr>
<tr class="memdesc:a7a87c5c6cb0b1233e10f063413f9d003"><td class="mdescLeft"> </td><td class="mdescRight">Returns a 16-bit trie value for a code point, with range checking. <a href="#a7a87c5c6cb0b1233e10f063413f9d003">More...</a><br /></td></tr>
<tr class="separator:a7a87c5c6cb0b1233e10f063413f9d003"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8dec4ebf430a0322953b0de5d50179e8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a8dec4ebf430a0322953b0de5d50179e8">UCPTRIE_FAST_U16_NEXT</a>(trie, dataAccess, src, limit, c, result)</td></tr>
<tr class="memdesc:a8dec4ebf430a0322953b0de5d50179e8"><td class="mdescLeft"> </td><td class="mdescRight">UTF-16: Reads the next code point (UChar32 c, out), post-increments src, and gets a value from the trie. <a href="#a8dec4ebf430a0322953b0de5d50179e8">More...</a><br /></td></tr>
<tr class="separator:a8dec4ebf430a0322953b0de5d50179e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a932a432c7936a1b03cc2f453e8d3836e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a932a432c7936a1b03cc2f453e8d3836e">UCPTRIE_FAST_U16_PREV</a>(trie, dataAccess, start, src, c, result)</td></tr>
<tr class="memdesc:a932a432c7936a1b03cc2f453e8d3836e"><td class="mdescLeft"> </td><td class="mdescRight">UTF-16: Reads the previous code point (UChar32 c, out), pre-decrements src, and gets a value from the trie. <a href="#a932a432c7936a1b03cc2f453e8d3836e">More...</a><br /></td></tr>
<tr class="separator:a932a432c7936a1b03cc2f453e8d3836e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab75bf3d4d7b9d698464fac7e83bf7c2c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#ab75bf3d4d7b9d698464fac7e83bf7c2c">UCPTRIE_FAST_U8_NEXT</a>(trie, dataAccess, src, limit, result)</td></tr>
<tr class="memdesc:ab75bf3d4d7b9d698464fac7e83bf7c2c"><td class="mdescLeft"> </td><td class="mdescRight">UTF-8: Post-increments src and gets a value from the trie. <a href="#ab75bf3d4d7b9d698464fac7e83bf7c2c">More...</a><br /></td></tr>
<tr class="separator:ab75bf3d4d7b9d698464fac7e83bf7c2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a194bc0279a0c22564199e2b5eef130ad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a194bc0279a0c22564199e2b5eef130ad">UCPTRIE_FAST_U8_PREV</a>(trie, dataAccess, start, src, result)</td></tr>
<tr class="memdesc:a194bc0279a0c22564199e2b5eef130ad"><td class="mdescLeft"> </td><td class="mdescRight">UTF-8: Pre-decrements src and gets a value from the trie. <a href="#a194bc0279a0c22564199e2b5eef130ad">More...</a><br /></td></tr>
<tr class="separator:a194bc0279a0c22564199e2b5eef130ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac02216670afc74dc60cc91161c63913b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#ac02216670afc74dc60cc91161c63913b">UCPTRIE_ASCII_GET</a>(trie, dataAccess, c)   dataAccess(trie, c)</td></tr>
<tr class="memdesc:ac02216670afc74dc60cc91161c63913b"><td class="mdescLeft"> </td><td class="mdescRight">Returns a trie value for an ASCII code point, without range checking. <a href="#ac02216670afc74dc60cc91161c63913b">More...</a><br /></td></tr>
<tr class="separator:ac02216670afc74dc60cc91161c63913b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad33ea71b55eb2570bbc48faa51e58806"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#ad33ea71b55eb2570bbc48faa51e58806">UCPTRIE_FAST_BMP_GET</a>(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_FAST_INDEX(trie, c))</td></tr>
<tr class="memdesc:ad33ea71b55eb2570bbc48faa51e58806"><td class="mdescLeft"> </td><td class="mdescRight">Returns a trie value for a BMP code point (U+0000..U+FFFF), without range checking. <a href="#ad33ea71b55eb2570bbc48faa51e58806">More...</a><br /></td></tr>
<tr class="separator:ad33ea71b55eb2570bbc48faa51e58806"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14732d865095e395373bb9a8f43b7ef2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a14732d865095e395373bb9a8f43b7ef2">UCPTRIE_FAST_SUPP_GET</a>(trie, dataAccess, c)   dataAccess(trie, _UCPTRIE_SMALL_INDEX(trie, c))</td></tr>
<tr class="memdesc:a14732d865095e395373bb9a8f43b7ef2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a trie value for a supplementary code point (U+10000..U+10FFFF), without range checking. <a href="#a14732d865095e395373bb9a8f43b7ef2">More...</a><br /></td></tr>
<tr class="separator:a14732d865095e395373bb9a8f43b7ef2"><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:a0736c5a35aefa6f366f5847a7b9d1465"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465">UCPTrieType</a> { <a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465ae4474d990fe030905ffb0c11f3454b90">UCPTRIE_TYPE_ANY</a> = -1,
<a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465a0fc3f23899946bd2df3ff03adafbb032">UCPTRIE_TYPE_FAST</a>,
<a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465a75efbaba0dfeabdce18f7adff32f74f5">UCPTRIE_TYPE_SMALL</a>
}</td></tr>
<tr class="memdesc:a0736c5a35aefa6f366f5847a7b9d1465"><td class="mdescLeft"> </td><td class="mdescRight">Selectors for the type of a <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a>. <a href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465">More...</a><br /></td></tr>
<tr class="separator:a0736c5a35aefa6f366f5847a7b9d1465"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed67816e547cf6f2eeba67d73f319b6e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6e">UCPTrieValueWidth</a> { <a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ea03c8d65a443bf9af5fbf8c321c764285">UCPTRIE_VALUE_BITS_ANY</a> = -1,
<a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ea8aedbe482494a508cb3e703efe873aa7">UCPTRIE_VALUE_BITS_16</a>,
<a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ead3835bbac363a881d36886afb4a91698">UCPTRIE_VALUE_BITS_32</a>,
<a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ea04f3f0f8a4777631d6de33be33cd722e">UCPTRIE_VALUE_BITS_8</a>
}</td></tr>
<tr class="memdesc:aed67816e547cf6f2eeba67d73f319b6e"><td class="mdescLeft"> </td><td class="mdescRight">Selectors for the number of bits in a <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> data value. <a href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6e">More...</a><br /></td></tr>
<tr class="separator:aed67816e547cf6f2eeba67d73f319b6e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a93e3017261ea92d15e807952add15abd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="structUCPTrie.html">UCPTrie</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd">ucptrie_openFromBinary</a> (<a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465">UCPTrieType</a> type, <a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6e">UCPTrieValueWidth</a> valueWidth, const void *data, int32_t length, int32_t *pActualLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a93e3017261ea92d15e807952add15abd"><td class="mdescLeft"> </td><td class="mdescRight">Opens a trie from its binary form, stored in 32-bit-aligned memory. <a href="#a93e3017261ea92d15e807952add15abd">More...</a><br /></td></tr>
<tr class="separator:a93e3017261ea92d15e807952add15abd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13be49abe7850f15ae4cd13e86d8128a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a13be49abe7850f15ae4cd13e86d8128a">ucptrie_close</a> (<a class="el" href="structUCPTrie.html">UCPTrie</a> *trie)</td></tr>
<tr class="memdesc:a13be49abe7850f15ae4cd13e86d8128a"><td class="mdescLeft"> </td><td class="mdescRight">Closes a trie and releases associated memory. <a href="#a13be49abe7850f15ae4cd13e86d8128a">More...</a><br /></td></tr>
<tr class="separator:a13be49abe7850f15ae4cd13e86d8128a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adee14811537907a56731e9523e8eb264"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465">UCPTrieType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#adee14811537907a56731e9523e8eb264">ucptrie_getType</a> (const <a class="el" href="structUCPTrie.html">UCPTrie</a> *trie)</td></tr>
<tr class="memdesc:adee14811537907a56731e9523e8eb264"><td class="mdescLeft"> </td><td class="mdescRight">Returns the trie type. <a href="#adee14811537907a56731e9523e8eb264">More...</a><br /></td></tr>
<tr class="separator:adee14811537907a56731e9523e8eb264"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a588fd8a483bbebd4acd96ffd05a12a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6e">UCPTrieValueWidth</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a5a588fd8a483bbebd4acd96ffd05a12a">ucptrie_getValueWidth</a> (const <a class="el" href="structUCPTrie.html">UCPTrie</a> *trie)</td></tr>
<tr class="memdesc:a5a588fd8a483bbebd4acd96ffd05a12a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bits in a trie data value. <a href="#a5a588fd8a483bbebd4acd96ffd05a12a">More...</a><br /></td></tr>
<tr class="separator:a5a588fd8a483bbebd4acd96ffd05a12a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8cf468424195496115991f8a32eed84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#af8cf468424195496115991f8a32eed84">ucptrie_get</a> (const <a class="el" href="structUCPTrie.html">UCPTrie</a> *trie, <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c)</td></tr>
<tr class="memdesc:af8cf468424195496115991f8a32eed84"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value for a code point as stored in the trie, with range checking. <a href="#af8cf468424195496115991f8a32eed84">More...</a><br /></td></tr>
<tr class="separator:af8cf468424195496115991f8a32eed84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d6bdc9d8f313be0e4d151f0cfc0086c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#a6d6bdc9d8f313be0e4d151f0cfc0086c">ucptrie_getRange</a> (const <a class="el" href="structUCPTrie.html">UCPTrie</a> *trie, <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> start, <a class="el" href="ucpmap_8h.html#aa32ef75912d4bbf21792256d17f16b9c">UCPMapRangeOption</a> option, uint32_t surrogateValue, <a class="el" href="ucpmap_8h.html#a2d302e405f2ea7dd5f65990460f2dbae">UCPMapValueFilter</a> *filter, const void *context, uint32_t *pValue)</td></tr>
<tr class="memdesc:a6d6bdc9d8f313be0e4d151f0cfc0086c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last code point such that all those from start to there have the same value. <a href="#a6d6bdc9d8f313be0e4d151f0cfc0086c">More...</a><br /></td></tr>
<tr class="separator:a6d6bdc9d8f313be0e4d151f0cfc0086c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abca6115a1c9c61fd594b7df485702bab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucptrie_8h.html#abca6115a1c9c61fd594b7df485702bab">ucptrie_toBinary</a> (const <a class="el" href="structUCPTrie.html">UCPTrie</a> *trie, void *data, int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:abca6115a1c9c61fd594b7df485702bab"><td class="mdescLeft"> </td><td class="mdescRight">Writes a memory-mappable form of the trie into 32-bit aligned memory. <a href="#abca6115a1c9c61fd594b7df485702bab">More...</a><br /></td></tr>
<tr class="separator:abca6115a1c9c61fd594b7df485702bab"><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: This file defines an immutable Unicode code point trie. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> </dd>
<dd>
<a class="el" href="umutablecptrie_8h.html#ad8945cf34ca9d40596a66a1395baa19b" title="Mutable Unicode code point trie. ">UMutableCPTrie</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad8a8583a1ba1f1d43049d11c24be45ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8a8583a1ba1f1d43049d11c24be45ca">◆ </a></span>UCPTRIE_16</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_16</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">i </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ((trie)->data.ptr16[i])</td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro parameter value for a trie with 16-bit data values. </p>
<p>Use the name of this macro as a "dataAccess" parameter in other macros. Do not use this macro in any other way.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ea8aedbe482494a508cb3e703efe873aa7" title="The trie stores 16 bits per data value. ">UCPTRIE_VALUE_BITS_16</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002075">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00326">326</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="ac483af4cb261ba7d72e5d64f0e121d6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac483af4cb261ba7d72e5d64f0e121d6a">◆ </a></span>UCPTRIE_32</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_32</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">i </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ((trie)->data.ptr32[i])</td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro parameter value for a trie with 32-bit data values. </p>
<p>Use the name of this macro as a "dataAccess" parameter in other macros. Do not use this macro in any other way.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ead3835bbac363a881d36886afb4a91698" title="The trie stores 32 bits per data value. ">UCPTRIE_VALUE_BITS_32</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002076">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00336">336</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="a21da8c1396f9ebbd3f612c8cc222d240"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21da8c1396f9ebbd3f612c8cc222d240">◆ </a></span>UCPTRIE_8</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_8</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">i </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ((trie)->data.ptr8[i])</td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro parameter value for a trie with 8-bit data values. </p>
<p>Use the name of this macro as a "dataAccess" parameter in other macros. Do not use this macro in any other way.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ea04f3f0f8a4777631d6de33be33cd722e" title="The trie stores 8 bits per data value. ">UCPTRIE_VALUE_BITS_8</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002077">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00346">346</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="ac02216670afc74dc60cc91161c63913b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac02216670afc74dc60cc91161c63913b">◆ </a></span>UCPTRIE_ASCII_GET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_ASCII_GET</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">c </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   dataAccess(trie, c)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a trie value for an ASCII code point, without range checking. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie (of either fast or small type) </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">c</td><td>(UChar32, in) the input code point; must be U+0000..U+007F </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The ASCII code point's trie value. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002084">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00517">517</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="ad33ea71b55eb2570bbc48faa51e58806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad33ea71b55eb2570bbc48faa51e58806">◆ </a></span>UCPTRIE_FAST_BMP_GET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_FAST_BMP_GET</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">c </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   dataAccess(trie, _UCPTRIE_FAST_INDEX(trie, c))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a trie value for a BMP code point (U+0000..U+FFFF), without range checking. </p>
<p>Can be used to look up a value for a UTF-16 code unit if other parts of the string processing check for surrogates.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_FAST </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">c</td><td>(UChar32, in) the input code point, must be U+0000..U+FFFF </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The BMP code point's trie value. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002085">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00530">530</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="a46017f54183600938e79ba84b9bcd178"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46017f54183600938e79ba84b9bcd178">◆ </a></span>UCPTRIE_FAST_GET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_FAST_GET</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">c </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   dataAccess(trie, _UCPTRIE_CP_INDEX(trie, 0xffff, c))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a trie value for a code point, with range checking. </p>
<p>Returns the trie error value if c is not in the range 0..U+10FFFF.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_FAST </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">c</td><td>(UChar32, in) the input code point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The code point's trie value. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002078">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00358">358</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="a14732d865095e395373bb9a8f43b7ef2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14732d865095e395373bb9a8f43b7ef2">◆ </a></span>UCPTRIE_FAST_SUPP_GET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_FAST_SUPP_GET</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">c </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   dataAccess(trie, _UCPTRIE_SMALL_INDEX(trie, c))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a trie value for a supplementary code point (U+10000..U+10FFFF), without range checking. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_FAST </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">c</td><td>(UChar32, in) the input code point, must be U+10000..U+10FFFF </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The supplementary code point's trie value. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002086">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00542">542</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="a8dec4ebf430a0322953b0de5d50179e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dec4ebf430a0322953b0de5d50179e8">◆ </a></span>UCPTRIE_FAST_U16_NEXT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_FAST_U16_NEXT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">src, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">limit, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">c, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">result </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a> { \</div><div class="line"> (c) = *(src)++; \</div><div class="line"> int32_t __index; \</div><div class="line"> if (!<a class="code" href="utf16_8h.html#ac25b589c0c9b60160d357770fad39cea">U16_IS_SURROGATE</a>(c)) { \</div><div class="line"> __index = _UCPTRIE_FAST_INDEX(trie, c); \</div><div class="line"> } <span class="keywordflow">else</span> { \</div><div class="line"> uint16_t __c2; \</div><div class="line"> if (<a class="code" href="utf16_8h.html#a6e141a548138e8c24822d219b7e06cb4">U16_IS_SURROGATE_LEAD</a>(c) && (src) != (limit) && <a class="code" href="utf16_8h.html#afe8d9f450b9297897f018c2f23eb0724">U16_IS_TRAIL</a>(__c2 = *(src))) { \</div><div class="line"> ++(src); \</div><div class="line"> (c) = <a class="code" href="utf16_8h.html#ac1deffbf1956d9fe696129515e88f006">U16_GET_SUPPLEMENTARY</a>((c), __c2); \</div><div class="line"> __index = _UCPTRIE_SMALL_INDEX(trie, c); \</div><div class="line"> } <span class="keywordflow">else</span> { \</div><div class="line"> __index = (trie)->dataLength - UCPTRIE_ERROR_VALUE_NEG_DATA_OFFSET; \</div><div class="line"> } \</div><div class="line"> } \</div><div class="line"> (result) = dataAccess(trie, __index); \</div><div class="line">} <a class="code" href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttc" id="umachine_8h_html_a983e6cc57f8c1b0c5b9ad9ceb290418a"><div class="ttname"><a href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_END</div><div class="ttdoc">Defined as "while (false)" by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00156">umachine.h:156</a></div></div>
<div class="ttc" id="utf16_8h_html_a6e141a548138e8c24822d219b7e06cb4"><div class="ttname"><a href="utf16_8h.html#a6e141a548138e8c24822d219b7e06cb4">U16_IS_SURROGATE_LEAD</a></div><div class="ttdeci">#define U16_IS_SURROGATE_LEAD(c)</div><div class="ttdoc">Assuming c is a surrogate code point (U16_IS_SURROGATE(c)), is it a lead surrogate? </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00084">utf16.h:84</a></div></div>
<div class="ttc" id="utf16_8h_html_afe8d9f450b9297897f018c2f23eb0724"><div class="ttname"><a href="utf16_8h.html#afe8d9f450b9297897f018c2f23eb0724">U16_IS_TRAIL</a></div><div class="ttdeci">#define U16_IS_TRAIL(c)</div><div class="ttdoc">Is this code unit a trail surrogate (U+dc00..U+dfff)? </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00067">utf16.h:67</a></div></div>
<div class="ttc" id="utf16_8h_html_ac1deffbf1956d9fe696129515e88f006"><div class="ttname"><a href="utf16_8h.html#ac1deffbf1956d9fe696129515e88f006">U16_GET_SUPPLEMENTARY</a></div><div class="ttdeci">#define U16_GET_SUPPLEMENTARY(lead, trail)</div><div class="ttdoc">Get a supplementary code point value (U+10000..U+10ffff) from its lead and trail surrogates. </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00112">utf16.h:112</a></div></div>
<div class="ttc" id="utf16_8h_html_ac25b589c0c9b60160d357770fad39cea"><div class="ttname"><a href="utf16_8h.html#ac25b589c0c9b60160d357770fad39cea">U16_IS_SURROGATE</a></div><div class="ttdeci">#define U16_IS_SURROGATE(c)</div><div class="ttdoc">Is this code unit a surrogate (U+d800..U+dfff)? </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00075">utf16.h:75</a></div></div>
<div class="ttc" id="umachine_8h_html_abfdc26d020b4fab3ed5ca2b98fe5df43"><div class="ttname"><a href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_BEGIN</div><div class="ttdoc">Defined as the "do" keyword by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00147">umachine.h:147</a></div></div>
</div><!-- fragment -->
<p>UTF-16: Reads the next code point (UChar32 c, out), post-increments src, and gets a value from the trie. </p>
<p>Sets the trie error value if c is an unpaired surrogate.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_FAST </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">src</td><td>(const UChar *, in/out) the source text pointer </td></tr>
<tr><td class="paramname">limit</td><td>(const UChar *, in) the limit pointer for the text, or NULL if NUL-terminated </td></tr>
<tr><td class="paramname">c</td><td>(UChar32, out) variable for the code point </td></tr>
<tr><td class="paramname">result</td><td>(out) variable for the trie lookup result </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002080">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00386">386</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="a932a432c7936a1b03cc2f453e8d3836e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a932a432c7936a1b03cc2f453e8d3836e">◆ </a></span>UCPTRIE_FAST_U16_PREV</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_FAST_U16_PREV</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">start, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">src, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">c, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">result </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a> { \</div><div class="line"> (c) = *--(src); \</div><div class="line"> int32_t __index; \</div><div class="line"> if (!<a class="code" href="utf16_8h.html#ac25b589c0c9b60160d357770fad39cea">U16_IS_SURROGATE</a>(c)) { \</div><div class="line"> __index = _UCPTRIE_FAST_INDEX(trie, c); \</div><div class="line"> } <span class="keywordflow">else</span> { \</div><div class="line"> uint16_t __c2; \</div><div class="line"> if (<a class="code" href="utf16_8h.html#a1da8c1409deafe3ac32a8ab506086c10">U16_IS_SURROGATE_TRAIL</a>(c) && (src) != (start) && <a class="code" href="utf16_8h.html#ace839ae31a801fd9c53fa67c5f8b9144">U16_IS_LEAD</a>(__c2 = *((src) - 1))) { \</div><div class="line"> --(src); \</div><div class="line"> (c) = <a class="code" href="utf16_8h.html#ac1deffbf1956d9fe696129515e88f006">U16_GET_SUPPLEMENTARY</a>(__c2, (c)); \</div><div class="line"> __index = _UCPTRIE_SMALL_INDEX(trie, c); \</div><div class="line"> } <span class="keywordflow">else</span> { \</div><div class="line"> __index = (trie)->dataLength - UCPTRIE_ERROR_VALUE_NEG_DATA_OFFSET; \</div><div class="line"> } \</div><div class="line"> } \</div><div class="line"> (result) = dataAccess(trie, __index); \</div><div class="line">} <a class="code" href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttc" id="umachine_8h_html_a983e6cc57f8c1b0c5b9ad9ceb290418a"><div class="ttname"><a href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_END</div><div class="ttdoc">Defined as "while (false)" by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00156">umachine.h:156</a></div></div>
<div class="ttc" id="utf16_8h_html_ace839ae31a801fd9c53fa67c5f8b9144"><div class="ttname"><a href="utf16_8h.html#ace839ae31a801fd9c53fa67c5f8b9144">U16_IS_LEAD</a></div><div class="ttdeci">#define U16_IS_LEAD(c)</div><div class="ttdoc">Is this code unit a lead surrogate (U+d800..U+dbff)? </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00059">utf16.h:59</a></div></div>
<div class="ttc" id="utf16_8h_html_ac1deffbf1956d9fe696129515e88f006"><div class="ttname"><a href="utf16_8h.html#ac1deffbf1956d9fe696129515e88f006">U16_GET_SUPPLEMENTARY</a></div><div class="ttdeci">#define U16_GET_SUPPLEMENTARY(lead, trail)</div><div class="ttdoc">Get a supplementary code point value (U+10000..U+10ffff) from its lead and trail surrogates. </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00112">utf16.h:112</a></div></div>
<div class="ttc" id="utf16_8h_html_a1da8c1409deafe3ac32a8ab506086c10"><div class="ttname"><a href="utf16_8h.html#a1da8c1409deafe3ac32a8ab506086c10">U16_IS_SURROGATE_TRAIL</a></div><div class="ttdeci">#define U16_IS_SURROGATE_TRAIL(c)</div><div class="ttdoc">Assuming c is a surrogate code point (U16_IS_SURROGATE(c)), is it a trail surrogate? </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00093">utf16.h:93</a></div></div>
<div class="ttc" id="utf16_8h_html_ac25b589c0c9b60160d357770fad39cea"><div class="ttname"><a href="utf16_8h.html#ac25b589c0c9b60160d357770fad39cea">U16_IS_SURROGATE</a></div><div class="ttdeci">#define U16_IS_SURROGATE(c)</div><div class="ttdoc">Is this code unit a surrogate (U+d800..U+dfff)? </div><div class="ttdef"><b>Definition:</b> <a href="utf16_8h_source.html#l00075">utf16.h:75</a></div></div>
<div class="ttc" id="umachine_8h_html_abfdc26d020b4fab3ed5ca2b98fe5df43"><div class="ttname"><a href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_BEGIN</div><div class="ttdoc">Defined as the "do" keyword by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00147">umachine.h:147</a></div></div>
</div><!-- fragment -->
<p>UTF-16: Reads the previous code point (UChar32 c, out), pre-decrements src, and gets a value from the trie. </p>
<p>Sets the trie error value if c is an unpaired surrogate.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_FAST </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">start</td><td>(const UChar *, in) the start pointer for the text </td></tr>
<tr><td class="paramname">src</td><td>(const UChar *, in/out) the source text pointer </td></tr>
<tr><td class="paramname">c</td><td>(UChar32, out) variable for the code point </td></tr>
<tr><td class="paramname">result</td><td>(out) variable for the trie lookup result </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002081">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00417">417</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="ab75bf3d4d7b9d698464fac7e83bf7c2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab75bf3d4d7b9d698464fac7e83bf7c2c">◆ </a></span>UCPTRIE_FAST_U8_NEXT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_FAST_U8_NEXT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">src, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">limit, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">result </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a> { \</div><div class="line"> int32_t __lead = (uint8_t)*(src)++; \</div><div class="line"> if (!<a class="code" href="utf8_8h.html#a8f3a9427d880458a9fa6b169a3cc1b3c">U8_IS_SINGLE</a>(__lead)) { \</div><div class="line"> uint8_t __t1, __t2, __t3; \</div><div class="line"> if ((src) != (limit) && \</div><div class="line"> (__lead >= 0xe0 ? \</div><div class="line"> __lead < 0xf0 ? <span class="comment">/* U+0800..U+FFFF except surrogates */</span> \</div><div class="line"> <a class="code" href="utf8_8h.html#aabfe8ee746b8025ec80ed1977e8ae3c6">U8_LEAD3_T1_BITS</a>[__lead &= 0xf] & (1 << ((__t1 = *(src)) >> 5)) && \</div><div class="line"> ++(src) != (limit) && (__t2 = *(src) - 0x80) <= 0x3f && \</div><div class="line"> (__lead = ((int32_t)(trie)->index[(__lead << 6) + (__t1 & 0x3f)]) + __t2, 1) \</div><div class="line"> : <span class="comment">/* U+10000..U+10FFFF */</span> \</div><div class="line"> (__lead -= 0xf0) <= 4 && \</div><div class="line"> <a class="code" href="utf8_8h.html#ab7b00ab82ca3e89d24c4088b2b4e9416">U8_LEAD4_T1_BITS</a>[(__t1 = *(src)) >> 4] & (1 << __lead) && \</div><div class="line"> (__lead = (__lead << 6) | (__t1 & 0x3f), ++(src) != (limit)) && \</div><div class="line"> (__t2 = *(src) - 0x80) <= 0x3f && \</div><div class="line"> ++(src) != (limit) && (__t3 = *(src) - 0x80) <= 0x3f && \</div><div class="line"> (__lead = __lead >= (trie)->shifted12HighStart ? \</div><div class="line"> (trie)->dataLength - UCPTRIE_HIGH_VALUE_NEG_DATA_OFFSET : \</div><div class="line"> ucptrie_internalSmallU8Index((trie), __lead, __t2, __t3), 1) \</div><div class="line"> : <span class="comment">/* U+0080..U+07FF */</span> \</div><div class="line"> __lead >= 0xc2 && (__t1 = *(src) - 0x80) <= 0x3f && \</div><div class="line"> (__lead = (int32_t)(trie)->index[__lead & 0x1f] + __t1, 1))) { \</div><div class="line"> ++(src); \</div><div class="line"> } <span class="keywordflow">else</span> { \</div><div class="line"> __lead = (trie)->dataLength - UCPTRIE_ERROR_VALUE_NEG_DATA_OFFSET; <span class="comment">/* ill-formed*/</span> \</div><div class="line"> } \</div><div class="line"> } \</div><div class="line"> (result) = dataAccess(trie, __lead); \</div><div class="line">} <a class="code" href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttc" id="umachine_8h_html_a983e6cc57f8c1b0c5b9ad9ceb290418a"><div class="ttname"><a href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_END</div><div class="ttdoc">Defined as "while (false)" by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00156">umachine.h:156</a></div></div>
<div class="ttc" id="utf8_8h_html_a8f3a9427d880458a9fa6b169a3cc1b3c"><div class="ttname"><a href="utf8_8h.html#a8f3a9427d880458a9fa6b169a3cc1b3c">U8_IS_SINGLE</a></div><div class="ttdeci">#define U8_IS_SINGLE(c)</div><div class="ttdoc">Does this code unit (byte) encode a code point by itself (US-ASCII 0..0x7f)? </div><div class="ttdef"><b>Definition:</b> <a href="utf8_8h_source.html#l00173">utf8.h:173</a></div></div>
<div class="ttc" id="utf8_8h_html_ab7b00ab82ca3e89d24c4088b2b4e9416"><div class="ttname"><a href="utf8_8h.html#ab7b00ab82ca3e89d24c4088b2b4e9416">U8_LEAD4_T1_BITS</a></div><div class="ttdeci">#define U8_LEAD4_T1_BITS</div><div class="ttdoc">Internal bit vector for 4-byte UTF-8 validity check, for use in U8_IS_VALID_LEAD4_AND_T1. </div><div class="ttdef"><b>Definition:</b> <a href="utf8_8h_source.html#l00108">utf8.h:108</a></div></div>
<div class="ttc" id="utf8_8h_html_aabfe8ee746b8025ec80ed1977e8ae3c6"><div class="ttname"><a href="utf8_8h.html#aabfe8ee746b8025ec80ed1977e8ae3c6">U8_LEAD3_T1_BITS</a></div><div class="ttdeci">#define U8_LEAD3_T1_BITS</div><div class="ttdoc">Internal bit vector for 3-byte UTF-8 validity check, for use in U8_IS_VALID_LEAD3_AND_T1. </div><div class="ttdef"><b>Definition:</b> <a href="utf8_8h_source.html#l00091">utf8.h:91</a></div></div>
<div class="ttc" id="umachine_8h_html_abfdc26d020b4fab3ed5ca2b98fe5df43"><div class="ttname"><a href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_BEGIN</div><div class="ttdoc">Defined as the "do" keyword by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00147">umachine.h:147</a></div></div>
</div><!-- fragment -->
<p>UTF-8: Post-increments src and gets a value from the trie. </p>
<p>Sets the trie error value for an ill-formed byte sequence.</p>
<p>Unlike <a class="el" href="ucptrie_8h.html#a8dec4ebf430a0322953b0de5d50179e8" title="UTF-16: Reads the next code point (UChar32 c, out), post-increments src, and gets a value from the tr...">UCPTRIE_FAST_U16_NEXT()</a> this UTF-8 macro does not provide the code point because it would be more work to do so and is often not needed. If the trie value differs from the error value, then the byte sequence is well-formed, and the code point can be assembled without revalidation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_FAST </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">src</td><td>(const char *, in/out) the source text pointer </td></tr>
<tr><td class="paramname">limit</td><td>(const char *, in) the limit pointer for the text (must not be NULL) </td></tr>
<tr><td class="paramname">result</td><td>(out) variable for the trie lookup result </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002082">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00451">451</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="a194bc0279a0c22564199e2b5eef130ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a194bc0279a0c22564199e2b5eef130ad">◆ </a></span>UCPTRIE_FAST_U8_PREV</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_FAST_U8_PREV</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">start, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">src, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">result </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a> { \</div><div class="line"> int32_t __index = (uint8_t)*--(src); \</div><div class="line"> if (!<a class="code" href="utf8_8h.html#a8f3a9427d880458a9fa6b169a3cc1b3c">U8_IS_SINGLE</a>(__index)) { \</div><div class="line"> __index = ucptrie_internalU8PrevIndex((trie), __index, (<span class="keyword">const</span> uint8_t *)(start), \</div><div class="line"> (<span class="keyword">const</span> uint8_t *)(src)); \</div><div class="line"> (src) -= __index & 7; \</div><div class="line"> __index >>= 3; \</div><div class="line"> } \</div><div class="line"> (result) = dataAccess(trie, __index); \</div><div class="line">} <a class="code" href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttc" id="umachine_8h_html_a983e6cc57f8c1b0c5b9ad9ceb290418a"><div class="ttname"><a href="umachine_8h.html#a983e6cc57f8c1b0c5b9ad9ceb290418a">UPRV_BLOCK_MACRO_END</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_END</div><div class="ttdoc">Defined as "while (false)" by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00156">umachine.h:156</a></div></div>
<div class="ttc" id="utf8_8h_html_a8f3a9427d880458a9fa6b169a3cc1b3c"><div class="ttname"><a href="utf8_8h.html#a8f3a9427d880458a9fa6b169a3cc1b3c">U8_IS_SINGLE</a></div><div class="ttdeci">#define U8_IS_SINGLE(c)</div><div class="ttdoc">Does this code unit (byte) encode a code point by itself (US-ASCII 0..0x7f)? </div><div class="ttdef"><b>Definition:</b> <a href="utf8_8h_source.html#l00173">utf8.h:173</a></div></div>
<div class="ttc" id="umachine_8h_html_abfdc26d020b4fab3ed5ca2b98fe5df43"><div class="ttname"><a href="umachine_8h.html#abfdc26d020b4fab3ed5ca2b98fe5df43">UPRV_BLOCK_MACRO_BEGIN</a></div><div class="ttdeci">#define UPRV_BLOCK_MACRO_BEGIN</div><div class="ttdoc">Defined as the "do" keyword by default. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00147">umachine.h:147</a></div></div>
</div><!-- fragment -->
<p>UTF-8: Pre-decrements src and gets a value from the trie. </p>
<p>Sets the trie error value for an ill-formed byte sequence.</p>
<p>Unlike <a class="el" href="ucptrie_8h.html#a932a432c7936a1b03cc2f453e8d3836e" title="UTF-16: Reads the previous code point (UChar32 c, out), pre-decrements src, and gets a value from the...">UCPTRIE_FAST_U16_PREV()</a> this UTF-8 macro does not provide the code point because it would be more work to do so and is often not needed. If the trie value differs from the error value, then the byte sequence is well-formed, and the code point can be assembled without revalidation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_FAST </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">start</td><td>(const char *, in) the start pointer for the text </td></tr>
<tr><td class="paramname">src</td><td>(const char *, in/out) the source text pointer </td></tr>
<tr><td class="paramname">result</td><td>(out) variable for the trie lookup result </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002083">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00497">497</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="a7a87c5c6cb0b1233e10f063413f9d003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a87c5c6cb0b1233e10f063413f9d003">◆ </a></span>UCPTRIE_SMALL_GET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCPTRIE_SMALL_GET</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">trie, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dataAccess, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">c </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   dataAccess(trie, _UCPTRIE_CP_INDEX(trie, UCPTRIE_SMALL_MAX, c))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a 16-bit trie value for a code point, with range checking. </p>
<p>Returns the trie error value if c is not in the range U+0000..U+10FFFF.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>(const <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> *, in) the trie; must have type UCPTRIE_TYPE_SMALL </td></tr>
<tr><td class="paramname">dataAccess</td><td>UCPTRIE_16, UCPTRIE_32, or UCPTRIE_8 according to the trie’s value width </td></tr>
<tr><td class="paramname">c</td><td>(UChar32, in) the input code point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The code point's trie value. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002079">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00370">370</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a0736c5a35aefa6f366f5847a7b9d1465"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0736c5a35aefa6f366f5847a7b9d1465">◆ </a></span>UCPTrieType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465">UCPTrieType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selectors for the type of a <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a>. </p>
<p>Different trade-offs for size vs. speed.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="umutablecptrie_8h.html#a76b0cd62e85572cc15b471f22d54e06e" title="Compacts the data and builds an immutable UCPTrie according to the parameters. ">umutablecptrie_buildImmutable</a> </dd>
<dd>
<a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary</a> </dd>
<dd>
<a class="el" href="ucptrie_8h.html#adee14811537907a56731e9523e8eb264" title="Returns the trie type. ">ucptrie_getType</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002066">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0736c5a35aefa6f366f5847a7b9d1465ae4474d990fe030905ffb0c11f3454b90"></a>UCPTRIE_TYPE_ANY </td><td class="fielddoc"><p>For <a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary()</a> to accept any type. </p>
<p><a class="el" href="ucptrie_8h.html#adee14811537907a56731e9523e8eb264" title="Returns the trie type. ">ucptrie_getType()</a> will return the actual type. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable002087">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a0736c5a35aefa6f366f5847a7b9d1465a0fc3f23899946bd2df3ff03adafbb032"></a>UCPTRIE_TYPE_FAST </td><td class="fielddoc"><p>Fast/simple/larger BMP data structure. </p>
<p>Use functions and "fast" macros. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable002088">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a0736c5a35aefa6f366f5847a7b9d1465a75efbaba0dfeabdce18f7adff32f74f5"></a>UCPTRIE_TYPE_SMALL </td><td class="fielddoc"><p>Small/slower BMP data structure. </p>
<p>Use functions and "small" macros. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable002089">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00119">119</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<a id="aed67816e547cf6f2eeba67d73f319b6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed67816e547cf6f2eeba67d73f319b6e">◆ </a></span>UCPTrieValueWidth</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6e">UCPTrieValueWidth</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Selectors for the number of bits in a <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> data value. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="umutablecptrie_8h.html#a76b0cd62e85572cc15b471f22d54e06e" title="Compacts the data and builds an immutable UCPTrie according to the parameters. ">umutablecptrie_buildImmutable</a> </dd>
<dd>
<a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary</a> </dd>
<dd>
<a class="el" href="ucptrie_8h.html#a5a588fd8a483bbebd4acd96ffd05a12a" title="Returns the number of bits in a trie data value. ">ucptrie_getValueWidth</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002067">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aed67816e547cf6f2eeba67d73f319b6ea03c8d65a443bf9af5fbf8c321c764285"></a>UCPTRIE_VALUE_BITS_ANY </td><td class="fielddoc"><p>For <a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary()</a> to accept any data value width. </p>
<p><a class="el" href="ucptrie_8h.html#a5a588fd8a483bbebd4acd96ffd05a12a" title="Returns the number of bits in a trie data value. ">ucptrie_getValueWidth()</a> will return the actual data value width. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable002090">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="aed67816e547cf6f2eeba67d73f319b6ea8aedbe482494a508cb3e703efe873aa7"></a>UCPTRIE_VALUE_BITS_16 </td><td class="fielddoc"><p>The trie stores 16 bits per data value. </p>
<p>It returns them as unsigned values 0..0xffff=65535. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable002091">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="aed67816e547cf6f2eeba67d73f319b6ead3835bbac363a881d36886afb4a91698"></a>UCPTRIE_VALUE_BITS_32 </td><td class="fielddoc"><p>The trie stores 32 bits per data value. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002092">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="aed67816e547cf6f2eeba67d73f319b6ea04f3f0f8a4777631d6de33be33cd722e"></a>UCPTRIE_VALUE_BITS_8 </td><td class="fielddoc"><p>The trie stores 8 bits per data value. </p>
<p>It returns them as unsigned values 0..0xff=255. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable002093">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="ucptrie_8h_source.html#l00149">149</a> of file <a class="el" href="ucptrie_8h_source.html">ucptrie.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a13be49abe7850f15ae4cd13e86d8128a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13be49abe7850f15ae4cd13e86d8128a">◆ </a></span>ucptrie_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucptrie_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUCPTrie.html">UCPTrie</a> * </td>
<td class="paramname"><em>trie</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes a trie and releases associated memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>the trie </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002069">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<a id="af8cf468424195496115991f8a32eed84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8cf468424195496115991f8a32eed84">◆ </a></span>ucptrie_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> uint32_t ucptrie_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structUCPTrie.html">UCPTrie</a> * </td>
<td class="paramname"><em>trie</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td>
<td class="paramname"><em>c</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value for a code point as stored in the trie, with range checking. </p>
<p>Returns the trie error value if c is not in the range 0..U+10FFFF.</p>
<p>Easier to use than <a class="el" href="ucptrie_8h.html#a46017f54183600938e79ba84b9bcd178" title="Returns a trie value for a code point, with range checking. ">UCPTRIE_FAST_GET()</a> and similar macros but slower. Easier to use because, unlike the macros, this function works on all <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> objects, for all types and value widths.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>the trie </td></tr>
<tr><td class="paramname">c</td><td>the code point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the trie value, or the trie error value if the code point is not in the range 0..U+10FFFF </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002072">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<a id="a6d6bdc9d8f313be0e4d151f0cfc0086c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d6bdc9d8f313be0e4d151f0cfc0086c">◆ </a></span>ucptrie_getRange()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> ucptrie_getRange </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structUCPTrie.html">UCPTrie</a> * </td>
<td class="paramname"><em>trie</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucpmap_8h.html#aa32ef75912d4bbf21792256d17f16b9c">UCPMapRangeOption</a> </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>surrogateValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucpmap_8h.html#a2d302e405f2ea7dd5f65990460f2dbae">UCPMapValueFilter</a> * </td>
<td class="paramname"><em>filter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>pValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the last code point such that all those from start to there have the same value. </p>
<p>Can be used to efficiently iterate over all same-value ranges in a trie. (This is normally faster than iterating over code points and get()ting each value, but much slower than a data structure that stores ranges directly.)</p>
<p>If the UCPMapValueFilter function pointer is not NULL, then the value to be delivered is passed through that function, and the return value is the end of the range where all values are modified to the same actual value. The value is unchanged if that function pointer is NULL.</p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> start = 0, end;</div><div class="line">uint32_t value;</div><div class="line"><span class="keywordflow">while</span> ((end = <a class="code" href="ucptrie_8h.html#a6d6bdc9d8f313be0e4d151f0cfc0086c">ucptrie_getRange</a>(trie, start, <a class="code" href="ucpmap_8h.html#aa32ef75912d4bbf21792256d17f16b9ca3013a1d6bd08b42e51c8042326148292">UCPMAP_RANGE_NORMAL</a>, 0,</div><div class="line"> <a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>, <a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>, &value)) >= 0) {</div><div class="line"> <span class="comment">// Work with the range start..end and its value.</span></div><div class="line"> start = end + 1;</div><div class="line">}</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>the trie </td></tr>
<tr><td class="paramname">start</td><td>range start </td></tr>
<tr><td class="paramname">option</td><td>defines whether surrogates are treated normally, or as having the surrogateValue; usually UCPMAP_RANGE_NORMAL </td></tr>
<tr><td class="paramname">surrogateValue</td><td>value for surrogates; ignored if option==UCPMAP_RANGE_NORMAL </td></tr>
<tr><td class="paramname">filter</td><td>a pointer to a function that may modify the trie data value, or NULL if the values from the trie are to be used unmodified </td></tr>
<tr><td class="paramname">context</td><td>an opaque pointer that is passed on to the filter function </td></tr>
<tr><td class="paramname">pValue</td><td>if not NULL, receives the value that every code point start..end has; may have been modified by filter(context, trie value) if that function pointer is not NULL </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the range end code point, or -1 if start is not a valid code point </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002073">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<a id="adee14811537907a56731e9523e8eb264"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adee14811537907a56731e9523e8eb264">◆ </a></span>ucptrie_getType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465">UCPTrieType</a> ucptrie_getType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structUCPTrie.html">UCPTrie</a> * </td>
<td class="paramname"><em>trie</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the trie type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>the trie </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the trie type </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary</a> </dd>
<dd>
<a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465ae4474d990fe030905ffb0c11f3454b90" title="For ucptrie_openFromBinary() to accept any type. ">UCPTRIE_TYPE_ANY</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002070">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<a id="a5a588fd8a483bbebd4acd96ffd05a12a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a588fd8a483bbebd4acd96ffd05a12a">◆ </a></span>ucptrie_getValueWidth()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6e">UCPTrieValueWidth</a> ucptrie_getValueWidth </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structUCPTrie.html">UCPTrie</a> * </td>
<td class="paramname"><em>trie</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of bits in a trie data value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>the trie </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bits in a trie data value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary</a> </dd>
<dd>
<a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6ea03c8d65a443bf9af5fbf8c321c764285" title="For ucptrie_openFromBinary() to accept any data value width. ">UCPTRIE_VALUE_BITS_ANY</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002071">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<a id="a93e3017261ea92d15e807952add15abd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93e3017261ea92d15e807952add15abd">◆ </a></span>ucptrie_openFromBinary()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="structUCPTrie.html">UCPTrie</a>* ucptrie_openFromBinary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucptrie_8h.html#a0736c5a35aefa6f366f5847a7b9d1465">UCPTrieType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucptrie_8h.html#aed67816e547cf6f2eeba67d73f319b6e">UCPTrieValueWidth</a> </td>
<td class="paramname"><em>valueWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>pActualLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens a trie from its binary form, stored in 32-bit-aligned memory. </p>
<p>Inverse of <a class="el" href="ucptrie_8h.html#abca6115a1c9c61fd594b7df485702bab" title="Writes a memory-mappable form of the trie into 32-bit aligned memory. ">ucptrie_toBinary()</a>.</p>
<p>The memory must remain valid and unchanged as long as the trie is used. You must <a class="el" href="ucptrie_8h.html#a13be49abe7850f15ae4cd13e86d8128a" title="Closes a trie and releases associated memory. ">ucptrie_close()</a> the trie once you are done using it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>selects the trie type; results in an U_INVALID_FORMAT_ERROR if it does not match the binary data; use UCPTRIE_TYPE_ANY to accept any type </td></tr>
<tr><td class="paramname">valueWidth</td><td>selects the number of bits in a data value; results in an U_INVALID_FORMAT_ERROR if it does not match the binary data; use UCPTRIE_VALUE_BITS_ANY to accept any data value width </td></tr>
<tr><td class="paramname">data</td><td>a pointer to 32-bit-aligned memory containing the binary data of a <a class="el" href="structUCPTrie.html" title="Immutable Unicode code point trie structure. ">UCPTrie</a> </td></tr>
<tr><td class="paramname">length</td><td>the number of bytes available at data; can be more than necessary </td></tr>
<tr><td class="paramname">pActualLength</td><td>receives the actual number of bytes at data taken up by the trie data; can be NULL </td></tr>
<tr><td class="paramname">pErrorCode</td><td>an in/out ICU UErrorCode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the trie</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="umutablecptrie_8h.html#a1ccd5d9f012b8b0f6dfa4956a2487d94" title="Creates a mutable trie that initially maps each Unicode code point to the same value. ">umutablecptrie_open</a> </dd>
<dd>
<a class="el" href="umutablecptrie_8h.html#a76b0cd62e85572cc15b471f22d54e06e" title="Compacts the data and builds an immutable UCPTrie according to the parameters. ">umutablecptrie_buildImmutable</a> </dd>
<dd>
<a class="el" href="ucptrie_8h.html#abca6115a1c9c61fd594b7df485702bab" title="Writes a memory-mappable form of the trie into 32-bit aligned memory. ">ucptrie_toBinary</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002068">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<a id="abca6115a1c9c61fd594b7df485702bab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abca6115a1c9c61fd594b7df485702bab">◆ </a></span>ucptrie_toBinary()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int32_t ucptrie_toBinary </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structUCPTrie.html">UCPTrie</a> * </td>
<td class="paramname"><em>trie</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a memory-mappable form of the trie into 32-bit aligned memory. </p>
<p>Inverse of <a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>the trie </td></tr>
<tr><td class="paramname">data</td><td>a pointer to 32-bit-aligned memory to be filled with the trie data; can be NULL if capacity==0 </td></tr>
<tr><td class="paramname">capacity</td><td>the number of bytes available at data, or 0 for pure preflighting </td></tr>
<tr><td class="paramname">pErrorCode</td><td>an in/out ICU UErrorCode; U_BUFFER_OVERFLOW_ERROR if the capacity is too small </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes written or (if buffer overflow) needed for the trie</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucptrie_8h.html#a93e3017261ea92d15e807952add15abd" title="Opens a trie from its binary form, stored in 32-bit-aligned memory. ">ucptrie_openFromBinary()</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002074">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</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>