blob: d0a8f5645203d92d51059286e5824023113c7600 [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::SBInstruction 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.1.2 -->
<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="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_1SBInstruction.html">SBInstruction</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classlldb_1_1SBInstruction-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lldb::SBInstruction Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="SBInstruction_8h_source.html">SBInstruction.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68fd095f4a2a770f7953e08734177847"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a68fd095f4a2a770f7953e08734177847">SBInstruction</a> ()</td></tr>
<tr class="memitem:aeb62eff9337815676ce81bfd833e92c1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#aeb62eff9337815676ce81bfd833e92c1">SBInstruction</a> (const <a class="el" href="classlldb_1_1SBInstruction.html">SBInstruction</a> &amp;rhs)</td></tr>
<tr class="memitem:aa9de2c02cec437df4b5d97e89a47207b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlldb_1_1SBInstruction.html">SBInstruction</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#aa9de2c02cec437df4b5d97e89a47207b">operator=</a> (const <a class="el" href="classlldb_1_1SBInstruction.html">SBInstruction</a> &amp;rhs)</td></tr>
<tr class="memitem:a4e66d7b71bfb26565be76280dc5057df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a4e66d7b71bfb26565be76280dc5057df">~SBInstruction</a> ()</td></tr>
<tr class="memitem:a0abbe70ad2372828ddae7dd608a74410"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a0abbe70ad2372828ddae7dd608a74410">IsValid</a> ()</td></tr>
<tr class="memitem:aa053a3191fb55697c47178c9c71cfbbe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBAddress.html">SBAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#aa053a3191fb55697c47178c9c71cfbbe">GetAddress</a> ()</td></tr>
<tr class="memitem:aff1374ed946260f39bf9140fa97aa0fc"><td class="memItemLeft" align="right" valign="top">lldb::AddressClass&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#aff1374ed946260f39bf9140fa97aa0fc">GetAddressClass</a> ()</td></tr>
<tr class="memitem:a59b8db49852fa31e99bd03834897077c"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a59b8db49852fa31e99bd03834897077c">GetMnemonic</a> (<a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a> target)</td></tr>
<tr class="memitem:a77c6ac22d261ec082e1c89dcf81504de"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a77c6ac22d261ec082e1c89dcf81504de">GetOperands</a> (<a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a> target)</td></tr>
<tr class="memitem:a5f83690e486b88394866d280bf09a3eb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a5f83690e486b88394866d280bf09a3eb">GetComment</a> (<a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a> target)</td></tr>
<tr class="memitem:a7de0e98a9265debe0c7a3abe810d11f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBData.html">lldb::SBData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a7de0e98a9265debe0c7a3abe810d11f2">GetData</a> (<a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a> target)</td></tr>
<tr class="memitem:a59e80b0ba6a32669b7f10348c52fca30"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a59e80b0ba6a32669b7f10348c52fca30">GetByteSize</a> ()</td></tr>
<tr class="memitem:a087f53c1202e991468e11cb056fe91d8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a087f53c1202e991468e11cb056fe91d8">DoesBranch</a> ()</td></tr>
<tr class="memitem:a2c92bab9d9d73b0afe77e726f2572857"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a2c92bab9d9d73b0afe77e726f2572857">Print</a> (FILE *out)</td></tr>
<tr class="memitem:a3fcd105ec9be19ea6e49ba237463665f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a3fcd105ec9be19ea6e49ba237463665f">GetDescription</a> (<a class="el" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;description)</td></tr>
<tr class="memitem:abf66d49fa96c191905e9f4c3d2a2218f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#abf66d49fa96c191905e9f4c3d2a2218f">EmulateWithFrame</a> (<a class="el" href="classlldb_1_1SBFrame.html">lldb::SBFrame</a> &amp;frame, uint32_t evaluate_options)</td></tr>
<tr class="memitem:a9e51cbbb2b3426632960ab76302c17c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a9e51cbbb2b3426632960ab76302c17c4">DumpEmulation</a> (const char *triple)</td></tr>
<tr class="memitem:a3f8ce042930cc99a6ebfd9134ff73c3b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a3f8ce042930cc99a6ebfd9134ff73c3b">TestEmulation</a> (<a class="el" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;output_stream, const char *test_file)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a92ba22ef5ee264aef1acb3987d599e3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#a92ba22ef5ee264aef1acb3987d599e3e">SBInstruction</a> (const lldb::InstructionSP &amp;inst_sp)</td></tr>
<tr class="memitem:aa0431597c292d1fc150bca60ec313648"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#aa0431597c292d1fc150bca60ec313648">SetOpaque</a> (const lldb::InstructionSP &amp;inst_sp)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aef79410dcd84e1378958b6acc3d32dcb"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInstruction.html#aef79410dcd84e1378958b6acc3d32dcb">SBInstructionList</a></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="SBInstruction_8h_source.html#l00023">23</a> of file <a class="el" href="SBInstruction_8h_source.html">SBInstruction.h</a>.</p>
</div><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a68fd095f4a2a770f7953e08734177847"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBInstruction::SBInstruction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aeb62eff9337815676ce81bfd833e92c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBInstruction::SBInstruction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlldb_1_1SBInstruction.html">SBInstruction</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4e66d7b71bfb26565be76280dc5057df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBInstruction::~SBInstruction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a92ba22ef5ee264aef1acb3987d599e3e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">lldb::SBInstruction::SBInstruction </td>
<td>(</td>
<td class="paramtype">const lldb::InstructionSP &amp;&#160;</td>
<td class="paramname"><em>inst_sp</em></td><td>)</td>
<td></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>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a087f53c1202e991468e11cb056fe91d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBInstruction::DoesBranch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9e51cbbb2b3426632960ab76302c17c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBInstruction::DumpEmulation </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>triple</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="abf66d49fa96c191905e9f4c3d2a2218f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBInstruction::EmulateWithFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBFrame.html">lldb::SBFrame</a> &amp;&#160;</td>
<td class="paramname"><em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>evaluate_options</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="aa053a3191fb55697c47178c9c71cfbbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlldb_1_1SBAddress.html">SBAddress</a> lldb::SBInstruction::GetAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aff1374ed946260f39bf9140fa97aa0fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::AddressClass lldb::SBInstruction::GetAddressClass </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a59e80b0ba6a32669b7f10348c52fca30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t lldb::SBInstruction::GetByteSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5f83690e486b88394866d280bf09a3eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lldb::SBInstruction::GetComment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a>&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7de0e98a9265debe0c7a3abe810d11f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlldb_1_1SBData.html">lldb::SBData</a> lldb::SBInstruction::GetData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a>&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3fcd105ec9be19ea6e49ba237463665f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBInstruction::GetDescription </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;&#160;</td>
<td class="paramname"><em>description</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a59b8db49852fa31e99bd03834897077c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lldb::SBInstruction::GetMnemonic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a>&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a77c6ac22d261ec082e1c89dcf81504de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lldb::SBInstruction::GetOperands </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBTarget.html">lldb::SBTarget</a>&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0abbe70ad2372828ddae7dd608a74410"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBInstruction::IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa9de2c02cec437df4b5d97e89a47207b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classlldb_1_1SBInstruction.html">SBInstruction</a>&amp; lldb::SBInstruction::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlldb_1_1SBInstruction.html">SBInstruction</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2c92bab9d9d73b0afe77e726f2572857"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lldb::SBInstruction::Print </td>
<td>(</td>
<td class="paramtype">FILE *&#160;</td>
<td class="paramname"><em>out</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa0431597c292d1fc150bca60ec313648"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void lldb::SBInstruction::SetOpaque </td>
<td>(</td>
<td class="paramtype">const lldb::InstructionSP &amp;&#160;</td>
<td class="paramname"><em>inst_sp</em></td><td>)</td>
<td></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="a3f8ce042930cc99a6ebfd9134ff73c3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBInstruction::TestEmulation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;&#160;</td>
<td class="paramname"><em>output_stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>test_file</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aef79410dcd84e1378958b6acc3d32dcb"></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_1SBInstructionList.html">SBInstructionList</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="SBInstruction_8h_source.html#l00079">79</a> of file <a class="el" href="SBInstruction_8h_source.html">SBInstruction.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SBInstruction_8h_source.html">SBInstruction.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<p class="footer">
Generated on Fri Jul 19 2013 13:25:55 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.1.2</a><br>
Copyright &copy; 2003-2013 University of Illinois at Urbana-Champaign.
All Rights Reserved.</p>
<hr>
<!--#include virtual="/attrib.incl" -->
</body>
</html>