1*132f818dSEnji Cooper<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2*132f818dSEnji Cooper<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> 3*132f818dSEnji Cooper<head> 4*132f818dSEnji Cooper<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5*132f818dSEnji Cooper<meta http-equiv="X-UA-Compatible" content="IE=11"/> 6*132f818dSEnji Cooper<meta name="generator" content="Doxygen 1.9.6"/> 7*132f818dSEnji Cooper<meta name="viewport" content="width=device-width, initial-scale=1"/> 8*132f818dSEnji Cooper<title>Lutok: lutok::stack_cleaner Class Reference</title> 9*132f818dSEnji Cooper<link href="tabs.css" rel="stylesheet" type="text/css"/> 10*132f818dSEnji Cooper<script type="text/javascript" src="jquery.js"></script> 11*132f818dSEnji Cooper<script type="text/javascript" src="dynsections.js"></script> 12*132f818dSEnji Cooper<link href="search/search.css" rel="stylesheet" type="text/css"/> 13*132f818dSEnji Cooper<script type="text/javascript" src="search/searchdata.js"></script> 14*132f818dSEnji Cooper<script type="text/javascript" src="search/search.js"></script> 15*132f818dSEnji Cooper<link href="doxygen.css" rel="stylesheet" type="text/css" /> 16*132f818dSEnji Cooper</head> 17*132f818dSEnji Cooper<body> 18*132f818dSEnji Cooper<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 19*132f818dSEnji Cooper<div id="titlearea"> 20*132f818dSEnji Cooper<table cellspacing="0" cellpadding="0"> 21*132f818dSEnji Cooper <tbody> 22*132f818dSEnji Cooper <tr id="projectrow"> 23*132f818dSEnji Cooper <td id="projectalign"> 24*132f818dSEnji Cooper <div id="projectname">Lutok<span id="projectnumber"> 0.6.2</span> 25*132f818dSEnji Cooper </div> 26*132f818dSEnji Cooper </td> 27*132f818dSEnji Cooper </tr> 28*132f818dSEnji Cooper </tbody> 29*132f818dSEnji Cooper</table> 30*132f818dSEnji Cooper</div> 31*132f818dSEnji Cooper<!-- end header part --> 32*132f818dSEnji Cooper<!-- Generated by Doxygen 1.9.6 --> 33*132f818dSEnji Cooper<script type="text/javascript"> 34*132f818dSEnji Cooper/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ 35*132f818dSEnji Coopervar searchBox = new SearchBox("searchBox", "search/",'.html'); 36*132f818dSEnji Cooper/* @license-end */ 37*132f818dSEnji Cooper</script> 38*132f818dSEnji Cooper<script type="text/javascript" src="menudata.js"></script> 39*132f818dSEnji Cooper<script type="text/javascript" src="menu.js"></script> 40*132f818dSEnji Cooper<script type="text/javascript"> 41*132f818dSEnji Cooper/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ 42*132f818dSEnji Cooper$(function() { 43*132f818dSEnji Cooper initMenu('',true,false,'search.php','Search'); 44*132f818dSEnji Cooper $(document).ready(function() { init_search(); }); 45*132f818dSEnji Cooper}); 46*132f818dSEnji Cooper/* @license-end */ 47*132f818dSEnji Cooper</script> 48*132f818dSEnji Cooper<div id="main-nav"></div> 49*132f818dSEnji Cooper<!-- window showing the filter options --> 50*132f818dSEnji Cooper<div id="MSearchSelectWindow" 51*132f818dSEnji Cooper onmouseover="return searchBox.OnSearchSelectShow()" 52*132f818dSEnji Cooper onmouseout="return searchBox.OnSearchSelectHide()" 53*132f818dSEnji Cooper onkeydown="return searchBox.OnSearchSelectKey(event)"> 54*132f818dSEnji Cooper</div> 55*132f818dSEnji Cooper 56*132f818dSEnji Cooper<!-- iframe showing the search results (closed by default) --> 57*132f818dSEnji Cooper<div id="MSearchResultsWindow"> 58*132f818dSEnji Cooper<div id="MSearchResults"> 59*132f818dSEnji Cooper<div class="SRPage"> 60*132f818dSEnji Cooper<div id="SRIndex"> 61*132f818dSEnji Cooper<div id="SRResults"></div> 62*132f818dSEnji Cooper<div class="SRStatus" id="Loading">Loading...</div> 63*132f818dSEnji Cooper<div class="SRStatus" id="Searching">Searching...</div> 64*132f818dSEnji Cooper<div class="SRStatus" id="NoMatches">No Matches</div> 65*132f818dSEnji Cooper</div> 66*132f818dSEnji Cooper</div> 67*132f818dSEnji Cooper</div> 68*132f818dSEnji Cooper</div> 69*132f818dSEnji Cooper 70*132f818dSEnji Cooper<div id="nav-path" class="navpath"> 71*132f818dSEnji Cooper <ul> 72*132f818dSEnji Cooper<li class="navelem"><b>lutok</b></li><li class="navelem"><a class="el" href="a00911.html">stack_cleaner</a></li> </ul> 73*132f818dSEnji Cooper</div> 74*132f818dSEnji Cooper</div><!-- top --> 75*132f818dSEnji Cooper<div class="header"> 76*132f818dSEnji Cooper <div class="summary"> 77*132f818dSEnji Cooper<a href="#nested-classes">Classes</a> | 78*132f818dSEnji Cooper<a href="#pub-methods">Public Member Functions</a> | 79*132f818dSEnji Cooper<a href="#pri-methods">Private Member Functions</a> | 80*132f818dSEnji Cooper<a href="#pri-attribs">Private Attributes</a> | 81*132f818dSEnji Cooper<a href="a00908.html">List of all members</a> </div> 82*132f818dSEnji Cooper <div class="headertitle"><div class="title">lutok::stack_cleaner Class Reference</div></div> 83*132f818dSEnji Cooper</div><!--header--> 84*132f818dSEnji Cooper<div class="contents"> 85*132f818dSEnji Cooper 86*132f818dSEnji Cooper<p>A RAII model for values on the Lua stack. 87*132f818dSEnji Cooper <a href="a00911.html#details">More...</a></p> 88*132f818dSEnji Cooper 89*132f818dSEnji Cooper<p><code>#include <<a class="el" href="a00041_source.html">stack_cleaner.hpp</a>></code></p> 90*132f818dSEnji Cooper<table class="memberdecls"> 91*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> 92*132f818dSEnji CooperClasses</h2></td></tr> 93*132f818dSEnji Cooper<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> 94*132f818dSEnji Cooper<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> 95*132f818dSEnji Cooper<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> 96*132f818dSEnji Cooper</table><table class="memberdecls"> 97*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> 98*132f818dSEnji CooperPublic Member Functions</h2></td></tr> 99*132f818dSEnji Cooper<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> 100*132f818dSEnji Cooper<tr class="memdesc:aa57f11b2de4bed78a353c67e2f615d82"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new stack cleaner. <br /></td></tr> 101*132f818dSEnji Cooper<tr class="separator:aa57f11b2de4bed78a353c67e2f615d82"><td class="memSeparator" colspan="2"> </td></tr> 102*132f818dSEnji Cooper<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> 103*132f818dSEnji Cooper<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> 104*132f818dSEnji Cooper<tr class="separator:ac5220a06585a77c020cd749780a609ef"><td class="memSeparator" colspan="2"> </td></tr> 105*132f818dSEnji Cooper<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> 106*132f818dSEnji Cooper<tr class="memdesc:a49785d233cb138150f55b31f9abb7199"><td class="mdescLeft"> </td><td class="mdescRight">Forgets about any elements currently in the stack. <br /></td></tr> 107*132f818dSEnji Cooper<tr class="separator:a49785d233cb138150f55b31f9abb7199"><td class="memSeparator" colspan="2"> </td></tr> 108*132f818dSEnji Cooper</table><table class="memberdecls"> 109*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a> 110*132f818dSEnji CooperPrivate Member Functions</h2></td></tr> 111*132f818dSEnji Cooper<tr class="memitem:a772715035b5f849c9a2e0dfbb3885d88"><td class="memItemLeft" align="right" valign="top"><a id="a772715035b5f849c9a2e0dfbb3885d88" name="a772715035b5f849c9a2e0dfbb3885d88"></a> 112*132f818dSEnji Cooper </td><td class="memItemRight" valign="bottom"><b>stack_cleaner</b> (const <a class="el" href="a00911.html">stack_cleaner</a> &)=delete</td></tr> 113*132f818dSEnji Cooper<tr class="memdesc:a772715035b5f849c9a2e0dfbb3885d88"><td class="mdescLeft"> </td><td class="mdescRight">Disallow copies. <br /></td></tr> 114*132f818dSEnji Cooper<tr class="separator:a772715035b5f849c9a2e0dfbb3885d88"><td class="memSeparator" colspan="2"> </td></tr> 115*132f818dSEnji Cooper<tr class="memitem:a4728d49eec3a2e916acc6a7ede21f1e7"><td class="memItemLeft" align="right" valign="top"><a id="a4728d49eec3a2e916acc6a7ede21f1e7" name="a4728d49eec3a2e916acc6a7ede21f1e7"></a> 116*132f818dSEnji Cooper<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> 117*132f818dSEnji Cooper<tr class="memdesc:a4728d49eec3a2e916acc6a7ede21f1e7"><td class="mdescLeft"> </td><td class="mdescRight">Disallow assignment. <br /></td></tr> 118*132f818dSEnji Cooper<tr class="separator:a4728d49eec3a2e916acc6a7ede21f1e7"><td class="memSeparator" colspan="2"> </td></tr> 119*132f818dSEnji Cooper</table><table class="memberdecls"> 120*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a> 121*132f818dSEnji CooperPrivate Attributes</h2></td></tr> 122*132f818dSEnji Cooper<tr class="memitem:a8d6fb663c4c137e8dc1544e318909e94"><td class="memItemLeft" align="right" valign="top"><a id="a8d6fb663c4c137e8dc1544e318909e94" name="a8d6fb663c4c137e8dc1544e318909e94"></a> 123*132f818dSEnji Cooperstd::unique_ptr< <a class="el" href="a00907.html">impl</a> > </td><td class="memItemRight" valign="bottom"><b>_pimpl</b></td></tr> 124*132f818dSEnji Cooper<tr class="memdesc:a8d6fb663c4c137e8dc1544e318909e94"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the shared internal implementation. <br /></td></tr> 125*132f818dSEnji Cooper<tr class="separator:a8d6fb663c4c137e8dc1544e318909e94"><td class="memSeparator" colspan="2"> </td></tr> 126*132f818dSEnji Cooper</table> 127*132f818dSEnji Cooper<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 128*132f818dSEnji Cooper<div class="textblock"><p>A RAII model for values on the Lua stack. </p> 129*132f818dSEnji Cooper<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> 130*132f818dSEnji Cooper<p>Use this class as follows:</p> 131*132f818dSEnji Cooper<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> 132*132f818dSEnji Cooper<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> 133*132f818dSEnji Cooper</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> 134*132f818dSEnji Cooper<a id="aa57f11b2de4bed78a353c67e2f615d82" name="aa57f11b2de4bed78a353c67e2f615d82"></a> 135*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#aa57f11b2de4bed78a353c67e2f615d82">◆ </a></span>stack_cleaner()</h2> 136*132f818dSEnji Cooper 137*132f818dSEnji Cooper<div class="memitem"> 138*132f818dSEnji Cooper<div class="memproto"> 139*132f818dSEnji Cooper <table class="memname"> 140*132f818dSEnji Cooper <tr> 141*132f818dSEnji Cooper <td class="memname">lutok::stack_cleaner::stack_cleaner </td> 142*132f818dSEnji Cooper <td>(</td> 143*132f818dSEnji Cooper <td class="paramtype"><a class="el" href="a00919.html">state</a> & </td> 144*132f818dSEnji Cooper <td class="paramname"><em>state_</em></td><td>)</td> 145*132f818dSEnji Cooper <td></td> 146*132f818dSEnji Cooper </tr> 147*132f818dSEnji Cooper </table> 148*132f818dSEnji Cooper</div><div class="memdoc"> 149*132f818dSEnji Cooper 150*132f818dSEnji Cooper<p>Creates a new stack cleaner. </p> 151*132f818dSEnji Cooper<p>This gathers the current height of the stack so that extra elements can be popped during destruction.</p> 152*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd> 153*132f818dSEnji Cooper <table class="params"> 154*132f818dSEnji Cooper <tr><td class="paramname">state_</td><td>The Lua state. </td></tr> 155*132f818dSEnji Cooper </table> 156*132f818dSEnji Cooper </dd> 157*132f818dSEnji Cooper</dl> 158*132f818dSEnji Cooper 159*132f818dSEnji Cooper</div> 160*132f818dSEnji Cooper</div> 161*132f818dSEnji Cooper<a id="ac5220a06585a77c020cd749780a609ef" name="ac5220a06585a77c020cd749780a609ef"></a> 162*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#ac5220a06585a77c020cd749780a609ef">◆ </a></span>~stack_cleaner()</h2> 163*132f818dSEnji Cooper 164*132f818dSEnji Cooper<div class="memitem"> 165*132f818dSEnji Cooper<div class="memproto"> 166*132f818dSEnji Cooper <table class="memname"> 167*132f818dSEnji Cooper <tr> 168*132f818dSEnji Cooper <td class="memname">lutok::stack_cleaner::~stack_cleaner </td> 169*132f818dSEnji Cooper <td>(</td> 170*132f818dSEnji Cooper <td class="paramtype">void </td> 171*132f818dSEnji Cooper <td class="paramname"></td><td>)</td> 172*132f818dSEnji Cooper <td></td> 173*132f818dSEnji Cooper </tr> 174*132f818dSEnji Cooper </table> 175*132f818dSEnji Cooper</div><div class="memdoc"> 176*132f818dSEnji Cooper 177*132f818dSEnji Cooper<p>Pops any values from the stack not known at construction time. </p> 178*132f818dSEnji Cooper<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> 179*132f818dSEnji Cooper 180*132f818dSEnji Cooper</div> 181*132f818dSEnji Cooper</div> 182*132f818dSEnji Cooper<h2 class="groupheader">Member Function Documentation</h2> 183*132f818dSEnji Cooper<a id="a49785d233cb138150f55b31f9abb7199" name="a49785d233cb138150f55b31f9abb7199"></a> 184*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a49785d233cb138150f55b31f9abb7199">◆ </a></span>forget()</h2> 185*132f818dSEnji Cooper 186*132f818dSEnji Cooper<div class="memitem"> 187*132f818dSEnji Cooper<div class="memproto"> 188*132f818dSEnji Cooper <table class="memname"> 189*132f818dSEnji Cooper <tr> 190*132f818dSEnji Cooper <td class="memname">void lutok::stack_cleaner::forget </td> 191*132f818dSEnji Cooper <td>(</td> 192*132f818dSEnji Cooper <td class="paramtype">void </td> 193*132f818dSEnji Cooper <td class="paramname"></td><td>)</td> 194*132f818dSEnji Cooper <td></td> 195*132f818dSEnji Cooper </tr> 196*132f818dSEnji Cooper </table> 197*132f818dSEnji Cooper</div><div class="memdoc"> 198*132f818dSEnji Cooper 199*132f818dSEnji Cooper<p>Forgets about any elements currently in the stack. </p> 200*132f818dSEnji Cooper<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> 201*132f818dSEnji Cooper 202*132f818dSEnji Cooper</div> 203*132f818dSEnji Cooper</div> 204*132f818dSEnji Cooper<hr/>The documentation for this class was generated from the following files:<ul> 205*132f818dSEnji Cooper<li><a class="el" href="a00041_source.html">stack_cleaner.hpp</a></li> 206*132f818dSEnji Cooper<li>stack_cleaner.cpp</li> 207*132f818dSEnji Cooper</ul> 208*132f818dSEnji Cooper</div><!-- contents --> 209*132f818dSEnji Cooper<!-- start footer part --> 210*132f818dSEnji Cooper<hr class="footer"/><address class="footer"><small> 211*132f818dSEnji CooperGenerated 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 212*132f818dSEnji Cooper</small></address> 213*132f818dSEnji Cooper</body> 214*132f818dSEnji Cooper</html> 215
