| <!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>libguac: guacamole/unicode.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">libguac |
|  <span id="projectnumber">1.1.0</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_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</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">unicode.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Provides functions for manipulating Unicode strings. |
| <a href="#details">More...</a></p> |
| |
| <p><a href="unicode_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:a423523f1531719c6ab4fafdb02008623"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8h.html#a423523f1531719c6ab4fafdb02008623">guac_utf8_charsize</a> (unsigned char c)</td></tr> |
| <tr class="memdesc:a423523f1531719c6ab4fafdb02008623"><td class="mdescLeft"> </td><td class="mdescRight">Given the initial byte of a single UTF-8 character, returns the overall byte size of the entire character. <a href="#a423523f1531719c6ab4fafdb02008623">More...</a><br /></td></tr> |
| <tr class="separator:a423523f1531719c6ab4fafdb02008623"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a778e48706f4ee85f229711fe4cb1343b"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8h.html#a778e48706f4ee85f229711fe4cb1343b">guac_utf8_strlen</a> (const char *str)</td></tr> |
| <tr class="memdesc:a778e48706f4ee85f229711fe4cb1343b"><td class="mdescLeft"> </td><td class="mdescRight">Given a UTF-8-encoded string, returns the length of the string in characters (not bytes). <a href="#a778e48706f4ee85f229711fe4cb1343b">More...</a><br /></td></tr> |
| <tr class="separator:a778e48706f4ee85f229711fe4cb1343b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa49339a4af9952b0b56402825059a2ce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8h.html#aa49339a4af9952b0b56402825059a2ce">guac_utf8_write</a> (int codepoint, char *utf8, int length)</td></tr> |
| <tr class="memdesc:aa49339a4af9952b0b56402825059a2ce"><td class="mdescLeft"> </td><td class="mdescRight">Given destination buffer and its length, writes the given codepoint as UTF-8 to the buffer, returning the number of bytes written. <a href="#aa49339a4af9952b0b56402825059a2ce">More...</a><br /></td></tr> |
| <tr class="separator:aa49339a4af9952b0b56402825059a2ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1690b7b5e4fbcfc556fa4ee7129a25af"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8h.html#a1690b7b5e4fbcfc556fa4ee7129a25af">guac_utf8_read</a> (const char *utf8, int length, int *codepoint)</td></tr> |
| <tr class="memdesc:a1690b7b5e4fbcfc556fa4ee7129a25af"><td class="mdescLeft"> </td><td class="mdescRight">Given a buffer containing UTF-8 characters, reads the first codepoint in the buffer, returning the length of the codepoint in bytes. <a href="#a1690b7b5e4fbcfc556fa4ee7129a25af">More...</a><br /></td></tr> |
| <tr class="separator:a1690b7b5e4fbcfc556fa4ee7129a25af"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Provides functions for manipulating Unicode strings. </p> |
| </div><h2 class="groupheader">Function Documentation</h2> |
| <a id="a423523f1531719c6ab4fafdb02008623"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a423523f1531719c6ab4fafdb02008623">◆ </a></span>guac_utf8_charsize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t guac_utf8_charsize </td> |
| <td>(</td> |
| <td class="paramtype">unsigned char </td> |
| <td class="paramname"><em>c</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Given the initial byte of a single UTF-8 character, returns the overall byte size of the entire character. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">c</td><td>The initial byte of the character to check. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The number of bytes in the given character overall. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a1690b7b5e4fbcfc556fa4ee7129a25af"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1690b7b5e4fbcfc556fa4ee7129a25af">◆ </a></span>guac_utf8_read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_utf8_read </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>utf8</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int * </td> |
| <td class="paramname"><em>codepoint</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Given a buffer containing UTF-8 characters, reads the first codepoint in the buffer, returning the length of the codepoint in bytes. </p> |
| <p>If no codepoint could be read, zero is returned.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">utf8</td><td>A buffer containing UTF-8 characters. </td></tr> |
| <tr><td class="paramname">length</td><td>The length of the buffer, in bytes. </td></tr> |
| <tr><td class="paramname">codepoint</td><td>A pointer to an integer which will contain the codepoint read, if any. If no character can be read, the integer will be left untouched. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The number of bytes read, which may be zero if there is not enough space in the buffer to read a character. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a778e48706f4ee85f229711fe4cb1343b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a778e48706f4ee85f229711fe4cb1343b">◆ </a></span>guac_utf8_strlen()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t guac_utf8_strlen </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>str</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Given a UTF-8-encoded string, returns the length of the string in characters (not bytes). </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">str</td><td>The UTF-8 string to calculate the length of. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The length in characters of the given UTF-8 string. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa49339a4af9952b0b56402825059a2ce"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa49339a4af9952b0b56402825059a2ce">◆ </a></span>guac_utf8_write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int guac_utf8_write </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>codepoint</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char * </td> |
| <td class="paramname"><em>utf8</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Given destination buffer and its length, writes the given codepoint as UTF-8 to the buffer, returning the number of bytes written. </p> |
| <p>If there is not enough space in the buffer to write the character, no bytes are written at all.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">codepoint</td><td>The Unicode codepoint to write to the buffer. </td></tr> |
| <tr><td class="paramname">utf8</td><td>The buffer to write to. </td></tr> |
| <tr><td class="paramname">length</td><td>The length of the buffer, in bytes. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The number of bytes written, which may be zero if there is not enough space in the buffer to write the UTF-8 character. </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> |
