<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Lutok: anonymous_namespace{test_utils.hpp}::stack_balance_checker 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/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Lutok  <span id="projectnumber">0.4</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="a00035.html">anonymous_namespace{test_utils.hpp}</a></li><li class="navelem"><a class="el" href="a00001.html">stack_balance_checker</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <div class="title">anonymous_namespace{test_utils.hpp}::stack_balance_checker Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Ensures that the Lua stack maintains its original height upon exit. <a href="a00001.html#details">More...</a></p> <p><code>#include <<a class="el" href="a00031_source.html">test_utils.hpp</a>></code></p> <p><a href="a00039.html">List of all members.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a1801f4117fb8801b914c7a834992fc1f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a1801f4117fb8801b914c7a834992fc1f">stack_balance_checker</a> (<a class="el" href="a00009.html">lutok::state</a> &state_, const bool with_sentinel_=true)</td></tr> <tr class="memdesc:a1801f4117fb8801b914c7a834992fc1f"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new stack balance checker. <a href="#a1801f4117fb8801b914c7a834992fc1f"></a><br/></td></tr> <tr class="memitem:a4a77624ad3c7c3968056993d05b8d076"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a4a77624ad3c7c3968056993d05b8d076">~stack_balance_checker</a> (void)</td></tr> <tr class="memdesc:a4a77624ad3c7c3968056993d05b8d076"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the object. <a href="#a4a77624ad3c7c3968056993d05b8d076"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr class="memitem:a5a82e10af0379f4961958389b461ad7b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a82e10af0379f4961958389b461ad7b"></a> <a class="el" href="a00009.html">lutok::state</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a5a82e10af0379f4961958389b461ad7b">_state</a></td></tr> <tr class="memdesc:a5a82e10af0379f4961958389b461ad7b"><td class="mdescLeft"> </td><td class="mdescRight">The Lua state. <br/></td></tr> <tr class="memitem:ae83eb0b565eeec675516b790d5526391"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae83eb0b565eeec675516b790d5526391"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#ae83eb0b565eeec675516b790d5526391">_with_sentinel</a></td></tr> <tr class="memdesc:ae83eb0b565eeec675516b790d5526391"><td class="mdescLeft"> </td><td class="mdescRight">Whether to install a sentinel on the stack for balance enforcement. <br/></td></tr> <tr class="memitem:ab9d0aae743f764d0b7a71e9c2202f9d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9d0aae743f764d0b7a71e9c2202f9d9"></a> unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#ab9d0aae743f764d0b7a71e9c2202f9d9">_old_count</a></td></tr> <tr class="memdesc:ab9d0aae743f764d0b7a71e9c2202f9d9"><td class="mdescLeft"> </td><td class="mdescRight">The height of the stack on creation. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Ensures that the Lua stack maintains its original height upon exit. </p> <p>Use an instance of this class to check that a piece of code does not have side-effects on the Lua stack.</p> <p>To be used within a test case only. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a1801f4117fb8801b914c7a834992fc1f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">anonymous_namespace{test_utils.hpp}::stack_balance_checker::stack_balance_checker </td> <td>(</td> <td class="paramtype"><a class="el" href="a00009.html">lutok::state</a> & </td> <td class="paramname"><em>state_</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bool </td> <td class="paramname"><em>with_sentinel_</em> = <code>true</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs a new stack balance checker. </p> <dl class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">state_</td><td>The Lua state to validate. </td></tr> <tr><td class="paramname">with_sentinel_</td><td>If true, insert a sentinel item into the stack and validate upon exit that the item is still there. This is an attempt to ensure that already-existing items are not removed from the stack by the code under test. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a4a77624ad3c7c3968056993d05b8d076"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">anonymous_namespace{test_utils.hpp}::stack_balance_checker::~stack_balance_checker </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Destructor for the object. </p> <p>If the stack height does not match the height when the instance was created, this fails the test case. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="a00031_source.html">test_utils.hpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Sat Dec 7 2013 19:02:36 for Lutok by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.1 </small></address> </body> </html>