generic-library/boost
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
boost/libs/nowide/doc/html/namespaceboost_1_1nowide_1_1utf.html
Edouard DUPIN d0115b733d [DEV] add v1.76.0
2021-10-05 21:37:46 +02:00

214 lines
13 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Boost.Nowide: boost::nowide::utf Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Boost.Nowide
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>boost</b></li><li class="navelem"><a class="el" href="namespaceboost_1_1nowide.html">nowide</a></li><li class="navelem"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html">utf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">boost::nowide::utf Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Namespace that holds basic operations on UTF encoded sequences.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1nowide_1_1utf_1_1utf__traits.html">utf_traits</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">UTF Traits class - functions to convert UTF sequences to and from Unicode code points. <a href="structboost_1_1nowide_1_1utf_1_1utf__traits.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4bd651000593bf73be05d50278e2c1e3"><td class="memItemLeft" align="right" valign="top"><a id="a4bd651000593bf73be05d50278e2c1e3"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html#a4bd651000593bf73be05d50278e2c1e3">code_point</a> = uint32_t</td></tr>
<tr class="memdesc:a4bd651000593bf73be05d50278e2c1e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The integral type that can hold a Unicode code point. <br /></td></tr>
<tr class="separator:a4bd651000593bf73be05d50278e2c1e3"><td class="memSeparator" colspan="2">&#160;</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:af88d6b53b99aec7da32bd67087e7fdcd"><td class="memTemplParams" colspan="2">template&lt;typename Char &gt; </td></tr>
<tr class="memitem:af88d6b53b99aec7da32bd67087e7fdcd"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html#af88d6b53b99aec7da32bd67087e7fdcd">strlen</a> (const Char *s)</td></tr>
<tr class="separator:af88d6b53b99aec7da32bd67087e7fdcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a105f0d686d048295780f66696222391c"><td class="memTemplParams" colspan="2">template&lt;typename CharOut , typename CharIn &gt; </td></tr>
<tr class="memitem:a105f0d686d048295780f66696222391c"><td class="memTemplItemLeft" align="right" valign="top">CharOut *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html#a105f0d686d048295780f66696222391c">convert_buffer</a> (CharOut *buffer, size_t buffer_size, const CharIn *source_begin, const CharIn *source_end)</td></tr>
<tr class="separator:a105f0d686d048295780f66696222391c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab23f248c3a3a7f5adffb89e155e5a0fe"><td class="memTemplParams" colspan="2">template&lt;typename CharOut , typename CharIn &gt; </td></tr>
<tr class="memitem:ab23f248c3a3a7f5adffb89e155e5a0fe"><td class="memTemplItemLeft" align="right" valign="top">std::basic_string&lt; CharOut &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html#ab23f248c3a3a7f5adffb89e155e5a0fe">convert_string</a> (const CharIn *begin, const CharIn *end)</td></tr>
<tr class="separator:ab23f248c3a3a7f5adffb89e155e5a0fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36d7b6788f08461409fbfbba8af8b0a4"><td class="memItemLeft" align="right" valign="top"><a id="a36d7b6788f08461409fbfbba8af8b0a4"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html#a36d7b6788f08461409fbfbba8af8b0a4">is_valid_codepoint</a> (<a class="el" href="namespaceboost_1_1nowide_1_1utf.html#a4bd651000593bf73be05d50278e2c1e3">code_point</a> v)</td></tr>
<tr class="memdesc:a36d7b6788f08461409fbfbba8af8b0a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">the function checks if <em>v</em> is a valid code point <br /></td></tr>
<tr class="separator:a36d7b6788f08461409fbfbba8af8b0a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:aaaf1f34f7f0c7d3c98f6896e737873ae"><td class="memItemLeft" align="right" valign="top"><a id="aaaf1f34f7f0c7d3c98f6896e737873ae"></a>
static const <a class="el" href="namespaceboost_1_1nowide_1_1utf.html#a4bd651000593bf73be05d50278e2c1e3">code_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html#aaaf1f34f7f0c7d3c98f6896e737873ae">illegal</a> = 0xFFFFFFFFu</td></tr>
<tr class="memdesc:aaaf1f34f7f0c7d3c98f6896e737873ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special constant that defines illegal code point. <br /></td></tr>
<tr class="separator:aaaf1f34f7f0c7d3c98f6896e737873ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80a0fd866c8fa2791c400dc501a4e25f"><td class="memItemLeft" align="right" valign="top"><a id="a80a0fd866c8fa2791c400dc501a4e25f"></a>
static const <a class="el" href="namespaceboost_1_1nowide_1_1utf.html#a4bd651000593bf73be05d50278e2c1e3">code_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1nowide_1_1utf.html#a80a0fd866c8fa2791c400dc501a4e25f">incomplete</a> = 0xFFFFFFFEu</td></tr>
<tr class="memdesc:a80a0fd866c8fa2791c400dc501a4e25f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special constant that defines incomplete code point. <br /></td></tr>
<tr class="separator:a80a0fd866c8fa2791c400dc501a4e25f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Namespace that holds basic operations on UTF encoded sequences. </p>
<p>All functions defined in this namespace do not require linking with Boost.Nowide library. Extracted from Boost.Locale </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a105f0d686d048295780f66696222391c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a105f0d686d048295780f66696222391c">&#9670;&nbsp;</a></span>convert_buffer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharOut , typename CharIn &gt; </div>
<table class="memname">
<tr>
<td class="memname">CharOut* boost::nowide::utf::convert_buffer </td>
<td>(</td>
<td class="paramtype">CharOut *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>buffer_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const CharIn *&#160;</td>
<td class="paramname"><em>source_begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const CharIn *&#160;</td>
<td class="paramname"><em>source_end</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a buffer of UTF sequences in the range [source_begin, source_end) from <em>CharIn</em> to <em>CharOut</em> to the output <em>buffer</em> of size <em>buffer_size</em>.</p>
<dl class="section return"><dt>Returns</dt><dd>original buffer containing the NULL terminated string or NULL</dd></dl>
<p>If there is not enough room in the buffer NULL is returned, and the content of the buffer is undefined. Any illegal sequences are replaced with the replacement character, see <a class="el" href="replacement_8hpp.html#a51c35d4bbf84bc443caab9afce302447">BOOST_NOWIDE_REPLACEMENT_CHARACTER</a> </p>
</div>
</div>
<a id="ab23f248c3a3a7f5adffb89e155e5a0fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab23f248c3a3a7f5adffb89e155e5a0fe">&#9670;&nbsp;</a></span>convert_string()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharOut , typename CharIn &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::basic_string&lt;CharOut&gt; boost::nowide::utf::convert_string </td>
<td>(</td>
<td class="paramtype">const CharIn *&#160;</td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const CharIn *&#160;</td>
<td class="paramname"><em>end</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert the UTF sequences in range [begin, end) from <em>CharIn</em> to <em>CharOut</em> and return it as a string</p>
<p>Any illegal sequences are replaced with the replacement character, see <a class="el" href="replacement_8hpp.html#a51c35d4bbf84bc443caab9afce302447">BOOST_NOWIDE_REPLACEMENT_CHARACTER</a> </p><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">CharOut</td><td>Output character type </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af88d6b53b99aec7da32bd67087e7fdcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af88d6b53b99aec7da32bd67087e7fdcd">&#9670;&nbsp;</a></span>strlen()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Char &gt; </div>
<table class="memname">
<tr>
<td class="memname">size_t boost::nowide::utf::strlen </td>
<td>(</td>
<td class="paramtype">const Char *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the length of the given string in code units. That is the number of elements of type Char until the first NULL character. Equivalent to <code>std::strlen(s)</code> but can handle wide-strings </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink