]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - www/cpp_reference/html/classlldb_1_1SBInputReader.html
Vendor import of lldb trunk r256945:
[FreeBSD/FreeBSD.git] / www / cpp_reference / html / classlldb_1_1SBInputReader.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: lldb::SBInputReader Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
16       <li><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="annotated.html"><span>Class&#160;List</span></a></li>
22       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
23       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
24     </ul>
25   </div>
26 <div id="nav-path" class="navpath">
27   <ul>
28 <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>
29 </div>
30 </div><!-- top -->
31 <div class="header">
32   <div class="summary">
33 <a href="#pub-types">Public Types</a> &#124;
34 <a href="#pub-methods">Public Member Functions</a> &#124;
35 <a href="#pro-methods">Protected Member Functions</a> &#124;
36 <a href="#friends">Friends</a> &#124;
37 <a href="classlldb_1_1SBInputReader-members.html">List of all members</a>  </div>
38   <div class="headertitle">
39 <div class="title">lldb::SBInputReader Class Reference</div>  </div>
40 </div><!--header-->
41 <div class="contents">
42
43 <p><code>#include &lt;<a class="el" href="SBInputReader_8h_source.html">SBInputReader.h</a>&gt;</code></p>
44 <table class="memberdecls">
45 <tr class="heading"><td colspan="2"><h2><a name="pub-types"></a>
46 Public Types</h2></td></tr>
47 <tr class="memitem:a372c636adfdc4020a492b237880139f7"><td class="memItemLeft" align="right" valign="top">typedef size_t(*&#160;</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>
48 </table><table class="memberdecls">
49 <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
50 Public Member Functions</h2></td></tr>
51 <tr class="memitem:aef8cd878f1522b5330ac6bd1292bf408"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#aef8cd878f1522b5330ac6bd1292bf408">SBInputReader</a> ()</td></tr>
52 <tr class="memitem:a17a05ae24380cb267c66d5427a283519"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a17a05ae24380cb267c66d5427a283519">SBInputReader</a> (const lldb::InputReaderSP &amp;reader_sp)</td></tr>
53 <tr class="memitem:ab8639e420e1e4cad1bacbd8532f37362"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;rhs)</td></tr>
54 <tr class="memitem:afbb00baedea8c4216461ba11da3150e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#afbb00baedea8c4216461ba11da3150e5">~SBInputReader</a> ()</td></tr>
55 <tr class="memitem:a077c8c942ee9727c92be28c61c668b6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlldb_1_1SBError.html">SBError</a>&#160;</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> &amp;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>
56 <tr class="memitem:a50c29672aa70d5a2ca83dd5e1d735ed0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a50c29672aa70d5a2ca83dd5e1d735ed0">IsValid</a> () const </td></tr>
57 <tr class="memitem:a5bcbc40e83d8e9313a68f91aa89849e0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &amp;&#160;</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> &amp;rhs)</td></tr>
58 <tr class="memitem:a4fcb6b38f31c9d301c2396bfe8ca6e78"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a4fcb6b38f31c9d301c2396bfe8ca6e78">IsActive</a> () const </td></tr>
59 <tr class="memitem:ae0234f40588db9c462e363945786fe2e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#ae0234f40588db9c462e363945786fe2e">IsDone</a> () const </td></tr>
60 <tr class="memitem:ab7dc5f6a0cf6ebe72855842765be219b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#ab7dc5f6a0cf6ebe72855842765be219b">SetIsDone</a> (bool value)</td></tr>
61 <tr class="memitem:a98bd1c5a1a2b807f238b3a8714616387"><td class="memItemLeft" align="right" valign="top">InputReaderGranularity&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a98bd1c5a1a2b807f238b3a8714616387">GetGranularity</a> ()</td></tr>
62 </table><table class="memberdecls">
63 <tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
64 Protected Member Functions</h2></td></tr>
65 <tr class="memitem:a628c2f397155b315aeb39489ebe1ff4e"><td class="memItemLeft" align="right" valign="top">lldb_private::InputReader *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a628c2f397155b315aeb39489ebe1ff4e">operator-&gt;</a> () const </td></tr>
66 <tr class="memitem:a29ed5730185ae11740723f1690356934"><td class="memItemLeft" align="right" valign="top">lldb::InputReaderSP &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a29ed5730185ae11740723f1690356934">operator*</a> ()</td></tr>
67 <tr class="memitem:a0f3409af81fb2f0e3be0452209e9389b"><td class="memItemLeft" align="right" valign="top">const lldb::InputReaderSP &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a0f3409af81fb2f0e3be0452209e9389b">operator*</a> () const </td></tr>
68 <tr class="memitem:a2be4cb2149677a5aa65b8a96f767beea"><td class="memItemLeft" align="right" valign="top">lldb_private::InputReader *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a2be4cb2149677a5aa65b8a96f767beea">get</a> () const </td></tr>
69 <tr class="memitem:a694e8556cf0fb62da2c3297118355cee"><td class="memItemLeft" align="right" valign="top">lldb_private::InputReader &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a694e8556cf0fb62da2c3297118355cee">ref</a> () const </td></tr>
70 </table><table class="memberdecls">
71 <tr class="heading"><td colspan="2"><h2><a name="friends"></a>
72 Friends</h2></td></tr>
73 <tr class="memitem:a57b27e10004af3d21e9f5a904faf2988"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBInputReader.html#a57b27e10004af3d21e9f5a904faf2988">SBDebugger</a></td></tr>
74 </table>
75 <a name="details" id="details"></a><h2>Detailed Description</h2>
76 <div class="textblock">
77 <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>
78 </div><h2>Member Typedef Documentation</h2>
79 <a class="anchor" id="a372c636adfdc4020a492b237880139f7"></a>
80 <div class="memitem">
81 <div class="memproto">
82       <table class="memname">
83         <tr>
84           <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>
85         </tr>
86       </table>
87 </div><div class="memdoc">
88
89 <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>
90
91 </div>
92 </div>
93 <h2>Constructor &amp; Destructor Documentation</h2>
94 <a class="anchor" id="aef8cd878f1522b5330ac6bd1292bf408"></a>
95 <div class="memitem">
96 <div class="memproto">
97       <table class="memname">
98         <tr>
99           <td class="memname">lldb::SBInputReader::SBInputReader </td>
100           <td>(</td>
101           <td class="paramname"></td><td>)</td>
102           <td></td>
103         </tr>
104       </table>
105 </div><div class="memdoc">
106
107 </div>
108 </div>
109 <a class="anchor" id="a17a05ae24380cb267c66d5427a283519"></a>
110 <div class="memitem">
111 <div class="memproto">
112       <table class="memname">
113         <tr>
114           <td class="memname">lldb::SBInputReader::SBInputReader </td>
115           <td>(</td>
116           <td class="paramtype">const lldb::InputReaderSP &amp;&#160;</td>
117           <td class="paramname"><em>reader_sp</em></td><td>)</td>
118           <td></td>
119         </tr>
120       </table>
121 </div><div class="memdoc">
122
123 </div>
124 </div>
125 <a class="anchor" id="ab8639e420e1e4cad1bacbd8532f37362"></a>
126 <div class="memitem">
127 <div class="memproto">
128       <table class="memname">
129         <tr>
130           <td class="memname">lldb::SBInputReader::SBInputReader </td>
131           <td>(</td>
132           <td class="paramtype">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &amp;&#160;</td>
133           <td class="paramname"><em>rhs</em></td><td>)</td>
134           <td></td>
135         </tr>
136       </table>
137 </div><div class="memdoc">
138
139 </div>
140 </div>
141 <a class="anchor" id="afbb00baedea8c4216461ba11da3150e5"></a>
142 <div class="memitem">
143 <div class="memproto">
144       <table class="memname">
145         <tr>
146           <td class="memname">lldb::SBInputReader::~SBInputReader </td>
147           <td>(</td>
148           <td class="paramname"></td><td>)</td>
149           <td></td>
150         </tr>
151       </table>
152 </div><div class="memdoc">
153
154 </div>
155 </div>
156 <h2>Member Function Documentation</h2>
157 <a class="anchor" id="a2be4cb2149677a5aa65b8a96f767beea"></a>
158 <div class="memitem">
159 <div class="memproto">
160 <table class="mlabels">
161   <tr>
162   <td class="mlabels-left">
163       <table class="memname">
164         <tr>
165           <td class="memname">lldb_private::InputReader* lldb::SBInputReader::get </td>
166           <td>(</td>
167           <td class="paramname"></td><td>)</td>
168           <td> const</td>
169         </tr>
170       </table>
171   </td>
172   <td class="mlabels-right">
173 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
174   </tr>
175 </table>
176 </div><div class="memdoc">
177
178 </div>
179 </div>
180 <a class="anchor" id="a98bd1c5a1a2b807f238b3a8714616387"></a>
181 <div class="memitem">
182 <div class="memproto">
183       <table class="memname">
184         <tr>
185           <td class="memname">InputReaderGranularity lldb::SBInputReader::GetGranularity </td>
186           <td>(</td>
187           <td class="paramname"></td><td>)</td>
188           <td></td>
189         </tr>
190       </table>
191 </div><div class="memdoc">
192
193 </div>
194 </div>
195 <a class="anchor" id="a077c8c942ee9727c92be28c61c668b6d"></a>
196 <div class="memitem">
197 <div class="memproto">
198       <table class="memname">
199         <tr>
200           <td class="memname"><a class="el" href="classlldb_1_1SBError.html">SBError</a> lldb::SBInputReader::Initialize </td>
201           <td>(</td>
202           <td class="paramtype"><a class="el" href="classlldb_1_1SBDebugger.html">SBDebugger</a> &amp;&#160;</td>
203           <td class="paramname"><em>debugger</em>, </td>
204         </tr>
205         <tr>
206           <td class="paramkey"></td>
207           <td></td>
208           <td class="paramtype"><a class="el" href="classlldb_1_1SBInputReader.html#a372c636adfdc4020a492b237880139f7">Callback</a>&#160;</td>
209           <td class="paramname"><em>callback</em>, </td>
210         </tr>
211         <tr>
212           <td class="paramkey"></td>
213           <td></td>
214           <td class="paramtype">void *&#160;</td>
215           <td class="paramname"><em>callback_baton</em>, </td>
216         </tr>
217         <tr>
218           <td class="paramkey"></td>
219           <td></td>
220           <td class="paramtype">lldb::InputReaderGranularity&#160;</td>
221           <td class="paramname"><em>granularity</em>, </td>
222         </tr>
223         <tr>
224           <td class="paramkey"></td>
225           <td></td>
226           <td class="paramtype">const char *&#160;</td>
227           <td class="paramname"><em>end_token</em>, </td>
228         </tr>
229         <tr>
230           <td class="paramkey"></td>
231           <td></td>
232           <td class="paramtype">const char *&#160;</td>
233           <td class="paramname"><em>prompt</em>, </td>
234         </tr>
235         <tr>
236           <td class="paramkey"></td>
237           <td></td>
238           <td class="paramtype">bool&#160;</td>
239           <td class="paramname"><em>echo</em>&#160;</td>
240         </tr>
241         <tr>
242           <td></td>
243           <td>)</td>
244           <td></td><td></td>
245         </tr>
246       </table>
247 </div><div class="memdoc">
248
249 </div>
250 </div>
251 <a class="anchor" id="a4fcb6b38f31c9d301c2396bfe8ca6e78"></a>
252 <div class="memitem">
253 <div class="memproto">
254       <table class="memname">
255         <tr>
256           <td class="memname">bool lldb::SBInputReader::IsActive </td>
257           <td>(</td>
258           <td class="paramname"></td><td>)</td>
259           <td> const</td>
260         </tr>
261       </table>
262 </div><div class="memdoc">
263
264 </div>
265 </div>
266 <a class="anchor" id="ae0234f40588db9c462e363945786fe2e"></a>
267 <div class="memitem">
268 <div class="memproto">
269       <table class="memname">
270         <tr>
271           <td class="memname">bool lldb::SBInputReader::IsDone </td>
272           <td>(</td>
273           <td class="paramname"></td><td>)</td>
274           <td> const</td>
275         </tr>
276       </table>
277 </div><div class="memdoc">
278
279 </div>
280 </div>
281 <a class="anchor" id="a50c29672aa70d5a2ca83dd5e1d735ed0"></a>
282 <div class="memitem">
283 <div class="memproto">
284       <table class="memname">
285         <tr>
286           <td class="memname">bool lldb::SBInputReader::IsValid </td>
287           <td>(</td>
288           <td class="paramname"></td><td>)</td>
289           <td> const</td>
290         </tr>
291       </table>
292 </div><div class="memdoc">
293
294 </div>
295 </div>
296 <a class="anchor" id="a29ed5730185ae11740723f1690356934"></a>
297 <div class="memitem">
298 <div class="memproto">
299 <table class="mlabels">
300   <tr>
301   <td class="mlabels-left">
302       <table class="memname">
303         <tr>
304           <td class="memname">lldb::InputReaderSP&amp; lldb::SBInputReader::operator* </td>
305           <td>(</td>
306           <td class="paramname"></td><td>)</td>
307           <td></td>
308         </tr>
309       </table>
310   </td>
311   <td class="mlabels-right">
312 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
313   </tr>
314 </table>
315 </div><div class="memdoc">
316
317 </div>
318 </div>
319 <a class="anchor" id="a0f3409af81fb2f0e3be0452209e9389b"></a>
320 <div class="memitem">
321 <div class="memproto">
322 <table class="mlabels">
323   <tr>
324   <td class="mlabels-left">
325       <table class="memname">
326         <tr>
327           <td class="memname">const lldb::InputReaderSP&amp; lldb::SBInputReader::operator* </td>
328           <td>(</td>
329           <td class="paramname"></td><td>)</td>
330           <td> const</td>
331         </tr>
332       </table>
333   </td>
334   <td class="mlabels-right">
335 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
336   </tr>
337 </table>
338 </div><div class="memdoc">
339
340 </div>
341 </div>
342 <a class="anchor" id="a628c2f397155b315aeb39489ebe1ff4e"></a>
343 <div class="memitem">
344 <div class="memproto">
345 <table class="mlabels">
346   <tr>
347   <td class="mlabels-left">
348       <table class="memname">
349         <tr>
350           <td class="memname">lldb_private::InputReader* lldb::SBInputReader::operator-&gt; </td>
351           <td>(</td>
352           <td class="paramname"></td><td>)</td>
353           <td> const</td>
354         </tr>
355       </table>
356   </td>
357   <td class="mlabels-right">
358 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
359   </tr>
360 </table>
361 </div><div class="memdoc">
362
363 </div>
364 </div>
365 <a class="anchor" id="a5bcbc40e83d8e9313a68f91aa89849e0"></a>
366 <div class="memitem">
367 <div class="memproto">
368       <table class="memname">
369         <tr>
370           <td class="memname">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a>&amp; lldb::SBInputReader::operator= </td>
371           <td>(</td>
372           <td class="paramtype">const <a class="el" href="classlldb_1_1SBInputReader.html">lldb::SBInputReader</a> &amp;&#160;</td>
373           <td class="paramname"><em>rhs</em></td><td>)</td>
374           <td></td>
375         </tr>
376       </table>
377 </div><div class="memdoc">
378
379 </div>
380 </div>
381 <a class="anchor" id="a694e8556cf0fb62da2c3297118355cee"></a>
382 <div class="memitem">
383 <div class="memproto">
384 <table class="mlabels">
385   <tr>
386   <td class="mlabels-left">
387       <table class="memname">
388         <tr>
389           <td class="memname">lldb_private::InputReader&amp; lldb::SBInputReader::ref </td>
390           <td>(</td>
391           <td class="paramname"></td><td>)</td>
392           <td> const</td>
393         </tr>
394       </table>
395   </td>
396   <td class="mlabels-right">
397 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
398   </tr>
399 </table>
400 </div><div class="memdoc">
401
402 </div>
403 </div>
404 <a class="anchor" id="ab7dc5f6a0cf6ebe72855842765be219b"></a>
405 <div class="memitem">
406 <div class="memproto">
407       <table class="memname">
408         <tr>
409           <td class="memname">void lldb::SBInputReader::SetIsDone </td>
410           <td>(</td>
411           <td class="paramtype">bool&#160;</td>
412           <td class="paramname"><em>value</em></td><td>)</td>
413           <td></td>
414         </tr>
415       </table>
416 </div><div class="memdoc">
417
418 </div>
419 </div>
420 <h2>Friends And Related Function Documentation</h2>
421 <a class="anchor" id="a57b27e10004af3d21e9f5a904faf2988"></a>
422 <div class="memitem">
423 <div class="memproto">
424 <table class="mlabels">
425   <tr>
426   <td class="mlabels-left">
427       <table class="memname">
428         <tr>
429           <td class="memname">friend class <a class="el" href="classlldb_1_1SBDebugger.html">SBDebugger</a></td>
430         </tr>
431       </table>
432   </td>
433   <td class="mlabels-right">
434 <span class="mlabels"><span class="mlabel">friend</span></span>  </td>
435   </tr>
436 </table>
437 </div><div class="memdoc">
438
439 <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>
440
441 </div>
442 </div>
443 <hr/>The documentation for this class was generated from the following file:<ul>
444 <li><a class="el" href="SBInputReader_8h_source.html">SBInputReader.h</a></li>
445 </ul>
446 </div><!-- contents -->
447 <hr>
448 <p class="footer">
449 Generated on Fri Jul 19 2013 13:25:55 for <a href="http://lldb.llvm.org/">LLVM</a> by
450 <a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
451 align="middle" border="0"/>1.8.1.2</a><br>
452 Copyright &copy; 2003-2013 University of Illinois at Urbana-Champaign.
453 All Rights Reserved.</p>
454 <hr>
455 <!--#include virtual="/attrib.incl" -->
456 </body>
457 </html>