Home | History | Annotate | Download | only in 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: SBInputReader.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.1.2 -->
     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_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>
     27 </div>
     28 </div><!-- top -->
     29 <div class="header">
     30   <div class="headertitle">
     31 <div class="title">SBInputReader.h</div>  </div>
     32 </div><!--header-->
     33 <div class="contents">
     34 <a href="SBInputReader_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">//===-- SBInputReader.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_SBInputReader_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_SBInputReader_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="preprocessor">#include &quot;<a class="code" href="SBDefines_8h.html">lldb/API/SBDefines.h</a>&quot;</span></div>
     47 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div>
     48 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="keyword">namespace </span>lldb {</div>
     49 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
     50 <div class="line"><a name="l00017"></a><span class="lineno"><a class="code" href="classlldb_1_1SBInputReader.html">   17</a></span>&#160;<span class="keyword">class </span><a class="code" href="classlldb_1_1SBInputReader.html">SBInputReader</a></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="keyword">public</span>:</div>
     53 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
     54 <div class="line"><a name="l00021"></a><span class="lineno"><a class="code" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">   21</a></span>&#160;    <span class="keyword">typedef</span> size_t (*<a class="code" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">Callback</a>) (<span class="keywordtype">void</span> *baton, </div>
     55 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;                                <a class="code" href="classlldb_1_1SBInputReader.html">SBInputReader</a> *reader, </div>
     56 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;                                InputReaderAction notification,</div>
     57 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;                                <span class="keyword">const</span> <span class="keywordtype">char</span> *bytes, </div>
     58 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;                                <span class="keywordtype">size_t</span> bytes_len);</div>
     59 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div>
     60 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#aef8cd878f1522b5330ac6bd1292bf408">SBInputReader</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="classlldb_1_1SBInputReader.html#aef8cd878f1522b5330ac6bd1292bf408">SBInputReader</a> (<span class="keyword">const</span> lldb::InputReaderSP &amp;reader_sp);</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_1SBInputReader.html#aef8cd878f1522b5330ac6bd1292bf408">SBInputReader</a> (<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &amp;rhs);</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;    <a class="code" href="classlldb_1_1SBInputReader.html#afbb00baedea8c4216461ba11da3150e5">~SBInputReader</a> ();</div>
     67 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</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="classlldb_1_1SBError.html">SBError</a></div>
     70 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a077c8c942ee9727c92be28c61c668b6d">Initialize</a> (<a class="code" href="classlldb_1_1SBDebugger.html">SBDebugger</a> &amp;debugger,</div>
     71 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;                <a class="code" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">Callback</a> callback,</div>
     72 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;                <span class="keywordtype">void</span> *callback_baton,</div>
     73 <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;                lldb::InputReaderGranularity granularity,</div>
     74 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;                <span class="keyword">const</span> <span class="keywordtype">char</span> *end_token,</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> *prompt,</div>
     76 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;                <span class="keywordtype">bool</span> echo);</div>
     77 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    </div>
     78 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordtype">bool</span></div>
     79 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a50c29672aa70d5a2ca83dd5e1d735ed0">IsValid</a> () <span class="keyword">const</span>;</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="keyword">const</span> <a class="code" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &amp;</div>
     82 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a5bcbc40e83d8e9313a68f91aa89849e0">operator = </a>(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &amp;rhs);</div>
     83 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
     84 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <span class="keywordtype">bool</span></div>
     85 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a4fcb6b38f31c9d301c2396bfe8ca6e78">IsActive</a> () <span class="keyword">const</span>;</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">bool</span></div>
     88 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#ae0234f40588db9c462e363945786fe2e">IsDone</a> () <span class="keyword">const</span>;</div>
     89 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
     90 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordtype">void</span></div>
     91 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#ab7dc5f6a0cf6ebe72855842765be219b">SetIsDone</a> (<span class="keywordtype">bool</span> value);</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;    InputReaderGranularity</div>
     94 <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a98bd1c5a1a2b807f238b3a8714616387">GetGranularity</a> ();</div>
     95 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
     96 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keyword">protected</span>:</div>
     97 <div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="classlldb_1_1SBInputReader.html#a57b27e10004af3d21e9f5a904faf2988">   64</a></span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBDebugger.html">SBDebugger</a>;</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;    lldb_private::InputReader *</div>
    100 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a628c2f397155b315aeb39489ebe1ff4e">operator-&gt;</a>() <span class="keyword">const</span>;</div>
    101 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
    102 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    lldb::InputReaderSP &amp;</div>
    103 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a29ed5730185ae11740723f1690356934">operator *</a>();</div>
    104 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
    105 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keyword">const</span> lldb::InputReaderSP &amp;</div>
    106 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a29ed5730185ae11740723f1690356934">operator *</a>() <span class="keyword">const</span>;</div>
    107 <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div>
    108 <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    lldb_private::InputReader *</div>
    109 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keyword">get</span>() <span class="keyword">const</span>;</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;    lldb_private::InputReader &amp;</div>
    112 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a694e8556cf0fb62da2c3297118355cee">ref</a>() <span class="keyword">const</span>;</div>
    113 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div>
    114 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="keyword">private</span>:</div>
    115 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
    116 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keyword">static</span> <span class="keywordtype">size_t</span></div>
    117 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    PrivateCallback (<span class="keywordtype">void</span> *baton, </div>
    118 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;                     lldb_private::InputReader &amp;reader, </div>
    119 <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;                     lldb::InputReaderAction notification,</div>
    120 <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;                     <span class="keyword">const</span> <span class="keywordtype">char</span> *bytes, </div>
    121 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;                     <span class="keywordtype">size_t</span> bytes_len);</div>
    122 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div>
    123 <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    lldb::InputReaderSP m_opaque_sp;</div>
    124 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <a class="code" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">Callback</a> m_callback_function;</div>
    125 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="keywordtype">void</span> *m_callback_baton;</div>
    126 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;};</div>
    127 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
    128 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;} <span class="comment">// namespace lldb</span></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;<span class="preprocessor">#endif // LLDB_SBInputReader_h_</span></div>
    131 </div><!-- fragment --></div><!-- contents -->
    132 <hr>
    133 <p class="footer">
    134 Generated on Fri Jul 19 2013 13:25:55 for <a href="http://lldb.llvm.org/">LLVM</a> by
    135 <a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
    136 align="middle" border="0"/>1.8.1.2</a><br>
    137 Copyright &copy; 2003-2013 University of Illinois at Urbana-Champaign.
    138 All Rights Reserved.</p>
    139 <hr>
    140 <!--#include virtual="/attrib.incl" -->
    141 </body>
    142 </html>
    143