peperunas/binaryninja
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
193103a6b4
binaryninja/commercial/api-docs/binaryninja.types-module.html

907 lines
61 KiB
HTML
Raw Normal View History

dindon
2018-12-13 18:39:52 +00:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>types module &mdash; Binary Ninja API 1.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
<link rel="top" title="Binary Ninja API 1.1.0 documentation" href="index.html"/>
<link rel="next" title="binaryninja.types.BoolWithConfidence" href="binaryninja.types.BoolWithConfidence.html"/>
<link rel="prev" title="binaryninja.transform.with_metaclass" href="binaryninja.transform.with_metaclass.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Binary Ninja API
</a>
<div class="version">
1.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="binaryninja.architecture-module.html">architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.atexit-module.html">atexit</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.basicblock-module.html">basicblock</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryninja-module.html">binaryninja</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.binaryview-module.html">binaryview</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.builtins-module.html">builtins</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.callingconvention-module.html">callingconvention</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.databuffer-module.html">databuffer</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.demangle-module.html">demangle</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.downloadprovider-module.html">downloadprovider</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.enums-module.html">enums</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.fileaccessor-module.html">fileaccessor</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.filemetadata-module.html">filemetadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.function-module.html">function</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.functionrecognizer-module.html">functionrecognizer</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.highlight-module.html">highlight</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.interaction-module.html">interaction</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lineardisassembly-module.html">lineardisassembly</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.log-module.html">log</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.lowlevelil-module.html">lowlevelil</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mainthread-module.html">mainthread</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.mediumlevelil-module.html">mediumlevelil</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.metadata-module.html">metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.platform-module.html">platform</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.plugin-module.html">plugin</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.pluginmanager-module.html">pluginmanager</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.pyopenssl-module.html">pyopenssl</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.requests-module.html">requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.scriptingprovider-module.html">scriptingprovider</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.setting-module.html">setting</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">types</a><ul>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.BoolWithConfidence.html">binaryninja.types.BoolWithConfidence</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Enumeration.html">binaryninja.types.Enumeration</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.EnumerationMember.html">binaryninja.types.EnumerationMember</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.FunctionParameter.html">binaryninja.types.FunctionParameter</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.NamedTypeReference.html">binaryninja.types.NamedTypeReference</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.QualifiedName.html">binaryninja.types.QualifiedName</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.ReferenceTypeWithConfidence.html">binaryninja.types.ReferenceTypeWithConfidence</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.RegisterSet.html">binaryninja.types.RegisterSet</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.RegisterStackAdjustmentWithConfidence.html">binaryninja.types.RegisterStackAdjustmentWithConfidence</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.SizeWithConfidence.html">binaryninja.types.SizeWithConfidence</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Structure.html">binaryninja.types.Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.StructureMember.html">binaryninja.types.StructureMember</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Symbol.html">binaryninja.types.Symbol</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Type.html">binaryninja.types.Type</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.TypeParserResult.html">binaryninja.types.TypeParserResult</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.preprocess_source.html">binaryninja.types.preprocess_source</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.pyNativeStr.html">binaryninja.types.pyNativeStr</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.range.html">binaryninja.types.range</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.undoaction-module.html">undoaction</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.update-module.html">update</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Binary Ninja API</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>types module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.types-module.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="types-module">
<h1>types module<a class="headerlink" href="#types-module" title="Permalink to this headline"></a></h1>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.BoolWithConfidence.html#binaryninja.types.BoolWithConfidence" title="binaryninja.types.BoolWithConfidence"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.BoolWithConfidence</span></code></a>(value)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.Enumeration.html#binaryninja.types.Enumeration" title="binaryninja.types.Enumeration"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.Enumeration</span></code></a>([handle])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.EnumerationMember.html#binaryninja.types.EnumerationMember" title="binaryninja.types.EnumerationMember"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.EnumerationMember</span></code></a>(name,&nbsp;...)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.FunctionParameter.html#binaryninja.types.FunctionParameter" title="binaryninja.types.FunctionParameter"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.FunctionParameter</span></code></a>(param_type)</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.NamedTypeReference.html#binaryninja.types.NamedTypeReference" title="binaryninja.types.NamedTypeReference"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.NamedTypeReference</span></code></a>([...])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.QualifiedName.html#binaryninja.types.QualifiedName" title="binaryninja.types.QualifiedName"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.QualifiedName</span></code></a>([name])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.ReferenceTypeWithConfidence.html#binaryninja.types.ReferenceTypeWithConfidence" title="binaryninja.types.ReferenceTypeWithConfidence"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.ReferenceTypeWithConfidence</span></code></a>(value)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.RegisterSet.html#binaryninja.types.RegisterSet" title="binaryninja.types.RegisterSet"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.RegisterSet</span></code></a>(reg_list[,&nbsp;...])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.RegisterStackAdjustmentWithConfidence.html#binaryninja.types.RegisterStackAdjustmentWithConfidence" title="binaryninja.types.RegisterStackAdjustmentWithConfidence"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.RegisterStackAdjustmentWithConfidence</span></code></a>(value)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.SizeWithConfidence.html#binaryninja.types.SizeWithConfidence" title="binaryninja.types.SizeWithConfidence"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.SizeWithConfidence</span></code></a>(value)</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.Structure.html#binaryninja.types.Structure" title="binaryninja.types.Structure"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.Structure</span></code></a>([handle])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.StructureMember.html#binaryninja.types.StructureMember" title="binaryninja.types.StructureMember"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.StructureMember</span></code></a>(t,&nbsp;name,&nbsp;...)</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.Symbol.html#binaryninja.types.Symbol" title="binaryninja.types.Symbol"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.Symbol</span></code></a>(sym_type,&nbsp;addr,&nbsp;...)</td>
<td>Symbols are defined as one of the following types:</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.Type.html#binaryninja.types.Type" title="binaryninja.types.Type"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.Type</span></code></a>(handle[,&nbsp;platform,&nbsp;...])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.TypeParserResult.html#binaryninja.types.TypeParserResult" title="binaryninja.types.TypeParserResult"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.TypeParserResult</span></code></a>(types,&nbsp;...)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.preprocess_source.html#binaryninja.types.preprocess_source" title="binaryninja.types.preprocess_source"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.preprocess_source</span></code></a>(source)</td>
<td><code class="docutils literal"><span class="pre">preprocess_source</span></code> run the C preprocessor on the given source or source filename.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.types.pyNativeStr.html#binaryninja.types.pyNativeStr" title="binaryninja.types.pyNativeStr"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.pyNativeStr</span></code></a>(arg)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.types.range.html#binaryninja.types.range" title="binaryninja.types.range"><code class="xref py py-obj docutils literal"><span class="pre">binaryninja.types.range</span></code></a>(*args)</td>
<td>A Python2 and Python3 Compatible Range Generator</td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-binaryninja.types"></span><dl class="class">
<dt id="binaryninja.types.BoolWithConfidence">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">BoolWithConfidence</code><span class="sig-paren">(</span><em>value</em>, <em>confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#BoolWithConfidence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.BoolWithConfidence" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.Enumeration">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">Enumeration</code><span class="sig-paren">(</span><em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Enumeration"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Enumeration" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="method">
<dt id="binaryninja.types.Enumeration.append">
<code class="descname">append</code><span class="sig-paren">(</span><em>name</em>, <em>value=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Enumeration.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Enumeration.append" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Enumeration.members">
<code class="descname">members</code><a class="headerlink" href="#binaryninja.types.Enumeration.members" title="Permalink to this definition"></a></dt>
<dd><p>Enumeration member list (read-only)</p>
</dd></dl>
<dl class="method">
<dt id="binaryninja.types.Enumeration.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>i</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Enumeration.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Enumeration.remove" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Enumeration.replace">
<code class="descname">replace</code><span class="sig-paren">(</span><em>i</em>, <em>name</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Enumeration.replace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Enumeration.replace" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.EnumerationMember">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">EnumerationMember</code><span class="sig-paren">(</span><em>name</em>, <em>value</em>, <em>default</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#EnumerationMember"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.EnumerationMember" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.FunctionParameter">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">FunctionParameter</code><span class="sig-paren">(</span><em>param_type</em>, <em>name=''</em>, <em>location=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#FunctionParameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.FunctionParameter" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.NamedTypeReference">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">NamedTypeReference</code><span class="sig-paren">(</span><em>type_class=&lt;NamedTypeReferenceClass.UnknownNamedTypeClass: 0&gt;</em>, <em>type_id=None</em>, <em>name=None</em>, <em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#NamedTypeReference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.NamedTypeReference" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="classmethod">
<dt id="binaryninja.types.NamedTypeReference.generate_auto_demangled_type_ref">
<em class="property">classmethod </em><code class="descname">generate_auto_demangled_type_ref</code><span class="sig-paren">(</span><em>type_class</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#NamedTypeReference.generate_auto_demangled_type_ref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.NamedTypeReference.generate_auto_demangled_type_ref" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.NamedTypeReference.generate_auto_type_ref">
<em class="property">classmethod </em><code class="descname">generate_auto_type_ref</code><span class="sig-paren">(</span><em>type_class</em>, <em>source</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#NamedTypeReference.generate_auto_type_ref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.NamedTypeReference.generate_auto_type_ref" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.NamedTypeReference.name">
<code class="descname">name</code><a class="headerlink" href="#binaryninja.types.NamedTypeReference.name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.NamedTypeReference.type_class">
<code class="descname">type_class</code><a class="headerlink" href="#binaryninja.types.NamedTypeReference.type_class" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.NamedTypeReference.type_id">
<code class="descname">type_id</code><a class="headerlink" href="#binaryninja.types.NamedTypeReference.type_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.QualifiedName">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">QualifiedName</code><span class="sig-paren">(</span><em>name=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#QualifiedName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.QualifiedName" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.ReferenceTypeWithConfidence">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">ReferenceTypeWithConfidence</code><span class="sig-paren">(</span><em>value</em>, <em>confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#ReferenceTypeWithConfidence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.ReferenceTypeWithConfidence" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.RegisterSet">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">RegisterSet</code><span class="sig-paren">(</span><em>reg_list</em>, <em>confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#RegisterSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.RegisterSet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="method">
<dt id="binaryninja.types.RegisterSet.with_confidence">
<code class="descname">with_confidence</code><span class="sig-paren">(</span><em>confidence</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#RegisterSet.with_confidence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.RegisterSet.with_confidence" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.RegisterStackAdjustmentWithConfidence">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">RegisterStackAdjustmentWithConfidence</code><span class="sig-paren">(</span><em>value</em>, <em>confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#RegisterStackAdjustmentWithConfidence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.RegisterStackAdjustmentWithConfidence" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.SizeWithConfidence">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">SizeWithConfidence</code><span class="sig-paren">(</span><em>value</em>, <em>confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#SizeWithConfidence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.SizeWithConfidence" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.Structure">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">Structure</code><span class="sig-paren">(</span><em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Structure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Structure" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="binaryninja.types.Structure.alignment">
<code class="descname">alignment</code><a class="headerlink" href="#binaryninja.types.Structure.alignment" title="Permalink to this definition"></a></dt>
<dd><p>Structure alignment</p>
</dd></dl>
<dl class="method">
<dt id="binaryninja.types.Structure.append">
<code class="descname">append</code><span class="sig-paren">(</span><em>t</em>, <em>name=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Structure.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Structure.append" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Structure.insert">
<code class="descname">insert</code><span class="sig-paren">(</span><em>offset</em>, <em>t</em>, <em>name=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Structure.insert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Structure.insert" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Structure.members">
<code class="descname">members</code><a class="headerlink" href="#binaryninja.types.Structure.members" title="Permalink to this definition"></a></dt>
<dd><p>Structure member list (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Structure.packed">
<code class="descname">packed</code><a class="headerlink" href="#binaryninja.types.Structure.packed" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Structure.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>i</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Structure.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Structure.remove" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Structure.replace">
<code class="descname">replace</code><span class="sig-paren">(</span><em>i</em>, <em>t</em>, <em>name=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Structure.replace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Structure.replace" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Structure.type">
<code class="descname">type</code><a class="headerlink" href="#binaryninja.types.Structure.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Structure.union">
<code class="descname">union</code><a class="headerlink" href="#binaryninja.types.Structure.union" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Structure.width">
<code class="descname">width</code><a class="headerlink" href="#binaryninja.types.Structure.width" title="Permalink to this definition"></a></dt>
<dd><p>Structure width</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.StructureMember">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">StructureMember</code><span class="sig-paren">(</span><em>t</em>, <em>name</em>, <em>offset</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#StructureMember"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.StructureMember" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.Symbol">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">Symbol</code><span class="sig-paren">(</span><em>sym_type</em>, <em>addr</em>, <em>short_name</em>, <em>full_name=None</em>, <em>raw_name=None</em>, <em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Symbol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Symbol" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>Symbols are defined as one of the following types:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">SymbolType</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>FunctionSymbol</td>
<td>Symbol for Function that exists in the current binary</td>
</tr>
<tr class="row-odd"><td>ImportAddressSymbol</td>
<td>Symbol defined in the Import Address Table</td>
</tr>
<tr class="row-even"><td>ImportedFunctionSymbol</td>
<td>Symbol for Function that is not defined in the current binary</td>
</tr>
<tr class="row-odd"><td>DataSymbol</td>
<td>Symbol for Data in the current binary</td>
</tr>
<tr class="row-even"><td>ImportedDataSymbol</td>
<td>Symbol for Data that is not defined in the current binary</td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="attribute">
<dt id="binaryninja.types.Symbol.address">
<code class="descname">address</code><a class="headerlink" href="#binaryninja.types.Symbol.address" title="Permalink to this definition"></a></dt>
<dd><p>Symbol address (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Symbol.auto">
<code class="descname">auto</code><a class="headerlink" href="#binaryninja.types.Symbol.auto" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Symbol.full_name">
<code class="descname">full_name</code><a class="headerlink" href="#binaryninja.types.Symbol.full_name" title="Permalink to this definition"></a></dt>
<dd><p>Symbol full name (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Symbol.name">
<code class="descname">name</code><a class="headerlink" href="#binaryninja.types.Symbol.name" title="Permalink to this definition"></a></dt>
<dd><p>Symbol name (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Symbol.raw_name">
<code class="descname">raw_name</code><a class="headerlink" href="#binaryninja.types.Symbol.raw_name" title="Permalink to this definition"></a></dt>
<dd><p>Symbol raw name (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Symbol.short_name">
<code class="descname">short_name</code><a class="headerlink" href="#binaryninja.types.Symbol.short_name" title="Permalink to this definition"></a></dt>
<dd><p>Symbol short name (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Symbol.type">
<code class="descname">type</code><a class="headerlink" href="#binaryninja.types.Symbol.type" title="Permalink to this definition"></a></dt>
<dd><p>Symbol type (read-only)</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.Type">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">Type</code><span class="sig-paren">(</span><em>handle</em>, <em>platform=None</em>, <em>confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="binaryninja.types.Type.alignment">
<code class="descname">alignment</code><a class="headerlink" href="#binaryninja.types.Type.alignment" title="Permalink to this definition"></a></dt>
<dd><p>Type alignment (read-only)</p>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.array">
<em class="property">classmethod </em><code class="descname">array</code><span class="sig-paren">(</span><em>t</em>, <em>count</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.array"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.array" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.bool">
<em class="property">classmethod </em><code class="descname">bool</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.bool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.bool" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.calling_convention">
<code class="descname">calling_convention</code><a class="headerlink" href="#binaryninja.types.Type.calling_convention" title="Permalink to this definition"></a></dt>
<dd><p>Calling convention (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.can_return">
<code class="descname">can_return</code><a class="headerlink" href="#binaryninja.types.Type.can_return" title="Permalink to this definition"></a></dt>
<dd><p>Whether type can return (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.const">
<code class="descname">const</code><a class="headerlink" href="#binaryninja.types.Type.const" title="Permalink to this definition"></a></dt>
<dd><p>Whether type is const (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.count">
<code class="descname">count</code><a class="headerlink" href="#binaryninja.types.Type.count" title="Permalink to this definition"></a></dt>
<dd><p>Type count (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.element_type">
<code class="descname">element_type</code><a class="headerlink" href="#binaryninja.types.Type.element_type" title="Permalink to this definition"></a></dt>
<dd><p>Target (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.enumeration">
<code class="descname">enumeration</code><a class="headerlink" href="#binaryninja.types.Type.enumeration" title="Permalink to this definition"></a></dt>
<dd><p>Type enumeration (read-only)</p>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.enumeration_type">
<em class="property">classmethod </em><code class="descname">enumeration_type</code><span class="sig-paren">(</span><em>arch</em>, <em>e</em>, <em>width=None</em>, <em>sign=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.enumeration_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.enumeration_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.float">
<em class="property">classmethod </em><code class="descname">float</code><span class="sig-paren">(</span><em>width</em>, <em>altname=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.float"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.float" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal"><span class="pre">float</span></code> class method for creating an floating point Types.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>width</strong> (<a class="reference internal" href="#binaryninja.types.Type.int" title="binaryninja.types.Type.int"><em>int</em></a>) &#8211; width of the floating point number in bytes</li>
<li><strong>altname</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; alternate name for type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.function">
<em class="property">classmethod </em><code class="descname">function</code><span class="sig-paren">(</span><em>ret</em>, <em>params</em>, <em>calling_convention=None</em>, <em>variable_arguments=None</em>, <em>stack_adjust=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.function" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal"><span class="pre">function</span></code> class method for creating an function Type.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ret</strong> (<a class="reference internal" href="binaryninja.types.Type.html#binaryninja.types.Type" title="binaryninja.types.Type"><em>Type</em></a>) &#8211; width of the integer in bytes</li>
<li><strong>params</strong> (<em>list(Type)</em>) &#8211; list of parameter Types</li>
<li><strong>calling_convention</strong> (<a class="reference internal" href="binaryninja.callingconvention.CallingConvention.html#binaryninja.callingconvention.CallingConvention" title="binaryninja.callingconvention.CallingConvention"><em>CallingConvention</em></a>) &#8211; optional argument for function calling convention</li>
<li><strong>variable_arguments</strong> (<a class="reference internal" href="#binaryninja.types.Type.bool" title="binaryninja.types.Type.bool"><em>bool</em></a>) &#8211; optional argument for functions that have a variable number of arguments</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.generate_auto_demangled_type_id">
<em class="property">classmethod </em><code class="descname">generate_auto_demangled_type_id</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.generate_auto_demangled_type_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.generate_auto_demangled_type_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.generate_auto_type_id">
<em class="property">classmethod </em><code class="descname">generate_auto_type_id</code><span class="sig-paren">(</span><em>source</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.generate_auto_type_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.generate_auto_type_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.get_auto_demangled_type_id_source">
<em class="property">classmethod </em><code class="descname">get_auto_demangled_type_id_source</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.get_auto_demangled_type_id_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.get_auto_demangled_type_id_source" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Type.get_string_after_name">
<code class="descname">get_string_after_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.get_string_after_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.get_string_after_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Type.get_string_before_name">
<code class="descname">get_string_before_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.get_string_before_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.get_string_before_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Type.get_tokens">
<code class="descname">get_tokens</code><span class="sig-paren">(</span><em>base_confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.get_tokens"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.get_tokens" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Type.get_tokens_after_name">
<code class="descname">get_tokens_after_name</code><span class="sig-paren">(</span><em>base_confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.get_tokens_after_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.get_tokens_after_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.types.Type.get_tokens_before_name">
<code class="descname">get_tokens_before_name</code><span class="sig-paren">(</span><em>base_confidence=255</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.get_tokens_before_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.get_tokens_before_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.has_variable_arguments">
<code class="descname">has_variable_arguments</code><a class="headerlink" href="#binaryninja.types.Type.has_variable_arguments" title="Permalink to this definition"></a></dt>
<dd><p>Whether type has variable arguments (read-only)</p>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.int">
<em class="property">classmethod </em><code class="descname">int</code><span class="sig-paren">(</span><em>width</em>, <em>sign=None</em>, <em>altname=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.int"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.int" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal"><span class="pre">int</span></code> class method for creating an int Type.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>width</strong> (<a class="reference internal" href="#binaryninja.types.Type.int" title="binaryninja.types.Type.int"><em>int</em></a>) &#8211; width of the integer in bytes</li>
<li><strong>sign</strong> (<a class="reference internal" href="#binaryninja.types.Type.bool" title="binaryninja.types.Type.bool"><em>bool</em></a>) &#8211; optional variable representing signedness</li>
<li><strong>altname</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; alternate name for type</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.modified">
<code class="descname">modified</code><a class="headerlink" href="#binaryninja.types.Type.modified" title="Permalink to this definition"></a></dt>
<dd><p>Whether type is modified (read-only)</p>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.named_type">
<em class="property">classmethod </em><code class="descname">named_type</code><span class="sig-paren">(</span><em>named_type</em>, <em>width=0</em>, <em>align=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.named_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.named_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.named_type_from_registered_type">
<em class="property">classmethod </em><code class="descname">named_type_from_registered_type</code><span class="sig-paren">(</span><em>view</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.named_type_from_registered_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.named_type_from_registered_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.named_type_from_type">
<em class="property">classmethod </em><code class="descname">named_type_from_type</code><span class="sig-paren">(</span><em>name</em>, <em>t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.named_type_from_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.named_type_from_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.named_type_from_type_and_id">
<em class="property">classmethod </em><code class="descname">named_type_from_type_and_id</code><span class="sig-paren">(</span><em>type_id</em>, <em>name</em>, <em>t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.named_type_from_type_and_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.named_type_from_type_and_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.named_type_reference">
<code class="descname">named_type_reference</code><a class="headerlink" href="#binaryninja.types.Type.named_type_reference" title="Permalink to this definition"></a></dt>
<dd><p>Reference to a named type (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.offset">
<code class="descname">offset</code><a class="headerlink" href="#binaryninja.types.Type.offset" title="Permalink to this definition"></a></dt>
<dd><p>Offset into structure (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.parameters">
<code class="descname">parameters</code><a class="headerlink" href="#binaryninja.types.Type.parameters" title="Permalink to this definition"></a></dt>
<dd><p>Type parameters list (read-only)</p>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.pointer">
<em class="property">classmethod </em><code class="descname">pointer</code><span class="sig-paren">(</span><em>arch</em>, <em>t</em>, <em>const=None</em>, <em>volatile=None</em>, <em>ref_type=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.pointer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.pointer" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.return_value">
<code class="descname">return_value</code><a class="headerlink" href="#binaryninja.types.Type.return_value" title="Permalink to this definition"></a></dt>
<dd><p>Return value (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.signed">
<code class="descname">signed</code><a class="headerlink" href="#binaryninja.types.Type.signed" title="Permalink to this definition"></a></dt>
<dd><p>Wether type is signed (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.stack_adjustment">
<code class="descname">stack_adjustment</code><a class="headerlink" href="#binaryninja.types.Type.stack_adjustment" title="Permalink to this definition"></a></dt>
<dd><p>Stack adjustment for function (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.structure">
<code class="descname">structure</code><a class="headerlink" href="#binaryninja.types.Type.structure" title="Permalink to this definition"></a></dt>
<dd><p>Structure of the type (read-only)</p>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.structure_type">
<em class="property">classmethod </em><code class="descname">structure_type</code><span class="sig-paren">(</span><em>structure_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.structure_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.structure_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.target">
<code class="descname">target</code><a class="headerlink" href="#binaryninja.types.Type.target" title="Permalink to this definition"></a></dt>
<dd><p>Target (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.tokens">
<code class="descname">tokens</code><a class="headerlink" href="#binaryninja.types.Type.tokens" title="Permalink to this definition"></a></dt>
<dd><p>Type string as a list of tokens (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.type_class">
<code class="descname">type_class</code><a class="headerlink" href="#binaryninja.types.Type.type_class" title="Permalink to this definition"></a></dt>
<dd><p>Type class (read-only)</p>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.types.Type.void">
<em class="property">classmethod </em><code class="descname">void</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.void" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.types.Type.width">
<code class="descname">width</code><a class="headerlink" href="#binaryninja.types.Type.width" title="Permalink to this definition"></a></dt>
<dd><p>Type width (read-only)</p>
</dd></dl>
<dl class="method">
<dt id="binaryninja.types.Type.with_confidence">
<code class="descname">with_confidence</code><span class="sig-paren">(</span><em>confidence</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#Type.with_confidence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.Type.with_confidence" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.types.TypeParserResult">
<em class="property">class </em><code class="descclassname">binaryninja.types.</code><code class="descname">TypeParserResult</code><span class="sig-paren">(</span><em>types</em>, <em>variables</em>, <em>functions</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#TypeParserResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.TypeParserResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
</dd></dl>
<dl class="function">
<dt id="binaryninja.types.preprocess_source">
<code class="descclassname">binaryninja.types.</code><code class="descname">preprocess_source</code><span class="sig-paren">(</span><em>source</em>, <em>filename=None</em>, <em>include_dirs=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#preprocess_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.preprocess_source" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal"><span class="pre">preprocess_source</span></code> run the C preprocessor on the given source or source filename.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>source</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; source to preprocess</li>
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; optional filename to preprocess</li>
<li><strong>include_dirs</strong> (<em>list(str)</em>) &#8211; list of string directorires to use as include directories.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">returns a tuple of (preprocessed_source, error_string)</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">tuple(str,str)</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">source</span> <span class="o">=</span> <span class="s2">&quot;#define TEN 10</span><span class="se">\n</span><span class="s2">int x[TEN];</span><span class="se">\n</span><span class="s2">&quot;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">preprocess_source</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
<span class="go">(&#39;#line 1 &quot;input&quot;\n\n#line 2 &quot;input&quot;\n int x [ 10 ] ;\n&#39;, &#39;&#39;)</span>
<span class="go">&gt;&gt;&gt;</span>
</pre></div>
</div>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.types.BoolWithConfidence.html" class="btn btn-neutral float-right" title="binaryninja.types.BoolWithConfidence" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.transform.with_metaclass.html" class="btn btn-neutral" title="binaryninja.transform.with_metaclass" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016, Vector 35 LLC.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.1.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
Reference in New Issue Copy Permalink