| <!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: SBCommandReturnObject.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.6 --> |
| <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><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 List</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_6b47ac86da6aee9115280ffa56155f66.html">llvm</a></li><li class="navelem"><a class="el" href="dir_b8cffa74dcb91bca0da221349fa85523.html">tools</a></li><li class="navelem"><a class="el" href="dir_bdcf59bf838c999fcfc3dde87d35c9f0.html">lldb</a></li><li class="navelem"><a class="el" href="dir_42333c9da4438c4e48b6683e9ba44a59.html">include</a></li><li class="navelem"><a class="el" href="dir_30e71e610673c7b74c5ccda0fc334ee9.html">lldb</a></li><li class="navelem"><a class="el" href="dir_65cab015c1f428073772d528e6a1b53d.html">API</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">SBCommandReturnObject.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="SBCommandReturnObject_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> <span class="comment">//===-- SBCommandReturnObject.h ---------------------------------*- C++ -*-===//</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// The LLVM Compiler Infrastructure</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <span class="comment">// License. See LICENSE.TXT for details.</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//===----------------------------------------------------------------------===//</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef LLDB_SBCommandReturnObject_h_</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define LLDB_SBCommandReturnObject_h_</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// C Includes</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <stdio.h></span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// C++ Includes</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// Other libraries and framework includes</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// Project includes</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="SBDefines_8h.html">lldb/API/SBDefines.h</a>"</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>lldb {</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommandReturnObject.html"> 25</a></span> <span class="keyword">class </span>LLDB_API <a class="code" href="classlldb_1_1SBCommandReturnObject.html">SBCommandReturnObject</a> {</div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="namespacelldb.html#af2b1fa072f93ee719aeeb71d8930775c">SBCommandReturnObject</a>();</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="namespacelldb.html#af2b1fa072f93ee719aeeb71d8930775c">SBCommandReturnObject</a>(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &rhs);</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  ~<a class="code" href="classlldb_1_1SBCommandReturnObject.html">SBCommandReturnObject</a>();</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  operator=(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &rhs);</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="namespacelldb.html#af2b1fa072f93ee719aeeb71d8930775c">SBCommandReturnObject</a>(lldb_private::CommandReturnObject *ptr);</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  lldb_private::CommandReturnObject *Release();</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">bool</span> IsValid() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetOutput();</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetError();</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">size_t</span> PutOutput(FILE *fh);</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">size_t</span> GetOutputSize();</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">size_t</span> GetErrorSize();</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">size_t</span> PutError(FILE *fh);</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> Clear();</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  lldb::ReturnStatus GetStatus();</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> SetStatus(lldb::ReturnStatus status);</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> Succeeded();</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">bool</span> HasResult();</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> AppendMessage(<span class="keyword">const</span> <span class="keywordtype">char</span> *message);</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> AppendWarning(<span class="keyword">const</span> <span class="keywordtype">char</span> *message);</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> GetDescription(<a class="code" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &description);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// deprecated, these two functions do not take</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// ownership of file handle</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> SetImmediateOutputFile(FILE *fh);</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> SetImmediateErrorFile(FILE *fh);</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> SetImmediateOutputFile(FILE *fh, <span class="keywordtype">bool</span> transfer_ownership);</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> SetImmediateErrorFile(FILE *fh, <span class="keywordtype">bool</span> transfer_ownership);</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> PutCString(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span>, <span class="keywordtype">int</span> len = -1);</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">size_t</span> Printf(<span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...) __attribute__((format(printf, 2, 3)));</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetOutput(<span class="keywordtype">bool</span> only_if_no_immediate);</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetError(<span class="keywordtype">bool</span> only_if_no_immediate);</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> SetError(<a class="code" href="classlldb_1_1SBError.html">lldb::SBError</a> &error,</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *fallback_error_cstr = <span class="keyword">nullptr</span>);</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> SetError(<span class="keyword">const</span> <span class="keywordtype">char</span> *error_cstr);</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommandReturnObject.html#af3fb6efd0d4f3b3bb7b87db062eb48c9"> 94</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBCommandInterpreter.html">SBCommandInterpreter</a>;</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommandReturnObject.html#aee9a0d1e363dceb8bc8ae91580177403"> 95</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span>SBOptions;</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  lldb_private::CommandReturnObject *operator->() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  lldb_private::CommandReturnObject *<span class="keyword">get</span>() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  lldb_private::CommandReturnObject &operator*() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  lldb_private::CommandReturnObject &ref() <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span> SetLLDBObjectPtr(lldb_private::CommandReturnObject *ptr);</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  std::unique_ptr<lldb_private::CommandReturnObject> m_opaque_ap;</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> };</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> } <span class="comment">// namespace lldb</span></div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#endif // LLDB_SBCommandReturnObject_h_</span></div> |
| <div class="ttc" id="SBDefines_8h_html"><div class="ttname"><a href="SBDefines_8h.html">SBDefines.h</a></div></div> |
| <div class="ttc" id="classlldb_1_1SBCommandInterpreter_html"><div class="ttname"><a href="classlldb_1_1SBCommandInterpreter.html">lldb::SBCommandInterpreter</a></div><div class="ttdef"><b>Definition:</b> <a href="SBCommandInterpreter_8h_source.html#l00066">SBCommandInterpreter.h:66</a></div></div> |
| <div class="ttc" id="namespacelldb_html_af2b1fa072f93ee719aeeb71d8930775c"><div class="ttname"><a href="namespacelldb.html#af2b1fa072f93ee719aeeb71d8930775c">lldb::SBCommandReturnObject</a></div><div class="ttdeci">class LLDB_API SBCommandReturnObject</div><div class="ttdef"><b>Definition:</b> <a href="SBDefines_8h_source.html#l00040">SBDefines.h:40</a></div></div> |
| <div class="ttc" id="classlldb_1_1SBError_html"><div class="ttname"><a href="classlldb_1_1SBError.html">lldb::SBError</a></div><div class="ttdef"><b>Definition:</b> <a href="SBError_8h_source.html#l00017">SBError.h:17</a></div></div> |
| <div class="ttc" id="classlldb_1_1SBStream_html"><div class="ttname"><a href="classlldb_1_1SBStream.html">lldb::SBStream</a></div><div class="ttdef"><b>Definition:</b> <a href="SBStream_8h_source.html#l00019">SBStream.h:19</a></div></div> |
| <div class="ttc" id="classlldb_1_1SBCommandReturnObject_html"><div class="ttname"><a href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a></div><div class="ttdef"><b>Definition:</b> <a href="SBCommandReturnObject_8h_source.html#l00025">SBCommandReturnObject.h:25</a></div></div> |
| </div><!-- fragment --></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 © 2003-2013 University of Illinois at Urbana-Champaign. |
| All Rights Reserved.</p> |
| <hr> |
| <!--#include virtual="/attrib.incl" --> |
| </body> |
| </html> |
