blob: d1ec8e77645b7cad63ba8a702596279b4d679d8e [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: SBCompileUnit.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_217b186c19a2bb8bc0ee0f71fb72d4e8.html">tools</a></li><li class="navelem"><a class="el" href="dir_fa64c3fa8a988674a1a867b97ca9a790.html">lldb</a></li><li class="navelem"><a class="el" href="dir_9d4b8469db156c557ab1d649b027ec2e.html">include</a></li><li class="navelem"><a class="el" href="dir_c02e3ff158c3064d7b78c6aa6fc411e6.html">lldb</a></li><li class="navelem"><a class="el" href="dir_36ad4ea5df2b352cce0512435d34c8a4.html">API</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SBCompileUnit.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="SBCompileUnit_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//===-- SBCompileUnit.h -----------------------------------------*- C++ -*-===//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// The LLVM Compiler Infrastructure</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// This file is distributed under the University of Illinois Open Source</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// License. See LICENSE.TXT for details.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//===----------------------------------------------------------------------===//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#ifndef LLDB_SBCompileUnit_h_</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define LLDB_SBCompileUnit_h_</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="SBDefines_8h.html">lldb/API/SBDefines.h</a>&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="SBFileSpec_8h.html">lldb/API/SBFileSpec.h</a>&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span>lldb {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCompileUnit.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="classlldb_1_1SBCompileUnit.html">SBCompileUnit</a></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#ad41dedfd8bea1212602d99b2e021e3f2">SBCompileUnit</a> ();</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#ad41dedfd8bea1212602d99b2e021e3f2">SBCompileUnit</a> (<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCompileUnit.html">lldb::SBCompileUnit</a> &amp;rhs);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a4c013a8446480ba7dd030984c5fe48b6">~SBCompileUnit</a> ();</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCompileUnit.html">lldb::SBCompileUnit</a> &amp;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#ad82391cc4369ab2dcb9e4444f22e2f96">operator = </a>(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCompileUnit.html">lldb::SBCompileUnit</a> &amp;rhs);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a3bfac87f91292fc98d6b72812260b833">IsValid</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classlldb_1_1SBFileSpec.html">lldb::SBFileSpec</a></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#afca1e656977f4fe01f6f5169ba6991d3">GetFileSpec</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; uint32_t</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a5f28262e9cf63ece291615af976d82c3">GetNumLineEntries</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classlldb_1_1SBLineEntry.html">lldb::SBLineEntry</a></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a5aa99a17c6d0dd4b422b248d547c03d3">GetLineEntryAtIndex</a> (uint32_t idx) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint32_t</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a1ca82baeb77ea901f8749113abdaa7bf">FindLineEntryIndex</a> (uint32_t start_idx,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; uint32_t line,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classlldb_1_1SBFileSpec.html">lldb::SBFileSpec</a> *inline_file_spec) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; uint32_t</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a1ca82baeb77ea901f8749113abdaa7bf">FindLineEntryIndex</a> (uint32_t start_idx,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; uint32_t line,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="classlldb_1_1SBFileSpec.html">lldb::SBFileSpec</a> *inline_file_spec,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">bool</span> exact) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classlldb_1_1SBFileSpec.html">SBFileSpec</a></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#ae7cfa052394cb9cdfa3c24feb22599f4">GetSupportFileAtIndex</a> (uint32_t idx) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; uint32_t</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#aa178fa83d2f5820f79cdfd1f210b5ccd">GetNumSupportFiles</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint32_t</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a9d7e97af5eebd2c895fc69182206cdcb">FindSupportFileIndex</a> (uint32_t start_idx, <span class="keyword">const</span> <a class="code" href="classlldb_1_1SBFileSpec.html">SBFileSpec</a> &amp;sb_file, <span class="keywordtype">bool</span> full);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> /// Get all types matching \a type_mask from debug info in this</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> /// compile unit.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> ///</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> /// @param[in] type_mask</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> /// A bitfield that consists of one or more bits logically OR&#39;ed</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> /// together from the lldb::TypeClass enumeration. This allows</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"> /// you to request only structure types, or only class, struct</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> /// and union types. Passing in lldb::eTypeClassAny will return</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"> /// all types found in the debug information for this compile</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> /// unit.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> ///</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"> /// @return</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> /// A list of types in this compile unit that match \a type_mask</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"></span> <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="classlldb_1_1SBTypeList.html">lldb::SBTypeList</a></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a18801a5adfef9d7eb2a1fc01dba31a1f">GetTypes</a> (uint32_t type_mask = lldb::eTypeClassAny);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#ab9e4e4a97ecc58d8f2cc36949d18f315">operator == </a>(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCompileUnit.html">lldb::SBCompileUnit</a> &amp;rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#ae0eb32ab5006b9bb15a62bd36db54edd">operator != </a>(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCompileUnit.html">lldb::SBCompileUnit</a> &amp;rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#a958050257736177bd6cd33dfa73a9682">GetDescription</a> (<a class="code" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;description);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCompileUnit.html#a6e49cb4c7b4df1a9e1231d58a4952607"> 91</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBAddress.html">SBAddress</a>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCompileUnit.html#abf05358ec2c89fa95b69c85ed46492c9"> 92</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBFrame.html">SBFrame</a>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCompileUnit.html#a61223b184d8edf3f301c71ce68df8af5"> 93</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBSymbolContext.html">SBSymbolContext</a>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="classlldb_1_1SBCompileUnit.html#a5a50b764fceeae5ed6ecf04b9d1eba5c"> 94</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBModule.html">SBModule</a>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <a class="code" href="classlldb_1_1SBCompileUnit.html#ad41dedfd8bea1212602d99b2e021e3f2">SBCompileUnit</a> (lldb_private::CompileUnit *lldb_object_ptr);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">const</span> lldb_private::CompileUnit *</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; operator-&gt;() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">const</span> lldb_private::CompileUnit &amp;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; operator*() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; lldb_private::CompileUnit *</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">get</span> ();</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; reset (lldb_private::CompileUnit *lldb_object_ptr);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; lldb_private::CompileUnit *m_opaque_ptr;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;};</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;} <span class="comment">// namespace lldb</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="preprocessor">#endif // LLDB_SBCompileUnit_h_</span></div>
</div><!-- fragment --></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>