blob: 3fb021a8130b89277c8c5a8fc308d15a32a9743e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="keywords" content="LLDB,C++,doxygen,API,documentation"/>
<meta name="description" content="C++ source code API documentation for LLDB."/>
<title>LLVM: lldb::SBCommand Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head><body>
<p class="title">LLDB API Documentation</p>
<!-- Generated by Doxygen 1.8.6 -->
<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>
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelldb.html">lldb</a></li><li class="navelem"><a class="el" href="classlldb_1_1SBCommand.html">SBCommand</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classlldb_1_1SBCommand-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lldb::SBCommand Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="SBCommandInterpreter_8h_source.html">SBCommandInterpreter.h</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:ad209ed91e4e3e5ce68226039e8956d51"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#ad209ed91e4e3e5ce68226039e8956d51">SBCommand</a> ()</td></tr>
<tr class="separator:ad209ed91e4e3e5ce68226039e8956d51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8faadbdf8b1a60b6b48001e851696861"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#a8faadbdf8b1a60b6b48001e851696861">IsValid</a> ()</td></tr>
<tr class="separator:a8faadbdf8b1a60b6b48001e851696861"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b87c14d8da57a2af13854772d7bb7cb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#a2b87c14d8da57a2af13854772d7bb7cb">GetName</a> ()</td></tr>
<tr class="separator:a2b87c14d8da57a2af13854772d7bb7cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad59b204416195909d02c2eb82079376d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#ad59b204416195909d02c2eb82079376d">GetHelp</a> ()</td></tr>
<tr class="separator:ad59b204416195909d02c2eb82079376d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a147afad622be8ea1cb017b528d8056c1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#a147afad622be8ea1cb017b528d8056c1">GetHelpLong</a> ()</td></tr>
<tr class="separator:a147afad622be8ea1cb017b528d8056c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a964eabb3d1ec14dfe41fdc80ab141272"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#a964eabb3d1ec14dfe41fdc80ab141272">SetHelp</a> (const char *)</td></tr>
<tr class="separator:a964eabb3d1ec14dfe41fdc80ab141272"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc9b21302bf0455c1d2d336998ec79bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#adc9b21302bf0455c1d2d336998ec79bc">SetHelpLong</a> (const char *)</td></tr>
<tr class="separator:adc9b21302bf0455c1d2d336998ec79bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac456127dbc6df7aa2c6e96a4e234a9d8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#ac456127dbc6df7aa2c6e96a4e234a9d8">GetFlags</a> ()</td></tr>
<tr class="separator:ac456127dbc6df7aa2c6e96a4e234a9d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f08fb7212e0d7b7a63a05493b12dfca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#a0f08fb7212e0d7b7a63a05493b12dfca">SetFlags</a> (uint32_t flags)</td></tr>
<tr class="separator:a0f08fb7212e0d7b7a63a05493b12dfca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae44e3c8154cb548fa146ad72e1a85222"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBCommand.html">lldb::SBCommand</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#ae44e3c8154cb548fa146ad72e1a85222">AddMultiwordCommand</a> (const char *name, const char *help=nullptr)</td></tr>
<tr class="separator:ae44e3c8154cb548fa146ad72e1a85222"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e58d826a05725b075557f001fa3dc90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBCommand.html">lldb::SBCommand</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#a9e58d826a05725b075557f001fa3dc90">AddCommand</a> (const char *name, <a class="el" href="classlldb_1_1SBCommandPluginInterface.html">lldb::SBCommandPluginInterface</a> *impl, const char *help=nullptr)</td></tr>
<tr class="separator:a9e58d826a05725b075557f001fa3dc90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8079af00ae61a762c50abd08bf3eefe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBCommand.html">lldb::SBCommand</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#af8079af00ae61a762c50abd08bf3eefe">AddCommand</a> (const char *name, <a class="el" href="classlldb_1_1SBCommandPluginInterface.html">lldb::SBCommandPluginInterface</a> *impl, const char *help, const char *syntax)</td></tr>
<tr class="separator:af8079af00ae61a762c50abd08bf3eefe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a57b27e10004af3d21e9f5a904faf2988"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#a57b27e10004af3d21e9f5a904faf2988">SBDebugger</a></td></tr>
<tr class="separator:a57b27e10004af3d21e9f5a904faf2988"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3fb6efd0d4f3b3bb7b87db062eb48c9"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBCommand.html#af3fb6efd0d4f3b3bb7b87db062eb48c9">SBCommandInterpreter</a></td></tr>
<tr class="separator:af3fb6efd0d4f3b3bb7b87db062eb48c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="SBCommandInterpreter_8h_source.html#l00242">242</a> of file <a class="el" href="SBCommandInterpreter_8h_source.html">SBCommandInterpreter.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad209ed91e4e3e5ce68226039e8956d51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBCommand::SBCommand </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9e58d826a05725b075557f001fa3dc90"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlldb_1_1SBCommand.html">lldb::SBCommand</a> lldb::SBCommand::AddCommand </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"><a class="el" href="classlldb_1_1SBCommandPluginInterface.html">lldb::SBCommandPluginInterface</a> *&#160;</td>
<td class="paramname"><em>impl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>help</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af8079af00ae61a762c50abd08bf3eefe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlldb_1_1SBCommand.html">lldb::SBCommand</a> lldb::SBCommand::AddCommand </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"><a class="el" href="classlldb_1_1SBCommandPluginInterface.html">lldb::SBCommandPluginInterface</a> *&#160;</td>
<td class="paramname"><em>impl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>help</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>syntax</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae44e3c8154cb548fa146ad72e1a85222"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlldb_1_1SBCommand.html">lldb::SBCommand</a> lldb::SBCommand::AddMultiwordCommand </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>help</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac456127dbc6df7aa2c6e96a4e234a9d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t lldb::SBCommand::GetFlags </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad59b204416195909d02c2eb82079376d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lldb::SBCommand::GetHelp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a147afad622be8ea1cb017b528d8056c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lldb::SBCommand::GetHelpLong </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2b87c14d8da57a2af13854772d7bb7cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lldb::SBCommand::GetName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8faadbdf8b1a60b6b48001e851696861"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBCommand::IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0f08fb7212e0d7b7a63a05493b12dfca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lldb::SBCommand::SetFlags </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a964eabb3d1ec14dfe41fdc80ab141272"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lldb::SBCommand::SetHelp </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adc9b21302bf0455c1d2d336998ec79bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lldb::SBCommand::SetHelpLong </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="af3fb6efd0d4f3b3bb7b87db062eb48c9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classlldb_1_1SBCommandInterpreter.html">SBCommandInterpreter</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SBCommandInterpreter_8h_source.html#l00275">275</a> of file <a class="el" href="SBCommandInterpreter_8h_source.html">SBCommandInterpreter.h</a>.</p>
</div>
</div>
<a class="anchor" id="a57b27e10004af3d21e9f5a904faf2988"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classlldb_1_1SBDebugger.html">SBDebugger</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SBCommandInterpreter_8h_source.html#l00274">274</a> of file <a class="el" href="SBCommandInterpreter_8h_source.html">SBCommandInterpreter.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SBCommandInterpreter_8h_source.html">SBCommandInterpreter.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<p class="footer">
Generated on Fri Oct 14 2016 14:01:23 for <a href="http://lldb.llvm.org/">LLVM</a> by
<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
align="middle" border="0"/>1.8.6</a><br>
Copyright &copy; 2003-2013 University of Illinois at Urbana-Champaign.
All Rights Reserved.</p>
<hr>
<!--#include virtual="/attrib.incl" -->
</body>
</html>