XQuilla/docs/simple-api/classDebugCommand.html
2020-02-17 22:24:47 +01:00

426 lines
17 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classDebugCommand-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">DebugCommand Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="InteractiveDebugger_8hpp_source.html">InteractiveDebugger.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad07a49db928df23787896d42ac47d887"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#ad07a49db928df23787896d42ac47d887">~DebugCommand</a> ()</td></tr>
<tr class="separator:ad07a49db928df23787896d42ac47d887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43c359a17520d2e61af858d9c10715e5"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a43c359a17520d2e61af858d9c10715e5">getCommandName</a> () const </td></tr>
<tr class="separator:a43c359a17520d2e61af858d9c10715e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90b011b697c3b5c6f79f90305d923616"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a90b011b697c3b5c6f79f90305d923616">getCommandNameCompat</a> () const </td></tr>
<tr class="separator:a90b011b697c3b5c6f79f90305d923616"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ba5db9560ea93edc62853f65310804d"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a7ba5db9560ea93edc62853f65310804d">getBriefHelp</a> () const </td></tr>
<tr class="separator:a7ba5db9560ea93edc62853f65310804d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae099b5254c6f63b23cf9da34c0eb94de"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#ae099b5254c6f63b23cf9da34c0eb94de">getMoreHelp</a> () const </td></tr>
<tr class="separator:ae099b5254c6f63b23cf9da34c0eb94de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bbc5ae9a0d0e3a56fe4037cdcce9ae3"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a0bbc5ae9a0d0e3a56fe4037cdcce9ae3">matches</a> (const std::string &amp;command) const </td></tr>
<tr class="separator:a0bbc5ae9a0d0e3a56fe4037cdcce9ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25569d891bf8bc19dae08e75d84479da"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a25569d891bf8bc19dae08e75d84479da">execute</a> (<a class="el" href="classInputParser.html#a6d3311fbf25b5902702cd905cff59672">InputParser::Args</a> &amp;args, <a class="el" href="classBaseInteractiveDebugger.html">BaseInteractiveDebugger</a> &amp;env)=0</td></tr>
<tr class="separator:a25569d891bf8bc19dae08e75d84479da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a59106d99e9e88eedc327753eaf5330db"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a59106d99e9e88eedc327753eaf5330db">matches</a> (const std::string &amp;command, const std::string &amp;toMatch)</td></tr>
<tr class="separator:a59106d99e9e88eedc327753eaf5330db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab7642a08f9a39b02361518be2979fc16"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#ab7642a08f9a39b02361518be2979fc16">DebugCommand</a> (const char *name, const char *compatName, const char *briefHelp, const char *moreHelp)</td></tr>
<tr class="separator:ab7642a08f9a39b02361518be2979fc16"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a28622fcede660e8ef7f5ce763fcb3ed1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a28622fcede660e8ef7f5ce763fcb3ed1">name_</a></td></tr>
<tr class="separator:a28622fcede660e8ef7f5ce763fcb3ed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7930da08aa4f8506c7674bee5f2072d2"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a7930da08aa4f8506c7674bee5f2072d2">compatName_</a></td></tr>
<tr class="separator:a7930da08aa4f8506c7674bee5f2072d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf198f65b4397fc14275629b8505cdae"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#acf198f65b4397fc14275629b8505cdae">briefHelp_</a></td></tr>
<tr class="separator:acf198f65b4397fc14275629b8505cdae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a777bd7a506e4632b2e7e8561de796613"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDebugCommand.html#a777bd7a506e4632b2e7e8561de796613">moreHelp_</a></td></tr>
<tr class="separator:a777bd7a506e4632b2e7e8561de796613"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad07a49db928df23787896d42ac47d887"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual DebugCommand::~DebugCommand </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab7642a08f9a39b02361518be2979fc16"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DebugCommand::DebugCommand </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>compatName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>briefHelp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>moreHelp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a25569d891bf8bc19dae08e75d84479da"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void DebugCommand::execute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classInputParser.html#a6d3311fbf25b5902702cd905cff59672">InputParser::Args</a> &amp;&#160;</td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBaseInteractiveDebugger.html">BaseInteractiveDebugger</a> &amp;&#160;</td>
<td class="paramname"><em>env</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7ba5db9560ea93edc62853f65310804d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* DebugCommand::getBriefHelp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a43c359a17520d2e61af858d9c10715e5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* DebugCommand::getCommandName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a90b011b697c3b5c6f79f90305d923616"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* DebugCommand::getCommandNameCompat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae099b5254c6f63b23cf9da34c0eb94de"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* DebugCommand::getMoreHelp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a59106d99e9e88eedc327753eaf5330db"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool DebugCommand::matches </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>toMatch</em>&#160;</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">
</div>
</div>
<a class="anchor" id="a0bbc5ae9a0d0e3a56fe4037cdcce9ae3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool DebugCommand::matches </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>command</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="acf198f65b4397fc14275629b8505cdae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* DebugCommand::briefHelp_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7930da08aa4f8506c7674bee5f2072d2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* DebugCommand::compatName_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a777bd7a506e4632b2e7e8561de796613"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* DebugCommand::moreHelp_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a28622fcede660e8ef7f5ce763fcb3ed1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* DebugCommand::name_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="InteractiveDebugger_8hpp_source.html">InteractiveDebugger.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>