1
0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-01 01:02:14 +02:00
libnx/utf_8h_source.html
2025-05-08 06:59:12 +00:00

258 lines
31 KiB
HTML

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/runtime/util/utf.h Source File</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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_afd0453aeaaca58db0f3a26ffe540381.html">runtime</a></li><li class="navelem"><a class="el" href="dir_e5d059751f9468caba5da8d0091a02fd.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">utf.h</div></div>
</div><!--header-->
<div class="contents">
<a href="utf_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file utf.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief UTF conversion functions.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author mtheall</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;sys/types.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../../types.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/** Convert a UTF-8 sequence into a UTF-32 codepoint</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * @param[out] out Output codepoint</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * @param[in] in Input sequence</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * @returns number of input code units consumed</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="utf_8h.html#aace78933e35ab187df3ad6bd5a2a6383"> 19</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#aace78933e35ab187df3ad6bd5a2a6383">decode_utf8</a> (uint32_t *out, <span class="keyword">const</span> uint8_t *in);</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/** Convert a UTF-16 sequence into a UTF-32 codepoint</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> *</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @param[out] out Output codepoint</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @param[in] in Input sequence</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> *</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @returns number of input code units consumed</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> */</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="utf_8h.html#aab93c2be8e27403ee787ec299bf2bb0d"> 29</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#aab93c2be8e27403ee787ec299bf2bb0d">decode_utf16</a>(uint32_t *out, <span class="keyword">const</span> uint16_t *in);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"></span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">/** Convert a UTF-32 codepoint into a UTF-8 sequence</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> *</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @param[in] in Input codepoint</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> *</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> *</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @note \a out must be able to store 4 code units</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> */</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="utf_8h.html#af8127b9052fc5671da5589a486bd90c7"> 41</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#af8127b9052fc5671da5589a486bd90c7">encode_utf8</a> (uint8_t *out, uint32_t in);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">/** Convert a UTF-32 codepoint into a UTF-16 sequence</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> *</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @param[in] in Input codepoint</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> *</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @note \a out must be able to store 2 code units</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> */</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="utf_8h.html#a39a8de618e547cfb59367bc254a7a4d8"> 53</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#a39a8de618e547cfb59367bc254a7a4d8">encode_utf16</a>(uint16_t *out, uint32_t in);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"></span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">/** Convert a UTF-8 sequence into a UTF-16 sequence</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> *</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> * Fills the output buffer up to \a len code units.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * Returns the number of code units that the input would produce;</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * if it returns greater than \a len, the output has been</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * truncated.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> *</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> * @param[in] in Input sequence (null-terminated)</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> * @param[in] len Output length</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"> *</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> *</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @note \a out is not null-terminated</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> */</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="utf_8h.html#a42ed07f838ca52f4bba45d70582be053"> 71</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#a42ed07f838ca52f4bba45d70582be053">utf8_to_utf16</a>(uint16_t *out, <span class="keyword">const</span> uint8_t *in, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"></span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">/** Convert a UTF-8 sequence into a UTF-32 sequence</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> *</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * Fills the output buffer up to \a len code units.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * Returns the number of code units that the input would produce;</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * if it returns greater than \a len, the output has been</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> * truncated.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> *</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"> * @param[in] in Input sequence (null-terminated)</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> * @param[in] len Output length</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> *</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> * @note \a out is not null-terminated</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> */</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="utf_8h.html#ac9fa7e7747dd618e519e144f6a1aa182"> 89</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#ac9fa7e7747dd618e519e144f6a1aa182">utf8_to_utf32</a>(uint32_t *out, <span class="keyword">const</span> uint8_t *in, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"></span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment">/** Convert a UTF-16 sequence into a UTF-8 sequence</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"> *</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"> * Fills the output buffer up to \a len code units.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> * Returns the number of code units that the input would produce;</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> * if it returns greater than \a len, the output has been</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> * truncated.</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"> *</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"> * @param[in] in Input sequence (null-terminated)</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> * @param[in] len Output length</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> *</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment"> *</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"> * @note \a out is not null-terminated</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"> */</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="utf_8h.html#a853ad54c24e5ebcb6a6c2760cb753923"> 107</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#a853ad54c24e5ebcb6a6c2760cb753923">utf16_to_utf8</a>(uint8_t *out, <span class="keyword">const</span> uint16_t *in, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment"></span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment">/** Convert a UTF-16 sequence into a UTF-32 sequence</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment"> *</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment"> * Fills the output buffer up to \a len code units.</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"> * Returns the number of code units that the input would produce;</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment"> * if it returns greater than \a len, the output has been</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment"> * truncated.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment"> *</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="comment"> * @param[in] in Input sequence (null-terminated)</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment"> * @param[in] len Output length</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment"> *</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment"> *</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment"> * @note \a out is not null-terminated</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment"> */</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="utf_8h.html#ad8491ff70a66d8faa816c81ea409eb6c"> 125</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#ad8491ff70a66d8faa816c81ea409eb6c">utf16_to_utf32</a>(uint32_t *out, <span class="keyword">const</span> uint16_t *in, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment"></span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="comment">/** Convert a UTF-32 sequence into a UTF-8 sequence</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment"> *</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment"> * Fills the output buffer up to \a len code units.</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="comment"> * Returns the number of code units that the input would produce;</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="comment"> * if it returns greater than \a len, the output has been</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="comment"> * truncated.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="comment"> *</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="comment"> * @param[in] in Input sequence (null-terminated)</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><span class="comment"> * @param[in] len Output length</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="comment"> *</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="comment"> *</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="comment"> * @note \a out is not null-terminated</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="comment"> */</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="utf_8h.html#abaad7426e919e66bb5b6621d366d3148"> 143</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#abaad7426e919e66bb5b6621d366d3148">utf32_to_utf8</a>(uint8_t *out, <span class="keyword">const</span> uint32_t *in, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="comment"></span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="comment">/** Convert a UTF-32 sequence into a UTF-16 sequence</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="comment"> *</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="comment"> * @param[out] out Output sequence</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="comment"> * @param[in] in Input sequence (null-terminated)</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="comment"> * @param[in] len Output length</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="comment"> *</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><span class="comment"> * @returns number of output code units produced</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span><span class="comment"> * @returns -1 for error</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span><span class="comment"> *</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span><span class="comment"> * @note \a out is not null-terminated</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span><span class="comment"> */</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="utf_8h.html#aefceec54a91db2aef7bd916b18f0ae20"> 156</a></span>ssize_t <a class="code hl_function" href="utf_8h.html#aefceec54a91db2aef7bd916b18f0ae20">utf32_to_utf16</a>(uint16_t *out, <span class="keyword">const</span> uint32_t *in, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="ttc" id="autf_8h_html_a39a8de618e547cfb59367bc254a7a4d8"><div class="ttname"><a href="utf_8h.html#a39a8de618e547cfb59367bc254a7a4d8">encode_utf16</a></div><div class="ttdeci">ssize_t encode_utf16(uint16_t *out, uint32_t in)</div><div class="ttdoc">Convert a UTF-32 codepoint into a UTF-16 sequence.</div></div>
<div class="ttc" id="autf_8h_html_a42ed07f838ca52f4bba45d70582be053"><div class="ttname"><a href="utf_8h.html#a42ed07f838ca52f4bba45d70582be053">utf8_to_utf16</a></div><div class="ttdeci">ssize_t utf8_to_utf16(uint16_t *out, const uint8_t *in, size_t len)</div><div class="ttdoc">Convert a UTF-8 sequence into a UTF-16 sequence.</div></div>
<div class="ttc" id="autf_8h_html_a853ad54c24e5ebcb6a6c2760cb753923"><div class="ttname"><a href="utf_8h.html#a853ad54c24e5ebcb6a6c2760cb753923">utf16_to_utf8</a></div><div class="ttdeci">ssize_t utf16_to_utf8(uint8_t *out, const uint16_t *in, size_t len)</div><div class="ttdoc">Convert a UTF-16 sequence into a UTF-8 sequence.</div></div>
<div class="ttc" id="autf_8h_html_aab93c2be8e27403ee787ec299bf2bb0d"><div class="ttname"><a href="utf_8h.html#aab93c2be8e27403ee787ec299bf2bb0d">decode_utf16</a></div><div class="ttdeci">ssize_t decode_utf16(uint32_t *out, const uint16_t *in)</div><div class="ttdoc">Convert a UTF-16 sequence into a UTF-32 codepoint.</div></div>
<div class="ttc" id="autf_8h_html_aace78933e35ab187df3ad6bd5a2a6383"><div class="ttname"><a href="utf_8h.html#aace78933e35ab187df3ad6bd5a2a6383">decode_utf8</a></div><div class="ttdeci">ssize_t decode_utf8(uint32_t *out, const uint8_t *in)</div><div class="ttdoc">Convert a UTF-8 sequence into a UTF-32 codepoint.</div></div>
<div class="ttc" id="autf_8h_html_abaad7426e919e66bb5b6621d366d3148"><div class="ttname"><a href="utf_8h.html#abaad7426e919e66bb5b6621d366d3148">utf32_to_utf8</a></div><div class="ttdeci">ssize_t utf32_to_utf8(uint8_t *out, const uint32_t *in, size_t len)</div><div class="ttdoc">Convert a UTF-32 sequence into a UTF-8 sequence.</div></div>
<div class="ttc" id="autf_8h_html_ac9fa7e7747dd618e519e144f6a1aa182"><div class="ttname"><a href="utf_8h.html#ac9fa7e7747dd618e519e144f6a1aa182">utf8_to_utf32</a></div><div class="ttdeci">ssize_t utf8_to_utf32(uint32_t *out, const uint8_t *in, size_t len)</div><div class="ttdoc">Convert a UTF-8 sequence into a UTF-32 sequence.</div></div>
<div class="ttc" id="autf_8h_html_ad8491ff70a66d8faa816c81ea409eb6c"><div class="ttname"><a href="utf_8h.html#ad8491ff70a66d8faa816c81ea409eb6c">utf16_to_utf32</a></div><div class="ttdeci">ssize_t utf16_to_utf32(uint32_t *out, const uint16_t *in, size_t len)</div><div class="ttdoc">Convert a UTF-16 sequence into a UTF-32 sequence.</div></div>
<div class="ttc" id="autf_8h_html_aefceec54a91db2aef7bd916b18f0ae20"><div class="ttname"><a href="utf_8h.html#aefceec54a91db2aef7bd916b18f0ae20">utf32_to_utf16</a></div><div class="ttdeci">ssize_t utf32_to_utf16(uint16_t *out, const uint32_t *in, size_t len)</div><div class="ttdoc">Convert a UTF-32 sequence into a UTF-16 sequence.</div></div>
<div class="ttc" id="autf_8h_html_af8127b9052fc5671da5589a486bd90c7"><div class="ttname"><a href="utf_8h.html#af8127b9052fc5671da5589a486bd90c7">encode_utf8</a></div><div class="ttdeci">ssize_t encode_utf8(uint8_t *out, uint32_t in)</div><div class="ttdoc">Convert a UTF-32 codepoint into a UTF-8 sequence.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>