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: debug.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"> 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&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&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">debug.hpp</div></div> 73</div><!--header--> 74<div class="contents"> 75<a href="a00002.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">// "AS IS" 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_DEBUG_HPP)</span></div> 105<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#define LUTOK_DEBUG_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 <string></span></div> 108<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#include <memory></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="l00054" name="l00054"></a><span class="lineno"><a class="line" href="a00891.html"> 54</a></span><span class="keyword">class </span><a class="code hl_class" href="a00891.html">debug</a> {</div> 117<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">struct </span><a class="code hl_struct" href="a00887.html">impl</a>;</div> 118<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> 119<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="a00891.html#aa75685b294f3f6e12ffaa23e16573ac3"> 58</a></span> std::shared_ptr< impl > <a class="code hl_variable" href="a00891.html#aa75685b294f3f6e12ffaa23e16573ac3">_pimpl</a>;</div> 120<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> 121<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="keyword">public</span>:</div> 122<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <a class="code hl_function" href="a00891.html#abd68d045f1c1ea1f5d7352950fd1ad86">debug</a>(<span class="keywordtype">void</span>);</div> 123<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <a class="code hl_function" href="a00891.html#a2f3852310782d662aa026f2ba7df4a43">~debug</a>(<span class="keywordtype">void</span>);</div> 124<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div> 125<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">void</span> <a class="code hl_function" href="a00891.html#a049ac2cab81fd20b60df9654d99fcc09">get_info</a>(<a class="code hl_class" href="a00919.html">state</a>&, <span class="keyword">const</span> std::string&);</div> 126<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span> <a class="code hl_function" href="a00891.html#a779a4a30c29a62a2ece2511d24adbe55">get_stack</a>(<a class="code hl_class" href="a00919.html">state</a>&, <span class="keyword">const</span> <span class="keywordtype">int</span>);</div> 127<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div> 128<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">int</span> <a class="code hl_function" href="a00891.html#a81e2a1dcccfb7efe318621b2b6ddcbf1">event</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 129<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> std::string <a class="code hl_function" href="a00891.html#a857acff0068297c280806d6c4ddba69d">name</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 130<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> std::string <a class="code hl_function" href="a00891.html#ac9459807f325ed16e7b5861d02b75989">name_what</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 131<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> std::string <a class="code hl_function" href="a00891.html#aff444cd737733563f1f7e3222275b4e6">what</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 132<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> std::string <a class="code hl_function" href="a00891.html#a46309f4def276de192340af44de76ae4">source</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 133<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">int</span> <a class="code hl_function" href="a00891.html#a58853970890ad1f217d61bcef9990409">current_line</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 134<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> <a class="code hl_function" href="a00891.html#ab66d107969517226186fa1886becbff1">n_ups</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 135<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">int</span> <a class="code hl_function" href="a00891.html#a62ecbe6f42f2e672a940fc0364bfd84e">line_defined</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 136<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">int</span> <a class="code hl_function" href="a00891.html#a227447fda9dbc159deaa1116292b064d">last_line_defined</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 137<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> std::string <a class="code hl_function" href="a00891.html#ac5dba368eb343439821834ac8e161f5e">short_src</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> 138<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>};</div> 139<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div> 140<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> 141<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>} <span class="comment">// namespace lutok</span></div> 142<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div> 143<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="preprocessor">#endif </span><span class="comment">// !defined(LUTOK_DEBUG_HPP)</span></div> 144<div class="ttc" id="aa00887_html"><div class="ttname"><a href="a00887.html">lutok::debug::impl</a></div><div class="ttdoc">Internal implementation for lutok::debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:40</div></div> 145<div class="ttc" id="aa00891_html"><div class="ttname"><a href="a00891.html">lutok::debug</a></div><div class="ttdoc">A model for the Lua debug state.</div><div class="ttdef"><b>Definition:</b> debug.hpp:54</div></div> 146<div class="ttc" id="aa00891_html_a049ac2cab81fd20b60df9654d99fcc09"><div class="ttname"><a href="a00891.html#a049ac2cab81fd20b60df9654d99fcc09">lutok::debug::get_info</a></div><div class="ttdeci">void get_info(state &, const std::string &)</div><div class="ttdoc">Wrapper around lua_getinfo.</div><div class="ttdef"><b>Definition:</b> debug.cpp:67</div></div> 147<div class="ttc" id="aa00891_html_a227447fda9dbc159deaa1116292b064d"><div class="ttname"><a href="a00891.html#a227447fda9dbc159deaa1116292b064d">lutok::debug::last_line_defined</a></div><div class="ttdeci">int last_line_defined(void) const</div><div class="ttdoc">Accessor for the 'lastlinedefined' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:178</div></div> 148<div class="ttc" id="aa00891_html_a2f3852310782d662aa026f2ba7df4a43"><div class="ttname"><a href="a00891.html#a2f3852310782d662aa026f2ba7df4a43">lutok::debug::~debug</a></div><div class="ttdeci">~debug(void)</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> debug.cpp:54</div></div> 149<div class="ttc" id="aa00891_html_a46309f4def276de192340af44de76ae4"><div class="ttname"><a href="a00891.html#a46309f4def276de192340af44de76ae4">lutok::debug::source</a></div><div class="ttdeci">std::string source(void) const</div><div class="ttdoc">Accessor for the 'source' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:136</div></div> 150<div class="ttc" id="aa00891_html_a58853970890ad1f217d61bcef9990409"><div class="ttname"><a href="a00891.html#a58853970890ad1f217d61bcef9990409">lutok::debug::current_line</a></div><div class="ttdeci">int current_line(void) const</div><div class="ttdoc">Accessor for the 'currentline' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:147</div></div> 151<div class="ttc" id="aa00891_html_a62ecbe6f42f2e672a940fc0364bfd84e"><div class="ttname"><a href="a00891.html#a62ecbe6f42f2e672a940fc0364bfd84e">lutok::debug::line_defined</a></div><div class="ttdeci">int line_defined(void) const</div><div class="ttdoc">Accessor for the 'linedefined' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:167</div></div> 152<div class="ttc" id="aa00891_html_a779a4a30c29a62a2ece2511d24adbe55"><div class="ttname"><a href="a00891.html#a779a4a30c29a62a2ece2511d24adbe55">lutok::debug::get_stack</a></div><div class="ttdeci">void get_stack(state &, const int)</div><div class="ttdoc">Wrapper around lua_getstack.</div><div class="ttdef"><b>Definition:</b> debug.cpp:81</div></div> 153<div class="ttc" id="aa00891_html_a81e2a1dcccfb7efe318621b2b6ddcbf1"><div class="ttname"><a href="a00891.html#a81e2a1dcccfb7efe318621b2b6ddcbf1">lutok::debug::event</a></div><div class="ttdeci">int event(void) const</div><div class="ttdoc">Accessor for the 'event' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:93</div></div> 154<div class="ttc" id="aa00891_html_a857acff0068297c280806d6c4ddba69d"><div class="ttname"><a href="a00891.html#a857acff0068297c280806d6c4ddba69d">lutok::debug::name</a></div><div class="ttdeci">std::string name(void) const</div><div class="ttdoc">Accessor for the 'name' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:103</div></div> 155<div class="ttc" id="aa00891_html_aa75685b294f3f6e12ffaa23e16573ac3"><div class="ttname"><a href="a00891.html#aa75685b294f3f6e12ffaa23e16573ac3">lutok::debug::_pimpl</a></div><div class="ttdeci">std::shared_ptr< impl > _pimpl</div><div class="ttdoc">Pointer to the shared internal implementation.</div><div class="ttdef"><b>Definition:</b> debug.hpp:58</div></div> 156<div class="ttc" id="aa00891_html_ab66d107969517226186fa1886becbff1"><div class="ttname"><a href="a00891.html#ab66d107969517226186fa1886becbff1">lutok::debug::n_ups</a></div><div class="ttdeci">int n_ups(void) const</div><div class="ttdoc">Accessor for the 'nups' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:157</div></div> 157<div class="ttc" id="aa00891_html_abd68d045f1c1ea1f5d7352950fd1ad86"><div class="ttname"><a href="a00891.html#abd68d045f1c1ea1f5d7352950fd1ad86">lutok::debug::debug</a></div><div class="ttdeci">debug(void)</div><div class="ttdoc">Constructor for an empty debug structure.</div><div class="ttdef"><b>Definition:</b> debug.cpp:47</div></div> 158<div class="ttc" id="aa00891_html_ac5dba368eb343439821834ac8e161f5e"><div class="ttname"><a href="a00891.html#ac5dba368eb343439821834ac8e161f5e">lutok::debug::short_src</a></div><div class="ttdeci">std::string short_src(void) const</div><div class="ttdoc">Accessor for the 'short_src' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:188</div></div> 159<div class="ttc" id="aa00891_html_ac9459807f325ed16e7b5861d02b75989"><div class="ttname"><a href="a00891.html#ac9459807f325ed16e7b5861d02b75989">lutok::debug::name_what</a></div><div class="ttdeci">std::string name_what(void) const</div><div class="ttdoc">Accessor for the 'namewhat' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:114</div></div> 160<div class="ttc" id="aa00891_html_aff444cd737733563f1f7e3222275b4e6"><div class="ttname"><a href="a00891.html#aff444cd737733563f1f7e3222275b4e6">lutok::debug::what</a></div><div class="ttdeci">std::string what(void) const</div><div class="ttdoc">Accessor for the 'what' field of lua_Debug.</div><div class="ttdef"><b>Definition:</b> debug.cpp:125</div></div> 161<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> 162</div><!-- fragment --></div><!-- contents --> 163<!-- start footer part --> 164<hr class="footer"/><address class="footer"><small> 165Generated 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 166</small></address> 167</body> 168</html> 169