stdex/classstdex_1_1html_1_1document.html

206 lines
19 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::document&lt; T, TR, AX &gt; Class Template 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_1document.html">document</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classstdex_1_1html_1_1document-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::html::document&lt; T, TR, AX &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>HTML document.
<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>
<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:aecb7a14d12137d624dfe5378f27ab70c" id="r_aecb7a14d12137d624dfe5378f27ab70c"><td class="memItemLeft" align="right" valign="top"><a id="aecb7a14d12137d624dfe5378f27ab70c" name="aecb7a14d12137d624dfe5378f27ab70c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="memdesc:aecb7a14d12137d624dfe5378f27ab70c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empties document. <br /></td></tr>
<tr class="separator:aecb7a14d12137d624dfe5378f27ab70c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a273b8b833d039824d048517d80295f94" id="r_a273b8b833d039824d048517d80295f94"><td class="memItemLeft" align="right" valign="top"><a id="a273b8b833d039824d048517d80295f94" name="a273b8b833d039824d048517d80295f94"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>append</b> (_In_reads_or_z_opt_(num_chars) const T *<a class="el" href="#a20d48b4baf010dcdefaf2bca05ab6cfb">source</a>, size_t num_chars)</td></tr>
<tr class="memdesc:a273b8b833d039824d048517d80295f94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses HTML source code by chunks. <br /></td></tr>
<tr class="separator:a273b8b833d039824d048517d80295f94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa92c54c8d5244c427e26e7a8220cfc41" id="r_aa92c54c8d5244c427e26e7a8220cfc41"><td class="memItemLeft" align="right" valign="top"><a id="aa92c54c8d5244c427e26e7a8220cfc41" name="aa92c54c8d5244c427e26e7a8220cfc41"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>finalize</b> ()</td></tr>
<tr class="memdesc:aa92c54c8d5244c427e26e7a8220cfc41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalizes document when no more appending is planned. <br /></td></tr>
<tr class="separator:aa92c54c8d5244c427e26e7a8220cfc41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2fe171fbcaa696fd3eecd633491f4af" id="r_ae2fe171fbcaa696fd3eecd633491f4af"><td class="memItemLeft" align="right" valign="top"><a id="ae2fe171fbcaa696fd3eecd633491f4af" name="ae2fe171fbcaa696fd3eecd633491f4af"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>assign</b> (_In_reads_or_z_opt_(num_chars) const T *<a class="el" href="#a20d48b4baf010dcdefaf2bca05ab6cfb">source</a>, size_t num_chars)</td></tr>
<tr class="memdesc:ae2fe171fbcaa696fd3eecd633491f4af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses HTML document source code. <br /></td></tr>
<tr class="separator:ae2fe171fbcaa696fd3eecd633491f4af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20d48b4baf010dcdefaf2bca05ab6cfb" id="r_a20d48b4baf010dcdefaf2bca05ab6cfb"><td class="memItemLeft" align="right" valign="top"><a id="a20d48b4baf010dcdefaf2bca05ab6cfb" name="a20d48b4baf010dcdefaf2bca05ab6cfb"></a>
const std::basic_string&lt; T, TR, AX &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>source</b> () const</td></tr>
<tr class="memdesc:a20d48b4baf010dcdefaf2bca05ab6cfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns document HTML source code. <br /></td></tr>
<tr class="separator:a20d48b4baf010dcdefaf2bca05ab6cfb"><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:a854a42ac5d1b44a663992571ce016a5a" id="r_a854a42ac5d1b44a663992571ce016a5a"><td class="memItemLeft" align="right" valign="top"><a id="a854a42ac5d1b44a663992571ce016a5a" name="a854a42ac5d1b44a663992571ce016a5a"></a>
<a class="el" href="classstdex_1_1html_1_1element__start.html">element_start</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>active_element</b> () const</td></tr>
<tr class="memdesc:a854a42ac5d1b44a663992571ce016a5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns starting tag of currently active element or nullptr if no element is known to be started. <br /></td></tr>
<tr class="separator:a854a42ac5d1b44a663992571ce016a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad148afdd15332522ce290046e5acb5f5" id="r_ad148afdd15332522ce290046e5acb5f5"><td class="memItemLeft" align="right" valign="top"><a id="ad148afdd15332522ce290046e5acb5f5" name="ad148afdd15332522ce290046e5acb5f5"></a>
std::basic_string&lt; T, TR, AX &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>replace_entities</b> (_In_reads_or_z_opt_(num_chars) const T *input, size_t num_chars) const</td></tr>
<tr class="memdesc:ad148afdd15332522ce290046e5acb5f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replaces entities with their content. <br /></td></tr>
<tr class="separator:ad148afdd15332522ce290046e5acb5f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af3716224f1500d834b7e3ed6f21206ef" id="r_af3716224f1500d834b7e3ed6f21206ef"><td class="memItemLeft" align="right" valign="top"><a id="af3716224f1500d834b7e3ed6f21206ef" name="af3716224f1500d834b7e3ed6f21206ef"></a>
std::basic_string&lt; T, TR, AX &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_source</b></td></tr>
<tr class="memdesc:af3716224f1500d834b7e3ed6f21206ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Document HTML source code. <br /></td></tr>
<tr class="separator:af3716224f1500d834b7e3ed6f21206ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9abf2aafc5c688764c71efbe04ba261b" id="r_a9abf2aafc5c688764c71efbe04ba261b"><td class="memItemLeft" align="right" valign="top"><a id="a9abf2aafc5c688764c71efbe04ba261b" name="a9abf2aafc5c688764c71efbe04ba261b"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_num_parsed</b></td></tr>
<tr class="memdesc:a9abf2aafc5c688764c71efbe04ba261b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of characters already parsed. <br /></td></tr>
<tr class="separator:a9abf2aafc5c688764c71efbe04ba261b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c4e69123b0ae5c24d306ba3e2d8ce00" id="r_a7c4e69123b0ae5c24d306ba3e2d8ce00"><td class="memItemLeft" align="right" valign="top"><a id="a7c4e69123b0ae5c24d306ba3e2d8ce00" name="a7c4e69123b0ae5c24d306ba3e2d8ce00"></a>
stdex::charset_id&#160;</td><td class="memItemRight" valign="bottom"><b>m_charset</b></td></tr>
<tr class="memdesc:a7c4e69123b0ae5c24d306ba3e2d8ce00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Document charset. <br /></td></tr>
<tr class="separator:a7c4e69123b0ae5c24d306ba3e2d8ce00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e591a51beb766e0212843382507a3de" id="r_a3e591a51beb766e0212843382507a3de"><td class="memItemLeft" align="right" valign="top"><a id="a3e591a51beb766e0212843382507a3de" name="a3e591a51beb766e0212843382507a3de"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_num_valid_conditions</b></td></tr>
<tr class="memdesc:a3e591a51beb766e0212843382507a3de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of started valid conditions. <br /></td></tr>
<tr class="separator:a3e591a51beb766e0212843382507a3de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d75509731526b70e83b816903e484b8" id="r_a5d75509731526b70e83b816903e484b8"><td class="memItemLeft" align="right" valign="top"><a id="a5d75509731526b70e83b816903e484b8" name="a5d75509731526b70e83b816903e484b8"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_num_invalid_conditions</b></td></tr>
<tr class="memdesc:a5d75509731526b70e83b816903e484b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of started invalid conditions. <br /></td></tr>
<tr class="separator:a5d75509731526b70e83b816903e484b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e41b66730d8e0c7a715b5324c0a190b" id="r_a5e41b66730d8e0c7a715b5324c0a190b"><td class="memItemLeft" align="right" valign="top"><a id="a5e41b66730d8e0c7a715b5324c0a190b" name="a5e41b66730d8e0c7a715b5324c0a190b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_cdata</b></td></tr>
<tr class="memdesc:a5e41b66730d8e0c7a715b5324c0a190b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inside of CDATA? <br /></td></tr>
<tr class="separator:a5e41b66730d8e0c7a715b5324c0a190b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18af3f7eda58c94cc21233de66266854" id="r_a18af3f7eda58c94cc21233de66266854"><td class="memItemLeft" align="right" valign="top"><a id="a18af3f7eda58c94cc21233de66266854" name="a18af3f7eda58c94cc21233de66266854"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_rcdata</b></td></tr>
<tr class="memdesc:a18af3f7eda58c94cc21233de66266854"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inside of RCDATA? <br /></td></tr>
<tr class="separator:a18af3f7eda58c94cc21233de66266854"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27a95751e2df85cd09b5670da0a08751" id="r_a27a95751e2df85cd09b5670da0a08751"><td class="memItemLeft" align="right" valign="top"><a id="a27a95751e2df85cd09b5670da0a08751" name="a27a95751e2df85cd09b5670da0a08751"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__html__declaration__condition__start.html">stdex::parser::basic_html_declaration_condition_start</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_condition_start</b></td></tr>
<tr class="separator:a27a95751e2df85cd09b5670da0a08751"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13a53886f2645b9d94f3784c9b664d6d" id="r_a13a53886f2645b9d94f3784c9b664d6d"><td class="memItemLeft" align="right" valign="top"><a id="a13a53886f2645b9d94f3784c9b664d6d" name="a13a53886f2645b9d94f3784c9b664d6d"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__html__declaration__condition__end.html">stdex::parser::basic_html_declaration_condition_end</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_condition_end</b></td></tr>
<tr class="separator:a13a53886f2645b9d94f3784c9b664d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a095c42d98d750f64d6acade626b6cc7e" id="r_a095c42d98d750f64d6acade626b6cc7e"><td class="memItemLeft" align="right" valign="top"><a id="a095c42d98d750f64d6acade626b6cc7e" name="a095c42d98d750f64d6acade626b6cc7e"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__any__cu.html">stdex::parser::basic_any_cu</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_any_char</b></td></tr>
<tr class="separator:a095c42d98d750f64d6acade626b6cc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6ff9a07c77a0baff77bd18f51c5c9bc" id="r_ae6ff9a07c77a0baff77bd18f51c5c9bc"><td class="memItemLeft" align="right" valign="top"><a id="ae6ff9a07c77a0baff77bd18f51c5c9bc" name="ae6ff9a07c77a0baff77bd18f51c5c9bc"></a>
std::vector&lt; std::unique_ptr&lt; <a class="el" href="structstdex_1_1html_1_1entity.html">entity</a>&lt; T, TR, AX &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_entities</b></td></tr>
<tr class="memdesc:ae6ff9a07c77a0baff77bd18f51c5c9bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of entities. <br /></td></tr>
<tr class="separator:ae6ff9a07c77a0baff77bd18f51c5c9bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e39c9768993ca708cf5d97bd0715065" id="r_a9e39c9768993ca708cf5d97bd0715065"><td class="memItemLeft" align="right" valign="top"><a id="a9e39c9768993ca708cf5d97bd0715065" name="a9e39c9768993ca708cf5d97bd0715065"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__html__tag.html">stdex::parser::basic_html_tag</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_tag</b></td></tr>
<tr class="separator:a9e39c9768993ca708cf5d97bd0715065"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8228c7a43502a0918d0e94569403be2f" id="r_a8228c7a43502a0918d0e94569403be2f"><td class="memItemLeft" align="right" valign="top"><a id="a8228c7a43502a0918d0e94569403be2f" name="a8228c7a43502a0918d0e94569403be2f"></a>
sequence_store&#160;</td><td class="memItemRight" valign="bottom"><b>m_sequences</b></td></tr>
<tr class="memdesc:a8228c7a43502a0918d0e94569403be2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store of sequences. <br /></td></tr>
<tr class="separator:a8228c7a43502a0918d0e94569403be2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6af078df6d8322da283445c12275ad9" id="r_aa6af078df6d8322da283445c12275ad9"><td class="memItemLeft" align="right" valign="top"><a id="aa6af078df6d8322da283445c12275ad9" name="aa6af078df6d8322da283445c12275ad9"></a>
std::vector&lt; <a class="el" href="classstdex_1_1html_1_1element__start.html">element_start</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_element_stack</b></td></tr>
<tr class="memdesc:aa6af078df6d8322da283445c12275ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">LIFO stack of started elements. <br /></td></tr>
<tr class="separator:aa6af078df6d8322da283445c12275ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4e4403bba2f51ee61d0448c8a0dbd03" id="r_ae4e4403bba2f51ee61d0448c8a0dbd03"><td class="memItemLeft" align="right" valign="top"><a id="ae4e4403bba2f51ee61d0448c8a0dbd03" name="ae4e4403bba2f51ee61d0448c8a0dbd03"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_special_element</b></td></tr>
<tr class="memdesc:ae4e4403bba2f51ee61d0448c8a0dbd03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inside of a special element (&lt;SCRIPT&gt;, &lt;STYLE&gt;, ...)? <br /></td></tr>
<tr class="separator:ae4e4403bba2f51ee61d0448c8a0dbd03"><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:abe4cd4cb5c10638d494059093f738f62" id="r_abe4cd4cb5c10638d494059093f738f62"><td class="memItemLeft" align="right" valign="top"><a id="abe4cd4cb5c10638d494059093f738f62" name="abe4cd4cb5c10638d494059093f738f62"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>parser&lt; T, TR, AX &gt;</b></td></tr>
<tr class="separator:abe4cd4cb5c10638d494059093f738f62"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T, class TR = std::char_traits&lt;T&gt;, class AX = std::allocator&lt;T&gt;&gt;<br />
class stdex::html::document&lt; T, TR, AX &gt;</div><p>HTML document. </p>
</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 Fri Mar 15 2024 18:56:14 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>