xref: /freebsd/contrib/lutok/api-docs/html/a00899.html (revision 132f818ddbf457ee67d502cd89b5a18e0a34713d) 
1*132f818dSEnji Cooper<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2*132f818dSEnji Cooper<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3*132f818dSEnji Cooper<head>
4*132f818dSEnji Cooper<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5*132f818dSEnji Cooper<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6*132f818dSEnji Cooper<meta name="generator" content="Doxygen 1.9.6"/>
7*132f818dSEnji Cooper<meta name="viewport" content="width=device-width, initial-scale=1"/>
8*132f818dSEnji Cooper<title>Lutok: lutok::api_error Class Reference</title>
9*132f818dSEnji Cooper<link href="tabs.css" rel="stylesheet" type="text/css"/>
10*132f818dSEnji Cooper<script type="text/javascript" src="jquery.js"></script>
11*132f818dSEnji Cooper<script type="text/javascript" src="dynsections.js"></script>
12*132f818dSEnji Cooper<link href="search/search.css" rel="stylesheet" type="text/css"/>
13*132f818dSEnji Cooper<script type="text/javascript" src="search/searchdata.js"></script>
14*132f818dSEnji Cooper<script type="text/javascript" src="search/search.js"></script>
15*132f818dSEnji Cooper<link href="doxygen.css" rel="stylesheet" type="text/css" />
16*132f818dSEnji Cooper</head>
17*132f818dSEnji Cooper<body>
18*132f818dSEnji Cooper<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19*132f818dSEnji Cooper<div id="titlearea">
20*132f818dSEnji Cooper<table cellspacing="0" cellpadding="0">
21*132f818dSEnji Cooper <tbody>
22*132f818dSEnji Cooper <tr id="projectrow">
23*132f818dSEnji Cooper  <td id="projectalign">
24*132f818dSEnji Cooper   <div id="projectname">Lutok<span id="projectnumber">&#160;0.6.2</span>
25*132f818dSEnji Cooper   </div>
26*132f818dSEnji Cooper  </td>
27*132f818dSEnji Cooper </tr>
28*132f818dSEnji Cooper </tbody>
29*132f818dSEnji Cooper</table>
30*132f818dSEnji Cooper</div>
31*132f818dSEnji Cooper<!-- end header part -->
32*132f818dSEnji Cooper<!-- Generated by Doxygen 1.9.6 -->
33*132f818dSEnji Cooper<script type="text/javascript">
34*132f818dSEnji Cooper/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35*132f818dSEnji Coopervar searchBox = new SearchBox("searchBox", "search/",'.html');
36*132f818dSEnji Cooper/* @license-end */
37*132f818dSEnji Cooper</script>
38*132f818dSEnji Cooper<script type="text/javascript" src="menudata.js"></script>
39*132f818dSEnji Cooper<script type="text/javascript" src="menu.js"></script>
40*132f818dSEnji Cooper<script type="text/javascript">
41*132f818dSEnji Cooper/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
42*132f818dSEnji Cooper$(function() {
43*132f818dSEnji Cooper  initMenu('',true,false,'search.php','Search');
44*132f818dSEnji Cooper  $(document).ready(function() { init_search(); });
45*132f818dSEnji Cooper});
46*132f818dSEnji Cooper/* @license-end */
47*132f818dSEnji Cooper</script>
48*132f818dSEnji Cooper<div id="main-nav"></div>
49*132f818dSEnji Cooper<!-- window showing the filter options -->
50*132f818dSEnji Cooper<div id="MSearchSelectWindow"
51*132f818dSEnji Cooper     onmouseover="return searchBox.OnSearchSelectShow()"
52*132f818dSEnji Cooper     onmouseout="return searchBox.OnSearchSelectHide()"
53*132f818dSEnji Cooper     onkeydown="return searchBox.OnSearchSelectKey(event)">
54*132f818dSEnji Cooper</div>
55*132f818dSEnji Cooper
56*132f818dSEnji Cooper<!-- iframe showing the search results (closed by default) -->
57*132f818dSEnji Cooper<div id="MSearchResultsWindow">
58*132f818dSEnji Cooper<div id="MSearchResults">
59*132f818dSEnji Cooper<div class="SRPage">
60*132f818dSEnji Cooper<div id="SRIndex">
61*132f818dSEnji Cooper<div id="SRResults"></div>
62*132f818dSEnji Cooper<div class="SRStatus" id="Loading">Loading...</div>
63*132f818dSEnji Cooper<div class="SRStatus" id="Searching">Searching...</div>
64*132f818dSEnji Cooper<div class="SRStatus" id="NoMatches">No Matches</div>
65*132f818dSEnji Cooper</div>
66*132f818dSEnji Cooper</div>
67*132f818dSEnji Cooper</div>
68*132f818dSEnji Cooper</div>
69*132f818dSEnji Cooper
70*132f818dSEnji Cooper<div id="nav-path" class="navpath">
71*132f818dSEnji Cooper  <ul>
72*132f818dSEnji Cooper<li class="navelem"><b>lutok</b></li><li class="navelem"><a class="el" href="a00899.html">api_error</a></li>  </ul>
73*132f818dSEnji Cooper</div>
74*132f818dSEnji Cooper</div><!-- top -->
75*132f818dSEnji Cooper<div class="header">
76*132f818dSEnji Cooper  <div class="summary">
77*132f818dSEnji Cooper<a href="#pub-methods">Public Member Functions</a> &#124;
78*132f818dSEnji Cooper<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
79*132f818dSEnji Cooper<a href="#pri-attribs">Private Attributes</a> &#124;
80*132f818dSEnji Cooper<a href="a00896.html">List of all members</a>  </div>
81*132f818dSEnji Cooper  <div class="headertitle"><div class="title">lutok::api_error Class Reference</div></div>
82*132f818dSEnji Cooper</div><!--header-->
83*132f818dSEnji Cooper<div class="contents">
84*132f818dSEnji Cooper
85*132f818dSEnji Cooper<p>Exception for errors raised by the Lua API library.
86*132f818dSEnji Cooper <a href="a00899.html#details">More...</a></p>
87*132f818dSEnji Cooper
88*132f818dSEnji Cooper<p><code>#include &lt;<a class="el" href="a00053_source.html">exceptions.hpp</a>&gt;</code></p>
89*132f818dSEnji Cooper<div class="dynheader">
90*132f818dSEnji CooperInheritance diagram for lutok::api_error:</div>
91*132f818dSEnji Cooper<div class="dyncontent">
92*132f818dSEnji Cooper <div class="center">
93*132f818dSEnji Cooper  <img src="a00899.png" usemap="#lutok::api_5Ferror_map" alt=""/>
94*132f818dSEnji Cooper  <map id="lutok::api_5Ferror_map" name="lutok::api_5Ferror_map">
95*132f818dSEnji Cooper<area href="a00895.html" title="Base exception for lua errors." alt="lutok::error" shape="rect" coords="0,112,111,136"/>
96*132f818dSEnji Cooper  </map>
97*132f818dSEnji Cooper</div></div>
98*132f818dSEnji Cooper<table class="memberdecls">
99*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
100*132f818dSEnji CooperPublic Member Functions</h2></td></tr>
101*132f818dSEnji Cooper<tr class="memitem:aa751d87577c1b62a6aa91b183e5f00d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00899.html#aa751d87577c1b62a6aa91b183e5f00d0">api_error</a> (const std::string &amp;, const std::string &amp;)</td></tr>
102*132f818dSEnji Cooper<tr class="memdesc:aa751d87577c1b62a6aa91b183e5f00d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new error.  <br /></td></tr>
103*132f818dSEnji Cooper<tr class="separator:aa751d87577c1b62a6aa91b183e5f00d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
104*132f818dSEnji Cooper<tr class="memitem:ae7072e5ca79e159f18142b967279659b"><td class="memItemLeft" align="right" valign="top"><a id="ae7072e5ca79e159f18142b967279659b" name="ae7072e5ca79e159f18142b967279659b"></a>
105*132f818dSEnji Coopervirtual&#160;</td><td class="memItemRight" valign="bottom"><b>~api_error</b> (void)  throw ()</td></tr>
106*132f818dSEnji Cooper<tr class="memdesc:ae7072e5ca79e159f18142b967279659b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor for the error. <br /></td></tr>
107*132f818dSEnji Cooper<tr class="separator:ae7072e5ca79e159f18142b967279659b"><td class="memSeparator" colspan="2">&#160;</td></tr>
108*132f818dSEnji Cooper<tr class="memitem:a69a79fd116c6ab783e40139220fad08b"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00899.html#a69a79fd116c6ab783e40139220fad08b">api_function</a> (void) const</td></tr>
109*132f818dSEnji Cooper<tr class="memdesc:a69a79fd116c6ab783e40139220fad08b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of the Lua API function that caused this error.  <br /></td></tr>
110*132f818dSEnji Cooper<tr class="separator:a69a79fd116c6ab783e40139220fad08b"><td class="memSeparator" colspan="2">&#160;</td></tr>
111*132f818dSEnji Cooper<tr class="inherit_header pub_methods_a00895"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00895')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="a00895.html">lutok::error</a></td></tr>
112*132f818dSEnji Cooper<tr class="memitem:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00895"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00895.html#a0c0a2ad18088fcafc0ca2a3b61ac5e00">error</a> (const std::string &amp;)</td></tr>
113*132f818dSEnji Cooper<tr class="memdesc:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00895"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new error with a plain-text message.  <br /></td></tr>
114*132f818dSEnji Cooper<tr class="separator:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00895"><td class="memSeparator" colspan="2">&#160;</td></tr>
115*132f818dSEnji Cooper<tr class="memitem:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00895"><td class="memItemLeft" align="right" valign="top"><a id="a0e8084a7eaeb9c462e9ebfe26c3c86e8" name="a0e8084a7eaeb9c462e9ebfe26c3c86e8"></a>
116*132f818dSEnji Coopervirtual&#160;</td><td class="memItemRight" valign="bottom"><b>~error</b> (void)  throw ()</td></tr>
117*132f818dSEnji Cooper<tr class="memdesc:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00895"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor for the error. <br /></td></tr>
118*132f818dSEnji Cooper<tr class="separator:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00895"><td class="memSeparator" colspan="2">&#160;</td></tr>
119*132f818dSEnji Cooper</table><table class="memberdecls">
120*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
121*132f818dSEnji CooperStatic Public Member Functions</h2></td></tr>
122*132f818dSEnji Cooper<tr class="memitem:af34f12d221dbed4effb57ca541b609d5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00899.html">api_error</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00899.html#af34f12d221dbed4effb57ca541b609d5">from_stack</a> (<a class="el" href="a00919.html">state</a> &amp;, const std::string &amp;)</td></tr>
123*132f818dSEnji Cooper<tr class="memdesc:af34f12d221dbed4effb57ca541b609d5"><td class="mdescLeft">&#160;</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>
124*132f818dSEnji Cooper<tr class="separator:af34f12d221dbed4effb57ca541b609d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
125*132f818dSEnji Cooper</table><table class="memberdecls">
126*132f818dSEnji Cooper<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
127*132f818dSEnji CooperPrivate Attributes</h2></td></tr>
128*132f818dSEnji Cooper<tr class="memitem:a947be5cc18d28f4feed48cdb8362a9f4"><td class="memItemLeft" align="right" valign="top"><a id="a947be5cc18d28f4feed48cdb8362a9f4" name="a947be5cc18d28f4feed48cdb8362a9f4"></a>
129*132f818dSEnji Cooperstd::string&#160;</td><td class="memItemRight" valign="bottom"><b>_api_function</b></td></tr>
130*132f818dSEnji Cooper<tr class="memdesc:a947be5cc18d28f4feed48cdb8362a9f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the Lua C API function that caused the error. <br /></td></tr>
131*132f818dSEnji Cooper<tr class="separator:a947be5cc18d28f4feed48cdb8362a9f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
132*132f818dSEnji Cooper</table>
133*132f818dSEnji Cooper<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
134*132f818dSEnji Cooper<div class="textblock"><p>Exception for errors raised by the Lua API library. </p>
135*132f818dSEnji Cooper</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
136*132f818dSEnji Cooper<a id="aa751d87577c1b62a6aa91b183e5f00d0" name="aa751d87577c1b62a6aa91b183e5f00d0"></a>
137*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#aa751d87577c1b62a6aa91b183e5f00d0">&#9670;&#160;</a></span>api_error()</h2>
138*132f818dSEnji Cooper
139*132f818dSEnji Cooper<div class="memitem">
140*132f818dSEnji Cooper<div class="memproto">
141*132f818dSEnji Cooper<table class="mlabels">
142*132f818dSEnji Cooper  <tr>
143*132f818dSEnji Cooper  <td class="mlabels-left">
144*132f818dSEnji Cooper      <table class="memname">
145*132f818dSEnji Cooper        <tr>
146*132f818dSEnji Cooper          <td class="memname">lutok::api_error::api_error </td>
147*132f818dSEnji Cooper          <td>(</td>
148*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
149*132f818dSEnji Cooper          <td class="paramname"><em>api_function_</em>, </td>
150*132f818dSEnji Cooper        </tr>
151*132f818dSEnji Cooper        <tr>
152*132f818dSEnji Cooper          <td class="paramkey"></td>
153*132f818dSEnji Cooper          <td></td>
154*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
155*132f818dSEnji Cooper          <td class="paramname"><em>message</em>&#160;</td>
156*132f818dSEnji Cooper        </tr>
157*132f818dSEnji Cooper        <tr>
158*132f818dSEnji Cooper          <td></td>
159*132f818dSEnji Cooper          <td>)</td>
160*132f818dSEnji Cooper          <td></td><td></td>
161*132f818dSEnji Cooper        </tr>
162*132f818dSEnji Cooper      </table>
163*132f818dSEnji Cooper  </td>
164*132f818dSEnji Cooper  <td class="mlabels-right">
165*132f818dSEnji Cooper<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
166*132f818dSEnji Cooper  </tr>
167*132f818dSEnji Cooper</table>
168*132f818dSEnji Cooper</div><div class="memdoc">
169*132f818dSEnji Cooper
170*132f818dSEnji Cooper<p>Constructs a new error. </p>
171*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
172*132f818dSEnji Cooper  <table class="params">
173*132f818dSEnji Cooper    <tr><td class="paramname">api_function_</td><td>The name of the API function that caused the error. </td></tr>
174*132f818dSEnji Cooper    <tr><td class="paramname">message</td><td>The plain-text error message provided by Lua. </td></tr>
175*132f818dSEnji Cooper  </table>
176*132f818dSEnji Cooper  </dd>
177*132f818dSEnji Cooper</dl>
178*132f818dSEnji Cooper
179*132f818dSEnji Cooper</div>
180*132f818dSEnji Cooper</div>
181*132f818dSEnji Cooper<h2 class="groupheader">Member Function Documentation</h2>
182*132f818dSEnji Cooper<a id="a69a79fd116c6ab783e40139220fad08b" name="a69a79fd116c6ab783e40139220fad08b"></a>
183*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#a69a79fd116c6ab783e40139220fad08b">&#9670;&#160;</a></span>api_function()</h2>
184*132f818dSEnji Cooper
185*132f818dSEnji Cooper<div class="memitem">
186*132f818dSEnji Cooper<div class="memproto">
187*132f818dSEnji Cooper      <table class="memname">
188*132f818dSEnji Cooper        <tr>
189*132f818dSEnji Cooper          <td class="memname">const std::string &amp; lutok::api_error::api_function </td>
190*132f818dSEnji Cooper          <td>(</td>
191*132f818dSEnji Cooper          <td class="paramtype">void&#160;</td>
192*132f818dSEnji Cooper          <td class="paramname"></td><td>)</td>
193*132f818dSEnji Cooper          <td> const</td>
194*132f818dSEnji Cooper        </tr>
195*132f818dSEnji Cooper      </table>
196*132f818dSEnji Cooper</div><div class="memdoc">
197*132f818dSEnji Cooper
198*132f818dSEnji Cooper<p>Gets the name of the Lua API function that caused this error. </p>
199*132f818dSEnji Cooper<dl class="section return"><dt>Returns</dt><dd>The name of the function. </dd></dl>
200*132f818dSEnji Cooper
201*132f818dSEnji Cooper</div>
202*132f818dSEnji Cooper</div>
203*132f818dSEnji Cooper<a id="af34f12d221dbed4effb57ca541b609d5" name="af34f12d221dbed4effb57ca541b609d5"></a>
204*132f818dSEnji Cooper<h2 class="memtitle"><span class="permalink"><a href="#af34f12d221dbed4effb57ca541b609d5">&#9670;&#160;</a></span>from_stack()</h2>
205*132f818dSEnji Cooper
206*132f818dSEnji Cooper<div class="memitem">
207*132f818dSEnji Cooper<div class="memproto">
208*132f818dSEnji Cooper<table class="mlabels">
209*132f818dSEnji Cooper  <tr>
210*132f818dSEnji Cooper  <td class="mlabels-left">
211*132f818dSEnji Cooper      <table class="memname">
212*132f818dSEnji Cooper        <tr>
213*132f818dSEnji Cooper          <td class="memname"><a class="el" href="a00899.html">lutok::api_error</a> lutok::api_error::from_stack </td>
214*132f818dSEnji Cooper          <td>(</td>
215*132f818dSEnji Cooper          <td class="paramtype"><a class="el" href="a00919.html">state</a> &amp;&#160;</td>
216*132f818dSEnji Cooper          <td class="paramname"><em>state_</em>, </td>
217*132f818dSEnji Cooper        </tr>
218*132f818dSEnji Cooper        <tr>
219*132f818dSEnji Cooper          <td class="paramkey"></td>
220*132f818dSEnji Cooper          <td></td>
221*132f818dSEnji Cooper          <td class="paramtype">const std::string &amp;&#160;</td>
222*132f818dSEnji Cooper          <td class="paramname"><em>api_function_</em>&#160;</td>
223*132f818dSEnji Cooper        </tr>
224*132f818dSEnji Cooper        <tr>
225*132f818dSEnji Cooper          <td></td>
226*132f818dSEnji Cooper          <td>)</td>
227*132f818dSEnji Cooper          <td></td><td></td>
228*132f818dSEnji Cooper        </tr>
229*132f818dSEnji Cooper      </table>
230*132f818dSEnji Cooper  </td>
231*132f818dSEnji Cooper  <td class="mlabels-right">
232*132f818dSEnji Cooper<span class="mlabels"><span class="mlabel">static</span></span>  </td>
233*132f818dSEnji Cooper  </tr>
234*132f818dSEnji Cooper</table>
235*132f818dSEnji Cooper</div><div class="memdoc">
236*132f818dSEnji Cooper
237*132f818dSEnji Cooper<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>
238*132f818dSEnji Cooper<dl class="section pre"><dt>Precondition</dt><dd>There is an error message on the top of the stack. </dd></dl>
239*132f818dSEnji Cooper<dl class="section post"><dt>Postcondition</dt><dd>The error message is popped from the stack.</dd></dl>
240*132f818dSEnji Cooper<dl class="params"><dt>Parameters</dt><dd>
241*132f818dSEnji Cooper  <table class="params">
242*132f818dSEnji Cooper    <tr><td class="paramname">state_</td><td>The Lua state. </td></tr>
243*132f818dSEnji Cooper    <tr><td class="paramname">api_function_</td><td>The name of the Lua API function that caused the error.</td></tr>
244*132f818dSEnji Cooper  </table>
245*132f818dSEnji Cooper  </dd>
246*132f818dSEnji Cooper</dl>
247*132f818dSEnji Cooper<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>
248*132f818dSEnji Cooper
249*132f818dSEnji Cooper</div>
250*132f818dSEnji Cooper</div>
251*132f818dSEnji Cooper<hr/>The documentation for this class was generated from the following files:<ul>
252*132f818dSEnji Cooper<li><a class="el" href="a00053_source.html">exceptions.hpp</a></li>
253*132f818dSEnji Cooper<li>exceptions.cpp</li>
254*132f818dSEnji Cooper</ul>
255*132f818dSEnji Cooper</div><!-- contents -->
256*132f818dSEnji Cooper<!-- start footer part -->
257*132f818dSEnji Cooper<hr class="footer"/><address class="footer"><small>
258*132f818dSEnji CooperGenerated 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
259*132f818dSEnji Cooper</small></address>
260*132f818dSEnji Cooper</body>
261*132f818dSEnji Cooper</html>
262