binaryninja/personal/api-docs/binaryninja.datarender.InstructionTextToken.html

397 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>binaryninja.datarender.InstructionTextToken &mdash; Binary Ninja API Documentation v1.1</title>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Binary Ninja API Documentation v1.1" href="index.html"/>
<link rel="up" title="datarender module" href="binaryninja.datarender-module.html"/>
<link rel="next" title="binaryninja.datarender.Type" href="binaryninja.datarender.Type.html"/>
<link rel="prev" title="binaryninja.datarender.FileMetadata" href="binaryninja.datarender.FileMetadata.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">
<script>
window.addEventListener("load", function() {
var ver = document.getElementsByClassName("version");
ver[0].innerHTML = DOCUMENTATION_OPTIONS['VERSION'];
});
</script>
</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.binaryview-module.html">binaryview</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 current"><a class="reference internal" href="binaryninja.datarender-module.html">datarender</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.BinaryView.html">binaryninja.datarender.BinaryView</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.DataRenderer.html">binaryninja.datarender.DataRenderer</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.DisassemblyTextLine.html">binaryninja.datarender.DisassemblyTextLine</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.FileMetadata.html">binaryninja.datarender.FileMetadata</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">binaryninja.datarender.InstructionTextToken</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.Type.html">binaryninja.datarender.Type</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.datarender.log_error.html">binaryninja.datarender.log_error</a></li>
</ul>
</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.flowgraph-module.html">flowgraph</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.numbers-module.html">numbers</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.scriptingprovider-module.html">scriptingprovider</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.settings-module.html">settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
<li class="toctree-l1"><a class="reference internal" href="binaryninja.types-module.html">types</a></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><a href="binaryninja.datarender-module.html">datarender module</a> &raquo;</li>
<li>binaryninja.datarender.InstructionTextToken</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.datarender.InstructionTextToken.rst.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="binaryninja-datarender-instructiontexttoken">
<h1>binaryninja.datarender.InstructionTextToken<a class="headerlink" href="#binaryninja-datarender-instructiontexttoken" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="binaryninja.datarender.InstructionTextToken">
<em class="property">class </em><code class="descname">InstructionTextToken</code><span class="sig-paren">(</span><em>token_type</em>, <em>text</em>, <em>value=0</em>, <em>size=0</em>, <em>operand=4294967295</em>, <em>context=&lt;InstructionTextTokenContext.NoTokenContext: 0&gt;</em>, <em>address=0</em>, <em>confidence=255</em>, <em>typeNames=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/function.html#InstructionTextToken"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.InstructionTextToken" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">InstructionTextToken</span></code> is used to tell the core about the various components in the disassembly views.</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="37%" />
<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">InstructionTextTokenType</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>TextToken</td>
<td>Text that doesnt fit into the other tokens</td>
</tr>
<tr class="row-odd"><td>InstructionToken</td>
<td>The instruction mnemonic</td>
</tr>
<tr class="row-even"><td>OperandSeparatorToken</td>
<td>The comma or whatever else separates tokens</td>
</tr>
<tr class="row-odd"><td>RegisterToken</td>
<td>Registers</td>
</tr>
<tr class="row-even"><td>IntegerToken</td>
<td>Integers</td>
</tr>
<tr class="row-odd"><td>PossibleAddressToken</td>
<td>Integers that are likely addresses</td>
</tr>
<tr class="row-even"><td>BeginMemoryOperandToken</td>
<td>The start of memory operand</td>
</tr>
<tr class="row-odd"><td>EndMemoryOperandToken</td>
<td>The end of a memory operand</td>
</tr>
<tr class="row-even"><td>FloatingPointToken</td>
<td>Floating point number</td>
</tr>
<tr class="row-odd"><td>AnnotationToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>CodeRelativeAddressToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>StackVariableTypeToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>DataVariableTypeToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>FunctionReturnTypeToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>FunctionAttributeToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>ArgumentTypeToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>ArgumentNameToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>HexDumpByteValueToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>HexDumpSkippedByteToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>HexDumpInvalidByteToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>HexDumpTextToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>OpcodeToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>StringToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>CharacterConstantToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>CodeSymbolToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>DataSymbolToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>StackVariableToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-odd"><td>ImportToken</td>
<td><strong>For internal use only</strong></td>
</tr>
<tr class="row-even"><td>AddressDisplayToken</td>
<td><strong>For internal use only</strong></td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="method">
<dt id="binaryninja.datarender.InstructionTextToken.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>token_type</em>, <em>text</em>, <em>value=0</em>, <em>size=0</em>, <em>operand=4294967295</em>, <em>context=&lt;InstructionTextTokenContext.NoTokenContext: 0&gt;</em>, <em>address=0</em>, <em>confidence=255</em>, <em>typeNames=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/function.html#InstructionTextToken.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.InstructionTextToken.__init__" title="Permalink to this definition"></a></dt>
<dd><p>x.__init__(…) initializes x; see help(type(x)) for signature</p>
</dd></dl>
<p class="rubric">Methods</p>
<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.datarender.InstructionTextToken.__init__" title="binaryninja.datarender.InstructionTextToken.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(token_type,&nbsp;text[,&nbsp;value,&nbsp;size,&nbsp;…])</td>
<td>x.__init__(…) initializes x; see help(type(x)) for signature</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_instruction_lines</span></code>(tokens[,&nbsp;count])</td>
<td>Helper method for converting between core.BNInstructionTextToken and InstructionTextToken lists</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.datarender.Type.html" class="btn btn-neutral float-right" title="binaryninja.datarender.Type" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.datarender.FileMetadata.html" class="btn btn-neutral" title="binaryninja.datarender.FileMetadata" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015-2019, Vector 35 Inc.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>