1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<!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: lutok::stack_cleaner Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="/usr/share/javascript/jquery/jquery.min.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"><b>lutok</b></li><li class="navelem"><a class="el" href="a00007.html">stack_cleaner</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">lutok::stack_cleaner Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A RAII model for values on the Lua stack.
<a href="a00007.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00025_source.html">stack_cleaner.hpp</a>></code></p>
<p><a href="a00046.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00008.html">impl</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal implementation for <a class="el" href="a00007.html" title="A RAII model for values on the Lua stack.">lutok::stack_cleaner</a>. <a href="a00008.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa57f11b2de4bed78a353c67e2f615d82"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00007.html#aa57f11b2de4bed78a353c67e2f615d82">stack_cleaner</a> (<a class="el" href="a00009.html">state</a> &)</td></tr>
<tr class="memdesc:aa57f11b2de4bed78a353c67e2f615d82"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new stack cleaner. <a href="#aa57f11b2de4bed78a353c67e2f615d82"></a><br/></td></tr>
<tr class="memitem:ac5220a06585a77c020cd749780a609ef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00007.html#ac5220a06585a77c020cd749780a609ef">~stack_cleaner</a> (void)</td></tr>
<tr class="memdesc:ac5220a06585a77c020cd749780a609ef"><td class="mdescLeft"> </td><td class="mdescRight">Pops any values from the stack not known at construction time. <a href="#ac5220a06585a77c020cd749780a609ef"></a><br/></td></tr>
<tr class="memitem:a49785d233cb138150f55b31f9abb7199"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00007.html#a49785d233cb138150f55b31f9abb7199">forget</a> (void)</td></tr>
<tr class="memdesc:a49785d233cb138150f55b31f9abb7199"><td class="mdescLeft"> </td><td class="mdescRight">Forgets about any elements currently in the stack. <a href="#a49785d233cb138150f55b31f9abb7199"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a59845af1bb0fe1f97982eb32edd5fb00"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59845af1bb0fe1f97982eb32edd5fb00"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00007.html#a59845af1bb0fe1f97982eb32edd5fb00">stack_cleaner</a> (const <a class="el" href="a00007.html">stack_cleaner</a> &)</td></tr>
<tr class="memdesc:a59845af1bb0fe1f97982eb32edd5fb00"><td class="mdescLeft"> </td><td class="mdescRight">Disallow copies. <br/></td></tr>
<tr class="memitem:a83b8dae0c61d4761b34cf411fb3af775"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83b8dae0c61d4761b34cf411fb3af775"></a>
<a class="el" href="a00007.html">stack_cleaner</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00007.html#a83b8dae0c61d4761b34cf411fb3af775">operator=</a> (const <a class="el" href="a00007.html">stack_cleaner</a> &)</td></tr>
<tr class="memdesc:a83b8dae0c61d4761b34cf411fb3af775"><td class="mdescLeft"> </td><td class="mdescRight">Disallow assignment. <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:a839bb440cdc955fe559557f0af10a04e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a839bb440cdc955fe559557f0af10a04e"></a>
std::auto_ptr< <a class="el" href="a00008.html">impl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00007.html#a839bb440cdc955fe559557f0af10a04e">_pimpl</a></td></tr>
<tr class="memdesc:a839bb440cdc955fe559557f0af10a04e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the shared internal implementation. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A RAII model for values on the Lua stack. </p>
<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="a00007.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>
<p>Use this class as follows:</p>
<p>state s; { <a class="el" href="a00007.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="a00007.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>
<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>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa57f11b2de4bed78a353c67e2f615d82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lutok::stack_cleaner::stack_cleaner </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00009.html">state</a> & </td>
<td class="paramname"><em>state_</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new stack cleaner. </p>
<p>This gathers the current height of the stack so that extra elements can be popped during destruction.</p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">state_</td><td>The Lua state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac5220a06585a77c020cd749780a609ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lutok::stack_cleaner::~stack_cleaner </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pops any values from the stack not known at construction time. </p>
<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>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a49785d233cb138150f55b31f9abb7199"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lutok::stack_cleaner::forget </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Forgets about any elements currently in the stack. </p>
<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>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00025_source.html">stack_cleaner.hpp</a></li>
<li>stack_cleaner.cpp</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>
|
