stdex/classstdex_1_1html_1_1document.html

204 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::html::document&lt; _Elem, _Traits, _Alloc &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>
<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.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>
<!-- 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; _Elem, _Traits, _Alloc &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>HTML document.
<a href="classstdex_1_1html_1_1document.html#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:adb0c50a68ad6ef3cbc3a78e3361932b7" id="r_adb0c50a68ad6ef3cbc3a78e3361932b7"><td class="memItemLeft" align="right" valign="top"><a id="adb0c50a68ad6ef3cbc3a78e3361932b7" name="adb0c50a68ad6ef3cbc3a78e3361932b7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="memdesc:adb0c50a68ad6ef3cbc3a78e3361932b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empties document. <br /></td></tr>
<tr class="separator:adb0c50a68ad6ef3cbc3a78e3361932b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79585dbbf1916073dfa9ce8343f3137b" id="r_a79585dbbf1916073dfa9ce8343f3137b"><td class="memItemLeft" align="right" valign="top"><a id="a79585dbbf1916073dfa9ce8343f3137b" name="a79585dbbf1916073dfa9ce8343f3137b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>append</b> (_In_reads_or_z_opt_(num_chars) const _Elem *<a class="el" href="classstdex_1_1html_1_1document.html#adf28cd75b7cfcf892a77bc25d921f673">source</a>, size_t num_chars=SIZE_MAX)</td></tr>
<tr class="memdesc:a79585dbbf1916073dfa9ce8343f3137b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses HTML source code by chunks. <br /></td></tr>
<tr class="separator:a79585dbbf1916073dfa9ce8343f3137b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25a46afab4d3c523ef3734f6b7584098" id="r_a25a46afab4d3c523ef3734f6b7584098"><td class="memItemLeft" align="right" valign="top"><a id="a25a46afab4d3c523ef3734f6b7584098" name="a25a46afab4d3c523ef3734f6b7584098"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>finalize</b> ()</td></tr>
<tr class="memdesc:a25a46afab4d3c523ef3734f6b7584098"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalizes document when no more appending is planned. <br /></td></tr>
<tr class="separator:a25a46afab4d3c523ef3734f6b7584098"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85458aea6b21a1154c20e5d6183aa285" id="r_a85458aea6b21a1154c20e5d6183aa285"><td class="memItemLeft" align="right" valign="top"><a id="a85458aea6b21a1154c20e5d6183aa285" name="a85458aea6b21a1154c20e5d6183aa285"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>assign</b> (_In_reads_or_z_opt_(num_chars) const _Elem *<a class="el" href="classstdex_1_1html_1_1document.html#adf28cd75b7cfcf892a77bc25d921f673">source</a>, size_t num_chars=SIZE_MAX)</td></tr>
<tr class="memdesc:a85458aea6b21a1154c20e5d6183aa285"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses HTML document source code. <br /></td></tr>
<tr class="separator:a85458aea6b21a1154c20e5d6183aa285"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf28cd75b7cfcf892a77bc25d921f673" id="r_adf28cd75b7cfcf892a77bc25d921f673"><td class="memItemLeft" align="right" valign="top"><a id="adf28cd75b7cfcf892a77bc25d921f673" name="adf28cd75b7cfcf892a77bc25d921f673"></a>
const std::basic_string&lt; _Elem, _Traits, _Alloc &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>source</b> () const</td></tr>
<tr class="memdesc:adf28cd75b7cfcf892a77bc25d921f673"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns document HTML source code. <br /></td></tr>
<tr class="separator:adf28cd75b7cfcf892a77bc25d921f673"><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:ac8d974ade6e33245a9354b0fa0c2a762" id="r_ac8d974ade6e33245a9354b0fa0c2a762"><td class="memItemLeft" align="right" valign="top"><a id="ac8d974ade6e33245a9354b0fa0c2a762" name="ac8d974ade6e33245a9354b0fa0c2a762"></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:ac8d974ade6e33245a9354b0fa0c2a762"><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:ac8d974ade6e33245a9354b0fa0c2a762"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad51755eb57de670729adf07f32d5225d" id="r_ad51755eb57de670729adf07f32d5225d"><td class="memItemLeft" align="right" valign="top"><a id="ad51755eb57de670729adf07f32d5225d" name="ad51755eb57de670729adf07f32d5225d"></a>
std::basic_string&lt; _Elem, _Traits, _Alloc &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>replace_entities</b> (_In_reads_or_z_opt_(num_chars) const _Elem *input, size_t num_chars) const</td></tr>
<tr class="memdesc:ad51755eb57de670729adf07f32d5225d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replaces entities with their content. <br /></td></tr>
<tr class="separator:ad51755eb57de670729adf07f32d5225d"><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:aa026d9c57191dac5169a987963bb7d08" id="r_aa026d9c57191dac5169a987963bb7d08"><td class="memItemLeft" align="right" valign="top"><a id="aa026d9c57191dac5169a987963bb7d08" name="aa026d9c57191dac5169a987963bb7d08"></a>
std::basic_string&lt; _Elem, _Traits, _Alloc &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_source</b></td></tr>
<tr class="memdesc:aa026d9c57191dac5169a987963bb7d08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Document HTML source code. <br /></td></tr>
<tr class="separator:aa026d9c57191dac5169a987963bb7d08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af814056135de920c0f4acdcf8c928e72" id="r_af814056135de920c0f4acdcf8c928e72"><td class="memItemLeft" align="right" valign="top"><a id="af814056135de920c0f4acdcf8c928e72" name="af814056135de920c0f4acdcf8c928e72"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_num_parsed</b></td></tr>
<tr class="memdesc:af814056135de920c0f4acdcf8c928e72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of characters already parsed. <br /></td></tr>
<tr class="separator:af814056135de920c0f4acdcf8c928e72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f29e08ebaf36b923ddf092384185ac1" id="r_a2f29e08ebaf36b923ddf092384185ac1"><td class="memItemLeft" align="right" valign="top"><a id="a2f29e08ebaf36b923ddf092384185ac1" name="a2f29e08ebaf36b923ddf092384185ac1"></a>
stdex::charset_id&#160;</td><td class="memItemRight" valign="bottom"><b>m_charset</b></td></tr>
<tr class="memdesc:a2f29e08ebaf36b923ddf092384185ac1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Document charset. <br /></td></tr>
<tr class="separator:a2f29e08ebaf36b923ddf092384185ac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addfef8cebec2ac619d1174084df730bd" id="r_addfef8cebec2ac619d1174084df730bd"><td class="memItemLeft" align="right" valign="top"><a id="addfef8cebec2ac619d1174084df730bd" name="addfef8cebec2ac619d1174084df730bd"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_num_valid_conditions</b></td></tr>
<tr class="memdesc:addfef8cebec2ac619d1174084df730bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of started valid conditions. <br /></td></tr>
<tr class="separator:addfef8cebec2ac619d1174084df730bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a821db1267c62fbea66ea5bee6ef595cb" id="r_a821db1267c62fbea66ea5bee6ef595cb"><td class="memItemLeft" align="right" valign="top"><a id="a821db1267c62fbea66ea5bee6ef595cb" name="a821db1267c62fbea66ea5bee6ef595cb"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_num_invalid_conditions</b></td></tr>
<tr class="memdesc:a821db1267c62fbea66ea5bee6ef595cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of started invalid conditions. <br /></td></tr>
<tr class="separator:a821db1267c62fbea66ea5bee6ef595cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa1e63e920558cb8058e713a7121057c" id="r_afa1e63e920558cb8058e713a7121057c"><td class="memItemLeft" align="right" valign="top"><a id="afa1e63e920558cb8058e713a7121057c" name="afa1e63e920558cb8058e713a7121057c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_cdata</b></td></tr>
<tr class="memdesc:afa1e63e920558cb8058e713a7121057c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inside of CDATA? <br /></td></tr>
<tr class="separator:afa1e63e920558cb8058e713a7121057c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50e945a21d566661b8e139b26ccb52b8" id="r_a50e945a21d566661b8e139b26ccb52b8"><td class="memItemLeft" align="right" valign="top"><a id="a50e945a21d566661b8e139b26ccb52b8" name="a50e945a21d566661b8e139b26ccb52b8"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_rcdata</b></td></tr>
<tr class="memdesc:a50e945a21d566661b8e139b26ccb52b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inside of RCDATA? <br /></td></tr>
<tr class="separator:a50e945a21d566661b8e139b26ccb52b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ef3ed76e9a03264a2e6db2e656bf42" id="r_a88ef3ed76e9a03264a2e6db2e656bf42"><td class="memItemLeft" align="right" valign="top"><a id="a88ef3ed76e9a03264a2e6db2e656bf42" name="a88ef3ed76e9a03264a2e6db2e656bf42"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__html__declaration__condition__start.html">stdex::parser::basic_html_declaration_condition_start</a>&lt; _Elem &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_condition_start</b></td></tr>
<tr class="separator:a88ef3ed76e9a03264a2e6db2e656bf42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea8d8c51deb894e16e6a144faa19ec04" id="r_aea8d8c51deb894e16e6a144faa19ec04"><td class="memItemLeft" align="right" valign="top"><a id="aea8d8c51deb894e16e6a144faa19ec04" name="aea8d8c51deb894e16e6a144faa19ec04"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__html__declaration__condition__end.html">stdex::parser::basic_html_declaration_condition_end</a>&lt; _Elem &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_condition_end</b></td></tr>
<tr class="separator:aea8d8c51deb894e16e6a144faa19ec04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8741d39baedad965df73fd5238a7199" id="r_aa8741d39baedad965df73fd5238a7199"><td class="memItemLeft" align="right" valign="top"><a id="aa8741d39baedad965df73fd5238a7199" name="aa8741d39baedad965df73fd5238a7199"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__any__cu.html">stdex::parser::basic_any_cu</a>&lt; _Elem &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_any_char</b></td></tr>
<tr class="separator:aa8741d39baedad965df73fd5238a7199"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e48388317e6c0a5b5119c4ce6a88dcb" id="r_a8e48388317e6c0a5b5119c4ce6a88dcb"><td class="memItemLeft" align="right" valign="top"><a id="a8e48388317e6c0a5b5119c4ce6a88dcb" name="a8e48388317e6c0a5b5119c4ce6a88dcb"></a>
std::vector&lt; std::unique_ptr&lt; <a class="el" href="structstdex_1_1html_1_1entity.html">entity</a>&lt; _Elem, _Traits, _Alloc &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_entities</b></td></tr>
<tr class="memdesc:a8e48388317e6c0a5b5119c4ce6a88dcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of entities. <br /></td></tr>
<tr class="separator:a8e48388317e6c0a5b5119c4ce6a88dcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89f5ae28c55433dfd981be7d52424ed8" id="r_a89f5ae28c55433dfd981be7d52424ed8"><td class="memItemLeft" align="right" valign="top"><a id="a89f5ae28c55433dfd981be7d52424ed8" name="a89f5ae28c55433dfd981be7d52424ed8"></a>
<a class="el" href="classstdex_1_1parser_1_1basic__html__tag.html">stdex::parser::basic_html_tag</a>&lt; _Elem &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_tag</b></td></tr>
<tr class="separator:a89f5ae28c55433dfd981be7d52424ed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7de5f3c6d8292e7d696f6817f4925f6d" id="r_a7de5f3c6d8292e7d696f6817f4925f6d"><td class="memItemLeft" align="right" valign="top"><a id="a7de5f3c6d8292e7d696f6817f4925f6d" name="a7de5f3c6d8292e7d696f6817f4925f6d"></a>
sequence_store&#160;</td><td class="memItemRight" valign="bottom"><b>m_sequences</b></td></tr>
<tr class="memdesc:a7de5f3c6d8292e7d696f6817f4925f6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Store of sequences. <br /></td></tr>
<tr class="separator:a7de5f3c6d8292e7d696f6817f4925f6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19e4abf1a36c12c6762e17471d83dd2b" id="r_a19e4abf1a36c12c6762e17471d83dd2b"><td class="memItemLeft" align="right" valign="top"><a id="a19e4abf1a36c12c6762e17471d83dd2b" name="a19e4abf1a36c12c6762e17471d83dd2b"></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:a19e4abf1a36c12c6762e17471d83dd2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">LIFO stack of started elements. <br /></td></tr>
<tr class="separator:a19e4abf1a36c12c6762e17471d83dd2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f1863bab99619fc0bc4e71f9c9c026d" id="r_a5f1863bab99619fc0bc4e71f9c9c026d"><td class="memItemLeft" align="right" valign="top"><a id="a5f1863bab99619fc0bc4e71f9c9c026d" name="a5f1863bab99619fc0bc4e71f9c9c026d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_special_element</b></td></tr>
<tr class="memdesc:a5f1863bab99619fc0bc4e71f9c9c026d"><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:a5f1863bab99619fc0bc4e71f9c9c026d"><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:a73ebe1562c231fe2794b549a2cffd436" id="r_a73ebe1562c231fe2794b549a2cffd436"><td class="memItemLeft" align="right" valign="top"><a id="a73ebe1562c231fe2794b549a2cffd436" name="a73ebe1562c231fe2794b549a2cffd436"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>parser&lt; _Elem, _Traits, _Alloc &gt;</b></td></tr>
<tr class="separator:a73ebe1562c231fe2794b549a2cffd436"><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 _Elem, class _Traits = std::char_traits&lt;_Elem&gt;, class _Alloc = std::allocator&lt;_Elem&gt;&gt;<br />
class stdex::html::document&lt; _Elem, _Traits, _Alloc &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 Wed Nov 29 2023 10:32:50 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.9.8
</small></address>
</body>
</html>