diff options
Diffstat (limited to 'api-docs/html/a00911.html')
| -rw-r--r-- | api-docs/html/a00911.html | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/api-docs/html/a00911.html b/api-docs/html/a00911.html new file mode 100644 index 000000000000..98853b776afc --- /dev/null +++ b/api-docs/html/a00911.html @@ -0,0 +1,214 @@ +<!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.6"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Lutok: lutok::stack_cleaner 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> +<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">Lutok<span id="projectnumber"> 0.6.2</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.6 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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>lutok</b></li><li class="navelem"><a class="el" href="a00911.html">stack_cleaner</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pri-methods">Private Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> | +<a href="a00908.html">List of all members</a> </div> + <div class="headertitle"><div class="title">lutok::stack_cleaner Class Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>A RAII model for values on the Lua stack. + <a href="a00911.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="a00041_source.html">stack_cleaner.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00907.html">impl</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal implementation for <a class="el" href="a00911.html" title="A RAII model for values on the Lua stack.">lutok::stack_cleaner</a>. <a href="a00907.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:aa57f11b2de4bed78a353c67e2f615d82"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00911.html#aa57f11b2de4bed78a353c67e2f615d82">stack_cleaner</a> (<a class="el" href="a00919.html">state</a> &)</td></tr> +<tr class="memdesc:aa57f11b2de4bed78a353c67e2f615d82"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new stack cleaner. <br /></td></tr> +<tr class="separator:aa57f11b2de4bed78a353c67e2f615d82"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac5220a06585a77c020cd749780a609ef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00911.html#ac5220a06585a77c020cd749780a609ef">~stack_cleaner</a> (void)</td></tr> +<tr class="memdesc:ac5220a06585a77c020cd749780a609ef"><td class="mdescLeft"> </td><td class="mdescRight">Pops any values from the stack not known at construction time. <br /></td></tr> +<tr class="separator:ac5220a06585a77c020cd749780a609ef"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a49785d233cb138150f55b31f9abb7199"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00911.html#a49785d233cb138150f55b31f9abb7199">forget</a> (void)</td></tr> +<tr class="memdesc:a49785d233cb138150f55b31f9abb7199"><td class="mdescLeft"> </td><td class="mdescRight">Forgets about any elements currently in the stack. <br /></td></tr> +<tr class="separator:a49785d233cb138150f55b31f9abb7199"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a> +Private Member Functions</h2></td></tr> +<tr class="memitem:a772715035b5f849c9a2e0dfbb3885d88"><td class="memItemLeft" align="right" valign="top"><a id="a772715035b5f849c9a2e0dfbb3885d88" name="a772715035b5f849c9a2e0dfbb3885d88"></a> + </td><td class="memItemRight" valign="bottom"><b>stack_cleaner</b> (const <a class="el" href="a00911.html">stack_cleaner</a> &)=delete</td></tr> +<tr class="memdesc:a772715035b5f849c9a2e0dfbb3885d88"><td class="mdescLeft"> </td><td class="mdescRight">Disallow copies. <br /></td></tr> +<tr class="separator:a772715035b5f849c9a2e0dfbb3885d88"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4728d49eec3a2e916acc6a7ede21f1e7"><td class="memItemLeft" align="right" valign="top"><a id="a4728d49eec3a2e916acc6a7ede21f1e7" name="a4728d49eec3a2e916acc6a7ede21f1e7"></a> +<a class="el" href="a00911.html">stack_cleaner</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="a00911.html">stack_cleaner</a> &)=delete</td></tr> +<tr class="memdesc:a4728d49eec3a2e916acc6a7ede21f1e7"><td class="mdescLeft"> </td><td class="mdescRight">Disallow assignment. <br /></td></tr> +<tr class="separator:a4728d49eec3a2e916acc6a7ede21f1e7"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr class="memitem:a8d6fb663c4c137e8dc1544e318909e94"><td class="memItemLeft" align="right" valign="top"><a id="a8d6fb663c4c137e8dc1544e318909e94" name="a8d6fb663c4c137e8dc1544e318909e94"></a> +std::unique_ptr< <a class="el" href="a00907.html">impl</a> > </td><td class="memItemRight" valign="bottom"><b>_pimpl</b></td></tr> +<tr class="memdesc:a8d6fb663c4c137e8dc1544e318909e94"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the shared internal implementation. <br /></td></tr> +<tr class="separator:a8d6fb663c4c137e8dc1544e318909e94"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A RAII model for values on the Lua stack. </p> +<p>At creation time, the object records the current depth of the Lua stack and, during destruction, restores the recorded depth by popping as many stack entries as required. As a corollary, the stack can only grow during the lifetime of a <a class="el" href="a00911.html" title="A RAII model for values on the Lua stack.">stack_cleaner</a> object (or shrink, but cannot become shorter than the depth recorded at creation time).</p> +<p>Use this class as follows:</p> +<p>state s; { <a class="el" href="a00911.html" title="A RAII model for values on the Lua stack.">stack_cleaner</a> cleaner1(s); s.push_integer(3); s.push_integer(5); ... do stuff here ... for (...) { <a class="el" href="a00911.html" title="A RAII model for values on the Lua stack.">stack_cleaner</a> cleaner2(s); s.load_string("..."); s.pcall(0, 1, 0); ... do stuff here ... } // cleaner2 destroyed; the result of pcall is gone. } // cleaner1 destroyed; the integers 3 and 5 are gone.</p> +<p>You must give a name to the instantiated objects even if they cannot be accessed later. Otherwise, the instance will be destroyed right away and will not have the desired effect. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="aa57f11b2de4bed78a353c67e2f615d82" name="aa57f11b2de4bed78a353c67e2f615d82"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa57f11b2de4bed78a353c67e2f615d82">◆ </a></span>stack_cleaner()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">lutok::stack_cleaner::stack_cleaner </td> + <td>(</td> + <td class="paramtype"><a class="el" href="a00919.html">state</a> & </td> + <td class="paramname"><em>state_</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates a new stack cleaner. </p> +<p>This gathers the current height of the stack so that extra elements can be popped during destruction.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">state_</td><td>The Lua state. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ac5220a06585a77c020cd749780a609ef" name="ac5220a06585a77c020cd749780a609ef"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac5220a06585a77c020cd749780a609ef">◆ </a></span>~stack_cleaner()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">lutok::stack_cleaner::~stack_cleaner </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Pops any values from the stack not known at construction time. </p> +<dl class="section pre"><dt>Precondition</dt><dd>The current height of the stack must be equal or greater to the height of the stack when this object was instantiated. </dd></dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a49785d233cb138150f55b31f9abb7199" name="a49785d233cb138150f55b31f9abb7199"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a49785d233cb138150f55b31f9abb7199">◆ </a></span>forget()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void lutok::stack_cleaner::forget </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Forgets about any elements currently in the stack. </p> +<p>This allows a function to return values on the stack because all the elements that are currently in the stack will not be touched during destruction when the function is called. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a00041_source.html">stack_cleaner.hpp</a></li> +<li>stack_cleaner.cpp</li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 +</small></address> +</body> +</html> |