xref: /freebsd/contrib/lutok/api-docs/html/a00053_source.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: exceptions.hpp Source File</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</div><!-- top -->
50<!-- window showing the filter options -->
51<div id="MSearchSelectWindow"
52     onmouseover="return searchBox.OnSearchSelectShow()"
53     onmouseout="return searchBox.OnSearchSelectHide()"
54     onkeydown="return searchBox.OnSearchSelectKey(event)">
55</div>
56
57<!-- iframe showing the search results (closed by default) -->
58<div id="MSearchResultsWindow">
59<div id="MSearchResults">
60<div class="SRPage">
61<div id="SRIndex">
62<div id="SRResults"></div>
63<div class="SRStatus" id="Loading">Loading...</div>
64<div class="SRStatus" id="Searching">Searching...</div>
65<div class="SRStatus" id="NoMatches">No Matches</div>
66</div>
67</div>
68</div>
69</div>
70
71<div class="header">
72  <div class="headertitle"><div class="title">exceptions.hpp</div></div>
73</div><!--header-->
74<div class="contents">
75<a href="a00053.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright 2011 Google Inc.</span></div>
76<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// All rights reserved.</span></div>
77<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">//</span></div>
78<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// Redistribution and use in source and binary forms, with or without</span></div>
79<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// modification, are permitted provided that the following conditions are</span></div>
80<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment">// met:</span></div>
81<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment">//</span></div>
82<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment">// * Redistributions of source code must retain the above copyright</span></div>
83<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment">//   notice, this list of conditions and the following disclaimer.</span></div>
84<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment">// * Redistributions in binary form must reproduce the above copyright</span></div>
85<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment">//   notice, this list of conditions and the following disclaimer in the</span></div>
86<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">//   documentation and/or other materials provided with the distribution.</span></div>
87<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// * Neither the name of Google Inc. nor the names of its contributors</span></div>
88<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">//   may be used to endorse or promote products derived from this software</span></div>
89<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">//   without specific prior written permission.</span></div>
90<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment">//</span></div>
91<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div>
92<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">// &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div>
93<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment">// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div>
94<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment">// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div>
95<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment">// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div>
96<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment">// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div>
97<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment">// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
98<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment">// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
99<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
100<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div>
101<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
102<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
103<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
104<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#if !defined(LUTOK_EXCEPTIONS_HPP)</span></div>
105<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#define LUTOK_EXCEPTIONS_HPP</span></div>
106<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
107<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="preprocessor">#include &lt;stdexcept&gt;</span></div>
108<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#include &lt;string&gt;</span></div>
109<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
110<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="keyword">namespace </span>lutok {</div>
111<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
112<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
113<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="keyword">class </span>state;</div>
114<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span> </div>
115<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
116<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="a00895.html">   45</a></span><span class="keyword">class </span><a class="code hl_class" href="a00895.html">error</a> : <span class="keyword">public</span> std::runtime_error {</div>
117<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="keyword">public</span>:</div>
118<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>    <span class="keyword">explicit</span> <a class="code hl_class" href="a00895.html">error</a>(<span class="keyword">const</span> std::string&amp;);</div>
119<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>    <span class="keyword">virtual</span> <a class="code hl_function" href="a00895.html#a0e8084a7eaeb9c462e9ebfe26c3c86e8">~error</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span>();</div>
120<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>};</div>
121<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span> </div>
122<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
123<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="a00899.html">   53</a></span><span class="keyword">class </span><a class="code hl_class" href="a00899.html">api_error</a> : <span class="keyword">public</span> <a class="code hl_class" href="a00895.html">error</a> {</div>
124<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="a00899.html#a947be5cc18d28f4feed48cdb8362a9f4">   55</a></span>    std::string <a class="code hl_variable" href="a00899.html#a947be5cc18d28f4feed48cdb8362a9f4">_api_function</a>;</div>
125<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
126<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="keyword">public</span>:</div>
127<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    <span class="keyword">explicit</span> <a class="code hl_class" href="a00899.html">api_error</a>(<span class="keyword">const</span> std::string&amp;, <span class="keyword">const</span> std::string&amp;);</div>
128<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    <span class="keyword">virtual</span> <a class="code hl_function" href="a00899.html#ae7072e5ca79e159f18142b967279659b">~api_error</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span>();</div>
129<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span> </div>
130<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    <span class="keyword">static</span> <a class="code hl_class" href="a00899.html">api_error</a> <a class="code hl_function" href="a00899.html#af34f12d221dbed4effb57ca541b609d5">from_stack</a>(<a class="code hl_class" href="a00919.html">state</a>&amp;, <span class="keyword">const</span> std::string&amp;);</div>
131<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
132<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="a00899.html#a69a79fd116c6ab783e40139220fad08b">api_function</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
133<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>};</div>
134<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span> </div>
135<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
136<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="a00903.html">   68</a></span><span class="keyword">class </span><a class="code hl_class" href="a00903.html">file_not_found_error</a> : <span class="keyword">public</span> <a class="code hl_class" href="a00895.html">error</a> {</div>
137<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="a00903.html#a3d0b3583063025c59481b05e2d6345ec">   70</a></span>    std::string <a class="code hl_variable" href="a00903.html#a3d0b3583063025c59481b05e2d6345ec">_filename</a>;</div>
138<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span> </div>
139<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="keyword">public</span>:</div>
140<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>    <span class="keyword">explicit</span> <a class="code hl_class" href="a00903.html">file_not_found_error</a>(<span class="keyword">const</span> std::string&amp;);</div>
141<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>    <span class="keyword">virtual</span> <a class="code hl_function" href="a00903.html#a21b0cecf0221c87e70a0fecfaf755da5">~file_not_found_error</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span>();</div>
142<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
143<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>    <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="a00903.html#a02c12b0b81aceaaf859b9eb0a5fdf376">filename</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
144<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>};</div>
145<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
146<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
147<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>}  <span class="comment">// namespace lutok</span></div>
148<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span> </div>
149<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span> </div>
150<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="preprocessor">#endif  </span><span class="comment">// !defined(LUTOK_EXCEPTIONS_HPP)</span></div>
151<div class="ttc" id="aa00895_html"><div class="ttname"><a href="a00895.html">lutok::error</a></div><div class="ttdoc">Base exception for lua errors.</div><div class="ttdef"><b>Definition:</b> exceptions.hpp:45</div></div>
152<div class="ttc" id="aa00895_html_a0e8084a7eaeb9c462e9ebfe26c3c86e8"><div class="ttname"><a href="a00895.html#a0e8084a7eaeb9c462e9ebfe26c3c86e8">lutok::error::~error</a></div><div class="ttdeci">virtual ~error(void)</div><div class="ttdoc">Destructor for the error.</div><div class="ttdef"><b>Definition:</b> exceptions.cpp:48</div></div>
153<div class="ttc" id="aa00899_html"><div class="ttname"><a href="a00899.html">lutok::api_error</a></div><div class="ttdoc">Exception for errors raised by the Lua API library.</div><div class="ttdef"><b>Definition:</b> exceptions.hpp:53</div></div>
154<div class="ttc" id="aa00899_html_a69a79fd116c6ab783e40139220fad08b"><div class="ttname"><a href="a00899.html#a69a79fd116c6ab783e40139220fad08b">lutok::api_error::api_function</a></div><div class="ttdeci">const std::string &amp; api_function(void) const</div><div class="ttdoc">Gets the name of the Lua API function that caused this error.</div><div class="ttdef"><b>Definition:</b> exceptions.cpp:96</div></div>
155<div class="ttc" id="aa00899_html_a947be5cc18d28f4feed48cdb8362a9f4"><div class="ttname"><a href="a00899.html#a947be5cc18d28f4feed48cdb8362a9f4">lutok::api_error::_api_function</a></div><div class="ttdeci">std::string _api_function</div><div class="ttdoc">Name of the Lua C API function that caused the error.</div><div class="ttdef"><b>Definition:</b> exceptions.hpp:55</div></div>
156<div class="ttc" id="aa00899_html_ae7072e5ca79e159f18142b967279659b"><div class="ttname"><a href="a00899.html#ae7072e5ca79e159f18142b967279659b">lutok::api_error::~api_error</a></div><div class="ttdeci">virtual ~api_error(void)</div><div class="ttdoc">Destructor for the error.</div><div class="ttdef"><b>Definition:</b> exceptions.cpp:66</div></div>
157<div class="ttc" id="aa00899_html_af34f12d221dbed4effb57ca541b609d5"><div class="ttname"><a href="a00899.html#af34f12d221dbed4effb57ca541b609d5">lutok::api_error::from_stack</a></div><div class="ttdeci">static api_error from_stack(state &amp;, const std::string &amp;)</div><div class="ttdoc">Constructs a new api_error with the message on the top of the Lua stack.</div><div class="ttdef"><b>Definition:</b> exceptions.cpp:81</div></div>
158<div class="ttc" id="aa00903_html"><div class="ttname"><a href="a00903.html">lutok::file_not_found_error</a></div><div class="ttdoc">File not found error.</div><div class="ttdef"><b>Definition:</b> exceptions.hpp:68</div></div>
159<div class="ttc" id="aa00903_html_a02c12b0b81aceaaf859b9eb0a5fdf376"><div class="ttname"><a href="a00903.html#a02c12b0b81aceaaf859b9eb0a5fdf376">lutok::file_not_found_error::filename</a></div><div class="ttdeci">const std::string &amp; filename(void) const</div><div class="ttdoc">Gets the name of the file that could not be found.</div><div class="ttdef"><b>Definition:</b> exceptions.cpp:123</div></div>
160<div class="ttc" id="aa00903_html_a21b0cecf0221c87e70a0fecfaf755da5"><div class="ttname"><a href="a00903.html#a21b0cecf0221c87e70a0fecfaf755da5">lutok::file_not_found_error::~file_not_found_error</a></div><div class="ttdeci">virtual ~file_not_found_error(void)</div><div class="ttdoc">Destructor for the error.</div><div class="ttdef"><b>Definition:</b> exceptions.cpp:114</div></div>
161<div class="ttc" id="aa00903_html_a3d0b3583063025c59481b05e2d6345ec"><div class="ttname"><a href="a00903.html#a3d0b3583063025c59481b05e2d6345ec">lutok::file_not_found_error::_filename</a></div><div class="ttdeci">std::string _filename</div><div class="ttdoc">Name of the not-found file.</div><div class="ttdef"><b>Definition:</b> exceptions.hpp:70</div></div>
162<div class="ttc" id="aa00919_html"><div class="ttname"><a href="a00919.html">lutok::state</a></div><div class="ttdoc">A RAII model for the Lua state.</div><div class="ttdef"><b>Definition:</b> state.hpp:71</div></div>
163</div><!-- fragment --></div><!-- contents -->
164<!-- start footer part -->
165<hr class="footer"/><address class="footer"><small>
166Generated 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
167</small></address>
168</body>
169</html>
170