xref: /freebsd/contrib/lutok/api-docs/html/a00041_source.html (revision 132f818ddbf457ee67d502cd89b5a18e0a34713d)
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: stack_cleaner.hpp Source File</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">&#160;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&amp;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&amp;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</div><!-- top -->
50*132f818dSEnji Cooper<!-- window showing the filter options -->
51*132f818dSEnji Cooper<div id="MSearchSelectWindow"
52*132f818dSEnji Cooper     onmouseover="return searchBox.OnSearchSelectShow()"
53*132f818dSEnji Cooper     onmouseout="return searchBox.OnSearchSelectHide()"
54*132f818dSEnji Cooper     onkeydown="return searchBox.OnSearchSelectKey(event)">
55*132f818dSEnji Cooper</div>
56*132f818dSEnji Cooper
57*132f818dSEnji Cooper<!-- iframe showing the search results (closed by default) -->
58*132f818dSEnji Cooper<div id="MSearchResultsWindow">
59*132f818dSEnji Cooper<div id="MSearchResults">
60*132f818dSEnji Cooper<div class="SRPage">
61*132f818dSEnji Cooper<div id="SRIndex">
62*132f818dSEnji Cooper<div id="SRResults"></div>
63*132f818dSEnji Cooper<div class="SRStatus" id="Loading">Loading...</div>
64*132f818dSEnji Cooper<div class="SRStatus" id="Searching">Searching...</div>
65*132f818dSEnji Cooper<div class="SRStatus" id="NoMatches">No Matches</div>
66*132f818dSEnji Cooper</div>
67*132f818dSEnji Cooper</div>
68*132f818dSEnji Cooper</div>
69*132f818dSEnji Cooper</div>
70*132f818dSEnji Cooper
71*132f818dSEnji Cooper<div class="header">
72*132f818dSEnji Cooper  <div class="headertitle"><div class="title">stack_cleaner.hpp</div></div>
73*132f818dSEnji Cooper</div><!--header-->
74*132f818dSEnji Cooper<div class="contents">
75*132f818dSEnji Cooper<a href="a00041.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright 2011 Google Inc.</span></div>
76*132f818dSEnji Cooper<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// All rights reserved.</span></div>
77*132f818dSEnji Cooper<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">//</span></div>
78*132f818dSEnji Cooper<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// Redistribution and use in source and binary forms, with or without</span></div>
79*132f818dSEnji Cooper<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// modification, are permitted provided that the following conditions are</span></div>
80*132f818dSEnji Cooper<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">// met:</span></div>
81*132f818dSEnji Cooper<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">//</span></div>
82*132f818dSEnji Cooper<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">// * Redistributions of source code must retain the above copyright</span></div>
83*132f818dSEnji Cooper<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment">//   notice, this list of conditions and the following disclaimer.</span></div>
84*132f818dSEnji Cooper<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">// * Redistributions in binary form must reproduce the above copyright</span></div>
85*132f818dSEnji Cooper<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">//   notice, this list of conditions and the following disclaimer in the</span></div>
86*132f818dSEnji Cooper<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">//   documentation and/or other materials provided with the distribution.</span></div>
87*132f818dSEnji Cooper<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// * Neither the name of Google Inc. nor the names of its contributors</span></div>
88*132f818dSEnji Cooper<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">//   may be used to endorse or promote products derived from this software</span></div>
89*132f818dSEnji Cooper<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">//   without specific prior written permission.</span></div>
90*132f818dSEnji Cooper<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">//</span></div>
91*132f818dSEnji Cooper<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div>
92*132f818dSEnji Cooper<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">// &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div>
93*132f818dSEnji Cooper<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment">// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div>
94*132f818dSEnji Cooper<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment">// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div>
95*132f818dSEnji Cooper<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment">// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div>
96*132f818dSEnji Cooper<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment">// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div>
97*132f818dSEnji Cooper<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment">// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
98*132f818dSEnji Cooper<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment">// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
99*132f818dSEnji Cooper<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
100*132f818dSEnji Cooper<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div>
101*132f818dSEnji Cooper<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
102*132f818dSEnji Cooper<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
103*132f818dSEnji Cooper<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
104*132f818dSEnji Cooper<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#if !defined(LUTOK_STACK_CLEANER_HPP)</span></div>
105*132f818dSEnji Cooper<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define LUTOK_STACK_CLEANER_HPP</span></div>
106*132f818dSEnji Cooper<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
107*132f818dSEnji Cooper<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
108*132f818dSEnji Cooper<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
109*132f818dSEnji Cooper<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#include &lt;lutok/state.hpp&gt;</span></div>
110*132f818dSEnji Cooper<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
111*132f818dSEnji Cooper<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="keyword">namespace </span>lutok {</div>
112*132f818dSEnji Cooper<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
113*132f818dSEnji Cooper<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
114*132f818dSEnji Cooper<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="a00911.html">   71</a></span><span class="keyword">class </span><a class="code hl_class" href="a00911.html">stack_cleaner</a> {</div>
115*132f818dSEnji Cooper<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    <span class="keyword">struct </span><a class="code hl_struct" href="a00907.html">impl</a>;</div>
116*132f818dSEnji Cooper<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span> </div>
117*132f818dSEnji Cooper<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="a00911.html#a8d6fb663c4c137e8dc1544e318909e94">   75</a></span>    std::unique_ptr&lt; impl &gt; <a class="code hl_variable" href="a00911.html#a8d6fb663c4c137e8dc1544e318909e94">_pimpl</a>;</div>
118*132f818dSEnji Cooper<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span> </div>
119*132f818dSEnji Cooper<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="a00911.html#a772715035b5f849c9a2e0dfbb3885d88">   78</a></span>    <a class="code hl_function" href="a00911.html#a772715035b5f849c9a2e0dfbb3885d88">stack_cleaner</a>(<span class="keyword">const</span> <a class="code hl_class" href="a00911.html">stack_cleaner</a>&amp;) = <span class="keyword">delete</span>;</div>
120*132f818dSEnji Cooper<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
121*132f818dSEnji Cooper<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="a00911.html#a4728d49eec3a2e916acc6a7ede21f1e7">   81</a></span>    <a class="code hl_class" href="a00911.html">stack_cleaner</a>&amp; <a class="code hl_function" href="a00911.html#a4728d49eec3a2e916acc6a7ede21f1e7">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="a00911.html">stack_cleaner</a>&amp;) = <span class="keyword">delete</span>;</div>
122*132f818dSEnji Cooper<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
123*132f818dSEnji Cooper<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="keyword">public</span>:</div>
124*132f818dSEnji Cooper<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>    <a class="code hl_class" href="a00911.html">stack_cleaner</a>(<a class="code hl_class" href="a00919.html">state</a>&amp;);</div>
125*132f818dSEnji Cooper<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>    <a class="code hl_function" href="a00911.html#ac5220a06585a77c020cd749780a609ef">~stack_cleaner</a>(<span class="keywordtype">void</span>);</div>
126*132f818dSEnji Cooper<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
127*132f818dSEnji Cooper<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="a00911.html#a49785d233cb138150f55b31f9abb7199">forget</a>(<span class="keywordtype">void</span>);</div>
128*132f818dSEnji Cooper<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>};</div>
129*132f818dSEnji Cooper<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span> </div>
130*132f818dSEnji Cooper<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span> </div>
131*132f818dSEnji Cooper<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>}  <span class="comment">// namespace lutok</span></div>
132*132f818dSEnji Cooper<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
133*132f818dSEnji Cooper<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="preprocessor">#endif  </span><span class="comment">// !defined(LUTOK_STACK_CLEANER_HPP)</span></div>
134*132f818dSEnji Cooper<div class="ttc" id="aa00907_html"><div class="ttname"><a href="a00907.html">lutok::stack_cleaner::impl</a></div><div class="ttdoc">Internal implementation for lutok::stack_cleaner.</div><div class="ttdef"><b>Definition:</b> stack_cleaner.cpp:37</div></div>
135*132f818dSEnji Cooper<div class="ttc" id="aa00911_html"><div class="ttname"><a href="a00911.html">lutok::stack_cleaner</a></div><div class="ttdoc">A RAII model for values on the Lua stack.</div><div class="ttdef"><b>Definition:</b> stack_cleaner.hpp:71</div></div>
136*132f818dSEnji Cooper<div class="ttc" id="aa00911_html_a4728d49eec3a2e916acc6a7ede21f1e7"><div class="ttname"><a href="a00911.html#a4728d49eec3a2e916acc6a7ede21f1e7">lutok::stack_cleaner::operator=</a></div><div class="ttdeci">stack_cleaner &amp; operator=(const stack_cleaner &amp;)=delete</div><div class="ttdoc">Disallow assignment.</div></div>
137*132f818dSEnji Cooper<div class="ttc" id="aa00911_html_a49785d233cb138150f55b31f9abb7199"><div class="ttname"><a href="a00911.html#a49785d233cb138150f55b31f9abb7199">lutok::stack_cleaner::forget</a></div><div class="ttdeci">void forget(void)</div><div class="ttdoc">Forgets about any elements currently in the stack.</div><div class="ttdef"><b>Definition:</b> stack_cleaner.cpp:88</div></div>
138*132f818dSEnji Cooper<div class="ttc" id="aa00911_html_a772715035b5f849c9a2e0dfbb3885d88"><div class="ttname"><a href="a00911.html#a772715035b5f849c9a2e0dfbb3885d88">lutok::stack_cleaner::stack_cleaner</a></div><div class="ttdeci">stack_cleaner(const stack_cleaner &amp;)=delete</div><div class="ttdoc">Disallow copies.</div></div>
139*132f818dSEnji Cooper<div class="ttc" id="aa00911_html_a8d6fb663c4c137e8dc1544e318909e94"><div class="ttname"><a href="a00911.html#a8d6fb663c4c137e8dc1544e318909e94">lutok::stack_cleaner::_pimpl</a></div><div class="ttdeci">std::unique_ptr&lt; impl &gt; _pimpl</div><div class="ttdoc">Pointer to the shared internal implementation.</div><div class="ttdef"><b>Definition:</b> stack_cleaner.hpp:75</div></div>
140*132f818dSEnji Cooper<div class="ttc" id="aa00911_html_ac5220a06585a77c020cd749780a609ef"><div class="ttname"><a href="a00911.html#ac5220a06585a77c020cd749780a609ef">lutok::stack_cleaner::~stack_cleaner</a></div><div class="ttdeci">~stack_cleaner(void)</div><div class="ttdoc">Pops any values from the stack not known at construction time.</div><div class="ttdef"><b>Definition:</b> stack_cleaner.cpp:72</div></div>
141*132f818dSEnji Cooper<div class="ttc" id="aa00919_html"><div class="ttname"><a href="a00919.html">lutok::state</a></div><div class="ttdoc">A RAII model for the Lua state.</div><div class="ttdef"><b>Definition:</b> state.hpp:71</div></div>
142*132f818dSEnji Cooper</div><!-- fragment --></div><!-- contents -->
143*132f818dSEnji Cooper<!-- start footer part -->
144*132f818dSEnji Cooper<hr class="footer"/><address class="footer"><small>
145*132f818dSEnji CooperGenerated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
146*132f818dSEnji Cooper</small></address>
147*132f818dSEnji Cooper</body>
148*132f818dSEnji Cooper</html>
149