diff options
Diffstat (limited to 'api-docs/html/a00923.html')
| -rw-r--r-- | api-docs/html/a00923.html | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/api-docs/html/a00923.html b/api-docs/html/a00923.html new file mode 100644 index 000000000000..60671056a265 --- /dev/null +++ b/api-docs/html/a00923.html @@ -0,0 +1,201 @@ +<!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: 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/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"><a class="el" href="a00067.html">anonymous_namespace{test_utils.hpp}</a></li><li class="navelem"><a class="el" href="a00923.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> | +<a href="a00920.html">List of all members</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="a00923.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="a00056_source.html">test_utils.hpp</a>></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:a1801f4117fb8801b914c7a834992fc1f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00923.html#a1801f4117fb8801b914c7a834992fc1f">stack_balance_checker</a> (<a class="el" href="a00919.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. <br /></td></tr> +<tr class="separator:a1801f4117fb8801b914c7a834992fc1f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4a77624ad3c7c3968056993d05b8d076"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00923.html#a4a77624ad3c7c3968056993d05b8d076">~stack_balance_checker</a> (void)</td></tr> +<tr class="memdesc:a4a77624ad3c7c3968056993d05b8d076"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the object. <br /></td></tr> +<tr class="separator:a4a77624ad3c7c3968056993d05b8d076"><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:a5a82e10af0379f4961958389b461ad7b"><td class="memItemLeft" align="right" valign="top"><a id="a5a82e10af0379f4961958389b461ad7b" name="a5a82e10af0379f4961958389b461ad7b"></a> +<a class="el" href="a00919.html">lutok::state</a> & </td><td class="memItemRight" valign="bottom"><b>_state</b></td></tr> +<tr class="memdesc:a5a82e10af0379f4961958389b461ad7b"><td class="mdescLeft"> </td><td class="mdescRight">The Lua state. <br /></td></tr> +<tr class="separator:a5a82e10af0379f4961958389b461ad7b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae83eb0b565eeec675516b790d5526391"><td class="memItemLeft" align="right" valign="top"><a id="ae83eb0b565eeec675516b790d5526391" name="ae83eb0b565eeec675516b790d5526391"></a> +bool </td><td class="memItemRight" valign="bottom"><b>_with_sentinel</b></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="separator:ae83eb0b565eeec675516b790d5526391"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab9d0aae743f764d0b7a71e9c2202f9d9"><td class="memItemLeft" align="right" valign="top"><a id="ab9d0aae743f764d0b7a71e9c2202f9d9" name="ab9d0aae743f764d0b7a71e9c2202f9d9"></a> +unsigned int </td><td class="memItemRight" valign="bottom"><b>_old_count</b></td></tr> +<tr class="memdesc:ab9d0aae743f764d0b7a71e9c2202f9d9"><td class="mdescLeft"> </td><td class="mdescRight">The height of the stack on creation. <br /></td></tr> +<tr class="separator:ab9d0aae743f764d0b7a71e9c2202f9d9"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">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><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a1801f4117fb8801b914c7a834992fc1f" name="a1801f4117fb8801b914c7a834992fc1f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1801f4117fb8801b914c7a834992fc1f">◆ </a></span>stack_balance_checker()</h2> + +<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="a00919.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 id="a4a77624ad3c7c3968056993d05b8d076" name="a4a77624ad3c7c3968056993d05b8d076"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4a77624ad3c7c3968056993d05b8d076">◆ </a></span>~stack_balance_checker()</h2> + +<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="a00056_source.html">test_utils.hpp</a></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> |