xref: /freebsd/contrib/lutok/api-docs/html/a00029.html (revision 132f818ddbf457ee67d502cd89b5a18e0a34713d)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6<meta name="generator" content="Doxygen 1.9.6"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>Lutok: state.hpp File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16</head>
17<body>
18<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19<div id="titlearea">
20<table cellspacing="0" cellpadding="0">
21 <tbody>
22 <tr id="projectrow">
23  <td id="projectalign">
24   <div id="projectname">Lutok<span id="projectnumber">&#160;0.6.2</span>
25   </div>
26  </td>
27 </tr>
28 </tbody>
29</table>
30</div>
31<!-- end header part -->
32<!-- Generated by Doxygen 1.9.6 -->
33<script type="text/javascript">
34/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35var searchBox = new SearchBox("searchBox", "search/",'.html');
36/* @license-end */
37</script>
38<script type="text/javascript" src="menudata.js"></script>
39<script type="text/javascript" src="menu.js"></script>
40<script type="text/javascript">
41/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42$(function() {
43  initMenu('',true,false,'search.php','Search');
44  $(document).ready(function() { init_search(); });
45});
46/* @license-end */
47</script>
48<div id="main-nav"></div>
49<!-- window showing the filter options -->
50<div id="MSearchSelectWindow"
51     onmouseover="return searchBox.OnSearchSelectShow()"
52     onmouseout="return searchBox.OnSearchSelectHide()"
53     onkeydown="return searchBox.OnSearchSelectKey(event)">
54</div>
55
56<!-- iframe showing the search results (closed by default) -->
57<div id="MSearchResultsWindow">
58<div id="MSearchResults">
59<div class="SRPage">
60<div id="SRIndex">
61<div id="SRResults"></div>
62<div class="SRStatus" id="Loading">Loading...</div>
63<div class="SRStatus" id="Searching">Searching...</div>
64<div class="SRStatus" id="NoMatches">No Matches</div>
65</div>
66</div>
67</div>
68</div>
69
70</div><!-- top -->
71<div class="header">
72  <div class="summary">
73<a href="#nested-classes">Classes</a> &#124;
74<a href="#typedef-members">Typedefs</a> &#124;
75<a href="#var-members">Variables</a>  </div>
76  <div class="headertitle"><div class="title">state.hpp File Reference</div></div>
77</div><!--header-->
78<div class="contents">
79
80<p>Provides the state wrapper class for the Lua C state.
81<a href="#details">More...</a></p>
82<div class="textblock"><code>#include &lt;memory&gt;</code><br />
83<code>#include &lt;string&gt;</code><br />
84</div>
85<p><a href="a00029_source.html">Go to the source code of this file.</a></p>
86<table class="memberdecls">
87<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
88Classes</h2></td></tr>
89<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00919.html">lutok::state</a></td></tr>
90<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A RAII model for the Lua state.  <a href="a00919.html#details">More...</a><br /></td></tr>
91<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
92</table><table class="memberdecls">
93<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
94Typedefs</h2></td></tr>
95<tr class="memitem:a8c623ca426c30c5fab4df2cb21635f17"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">lutok::cxx_function</a>) (state &amp;)</td></tr>
96<tr class="memdesc:a8c623ca426c30c5fab4df2cb21635f17"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of a C++ function that can be bound into Lua.  <br /></td></tr>
97<tr class="separator:a8c623ca426c30c5fab4df2cb21635f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
98</table><table class="memberdecls">
99<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
100Variables</h2></td></tr>
101<tr class="memitem:aeca83848a196d4259e249833cd32c806"><td class="memItemLeft" align="right" valign="top"><a id="aeca83848a196d4259e249833cd32c806" name="aeca83848a196d4259e249833cd32c806"></a>
102const int&#160;</td><td class="memItemRight" valign="bottom"><b>lutok::registry_index</b> = LUA_REGISTRYINDEX</td></tr>
103<tr class="memdesc:aeca83848a196d4259e249833cd32c806"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stack index constant pointing to the registry table. <br /></td></tr>
104<tr class="separator:aeca83848a196d4259e249833cd32c806"><td class="memSeparator" colspan="2">&#160;</td></tr>
105</table>
106<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
107<div class="textblock"><p>Provides the state wrapper class for the Lua C state. </p>
108</div><h2 class="groupheader">Typedef Documentation</h2>
109<a id="a8c623ca426c30c5fab4df2cb21635f17" name="a8c623ca426c30c5fab4df2cb21635f17"></a>
110<h2 class="memtitle"><span class="permalink"><a href="#a8c623ca426c30c5fab4df2cb21635f17">&#9670;&#160;</a></span>cxx_function</h2>
111
112<div class="memitem">
113<div class="memproto">
114      <table class="memname">
115        <tr>
116          <td class="memname">typedef int(* lutok::cxx_function) (state &amp;)</td>
117        </tr>
118      </table>
119</div><div class="memdoc">
120
121<p>The type of a C++ function that can be bound into Lua. </p>
122<p>Functions of this type are free to raise exceptions. These will not propagate into the Lua C API. However, any such exceptions will be reported as a Lua error and their type will be lost. </p>
123
124</div>
125</div>
126</div><!-- contents -->
127<!-- start footer part -->
128<hr class="footer"/><address class="footer"><small>
129Generated 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
130</small></address>
131</body>
132</html>
133