www/cpp_reference/html/SBCommandReturnObject_8h_source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head>
   3 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
   4 <meta name="keywords" content="LLDB,C++,doxygen,API,documentation"/>
   5 <meta name="description" content="C++ source code API documentation for LLDB."/>
   6 <title>LLVM: SBCommandReturnObject.h Source File</title>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
   8 </head><body>
   9 <p class="title">LLDB API Documentation</p>
  10 <!-- Generated by Doxygen 1.8.6 -->
  11   <div id="navrow1" class="tabs">
  12     <ul class="tablist">
  13       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  14       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  15       <li><a href="annotated.html"><span>Classes</span></a></li>
  16       <li class="current"><a href="files.html"><span>Files</span></a></li>
  17     </ul>
  18   </div>
  19   <div id="navrow2" class="tabs2">
  20     <ul class="tablist">
  21       <li><a href="files.html"><span>File&#160;List</span></a></li>
  22     </ul>
  23   </div>
  24 <div id="nav-path" class="navpath">
  25   <ul>
  26 <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>
  27 </div>
  28 </div><!-- top -->
  29 <div class="header">
  30   <div class="headertitle">
  31 <div class="title">SBCommandReturnObject.h</div>  </div>
  32 </div><!--header-->
  33 <div class="contents">
  34 <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>&#160;<span class="comment">//===-- SBCommandReturnObject.h ---------------------------------*- C++ -*-===//</span></div>
  35 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//</span></div>
  36 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//                     The LLVM Compiler Infrastructure</span></div>
  37 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div>
  38 <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>
  39 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// License. See LICENSE.TXT for details.</span></div>
  40 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div>
  41 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//===----------------------------------------------------------------------===//</span></div>
  42 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
  43 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef LLDB_SBCommandReturnObject_h_</span></div>
  44 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define LLDB_SBCommandReturnObject_h_</span></div>
  45 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor"></span></div>
  46 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// C Includes</span></div>
  47 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
  48 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
  49 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">// C++ Includes</span></div>
  50 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
  51 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
  52 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">// Other libraries and framework includes</span></div>
  53 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">// Project includes</span></div>
  54 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="SBDefines_8h.html">lldb/API/SBDefines.h</a>&quot;</span></div>
  55 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
  56 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span>lldb {</div>
  57 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
  58 <div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommandReturnObject.html">   25</a></span>&#160;<span class="keyword">class </span>LLDB_API <a class="code" href="classlldb_1_1SBCommandReturnObject.html">SBCommandReturnObject</a> {</div>
  59 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">public</span>:</div>
  60 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;  <a class="code" href="namespacelldb.html#af2b1fa072f93ee719aeeb71d8930775c">SBCommandReturnObject</a>();</div>
  61 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
  62 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  <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> &amp;rhs);</div>
  63 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
  64 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;  ~<a class="code" href="classlldb_1_1SBCommandReturnObject.html">SBCommandReturnObject</a>();</div>
  65 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
  66 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;  <span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &amp;</div>
  67 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  operator=(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBCommandReturnObject.html">lldb::SBCommandReturnObject</a> &amp;rhs);</div>
  68 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
  69 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;  <a class="code" href="namespacelldb.html#af2b1fa072f93ee719aeeb71d8930775c">SBCommandReturnObject</a>(lldb_private::CommandReturnObject *ptr);</div>
  70 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
  71 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;  lldb_private::CommandReturnObject *Release();</div>
  72 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
  73 <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;  <span class="keywordtype">bool</span> IsValid() <span class="keyword">const</span>;</div>
  74 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
  75 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetOutput();</div>
  76 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div>
  77 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetError();</div>
  78 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
  79 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  <span class="keywordtype">size_t</span> PutOutput(FILE *fh);</div>
  80 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
  81 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="keywordtype">size_t</span> GetOutputSize();</div>
  82 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
  83 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <span class="keywordtype">size_t</span> GetErrorSize();</div>
  84 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
  85 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="keywordtype">size_t</span> PutError(FILE *fh);</div>
  86 <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
  87 <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  <span class="keywordtype">void</span> Clear();</div>
  88 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
  89 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  lldb::ReturnStatus GetStatus();</div>
  90 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
  91 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <span class="keywordtype">void</span> SetStatus(lldb::ReturnStatus status);</div>
  92 <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
  93 <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  <span class="keywordtype">bool</span> Succeeded();</div>
  94 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div>
  95 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  <span class="keywordtype">bool</span> HasResult();</div>
  96 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
  97 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="keywordtype">void</span> AppendMessage(<span class="keyword">const</span> <span class="keywordtype">char</span> *message);</div>
  98 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
  99 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  <span class="keywordtype">void</span> AppendWarning(<span class="keyword">const</span> <span class="keywordtype">char</span> *message);</div>
 100 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
 101 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  <span class="keywordtype">bool</span> GetDescription(<a class="code" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;description);</div>
 102 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
 103 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  <span class="comment">// deprecated, these two functions do not take</span></div>
 104 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <span class="comment">// ownership of file handle</span></div>
 105 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  <span class="keywordtype">void</span> SetImmediateOutputFile(FILE *fh);</div>
 106 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
 107 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  <span class="keywordtype">void</span> SetImmediateErrorFile(FILE *fh);</div>
 108 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
 109 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  <span class="keywordtype">void</span> SetImmediateOutputFile(FILE *fh, <span class="keywordtype">bool</span> transfer_ownership);</div>
 110 <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
 111 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  <span class="keywordtype">void</span> SetImmediateErrorFile(FILE *fh, <span class="keywordtype">bool</span> transfer_ownership);</div>
 112 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
 113 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <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>
 114 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
 115 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  <span class="keywordtype">size_t</span> Printf(<span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...) __attribute__((format(printf, 2, 3)));</div>
 116 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
 117 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetOutput(<span class="keywordtype">bool</span> only_if_no_immediate);</div>
 118 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
 119 <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetError(<span class="keywordtype">bool</span> only_if_no_immediate);</div>
 120 <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
 121 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;  <span class="keywordtype">void</span> SetError(<a class="code" href="classlldb_1_1SBError.html">lldb::SBError</a> &amp;error,</div>
 122 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;                <span class="keyword">const</span> <span class="keywordtype">char</span> *fallback_error_cstr = <span class="keyword">nullptr</span>);</div>
 123 <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div>
 124 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  <span class="keywordtype">void</span> SetError(<span class="keyword">const</span> <span class="keywordtype">char</span> *error_cstr);</div>
 125 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
 126 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="keyword">protected</span>:</div>
 127 <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommandReturnObject.html#af3fb6efd0d4f3b3bb7b87db062eb48c9">   94</a></span>&#160;  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBCommandInterpreter.html">SBCommandInterpreter</a>;</div>
 128 <div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classlldb_1_1SBCommandReturnObject.html#aee9a0d1e363dceb8bc8ae91580177403">   95</a></span>&#160;  <span class="keyword">friend</span> <span class="keyword">class </span>SBOptions;</div>
 129 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div>
 130 <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;  lldb_private::CommandReturnObject *operator-&gt;() <span class="keyword">const</span>;</div>
 131 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
 132 <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  lldb_private::CommandReturnObject *<span class="keyword">get</span>() <span class="keyword">const</span>;</div>
 133 <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div>
 134 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  lldb_private::CommandReturnObject &amp;operator*() <span class="keyword">const</span>;</div>
 135 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div>
 136 <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  lldb_private::CommandReturnObject &amp;ref() <span class="keyword">const</span>;</div>
 137 <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div>
 138 <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  <span class="keywordtype">void</span> SetLLDBObjectPtr(lldb_private::CommandReturnObject *ptr);</div>
 139 <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div>
 140 <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="keyword">private</span>:</div>
 141 <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  std::unique_ptr&lt;lldb_private::CommandReturnObject&gt; m_opaque_ap;</div>
 142 <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;};</div>
 143 <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;</div>
 144 <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;} <span class="comment">// namespace lldb</span></div>
 145 <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div>
 146 <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="preprocessor">#endif // LLDB_SBCommandReturnObject_h_</span></div>
 147 <div class="ttc" id="SBDefines_8h_html"><div class="ttname"><a href="SBDefines_8h.html">SBDefines.h</a></div></div>
 148 <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>
 149 <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>
 150 <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>
 151 <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>
 152 <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>
 153 </div><!-- fragment --></div><!-- contents -->
 154 <hr>
 155 <p class="footer">
 156 Generated on Fri Oct 14 2016 14:01:23 for <a href="http://lldb.llvm.org/">LLVM</a> by
 157 <a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
 158 align="middle" border="0"/>1.8.6</a><br>
 159 Copyright &copy; 2003-2013 University of Illinois at Urbana-Champaign.
 160 All Rights Reserved.</p>
 161 <hr>
 162 <!--#include virtual="/attrib.incl" -->
 163 </body>
 164 </html>