stdex/classstdex_1_1html_1_1token.html

238 lines
14 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::html::token Class 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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');
$(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">
<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"><b>stdex</b></li><li class="navelem"><b>html</b></li><li class="navelem"><a class="el" href="classstdex_1_1html_1_1token.html">token</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classstdex_1_1html_1_1token-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::html::token Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>HTML token base class.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="html_8hpp_source.html">stdex/html.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stdex::html::token:</div>
<div class="dyncontent">
<div class="center">
<img src="classstdex_1_1html_1_1token.png" usemap="#stdex::html::token_map" alt=""/>
<map id="stdex::html::token_map" name="stdex::html::token_map">
<area href="classstdex_1_1html_1_1text__token.html" alt="stdex::html::text_token&lt; T, std::char_traits&lt; T &gt;, std::allocator&lt; T &gt; &gt;" shape="rect" coords="0,56,395,80"/>
<area href="classstdex_1_1html_1_1text__token.html" title="Token representing part of HTML text." alt="stdex::html::text_token&lt; T, TR, AX &gt;" shape="rect" coords="405,56,800,80"/>
<area href="classstdex_1_1html_1_1url__token.html" title="HTTP token representing an URL." alt="stdex::html::url_token&lt; T, TR, AX &gt;" shape="rect" coords="810,56,1205,80"/>
<area href="classstdex_1_1html_1_1starting__token.html" title="Token representing start HTML tag." alt="stdex::html::starting_token&lt; T, TR, AX &gt;" shape="rect" coords="405,112,800,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af5ccf4221ba4739d91daffced7683e9e" id="r_af5ccf4221ba4739d91daffced7683e9e"><td class="memTemplParams" colspan="2">template&lt;class TR = std::char_traits&lt;char&gt;, class AX = std::allocator&lt;char&gt;&gt; </td></tr>
<tr class="memitem:af5ccf4221ba4739d91daffced7683e9e"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af5ccf4221ba4739d91daffced7683e9e">append_tag</a> (std::basic_string&lt; char, TR, AX &gt; &amp;str) const</td></tr>
<tr class="memdesc:af5ccf4221ba4739d91daffced7683e9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Appends token tag to the source code. <br /></td></tr>
<tr class="separator:af5ccf4221ba4739d91daffced7683e9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd4f24cfd401b7f48f7ac2fd6c4bd5ff" id="r_abd4f24cfd401b7f48f7ac2fd6c4bd5ff"><td class="memTemplParams" colspan="2">template&lt;class TR = std::char_traits&lt;wchar_t&gt;, class AX = std::allocator&lt;wchar_t&gt;&gt; </td></tr>
<tr class="memitem:abd4f24cfd401b7f48f7ac2fd6c4bd5ff"><td class="memTemplItemLeft" align="right" valign="top">size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#abd4f24cfd401b7f48f7ac2fd6c4bd5ff">append_tag</a> (std::basic_string&lt; wchar_t, TR, AX &gt; &amp;str) const</td></tr>
<tr class="memdesc:abd4f24cfd401b7f48f7ac2fd6c4bd5ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Appends token tag to the source code. <br /></td></tr>
<tr class="separator:abd4f24cfd401b7f48f7ac2fd6c4bd5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a964dd9935df7bd4d4c8d449e52ba23a7" id="r_a964dd9935df7bd4d4c8d449e52ba23a7"><td class="memTemplParams" colspan="2"><a id="a964dd9935df7bd4d4c8d449e52ba23a7" name="a964dd9935df7bd4d4c8d449e52ba23a7"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a964dd9935df7bd4d4c8d449e52ba23a7"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classstdex_1_1html_1_1token.html">token</a> *&#160;</td><td class="memTemplItemRight" valign="bottom"><b>parse_tag</b> (const T *str, size_t &amp;offset)</td></tr>
<tr class="separator:a964dd9935df7bd4d4c8d449e52ba23a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acd884397cc90fb8673de7958896954dc" id="r_acd884397cc90fb8673de7958896954dc"><td class="memItemLeft" align="right" valign="top"><a id="acd884397cc90fb8673de7958896954dc" name="acd884397cc90fb8673de7958896954dc"></a>
token_t&#160;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr class="memdesc:acd884397cc90fb8673de7958896954dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Token type. <br /></td></tr>
<tr class="separator:acd884397cc90fb8673de7958896954dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20890ed953b05911dd66fc23a81fd362" id="r_a20890ed953b05911dd66fc23a81fd362"><td class="memItemLeft" align="right" valign="top"><a id="a20890ed953b05911dd66fc23a81fd362" name="a20890ed953b05911dd66fc23a81fd362"></a>
<a class="el" href="classstdex_1_1html_1_1sequence.html">sequence</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>sequence</b></td></tr>
<tr class="memdesc:a20890ed953b05911dd66fc23a81fd362"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the sequence this token represents or nullptr when it doesn't trivially represent one sequence. <br /></td></tr>
<tr class="separator:a20890ed953b05911dd66fc23a81fd362"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a44b08a117fe7c3f19982ec3c1edab" id="r_ab9a44b08a117fe7c3f19982ec3c1edab"><td class="memItemLeft" align="right" valign="top"><a id="ab9a44b08a117fe7c3f19982ec3c1edab" name="ab9a44b08a117fe7c3f19982ec3c1edab"></a>
uintptr_t&#160;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
<tr class="memdesc:ab9a44b08a117fe7c3f19982ec3c1edab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Any user-supplied data. <br /></td></tr>
<tr class="separator:ab9a44b08a117fe7c3f19982ec3c1edab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a62d5b304cd46c11895e69af8c269a203" id="r_a62d5b304cd46c11895e69af8c269a203"><td class="memItemLeft" align="right" valign="top"><a id="a62d5b304cd46c11895e69af8c269a203" name="a62d5b304cd46c11895e69af8c269a203"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>token</b> (token_t _type=token_t::root, <a class="el" href="classstdex_1_1html_1_1sequence.html">sequence</a> *_sequence=nullptr, uintptr_t _data=0)</td></tr>
<tr class="separator:a62d5b304cd46c11895e69af8c269a203"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a981ad229a3e9795881a66056bf60ee63" id="r_a981ad229a3e9795881a66056bf60ee63"><td class="memTemplParams" colspan="2"><a id="a981ad229a3e9795881a66056bf60ee63" name="a981ad229a3e9795881a66056bf60ee63"></a>
template&lt;class T , class TR , class AX &gt; </td></tr>
<tr class="memitem:a981ad229a3e9795881a66056bf60ee63"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>parser</b></td></tr>
<tr class="separator:a981ad229a3e9795881a66056bf60ee63"><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>HTML token base class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af5ccf4221ba4739d91daffced7683e9e" name="af5ccf4221ba4739d91daffced7683e9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5ccf4221ba4739d91daffced7683e9e">&#9670;&#160;</a></span>append_tag() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TR = std::char_traits&lt;char&gt;, class AX = std::allocator&lt;char&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t stdex::html::token::append_tag </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; char, TR, AX &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td> const</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 token tag to the source code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">str</td><td>Source code</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of code units appended </dd></dl>
</div>
</div>
<a id="abd4f24cfd401b7f48f7ac2fd6c4bd5ff" name="abd4f24cfd401b7f48f7ac2fd6c4bd5ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd4f24cfd401b7f48f7ac2fd6c4bd5ff">&#9670;&#160;</a></span>append_tag() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TR = std::char_traits&lt;wchar_t&gt;, class AX = std::allocator&lt;wchar_t&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t stdex::html::token::append_tag </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; wchar_t, TR, AX &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td> const</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 token tag to the source code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">str</td><td>Source code</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of code units appended </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="html_8hpp_source.html">html.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Feb 12 2024 12:04:02 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>