cyclone/c-api/group__prim__utf8.html
2021-04-06 20:02:18 -07:00

112 lines
8.3 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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cyclone Scheme: UTF-8</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="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Cyclone Scheme
&#160;<span id="projectnumber">0.28.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">UTF-8</div> </div>
</div><!--header-->
<div class="contents">
<p>Unicode processing using UTF-8.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga03d50d398fe997bc0958497ae5e220b6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__utf8_ga03d50d398fe997bc0958497ae5e220b6.html#ga03d50d398fe997bc0958497ae5e220b6">CYC_UTF8_ACCEPT</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:ga03d50d398fe997bc0958497ae5e220b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Successful state. <a href="group__prim__utf8_ga03d50d398fe997bc0958497ae5e220b6.html#ga03d50d398fe997bc0958497ae5e220b6">More...</a><br /></td></tr>
<tr class="separator:ga03d50d398fe997bc0958497ae5e220b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga004f7f3c7f21fdd61cfed88bdc1c2f20"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__utf8_ga004f7f3c7f21fdd61cfed88bdc1c2f20.html#ga004f7f3c7f21fdd61cfed88bdc1c2f20">Cyc_utf8_encode_char</a>(dest, dest_size, char_value)&#160;&#160;&#160;<a class="el" href="group__prim__utf8_gaca8690c116e9e5b16dea0bb8ac52edb3.html#gaca8690c116e9e5b16dea0bb8ac52edb3">Cyc_utf8_encode</a>(dest, dest_size, &amp;char_value, 1)</td></tr>
<tr class="separator:ga004f7f3c7f21fdd61cfed88bdc1c2f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae36b2d3bf5e2f989159fd3e6606a242a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__utf8_gae36b2d3bf5e2f989159fd3e6606a242a.html#gae36b2d3bf5e2f989159fd3e6606a242a">CYC_UTF8_REJECT</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:gae36b2d3bf5e2f989159fd3e6606a242a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invalid state. <a href="group__prim__utf8_gae36b2d3bf5e2f989159fd3e6606a242a.html#gae36b2d3bf5e2f989159fd3e6606a242a">More...</a><br /></td></tr>
<tr class="separator:gae36b2d3bf5e2f989159fd3e6606a242a"><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:ga9158b37fabe72056d8e2dac07dc4e039"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__utf8_ga9158b37fabe72056d8e2dac07dc4e039.html#ga9158b37fabe72056d8e2dac07dc4e039">Cyc_utf8_count_code_points</a> (uint8_t *s)</td></tr>
<tr class="memdesc:ga9158b37fabe72056d8e2dac07dc4e039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Count the number of code points in a string. Based on example code from Bjoern Hoehrmann. <a href="group__prim__utf8_ga9158b37fabe72056d8e2dac07dc4e039.html#ga9158b37fabe72056d8e2dac07dc4e039">More...</a><br /></td></tr>
<tr class="separator:ga9158b37fabe72056d8e2dac07dc4e039"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca8690c116e9e5b16dea0bb8ac52edb3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__utf8_gaca8690c116e9e5b16dea0bb8ac52edb3.html#gaca8690c116e9e5b16dea0bb8ac52edb3">Cyc_utf8_encode</a> (char *dest, int sz, uint32_t *src, int srcsz)</td></tr>
<tr class="separator:gaca8690c116e9e5b16dea0bb8ac52edb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaddbaec1bb68f1e4198401d0c27308bfa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__utf8_gaddbaec1bb68f1e4198401d0c27308bfa.html#gaddbaec1bb68f1e4198401d0c27308bfa">Cyc_utf8_validate</a> (char *str, size_t len)</td></tr>
<tr class="memdesc:gaddbaec1bb68f1e4198401d0c27308bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simplified version of Cyc_utf8_validate_stream that must always be called with a complete string buffer. <a href="group__prim__utf8_gaddbaec1bb68f1e4198401d0c27308bfa.html#gaddbaec1bb68f1e4198401d0c27308bfa">More...</a><br /></td></tr>
<tr class="separator:gaddbaec1bb68f1e4198401d0c27308bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga72f9c931a78dc754d545c044a05bef2f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__prim__utf8_ga72f9c931a78dc754d545c044a05bef2f.html#ga72f9c931a78dc754d545c044a05bef2f">Cyc_utf8_validate_stream</a> (uint32_t *state, char *str, size_t len)</td></tr>
<tr class="memdesc:ga72f9c931a78dc754d545c044a05bef2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use this when validating from a stream, as it may be that the stream stopped in the middle of a codepoint, hence state passed in as an arg, so it can be tested in a loop and also after the loop has finished. <a href="group__prim__utf8_ga72f9c931a78dc754d545c044a05bef2f.html#ga72f9c931a78dc754d545c044a05bef2f">More...</a><br /></td></tr>
<tr class="separator:ga72f9c931a78dc754d545c044a05bef2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Unicode processing using UTF-8. </p>
</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.17
</small></address>
</body>
</html>