<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Lutok: lutok::debug 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Lutok
 <span id="projectnumber">0.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>lutok</b></li><li class="navelem"><a class="el" href="a00003.html">debug</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">lutok::debug Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A model for the Lua debug state.
<a href="a00003.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00016_source.html">debug.hpp</a>></code></p>
<p><a href="a00041.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html">impl</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal implementation for <a class="el" href="a00003.html" title="A model for the Lua debug state.">lutok::debug</a>. <a href="a00004.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abd68d045f1c1ea1f5d7352950fd1ad86"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd68d045f1c1ea1f5d7352950fd1ad86"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#abd68d045f1c1ea1f5d7352950fd1ad86">debug</a> (void)</td></tr>
<tr class="memdesc:abd68d045f1c1ea1f5d7352950fd1ad86"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for an empty debug structure. <br/></td></tr>
<tr class="memitem:a2f3852310782d662aa026f2ba7df4a43"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f3852310782d662aa026f2ba7df4a43"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a2f3852310782d662aa026f2ba7df4a43">~debug</a> (void)</td></tr>
<tr class="memdesc:a2f3852310782d662aa026f2ba7df4a43"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr class="memitem:a049ac2cab81fd20b60df9654d99fcc09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a049ac2cab81fd20b60df9654d99fcc09">get_info</a> (<a class="el" href="a00009.html">state</a> &, const std::string &)</td></tr>
<tr class="memdesc:a049ac2cab81fd20b60df9654d99fcc09"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper around lua_getinfo. <a href="#a049ac2cab81fd20b60df9654d99fcc09"></a><br/></td></tr>
<tr class="memitem:a779a4a30c29a62a2ece2511d24adbe55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a779a4a30c29a62a2ece2511d24adbe55">get_stack</a> (<a class="el" href="a00009.html">state</a> &, const int)</td></tr>
<tr class="memdesc:a779a4a30c29a62a2ece2511d24adbe55"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper around lua_getstack. <a href="#a779a4a30c29a62a2ece2511d24adbe55"></a><br/></td></tr>
<tr class="memitem:a56fb914e0c51e35e48ce1f16555e29ef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a56fb914e0c51e35e48ce1f16555e29ef">event</a> (void) const </td></tr>
<tr class="memdesc:a56fb914e0c51e35e48ce1f16555e29ef"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'event' field of lua_Debug. <a href="#a56fb914e0c51e35e48ce1f16555e29ef"></a><br/></td></tr>
<tr class="memitem:a4f8fe092cc103845e08abe2140ef1528"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a4f8fe092cc103845e08abe2140ef1528">name</a> (void) const </td></tr>
<tr class="memdesc:a4f8fe092cc103845e08abe2140ef1528"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'name' field of lua_Debug. <a href="#a4f8fe092cc103845e08abe2140ef1528"></a><br/></td></tr>
<tr class="memitem:a63d26ad925aa7ba2f797e9da69b32413"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a63d26ad925aa7ba2f797e9da69b32413">name_what</a> (void) const </td></tr>
<tr class="memdesc:a63d26ad925aa7ba2f797e9da69b32413"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'namewhat' field of lua_Debug. <a href="#a63d26ad925aa7ba2f797e9da69b32413"></a><br/></td></tr>
<tr class="memitem:a2553b12b74f25eb1565dfdb83d67963c"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a2553b12b74f25eb1565dfdb83d67963c">what</a> (void) const </td></tr>
<tr class="memdesc:a2553b12b74f25eb1565dfdb83d67963c"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'what' field of lua_Debug. <a href="#a2553b12b74f25eb1565dfdb83d67963c"></a><br/></td></tr>
<tr class="memitem:a30439af469e3202c19b11df3d3c4136b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a30439af469e3202c19b11df3d3c4136b">source</a> (void) const </td></tr>
<tr class="memdesc:a30439af469e3202c19b11df3d3c4136b"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'source' field of lua_Debug. <a href="#a30439af469e3202c19b11df3d3c4136b"></a><br/></td></tr>
<tr class="memitem:a9587bf672568342913c5bf46c2681933"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a9587bf672568342913c5bf46c2681933">current_line</a> (void) const </td></tr>
<tr class="memdesc:a9587bf672568342913c5bf46c2681933"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'currentline' field of lua_Debug. <a href="#a9587bf672568342913c5bf46c2681933"></a><br/></td></tr>
<tr class="memitem:adb5b5aa6084c23f06bb6a65560b99e9c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#adb5b5aa6084c23f06bb6a65560b99e9c">n_ups</a> (void) const </td></tr>
<tr class="memdesc:adb5b5aa6084c23f06bb6a65560b99e9c"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'nups' field of lua_Debug. <a href="#adb5b5aa6084c23f06bb6a65560b99e9c"></a><br/></td></tr>
<tr class="memitem:aff55e4c161817a0be414b208ef9b635f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#aff55e4c161817a0be414b208ef9b635f">line_defined</a> (void) const </td></tr>
<tr class="memdesc:aff55e4c161817a0be414b208ef9b635f"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'linedefined' field of lua_Debug. <a href="#aff55e4c161817a0be414b208ef9b635f"></a><br/></td></tr>
<tr class="memitem:a1a5d725c22a87b6f2141fcf512e4d6c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a1a5d725c22a87b6f2141fcf512e4d6c2">last_line_defined</a> (void) const </td></tr>
<tr class="memdesc:a1a5d725c22a87b6f2141fcf512e4d6c2"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'lastlinedefined' field of lua_Debug. <a href="#a1a5d725c22a87b6f2141fcf512e4d6c2"></a><br/></td></tr>
<tr class="memitem:a0d56a6421ae1c5b744482b9b7457a760"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a0d56a6421ae1c5b744482b9b7457a760">short_src</a> (void) const </td></tr>
<tr class="memdesc:a0d56a6421ae1c5b744482b9b7457a760"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for the 'short_src' field of lua_Debug. <a href="#a0d56a6421ae1c5b744482b9b7457a760"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a341b50b88a10d8065c02e35d0777aa6c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a341b50b88a10d8065c02e35d0777aa6c"></a>
std::tr1::shared_ptr< <a class="el" href="a00004.html">impl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a341b50b88a10d8065c02e35d0777aa6c">_pimpl</a></td></tr>
<tr class="memdesc:a341b50b88a10d8065c02e35d0777aa6c"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the shared internal implementation. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A model for the Lua debug state. </p>
<p>This extremely-simple class provides a mechanism to hide the internals of the C native lua_Debug type, exposing its internal fields using friendlier C++ types.</p>
<p>This class also acts as a complement to the state class by exposing any state-related functions as methods of this function. For example, while it might seem that <a class="el" href="a00003.html#a049ac2cab81fd20b60df9654d99fcc09" title="Wrapper around lua_getinfo.">get_info()</a> belongs in state, we expose it from here because its result is really mutating a debug object, not the state object. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9587bf672568342913c5bf46c2681933"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lutok::debug::current_line </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'currentline' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'currentline' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="a56fb914e0c51e35e48ce1f16555e29ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lutok::debug::event </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'event' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'event' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="a049ac2cab81fd20b60df9654d99fcc09"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lutok::debug::get_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00009.html">state</a> & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>what_</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrapper around lua_getinfo. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The Lua state. </td></tr>
<tr><td class="paramname">what_</td><td>The second parameter to lua_getinfo.</td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning:</dt><dd>Terminates execution if there is not enough memory to manipulate the Lua stack. </dd></dl>
</div>
</div>
<a class="anchor" id="a779a4a30c29a62a2ece2511d24adbe55"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lutok::debug::get_stack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00009.html">state</a> & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>level</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wrapper around lua_getstack. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The Lua state. </td></tr>
<tr><td class="paramname">level</td><td>The second parameter to lua_getstack. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1a5d725c22a87b6f2141fcf512e4d6c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lutok::debug::last_line_defined </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'lastlinedefined' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'lastlinedefined' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="aff55e4c161817a0be414b208ef9b635f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lutok::debug::line_defined </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'linedefined' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'linedefined' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="adb5b5aa6084c23f06bb6a65560b99e9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int lutok::debug::n_ups </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'nups' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'nups' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="a4f8fe092cc103845e08abe2140ef1528"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string lutok::debug::name </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'name' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'name' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="a63d26ad925aa7ba2f797e9da69b32413"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string lutok::debug::name_what </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'namewhat' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'namewhat' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="a0d56a6421ae1c5b744482b9b7457a760"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string lutok::debug::short_src </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'short_src' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'short_src' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="a30439af469e3202c19b11df3d3c4136b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string lutok::debug::source </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'source' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'source' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<a class="anchor" id="a2553b12b74f25eb1565dfdb83d67963c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string lutok::debug::what </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Accessor for the 'what' field of lua_Debug. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the 'what' field of the internal lua_Debug structure. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00016_source.html">debug.hpp</a></li>
<li>debug.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Dec 7 2013 19:02:36 for Lutok by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
7bace28d5ea6c160bc0c4eb9c0a59d61
>
files
>
12
