<!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::SBInputReader 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 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 List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="functions.html"><span>Class 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_1SBInputReader.html">SBInputReader</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#friends">Friends</a> | <a href="classlldb_1_1SBInputReader-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">lldb::SBInputReader Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="SBInputReader_8h_source.html">SBInputReader.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a372c636adfdc4020a492b237880139f7"><td class="memItemLeft" align="right" valign="top">typedef size_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">Callback</a> )(void *baton, <a class="el" href="classlldb_1_1SBInputReader.html">SBInputReader</a> *reader, InputReaderAction notification, const char *bytes, size_t bytes_len)</td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aef8cd878f1522b5330ac6bd1292bf408"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#aef8cd878f1522b5330ac6bd1292bf408">SBInputReader</a> ()</td></tr> <tr class="memitem:a17a05ae24380cb267c66d5427a283519"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a17a05ae24380cb267c66d5427a283519">SBInputReader</a> (const lldb::InputReaderSP &reader_sp)</td></tr> <tr class="memitem:ab8639e420e1e4cad1bacbd8532f37362"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#ab8639e420e1e4cad1bacbd8532f37362">SBInputReader</a> (const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &rhs)</td></tr> <tr class="memitem:afbb00baedea8c4216461ba11da3150e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#afbb00baedea8c4216461ba11da3150e5">~SBInputReader</a> ()</td></tr> <tr class="memitem:a077c8c942ee9727c92be28c61c668b6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBError.html">SBError</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a077c8c942ee9727c92be28c61c668b6d">Initialize</a> (<a class="el" href="classlldb_1_1SBDebugger.html">SBDebugger</a> &debugger, <a class="el" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">Callback</a> callback, void *callback_baton, lldb::InputReaderGranularity granularity, const char *end_token, const char *prompt, bool echo)</td></tr> <tr class="memitem:a50c29672aa70d5a2ca83dd5e1d735ed0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a50c29672aa70d5a2ca83dd5e1d735ed0">IsValid</a> () const </td></tr> <tr class="memitem:a5bcbc40e83d8e9313a68f91aa89849e0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a5bcbc40e83d8e9313a68f91aa89849e0">operator=</a> (const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &rhs)</td></tr> <tr class="memitem:a4fcb6b38f31c9d301c2396bfe8ca6e78"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a4fcb6b38f31c9d301c2396bfe8ca6e78">IsActive</a> () const </td></tr> <tr class="memitem:ae0234f40588db9c462e363945786fe2e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#ae0234f40588db9c462e363945786fe2e">IsDone</a> () const </td></tr> <tr class="memitem:ab7dc5f6a0cf6ebe72855842765be219b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#ab7dc5f6a0cf6ebe72855842765be219b">SetIsDone</a> (bool value)</td></tr> <tr class="memitem:a98bd1c5a1a2b807f238b3a8714616387"><td class="memItemLeft" align="right" valign="top">InputReaderGranularity </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a98bd1c5a1a2b807f238b3a8714616387">GetGranularity</a> ()</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:a628c2f397155b315aeb39489ebe1ff4e"><td class="memItemLeft" align="right" valign="top">lldb_private::InputReader * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a628c2f397155b315aeb39489ebe1ff4e">operator-></a> () const </td></tr> <tr class="memitem:a29ed5730185ae11740723f1690356934"><td class="memItemLeft" align="right" valign="top">lldb::InputReaderSP & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a29ed5730185ae11740723f1690356934">operator*</a> ()</td></tr> <tr class="memitem:a0f3409af81fb2f0e3be0452209e9389b"><td class="memItemLeft" align="right" valign="top">const lldb::InputReaderSP & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a0f3409af81fb2f0e3be0452209e9389b">operator*</a> () const </td></tr> <tr class="memitem:a2be4cb2149677a5aa65b8a96f767beea"><td class="memItemLeft" align="right" valign="top">lldb_private::InputReader * </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a2be4cb2149677a5aa65b8a96f767beea">get</a> () const </td></tr> <tr class="memitem:a694e8556cf0fb62da2c3297118355cee"><td class="memItemLeft" align="right" valign="top">lldb_private::InputReader & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a694e8556cf0fb62da2c3297118355cee">ref</a> () const </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:a57b27e10004af3d21e9f5a904faf2988"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a57b27e10004af3d21e9f5a904faf2988">SBDebugger</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="SBInputReader_8h_source.html#l00017">17</a> of file <a class="el" href="SBInputReader_8h_source.html">SBInputReader.h</a>.</p> </div><h2>Member Typedef Documentation</h2> <a class="anchor" id="a372c636adfdc4020a492b237880139f7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef size_t(* lldb::SBInputReader::Callback)(void *baton, <a class="el" href="classlldb_1_1SBInputReader.html">SBInputReader</a> *reader, InputReaderAction notification, const char *bytes, size_t bytes_len)</td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="SBInputReader_8h_source.html#l00021">21</a> of file <a class="el" href="SBInputReader_8h_source.html">SBInputReader.h</a>.</p> </div> </div> <h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aef8cd878f1522b5330ac6bd1292bf408"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">lldb::SBInputReader::SBInputReader </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a17a05ae24380cb267c66d5427a283519"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">lldb::SBInputReader::SBInputReader </td> <td>(</td> <td class="paramtype">const lldb::InputReaderSP & </td> <td class="paramname"><em>reader_sp</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ab8639e420e1e4cad1bacbd8532f37362"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">lldb::SBInputReader::SBInputReader </td> <td>(</td> <td class="paramtype">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> & </td> <td class="paramname"><em>rhs</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="afbb00baedea8c4216461ba11da3150e5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">lldb::SBInputReader::~SBInputReader </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2>Member Function Documentation</h2> <a class="anchor" id="a2be4cb2149677a5aa65b8a96f767beea"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">lldb_private::InputReader* lldb::SBInputReader::get </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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="a98bd1c5a1a2b807f238b3a8714616387"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">InputReaderGranularity lldb::SBInputReader::GetGranularity </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a077c8c942ee9727c92be28c61c668b6d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classlldb_1_1SBError.html">SBError</a> lldb::SBInputReader::Initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="classlldb_1_1SBDebugger.html">SBDebugger</a> & </td> <td class="paramname"><em>debugger</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">Callback</a> </td> <td class="paramname"><em>callback</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>callback_baton</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">lldb::InputReaderGranularity </td> <td class="paramname"><em>granularity</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>end_token</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>prompt</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>echo</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a4fcb6b38f31c9d301c2396bfe8ca6e78"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool lldb::SBInputReader::IsActive </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ae0234f40588db9c462e363945786fe2e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool lldb::SBInputReader::IsDone </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a50c29672aa70d5a2ca83dd5e1d735ed0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool lldb::SBInputReader::IsValid </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a29ed5730185ae11740723f1690356934"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">lldb::InputReaderSP& lldb::SBInputReader::operator* </td> <td>(</td> <td class="paramname"></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="a0f3409af81fb2f0e3be0452209e9389b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const lldb::InputReaderSP& lldb::SBInputReader::operator* </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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="a628c2f397155b315aeb39489ebe1ff4e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">lldb_private::InputReader* lldb::SBInputReader::operator-> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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="a5bcbc40e83d8e9313a68f91aa89849e0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a>& lldb::SBInputReader::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> & </td> <td class="paramname"><em>rhs</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a694e8556cf0fb62da2c3297118355cee"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">lldb_private::InputReader& lldb::SBInputReader::ref </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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="ab7dc5f6a0cf6ebe72855842765be219b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void lldb::SBInputReader::SetIsDone </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>value</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a57b27e10004af3d21e9f5a904faf2988"></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_1SBDebugger.html">SBDebugger</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="SBInputReader_8h_source.html#l00064">64</a> of file <a class="el" href="SBInputReader_8h_source.html">SBInputReader.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="SBInputReader_8h_source.html">SBInputReader.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 © 2003-2013 University of Illinois at Urbana-Champaign. All Rights Reserved.</p> <hr> <!--#include virtual="/attrib.incl" --> </body> </html>