aboutsummaryrefslogtreecommitdiff
path: root/api-docs/html/a00065.html
diff options
context:
space:
mode:
Diffstat (limited to 'api-docs/html/a00065.html')
-rw-r--r--api-docs/html/a00065.html430
1 files changed, 430 insertions, 0 deletions
diff --git a/api-docs/html/a00065.html b/api-docs/html/a00065.html
new file mode 100644
index 000000000000..984117749945
--- /dev/null
+++ b/api-docs/html/a00065.html
@@ -0,0 +1,430 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.9.6"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Lutok: anonymous_namespace{state.cpp} Namespace Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.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/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></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 id="projectrow">
+ <td id="projectalign">
+ <div id="projectname">Lutok<span id="projectnumber">&#160;0.6.2</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.6 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search/",'.html');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+/* @license-end */
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<div id="MSearchResults">
+<div class="SRPage">
+<div id="SRIndex">
+<div id="SRResults"></div>
+<div class="SRStatus" id="Loading">Loading...</div>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+</div>
+</div>
+</div>
+</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.cpp} Namespace Reference</div></div>
+</div><!--header-->
+<div class="contents">
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:ac895a6a4aab5ec5597bdfb62adf0f85c"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#ac895a6a4aab5ec5597bdfb62adf0f85c">protected_getglobal</a> (lua_State *state)</td></tr>
+<tr class="memdesc:ac895a6a4aab5ec5597bdfb62adf0f85c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_getglobal to run in a protected environment. <br /></td></tr>
+<tr class="separator:ac895a6a4aab5ec5597bdfb62adf0f85c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a901e28feef6c6a7c94edf906139464a4"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a901e28feef6c6a7c94edf906139464a4">protected_gettable</a> (lua_State *state)</td></tr>
+<tr class="memdesc:a901e28feef6c6a7c94edf906139464a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_gettable to run in a protected environment. <br /></td></tr>
+<tr class="separator:a901e28feef6c6a7c94edf906139464a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8163cc0f7d5dfba820e335e02769bd91"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a8163cc0f7d5dfba820e335e02769bd91">protected_next</a> (lua_State *state)</td></tr>
+<tr class="memdesc:a8163cc0f7d5dfba820e335e02769bd91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_next to run in a protected environment. <br /></td></tr>
+<tr class="separator:a8163cc0f7d5dfba820e335e02769bd91"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a931ec64a97c5b8ff24bd12b1318c4bf5"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a931ec64a97c5b8ff24bd12b1318c4bf5">protected_setglobal</a> (lua_State *state)</td></tr>
+<tr class="memdesc:a931ec64a97c5b8ff24bd12b1318c4bf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_setglobal to run in a protected environment. <br /></td></tr>
+<tr class="separator:a931ec64a97c5b8ff24bd12b1318c4bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a42654c15fd147850ad03cd891d1d7193"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a42654c15fd147850ad03cd891d1d7193">protected_settable</a> (lua_State *state)</td></tr>
+<tr class="memdesc:a42654c15fd147850ad03cd891d1d7193"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around lua_settable to run in a protected environment. <br /></td></tr>
+<tr class="separator:a42654c15fd147850ad03cd891d1d7193"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac12be03daffcd5d46ac51da378577e51"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#ac12be03daffcd5d46ac51da378577e51">call_cxx_function_from_c</a> (<a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">lutok::cxx_function</a> function, lua_State *raw_state) throw ()</td></tr>
+<tr class="memdesc:ac12be03daffcd5d46ac51da378577e51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls a C++ Lua function from a C calling environment. <br /></td></tr>
+<tr class="separator:ac12be03daffcd5d46ac51da378577e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a86e6a7c405a8feea00907b99c4d084ca"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a86e6a7c405a8feea00907b99c4d084ca">cxx_closure_trampoline</a> (lua_State *raw_state)</td></tr>
+<tr class="memdesc:a86e6a7c405a8feea00907b99c4d084ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lua glue to call a C++ closure. <br /></td></tr>
+<tr class="separator:a86e6a7c405a8feea00907b99c4d084ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af3c459196ed8b373a8376b5abeedd472"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#af3c459196ed8b373a8376b5abeedd472">cxx_function_trampoline</a> (lua_State *raw_state)</td></tr>
+<tr class="memdesc:af3c459196ed8b373a8376b5abeedd472"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lua glue to call a C++ function. <br /></td></tr>
+<tr class="separator:af3c459196ed8b373a8376b5abeedd472"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="ac12be03daffcd5d46ac51da378577e51" name="ac12be03daffcd5d46ac51da378577e51"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac12be03daffcd5d46ac51da378577e51">&#9670;&#160;</a></span>call_cxx_function_from_c()</h2>
+
+<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.cpp}::call_cxx_function_from_c </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="a00029.html#a8c623ca426c30c5fab4df2cb21635f17">lutok::cxx_function</a>&#160;</td>
+ <td class="paramname"><em>function</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">lua_State *&#160;</td>
+ <td class="paramname"><em>raw_state</em>&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ <tr>
+ <td align="right">throw </td><td>(</td><td colspan="2"></td>
+ </tr>
+ <tr>
+ <td align="right"></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>Calls a C++ Lua function from a C calling environment. </p>
+<p>Any errors reported by the C++ function are caught and reported to the caller as Lua errors.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">function</td><td>The C++ function to call. </td></tr>
+ <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 return values pushed onto the Lua stack by the function. </dd></dl>
+
+</div>
+</div>
+<a id="a86e6a7c405a8feea00907b99c4d084ca" name="a86e6a7c405a8feea00907b99c4d084ca"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a86e6a7c405a8feea00907b99c4d084ca">&#9670;&#160;</a></span>cxx_closure_trampoline()</h2>
+
+<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.cpp}::cxx_closure_trampoline </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>Lua glue to call a C++ closure. </p>
+<p>This Lua binding is actually a closure that we have constructed from the state.push_cxx_closure() method. The closure contains the same upvalues provided by the user plus an extra upvalue that contains the address of the C++ function we have to call. All we do here is safely delegate the execution to the wrapped C++ closure.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">raw_state</td><td>The Lua C API state.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The number of return values of the called closure. </dd></dl>
+
+</div>
+</div>
+<a id="af3c459196ed8b373a8376b5abeedd472" name="af3c459196ed8b373a8376b5abeedd472"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af3c459196ed8b373a8376b5abeedd472">&#9670;&#160;</a></span>cxx_function_trampoline()</h2>
+
+<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.cpp}::cxx_function_trampoline </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>Lua glue to call a C++ function. </p>
+<p>This Lua binding is actually a closure that we have constructed from the state.push_cxx_function() method. The closure has a single upvalue that contains the address of the C++ function we have to call. All we do here is safely delegate the execution to the wrapped C++ function.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">raw_state</td><td>The Lua C API state.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The number of return values of the called function. </dd></dl>
+
+</div>
+</div>
+<a id="ac895a6a4aab5ec5597bdfb62adf0f85c" name="ac895a6a4aab5ec5597bdfb62adf0f85c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac895a6a4aab5ec5597bdfb62adf0f85c">&#9670;&#160;</a></span>protected_getglobal()</h2>
+
+<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.cpp}::protected_getglobal </td>
+ <td>(</td>
+ <td class="paramtype">lua_State *&#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>Wrapper around lua_getglobal to run in a protected environment. </p>
+<dl class="section pre"><dt>Precondition</dt><dd>stack(-1) is the name of the global to get. </dd></dl>
+<dl class="section post"><dt>Postcondition</dt><dd>stack(-1) is the value of the global.</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">state</td><td>The Lua C API state.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The number of return values pushed onto the stack. </dd></dl>
+
+</div>
+</div>
+<a id="a901e28feef6c6a7c94edf906139464a4" name="a901e28feef6c6a7c94edf906139464a4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a901e28feef6c6a7c94edf906139464a4">&#9670;&#160;</a></span>protected_gettable()</h2>
+
+<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.cpp}::protected_gettable </td>
+ <td>(</td>
+ <td class="paramtype">lua_State *&#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>Wrapper around lua_gettable to run in a protected environment. </p>
+<dl class="section pre"><dt>Precondition</dt><dd>stack(-2) is the table to get the element from. </dd>
+<dd>
+stack(-1) is the table index. </dd></dl>
+<dl class="section post"><dt>Postcondition</dt><dd>stack(-1) is the value of stack(-2)[stack(-1)].</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">state</td><td>The Lua C API state.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The number of return values pushed onto the stack. </dd></dl>
+
+</div>
+</div>
+<a id="a8163cc0f7d5dfba820e335e02769bd91" name="a8163cc0f7d5dfba820e335e02769bd91"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8163cc0f7d5dfba820e335e02769bd91">&#9670;&#160;</a></span>protected_next()</h2>
+
+<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.cpp}::protected_next </td>
+ <td>(</td>
+ <td class="paramtype">lua_State *&#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>Wrapper around lua_next to run in a protected environment. </p>
+<dl class="section pre"><dt>Precondition</dt><dd>stack(-2) is the table to get the next element from. </dd>
+<dd>
+stack(-1) is the last processed key. </dd></dl>
+<dl class="section post"><dt>Postcondition</dt><dd>stack(-1) is the value of next(stack(-2), stack(-1)).</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">state</td><td>The Lua C API state.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The number of return values pushed onto the stack. </dd></dl>
+
+</div>
+</div>
+<a id="a931ec64a97c5b8ff24bd12b1318c4bf5" name="a931ec64a97c5b8ff24bd12b1318c4bf5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a931ec64a97c5b8ff24bd12b1318c4bf5">&#9670;&#160;</a></span>protected_setglobal()</h2>
+
+<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.cpp}::protected_setglobal </td>
+ <td>(</td>
+ <td class="paramtype">lua_State *&#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>Wrapper around lua_setglobal to run in a protected environment. </p>
+<dl class="section pre"><dt>Precondition</dt><dd>stack(-2) is the name of the global to set. </dd>
+<dd>
+stack(-1) is the value to set the global to.</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">state</td><td>The Lua C API state.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The number of return values pushed onto the stack. </dd></dl>
+
+</div>
+</div>
+<a id="a42654c15fd147850ad03cd891d1d7193" name="a42654c15fd147850ad03cd891d1d7193"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a42654c15fd147850ad03cd891d1d7193">&#9670;&#160;</a></span>protected_settable()</h2>
+
+<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.cpp}::protected_settable </td>
+ <td>(</td>
+ <td class="paramtype">lua_State *&#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>Wrapper around lua_settable to run in a protected environment. </p>
+<dl class="section pre"><dt>Precondition</dt><dd>stack(-3) is the table to set the element into. </dd>
+<dd>
+stack(-2) is the table index. </dd>
+<dd>
+stack(-1) is the value to set.</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">state</td><td>The Lua C API state.</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The number of return values pushed onto the stack. </dd></dl>
+
+</div>
+</div>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated 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
+</small></address>
+</body>
+</html>