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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
<!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::state_c_gate 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="a00011.html">state_c_gate</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">lutok::state_c_gate Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Gateway to the raw C state of Lua.
<a href="a00011.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00013_source.html">c_gate.hpp</a>></code></p>
<p><a href="a00040.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:a45cf8c049b489118bb6ed174fe834cbf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#a45cf8c049b489118bb6ed174fe834cbf">state_c_gate</a> (<a class="el" href="a00009.html">state</a> &)</td></tr>
<tr class="memdesc:a45cf8c049b489118bb6ed174fe834cbf"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new gateway to an existing C++ Lua state. <a href="#a45cf8c049b489118bb6ed174fe834cbf"></a><br/></td></tr>
<tr class="memitem:a8f86776a8758c2ae3f1ef280356230b8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#a8f86776a8758c2ae3f1ef280356230b8">~state_c_gate</a> (void)</td></tr>
<tr class="memdesc:a8f86776a8758c2ae3f1ef280356230b8"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8f86776a8758c2ae3f1ef280356230b8"></a><br/></td></tr>
<tr class="memitem:a9ca464b39c2f2ee1326590893d12aeba"><td class="memItemLeft" align="right" valign="top">lua_State * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#a9ca464b39c2f2ee1326590893d12aeba">c_state</a> (void)</td></tr>
<tr class="memdesc:a9ca464b39c2f2ee1326590893d12aeba"><td class="mdescLeft"> </td><td class="mdescRight">Returns the C native Lua state. <a href="#a9ca464b39c2f2ee1326590893d12aeba"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a6a9658d0088fe47855e2d081ce172f97"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00009.html">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#a6a9658d0088fe47855e2d081ce172f97">connect</a> (lua_State *)</td></tr>
<tr class="memdesc:a6a9658d0088fe47855e2d081ce172f97"><td class="mdescLeft"> </td><td class="mdescRight">Creates a C++ state for a C Lua state. <a href="#a6a9658d0088fe47855e2d081ce172f97"></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:a51083d09eb4ba2ef98e169d25f3916f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51083d09eb4ba2ef98e169d25f3916f4"></a>
<a class="el" href="a00009.html">state</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#a51083d09eb4ba2ef98e169d25f3916f4">_state</a></td></tr>
<tr class="memdesc:a51083d09eb4ba2ef98e169d25f3916f4"><td class="mdescLeft"> </td><td class="mdescRight">The C++ state that this class wraps. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Gateway to the raw C state of Lua. </p>
<p>This class provides a mechanism to muck with the internals of the state wrapper class. Client code may wish to do so if Lutok is missing some features of the performance of Lutok in a particular situation is not reasonable.</p>
<dl class="section warning"><dt>Warning:</dt><dd>The use of this class is discouraged. By using this class, you are entering the world of unsafety. Anything you do through the objects exposed through this class will not be controlled by RAII patterns not validated in any other way, so you can end up corrupting the Lua state and later get crashes on otherwise perfectly-valid C++ code. </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a45cf8c049b489118bb6ed174fe834cbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lutok::state_c_gate::state_c_gate </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 gateway to an existing C++ Lua state. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">state_</td><td>The state to connect to. This object must remain alive while the newly-constructed <a class="el" href="a00011.html" title="Gateway to the raw C state of Lua.">state_c_gate</a> is alive. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8f86776a8758c2ae3f1ef280356230b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lutok::state_c_gate::~state_c_gate </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Destroying this object has no implications on the life cycle of the Lua state. Only the corresponding state object controls when the Lua state is closed. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9ca464b39c2f2ee1326590893d12aeba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lua_State * lutok::state_c_gate::c_state </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the C native Lua state. </p>
<dl class="section return"><dt>Returns:</dt><dd>A native lua_State object holding the Lua C API state. </dd></dl>
</div>
</div>
<a class="anchor" id="a6a9658d0088fe47855e2d081ce172f97"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00009.html">lutok::state</a> lutok::state_c_gate::connect </td>
<td>(</td>
<td class="paramtype">lua_State * </td>
<td class="paramname"><em>raw_state</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a C++ state for a C Lua state. </p>
<dl class="section warning"><dt>Warning:</dt><dd>The created state object does NOT own the C state. You must take care to properly destroy the input lua_State when you are done with it to not leak resources.</dd></dl>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">raw_state</td><td>The raw state to wrap temporarily.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>The wrapped state without strong ownership on the input state. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00013_source.html">c_gate.hpp</a></li>
<li>c_gate.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>
|
