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

332 lines
17 KiB
HTML
Raw Normal View History

2019-04-03 14:46:40 +01: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>datarender module &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="next" title="binaryninja.datarender.BinaryView" href="binaryninja.datarender.BinaryView.html"/>
<link rel="prev" title="binaryninja.databuffer.unescape_string" href="binaryninja.databuffer.unescape_string.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="current reference internal" href="#">datarender</a><ul>
<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"><a class="reference internal" href="binaryninja.datarender.InstructionTextToken.html">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>datarender module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.datarender-module.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="datarender-module">
<h1>datarender module<a class="headerlink" href="#datarender-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.datarender.BinaryView.html#binaryninja.datarender.BinaryView" title="binaryninja.datarender.BinaryView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.datarender.BinaryView</span></code></a>([…])</td>
<td><code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">BinaryView</span></code> implements a view on binary data, and presents a queryable interface of a binary file.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.datarender.DataRenderer.html#binaryninja.datarender.DataRenderer" title="binaryninja.datarender.DataRenderer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.datarender.DataRenderer</span></code></a>([context])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.datarender.DisassemblyTextLine.html#binaryninja.datarender.DisassemblyTextLine" title="binaryninja.datarender.DisassemblyTextLine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.datarender.DisassemblyTextLine</span></code></a>(tokens)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.datarender.FileMetadata.html#binaryninja.datarender.FileMetadata" title="binaryninja.datarender.FileMetadata"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.datarender.FileMetadata</span></code></a>([…])</td>
<td><code class="docutils literal notranslate"><span class="pre">class</span> <span class="pre">FileMetadata</span></code> represents the file being analyzed by Binary Ninja.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.datarender.InstructionTextToken.html#binaryninja.datarender.InstructionTextToken" title="binaryninja.datarender.InstructionTextToken"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.datarender.InstructionTextToken</span></code></a>(…)</td>
<td><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.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.datarender.Type.html#binaryninja.datarender.Type" title="binaryninja.datarender.Type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.datarender.Type</span></code></a>(handle[,&nbsp;…])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.datarender.log_error.html#binaryninja.datarender.log_error" title="binaryninja.datarender.log_error"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.datarender.log_error</span></code></a>(text)</td>
<td><code class="docutils literal notranslate"><span class="pre">log_error</span></code> Logs message to console, if run through the GUI it logs with <strong>Error</strong> icon, focusing the error console.</td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-binaryninja.datarender"></span><dl class="class">
<dt id="binaryninja.datarender.DataRenderer">
<em class="property">class </em><code class="descname">DataRenderer</code><span class="sig-paren">(</span><em>context=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/datarender.html#DataRenderer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.DataRenderer" 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 notranslate"><span class="pre">object</span></code></a></p>
<dl class="classmethod">
<dt id="binaryninja.datarender.DataRenderer.is_type_of_struct_name">
<em class="property">classmethod </em><code class="descname">is_type_of_struct_name</code><span class="sig-paren">(</span><em>type</em>, <em>name</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/datarender.html#DataRenderer.is_type_of_struct_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.DataRenderer.is_type_of_struct_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.datarender.DataRenderer.perform_free_object">
<code class="descname">perform_free_object</code><span class="sig-paren">(</span><em>ctxt</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/datarender.html#DataRenderer.perform_free_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.DataRenderer.perform_free_object" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.datarender.DataRenderer.perform_get_lines_for_data">
<code class="descname">perform_get_lines_for_data</code><span class="sig-paren">(</span><em>ctxt</em>, <em>view</em>, <em>addr</em>, <em>type</em>, <em>prefix</em>, <em>width</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/datarender.html#DataRenderer.perform_get_lines_for_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.DataRenderer.perform_get_lines_for_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.datarender.DataRenderer.perform_is_valid_for_data">
<code class="descname">perform_is_valid_for_data</code><span class="sig-paren">(</span><em>ctxt</em>, <em>view</em>, <em>addr</em>, <em>type</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/datarender.html#DataRenderer.perform_is_valid_for_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.DataRenderer.perform_is_valid_for_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.datarender.DataRenderer.register_generic">
<code class="descname">register_generic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/datarender.html#DataRenderer.register_generic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.DataRenderer.register_generic" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.datarender.DataRenderer.register_type_specific">
<code class="descname">register_type_specific</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/datarender.html#DataRenderer.register_type_specific"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.datarender.DataRenderer.register_type_specific" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.datarender.BinaryView.html" class="btn btn-neutral float-right" title="binaryninja.datarender.BinaryView" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.databuffer.unescape_string.html" class="btn btn-neutral" title="binaryninja.databuffer.unescape_string" 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>