diff options
Diffstat (limited to 'api-docs/html/a00899.html')
| -rw-r--r-- | api-docs/html/a00899.html | 261 |
1 files changed, 261 insertions, 0 deletions
diff --git a/api-docs/html/a00899.html b/api-docs/html/a00899.html new file mode 100644 index 000000000000..425e938c8ff3 --- /dev/null +++ b/api-docs/html/a00899.html @@ -0,0 +1,261 @@ +<!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: lutok::api_error Class 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"> 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&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&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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><b>lutok</b></li><li class="navelem"><a class="el" href="a00899.html">api_error</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> | +<a href="a00896.html">List of all members</a> </div> + <div class="headertitle"><div class="title">lutok::api_error Class Reference</div></div> +</div><!--header--> +<div class="contents"> + +<p>Exception for errors raised by the Lua API library. + <a href="a00899.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="a00053_source.html">exceptions.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for lutok::api_error:</div> +<div class="dyncontent"> + <div class="center"> + <img src="a00899.png" usemap="#lutok::api_5Ferror_map" alt=""/> + <map id="lutok::api_5Ferror_map" name="lutok::api_5Ferror_map"> +<area href="a00895.html" title="Base exception for lua errors." alt="lutok::error" shape="rect" coords="0,112,111,136"/> + </map> +</div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:aa751d87577c1b62a6aa91b183e5f00d0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00899.html#aa751d87577c1b62a6aa91b183e5f00d0">api_error</a> (const std::string &, const std::string &)</td></tr> +<tr class="memdesc:aa751d87577c1b62a6aa91b183e5f00d0"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new error. <br /></td></tr> +<tr class="separator:aa751d87577c1b62a6aa91b183e5f00d0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae7072e5ca79e159f18142b967279659b"><td class="memItemLeft" align="right" valign="top"><a id="ae7072e5ca79e159f18142b967279659b" name="ae7072e5ca79e159f18142b967279659b"></a> +virtual </td><td class="memItemRight" valign="bottom"><b>~api_error</b> (void) throw ()</td></tr> +<tr class="memdesc:ae7072e5ca79e159f18142b967279659b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the error. <br /></td></tr> +<tr class="separator:ae7072e5ca79e159f18142b967279659b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a69a79fd116c6ab783e40139220fad08b"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00899.html#a69a79fd116c6ab783e40139220fad08b">api_function</a> (void) const</td></tr> +<tr class="memdesc:a69a79fd116c6ab783e40139220fad08b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the Lua API function that caused this error. <br /></td></tr> +<tr class="separator:a69a79fd116c6ab783e40139220fad08b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_a00895"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00895')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00895.html">lutok::error</a></td></tr> +<tr class="memitem:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00895"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00895.html#a0c0a2ad18088fcafc0ca2a3b61ac5e00">error</a> (const std::string &)</td></tr> +<tr class="memdesc:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00895"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new error with a plain-text message. <br /></td></tr> +<tr class="separator:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00895"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00895"><td class="memItemLeft" align="right" valign="top"><a id="a0e8084a7eaeb9c462e9ebfe26c3c86e8" name="a0e8084a7eaeb9c462e9ebfe26c3c86e8"></a> +virtual </td><td class="memItemRight" valign="bottom"><b>~error</b> (void) throw ()</td></tr> +<tr class="memdesc:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00895"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the error. <br /></td></tr> +<tr class="separator:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00895"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:af34f12d221dbed4effb57ca541b609d5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00899.html">api_error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00899.html#af34f12d221dbed4effb57ca541b609d5">from_stack</a> (<a class="el" href="a00919.html">state</a> &, const std::string &)</td></tr> +<tr class="memdesc:af34f12d221dbed4effb57ca541b609d5"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a> with the message on the top of the Lua stack. <br /></td></tr> +<tr class="separator:af34f12d221dbed4effb57ca541b609d5"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr class="memitem:a947be5cc18d28f4feed48cdb8362a9f4"><td class="memItemLeft" align="right" valign="top"><a id="a947be5cc18d28f4feed48cdb8362a9f4" name="a947be5cc18d28f4feed48cdb8362a9f4"></a> +std::string </td><td class="memItemRight" valign="bottom"><b>_api_function</b></td></tr> +<tr class="memdesc:a947be5cc18d28f4feed48cdb8362a9f4"><td class="mdescLeft"> </td><td class="mdescRight">Name of the Lua C API function that caused the error. <br /></td></tr> +<tr class="separator:a947be5cc18d28f4feed48cdb8362a9f4"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Exception for errors raised by the Lua API library. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="aa751d87577c1b62a6aa91b183e5f00d0" name="aa751d87577c1b62a6aa91b183e5f00d0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa751d87577c1b62a6aa91b183e5f00d0">◆ </a></span>api_error()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">lutok::api_error::api_error </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>api_function_</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>message</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Constructs a new error. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">api_function_</td><td>The name of the API function that caused the error. </td></tr> + <tr><td class="paramname">message</td><td>The plain-text error message provided by Lua. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a69a79fd116c6ab783e40139220fad08b" name="a69a79fd116c6ab783e40139220fad08b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a69a79fd116c6ab783e40139220fad08b">◆ </a></span>api_function()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const std::string & lutok::api_error::api_function </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Gets the name of the Lua API function that caused this error. </p> +<dl class="section return"><dt>Returns</dt><dd>The name of the function. </dd></dl> + +</div> +</div> +<a id="af34f12d221dbed4effb57ca541b609d5" name="af34f12d221dbed4effb57ca541b609d5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af34f12d221dbed4effb57ca541b609d5">◆ </a></span>from_stack()</h2> + +<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="a00899.html">lutok::api_error</a> lutok::api_error::from_stack </td> + <td>(</td> + <td class="paramtype"><a class="el" href="a00919.html">state</a> & </td> + <td class="paramname"><em>state_</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>api_function_</em> </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>Constructs a new <a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a> with the message on the top of the Lua stack. </p> +<dl class="section pre"><dt>Precondition</dt><dd>There is an error message on the top of the stack. </dd></dl> +<dl class="section post"><dt>Postcondition</dt><dd>The error message is popped from the stack.</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">api_function_</td><td>The name of the Lua API function that caused the error.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="a00899.html" title="Exception for errors raised by the Lua API library.">api_error</a> with the popped message. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a00053_source.html">exceptions.hpp</a></li> +<li>exceptions.cpp</li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <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> |