File: a00034.html

package info (click to toggle)
lutok 0.4%2Bdfsg-4.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,980 kB
  • sloc: sh: 11,302; cpp: 2,350; javascript: 1,131; makefile: 189
file content (359 lines) | stat: -rw-r--r-- 16,820 bytes parent folder | download | duplicates (2)
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
<!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{state_test.cpp} Namespace 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
   &#160;<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&#160;Page</span></a></li>
      <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
      <li><a href="namespacemembers.html"><span>Namespace&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">anonymous_namespace{state_test.cpp} Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a627b68d7ac220aba8661237b2ba4759b"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a627b68d7ac220aba8661237b2ba4759b">is_available</a> (<a class="el" href="a00009.html">lutok::state</a> &amp;state, const char *symbol)</td></tr>
<tr class="memdesc:a627b68d7ac220aba8661237b2ba4759b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a symbol is available.  <a href="#a627b68d7ac220aba8661237b2ba4759b"></a><br/></td></tr>
<tr class="memitem:a31884687c56b3a3f58f517cb9914a1f5"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a31884687c56b3a3f58f517cb9914a1f5">check_modules</a> (<a class="el" href="a00009.html">lutok::state</a> &amp;state, const std::string &amp;expected)</td></tr>
<tr class="memdesc:a31884687c56b3a3f58f517cb9914a1f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks that no modules are present or that only one has been loaded.  <a href="#a31884687c56b3a3f58f517cb9914a1f5"></a><br/></td></tr>
<tr class="memitem:a9d02f302ff9c6ea720b3be1fb3768aca"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a9d02f302ff9c6ea720b3be1fb3768aca">c_get_upvalues</a> (lua_State *raw_state)</td></tr>
<tr class="memdesc:a9d02f302ff9c6ea720b3be1fb3768aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">A C closure that returns its two integral upvalues.  <a href="#a9d02f302ff9c6ea720b3be1fb3768aca"></a><br/></td></tr>
<tr class="memitem:a7ec33b7379b04bedb9bf6e8bcc018d5f"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#a7ec33b7379b04bedb9bf6e8bcc018d5f">cxx_multiply_closure</a> (<a class="el" href="a00009.html">lutok::state</a> &amp;state)</td></tr>
<tr class="memdesc:a7ec33b7379b04bedb9bf6e8bcc018d5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A custom C++ multiply function with one of its factors on its closure.  <a href="#a7ec33b7379b04bedb9bf6e8bcc018d5f"></a><br/></td></tr>
<tr class="memitem:ae2375a17ea66d8f5a418e88c87b2c296"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#ae2375a17ea66d8f5a418e88c87b2c296">cxx_divide</a> (<a class="el" href="a00009.html">lutok::state</a> &amp;state)</td></tr>
<tr class="memdesc:ae2375a17ea66d8f5a418e88c87b2c296"><td class="mdescLeft">&#160;</td><td class="mdescRight">A custom C++ integral division function for Lua.  <a href="#ae2375a17ea66d8f5a418e88c87b2c296"></a><br/></td></tr>
<tr class="memitem:ad70cc6d355abc7d6456692aaca7b0bb1"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#ad70cc6d355abc7d6456692aaca7b0bb1">raise_long_error</a> (<a class="el" href="a00009.html">lutok::state</a> &amp;state)</td></tr>
<tr class="memdesc:ad70cc6d355abc7d6456692aaca7b0bb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Lua function that raises a very long error message.  <a href="#ad70cc6d355abc7d6456692aaca7b0bb1"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a9d02f302ff9c6ea720b3be1fb3768aca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int anonymous_namespace{state_test.cpp}::c_get_upvalues </td>
          <td>(</td>
          <td class="paramtype">lua_State *&#160;</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>A C closure that returns its two integral upvalues. </p>
<dl class="section post"><dt>Postcondition:</dt><dd>stack(-2) contains the first upvalue. </dd>
<dd>
stack(-1) contains the second upvalue.</dd></dl>
<dl class="params"><dt>Parameters:</dt><dd>
  <table class="params">
    <tr><td class="paramname">raw_state</td><td>The raw Lua state.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>The number of result values, i.e. 2. </dd></dl>

</div>
</div>
<a class="anchor" id="a31884687c56b3a3f58f517cb9914a1f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static void anonymous_namespace{state_test.cpp}::check_modules </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00009.html">lutok::state</a> &amp;&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>expected</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Checks that no modules are present or that only one has been loaded. </p>
<dl class="section post"><dt>Postcondition:</dt><dd>The test case terminates if there is any module present when expected is empty or if there two modules loaded when expected is defined.</dd></dl>
<dl class="params"><dt>Parameters:</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The Lua state. </td></tr>
    <tr><td class="paramname">expected</td><td>The module to expect. Empty if no modules are allowed. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae2375a17ea66d8f5a418e88c87b2c296"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int anonymous_namespace{state_test.cpp}::cxx_divide </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00009.html">lutok::state</a> &amp;&#160;</td>
          <td class="paramname"><em>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>A custom C++ integral division function for Lua. </p>
<dl class="section pre"><dt>Precondition:</dt><dd>stack(-2) contains the dividend. </dd>
<dd>
stack(-1) contains the divisor. </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>stack(-2) contains the quotient of the division. </dd>
<dd>
stack(-1) contains the remainder of the division.</dd></dl>
<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>
<dl class="section return"><dt>Returns:</dt><dd>The number of result values, i.e. 1.</dd></dl>
<dl class="exception"><dt>Exceptions:</dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::runtime_error</td><td>If the divisor is zero. </td></tr>
    <tr><td class="paramname">std::string</td><td>If the dividend or the divisor are negative. This is an exception not derived from std::exception on purpose to ensure that the C++ wrapping correctly captures any exception regardless of its type. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a7ec33b7379b04bedb9bf6e8bcc018d5f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int anonymous_namespace{state_test.cpp}::cxx_multiply_closure </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00009.html">lutok::state</a> &amp;&#160;</td>
          <td class="paramname"><em>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>A custom C++ multiply function with one of its factors on its closure. </p>
<dl class="section pre"><dt>Precondition:</dt><dd>stack(-1) contains the second factor. </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>stack(-1) contains the product of the two input factors.</dd></dl>
<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>
<dl class="section return"><dt>Returns:</dt><dd>The number of result values, i.e. 1. </dd></dl>

</div>
</div>
<a class="anchor" id="a627b68d7ac220aba8661237b2ba4759b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool anonymous_namespace{state_test.cpp}::is_available </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00009.html">lutok::state</a> &amp;&#160;</td>
          <td class="paramname"><em>state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>symbol</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Checks if a symbol is available. </p>
<dl class="params"><dt>Parameters:</dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The Lua state. </td></tr>
    <tr><td class="paramname">symbol</td><td>The symbol to check for.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>True if the symbol is defined, false otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="ad70cc6d355abc7d6456692aaca7b0bb1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int anonymous_namespace{state_test.cpp}::raise_long_error </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00009.html">lutok::state</a> &amp;&#160;</td>
          <td class="paramname"><em>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>A Lua function that raises a very long error message. </p>
<dl class="section pre"><dt>Precondition:</dt><dd>stack(-1) contains the length of the message to construct.</dd></dl>
<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>
<dl class="section return"><dt>Returns:</dt><dd>Never returns.</dd></dl>
<dl class="exception"><dt>Exceptions:</dt><dd>
  <table class="exception">
    <tr><td class="paramname">std::runtime_error</td><td>Unconditionally, with an error message formed by the repetition of 'A' as many times as requested. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Dec 7 2013 19:02:36 for Lutok by &#160;<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>