blob: 773dc2f3878d609df22a92765e166c88d0fdbf0a [file] [log] [blame]
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>lldb.SBInputReader</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://lldb.llvm.org">LLDB python API</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="lldb-module.html">Package&nbsp;lldb</a> ::
Class&nbsp;SBInputReader
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="lldb.SBInputReader-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class SBInputReader</h1><p class="nomargin-top"><span class="codelink"><a href="lldb-pysrc.html#SBInputReader">source&nbsp;code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_lldb_sbi" name="uml_class_diagram_for_lldb_sbi">
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__swig_setmethods__" title="lldb.SBInputReader.__swig_setmethods__" alt="" coords="17,31,197,49"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__swig_getmethods__" title="lldb.SBInputReader.__swig_getmethods__" alt="" coords="17,49,197,68"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__setattr__" title="x.__setattr__(&#39;name&#39;, value) &lt;==&gt; x.name = value" alt="" coords="17,71,197,89"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__getattr__" title="lldb.SBInputReader.__getattr__" alt="" coords="17,89,197,108"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__repr__" title="repr(x)" alt="" coords="17,108,197,127"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__init__" title="__init__(lldb::SBInputReader self) &#45;&gt; SBInputReader &#160;__init__(lldb::SBInputReader self, SBInputReader rhs) &#45;&gt; SBInputReader" alt="" coords="17,127,197,145"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__swig_destroy__" title="delete_SBInputReader(SBInputReader self)" alt="" coords="17,145,197,164"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__del__" title="lldb.SBInputReader.__del__" alt="" coords="17,164,197,183"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#Initialize" title="Initialize(SBInputReader self, SBDebugger debugger, lldb::SBInputReader::Callback callback, lldb::InputReaderGranularity granularity, ..." alt="" coords="17,183,197,201"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#__nonzero__" title="lldb.SBInputReader.__nonzero__" alt="" coords="17,201,197,220"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#IsValid" title="IsValid(SBInputReader self) &#45;&gt; bool" alt="" coords="17,220,197,239"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#IsActive" title="IsActive(SBInputReader self) &#45;&gt; bool" alt="" coords="17,239,197,257"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#IsDone" title="IsDone(SBInputReader self) &#45;&gt; bool" alt="" coords="17,257,197,276"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#SetIsDone" title="SetIsDone(SBInputReader self, bool value)" alt="" coords="17,276,197,295"/>
<area shape="rect" id="node22" href="lldb.SBInputReader-class.html#GetGranularity" title="GetGranularity(SBInputReader self) &#45;&gt; lldb::InputReaderGranularity" alt="" coords="17,295,197,313"/>
<area shape="rect" id="node1" href="lldb.SBInputReader-class.html" title="Proxy of C++ lldb::SBInputReader class" alt="" coords="5,6,208,319"/>
</map>
<img src="uml_class_diagram_for_lldb_sbi.gif" alt='' usemap="#uml_class_diagram_for_lldb_sbi" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Proxy of C++ lldb::SBInputReader class</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lldb.SBInputReader-class.html#__setattr__" class="summary-sig-name">__setattr__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">value</span>)</span><br />
x.__setattr__('name', value) &lt;==&gt; x.name = value</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.__setattr__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__getattr__"></a><span class="summary-sig-name">__getattr__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.__getattr__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lldb.SBInputReader-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
repr(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#_swig_repr">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lldb.SBInputReader-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*args</span>)</span><br />
__init__(lldb::SBInputReader self) -&gt; SBInputReader
__init__(lldb::SBInputReader self, SBInputReader rhs) -&gt;
SBInputReader</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__swig_destroy__"></a><span class="summary-sig-name">__swig_destroy__</span>(<span class="summary-sig-arg">...</span>)</span><br />
delete_SBInputReader(SBInputReader self)</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.__del__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="lldb.SBInputReader-class.html#Initialize" class="summary-sig-name">Initialize</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*args</span>)</span><br />
Initialize(SBInputReader self, SBDebugger debugger, lldb::SBInputReader::Callback callback, lldb::InputReaderGranularity granularity, ...</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.Initialize">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__nonzero__"></a><span class="summary-sig-name">__nonzero__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.__nonzero__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="IsValid"></a><span class="summary-sig-name">IsValid</span>(<span class="summary-sig-arg">self</span>)</span><br />
IsValid(SBInputReader self) -&gt; bool</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.IsValid">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="IsActive"></a><span class="summary-sig-name">IsActive</span>(<span class="summary-sig-arg">self</span>)</span><br />
IsActive(SBInputReader self) -&gt; bool</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.IsActive">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="IsDone"></a><span class="summary-sig-name">IsDone</span>(<span class="summary-sig-arg">self</span>)</span><br />
IsDone(SBInputReader self) -&gt; bool</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.IsDone">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="SetIsDone"></a><span class="summary-sig-name">SetIsDone</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*args</span>)</span><br />
SetIsDone(SBInputReader self, bool value)</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.SetIsDone">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="GetGranularity"></a><span class="summary-sig-name">GetGranularity</span>(<span class="summary-sig-arg">self</span>)</span><br />
GetGranularity(SBInputReader self) -&gt; lldb::InputReaderGranularity</td>
<td align="right" valign="top">
<span class="codelink"><a href="lldb-pysrc.html#SBInputReader.GetGranularity">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="__swig_setmethods__"></a><span class="summary-name">__swig_setmethods__</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="__swig_getmethods__"></a><span class="summary-name">__swig_getmethods__</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__setattr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__setattr__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lldb-pysrc.html#SBInputReader.__setattr__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>x.__setattr__('name', value) &lt;==&gt; x.name = value</p>
<dl class="fields">
<dt>Overrides:
object.__setattr__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lldb-pysrc.html#_swig_repr">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>repr(x)</p>
<dl class="fields">
<dt>Overrides:
object.__repr__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*args</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lldb-pysrc.html#SBInputReader.__init__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>__init__(lldb::SBInputReader self) -&gt; SBInputReader
__init__(lldb::SBInputReader self, SBInputReader rhs) -&gt;
SBInputReader</p>
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="Initialize"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">Initialize</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*args</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="lldb-pysrc.html#SBInputReader.Initialize">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<pre class="literalblock">
Initialize(SBInputReader self, SBDebugger debugger, lldb::SBInputReader::Callback callback, lldb::InputReaderGranularity granularity,
str const * end_token, str const * prompt, bool echo) -&gt; SBError
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://lldb.llvm.org">LLDB python API</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Fri Jul 19 13:22:35 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>