File: //opt/alt/alt-nodejs20/root/usr/share/doc/alt-nodejs20-libicu-doc/utfstring_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 78.3: common/unicode/utfstring.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 78.3
 <span id="projectnumber">78.3</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">utfstring.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C++ header-only API: C++ string helper functions.
<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="utf16_8h_source.html">unicode/utf16.h</a>"</code><br />
</div>
<p><a href="utfstring_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a939617d77e1adccdd59ef9d6c016865c"><td class="memTemplParams" colspan="2">template<typename StringClass > </td></tr>
<tr class="memitem:a939617d77e1adccdd59ef9d6c016865c"><td class="memTemplItemLeft" align="right" valign="top">StringClass & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="utfstring_8h.html#a939617d77e1adccdd59ef9d6c016865c">U_HEADER_ONLY_NAMESPACE::utfstring::appendOrFFFD</a> (StringClass &s, <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c)</td></tr>
<tr class="memdesc:a939617d77e1adccdd59ef9d6c016865c"><td class="mdescLeft"> </td><td class="mdescRight">Appends the code point to the string. <a href="utfstring_8h.html#a939617d77e1adccdd59ef9d6c016865c">More...</a><br /></td></tr>
<tr class="separator:a939617d77e1adccdd59ef9d6c016865c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac21d4b0e1daf039bd1450d0a62bc7f5e"><td class="memTemplParams" colspan="2">template<typename StringClass > </td></tr>
<tr class="memitem:ac21d4b0e1daf039bd1450d0a62bc7f5e"><td class="memTemplItemLeft" align="right" valign="top">StringClass & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="utfstring_8h.html#ac21d4b0e1daf039bd1450d0a62bc7f5e">U_HEADER_ONLY_NAMESPACE::utfstring::appendUnsafe</a> (StringClass &s, <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c)</td></tr>
<tr class="memdesc:ac21d4b0e1daf039bd1450d0a62bc7f5e"><td class="mdescLeft"> </td><td class="mdescRight">Appends the code point to the string. <a href="utfstring_8h.html#ac21d4b0e1daf039bd1450d0a62bc7f5e">More...</a><br /></td></tr>
<tr class="separator:ac21d4b0e1daf039bd1450d0a62bc7f5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2a1e27be01385029eae08c20cbc27c7"><td class="memTemplParams" colspan="2">template<typename StringClass > </td></tr>
<tr class="memitem:ad2a1e27be01385029eae08c20cbc27c7"><td class="memTemplItemLeft" align="right" valign="top">StringClass </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="utfstring_8h.html#ad2a1e27be01385029eae08c20cbc27c7">U_HEADER_ONLY_NAMESPACE::utfstring::encodeOrFFFD</a> (<a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c)</td></tr>
<tr class="memdesc:ad2a1e27be01385029eae08c20cbc27c7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the code point as a string of code units. <a href="utfstring_8h.html#ad2a1e27be01385029eae08c20cbc27c7">More...</a><br /></td></tr>
<tr class="separator:ad2a1e27be01385029eae08c20cbc27c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f483c0eb1c2ebb4c9736a5a8efd8694"><td class="memTemplParams" colspan="2">template<typename StringClass > </td></tr>
<tr class="memitem:a4f483c0eb1c2ebb4c9736a5a8efd8694"><td class="memTemplItemLeft" align="right" valign="top">StringClass </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="utfstring_8h.html#a4f483c0eb1c2ebb4c9736a5a8efd8694">U_HEADER_ONLY_NAMESPACE::utfstring::encodeUnsafe</a> (<a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c)</td></tr>
<tr class="memdesc:a4f483c0eb1c2ebb4c9736a5a8efd8694"><td class="mdescLeft"> </td><td class="mdescRight">Returns the code point as a string of code units. <a href="utfstring_8h.html#a4f483c0eb1c2ebb4c9736a5a8efd8694">More...</a><br /></td></tr>
<tr class="separator:a4f483c0eb1c2ebb4c9736a5a8efd8694"><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++ header-only API: C++ string helper functions. </p>
<p class="definition">Definition in file <a class="el" href="utfstring_8h_source.html">utfstring.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="file_a939617d77e1adccdd59ef9d6c016865c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#file_a939617d77e1adccdd59ef9d6c016865c">◆ </a></span>appendOrFFFD()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename StringClass > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringClass& U_HEADER_ONLY_NAMESPACE::utfstring::appendOrFFFD </td>
<td>(</td>
<td class="paramtype">StringClass & </td>
<td class="paramname"><em>s</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends the code point to the string. </p>
<p>Appends the U+FFFD replacement character instead if c is not a scalar value. See <a href="https://www.unicode.org/glossary/#unicode_scalar_value">https://www.unicode.org/glossary/#unicode_scalar_value</a></p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">StringClass</td><td>A version of std::basic_string (or a compatible type) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The string to append to </td></tr>
<tr><td class="paramname">c</td><td>The code point to append </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>s </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000113">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 78 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="utf_8h.html#a11496302e8ef16918b5d3f34ec5ab7c2" title="Is c a Unicode scalar value, that is, a non-surrogate code point? Only scalar values can be represent...">U_IS_SCALAR_VALUE</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="utfstring_8h_source.html#l00098">98</a> of file <a class="el" href="utfstring_8h_source.html">utfstring.h</a>.</p>
<p class="reference">References <a class="el" href="utfstring_8h_source.html#l00098">U_HEADER_ONLY_NAMESPACE::utfstring::appendOrFFFD()</a>.</p>
<p class="reference">Referenced by <a class="el" href="utfstring_8h_source.html#l00098">U_HEADER_ONLY_NAMESPACE::utfstring::appendOrFFFD()</a>.</p>
</div>
</div>
<a id="file_ac21d4b0e1daf039bd1450d0a62bc7f5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#file_ac21d4b0e1daf039bd1450d0a62bc7f5e">◆ </a></span>appendUnsafe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename StringClass > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringClass& U_HEADER_ONLY_NAMESPACE::utfstring::appendUnsafe </td>
<td>(</td>
<td class="paramtype">StringClass & </td>
<td class="paramname"><em>s</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends the code point to the string. </p>
<p>The code point must be a scalar value; otherwise the behavior is undefined. See <a href="https://www.unicode.org/glossary/#unicode_scalar_value">https://www.unicode.org/glossary/#unicode_scalar_value</a></p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">StringClass</td><td>A version of std::basic_string (or a compatible type) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The string to append to </td></tr>
<tr><td class="paramname">c</td><td>The code point to append (must be a scalar value) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>s </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000114">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 78 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="utf_8h.html#a11496302e8ef16918b5d3f34ec5ab7c2" title="Is c a Unicode scalar value, that is, a non-surrogate code point? Only scalar values can be represent...">U_IS_SCALAR_VALUE</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="utfstring_8h_source.html#l00115">115</a> of file <a class="el" href="utfstring_8h_source.html">utfstring.h</a>.</p>
<p class="reference">References <a class="el" href="utfstring_8h_source.html#l00115">U_HEADER_ONLY_NAMESPACE::utfstring::appendUnsafe()</a>.</p>
<p class="reference">Referenced by <a class="el" href="utfstring_8h_source.html#l00115">U_HEADER_ONLY_NAMESPACE::utfstring::appendUnsafe()</a>.</p>
</div>
</div>
<a id="file_ad2a1e27be01385029eae08c20cbc27c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#file_ad2a1e27be01385029eae08c20cbc27c7">◆ </a></span>encodeOrFFFD()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename StringClass > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringClass U_HEADER_ONLY_NAMESPACE::utfstring::encodeOrFFFD </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the code point as a string of code units. </p>
<p>Returns the U+FFFD replacement character instead if c is not a scalar value. See <a href="https://www.unicode.org/glossary/#unicode_scalar_value">https://www.unicode.org/glossary/#unicode_scalar_value</a></p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">StringClass</td><td>A version of std::basic_string (or a compatible type) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>The code point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the string of c's code units </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000115">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 78 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="utf_8h.html#a11496302e8ef16918b5d3f34ec5ab7c2" title="Is c a Unicode scalar value, that is, a non-surrogate code point? Only scalar values can be represent...">U_IS_SCALAR_VALUE</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="utfstring_8h_source.html#l00131">131</a> of file <a class="el" href="utfstring_8h_source.html">utfstring.h</a>.</p>
<p class="reference">References <a class="el" href="utfstring_8h_source.html#l00131">U_HEADER_ONLY_NAMESPACE::utfstring::encodeOrFFFD()</a>.</p>
<p class="reference">Referenced by <a class="el" href="utfstring_8h_source.html#l00131">U_HEADER_ONLY_NAMESPACE::utfstring::encodeOrFFFD()</a>.</p>
</div>
</div>
<a id="file_a4f483c0eb1c2ebb4c9736a5a8efd8694"></a>
<h2 class="memtitle"><span class="permalink"><a href="#file_a4f483c0eb1c2ebb4c9736a5a8efd8694">◆ </a></span>encodeUnsafe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename StringClass > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringClass U_HEADER_ONLY_NAMESPACE::utfstring::encodeUnsafe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the code point as a string of code units. </p>
<p>The code point must be a scalar value; otherwise the behavior is undefined. See <a href="https://www.unicode.org/glossary/#unicode_scalar_value">https://www.unicode.org/glossary/#unicode_scalar_value</a></p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">StringClass</td><td>A version of std::basic_string (or a compatible type) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>The code point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the string of c's code units </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000116">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 78 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="utf_8h.html#a11496302e8ef16918b5d3f34ec5ab7c2" title="Is c a Unicode scalar value, that is, a non-surrogate code point? Only scalar values can be represent...">U_IS_SCALAR_VALUE</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="utfstring_8h_source.html#l00149">149</a> of file <a class="el" href="utfstring_8h_source.html">utfstring.h</a>.</p>
<p class="reference">References <a class="el" href="utfstring_8h_source.html#l00149">U_HEADER_ONLY_NAMESPACE::utfstring::encodeUnsafe()</a>.</p>
<p class="reference">Referenced by <a class="el" href="utfstring_8h_source.html#l00149">U_HEADER_ONLY_NAMESPACE::utfstring::encodeUnsafe()</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>