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