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

652 lines
44 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>plugin 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.plugin.BackgroundTask" href="binaryninja.plugin.BackgroundTask.html"/>
<link rel="prev" title="binaryninja.platform.with_metaclass" href="binaryninja.platform.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">
<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"><a class="reference internal" href="binaryninja.datarender-module.html">datarender</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.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 current"><a class="current reference internal" href="#">plugin</a><ul>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.BackgroundTask.html">binaryninja.plugin.BackgroundTask</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.BackgroundTaskThread.html">binaryninja.plugin.BackgroundTaskThread</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.MainThreadAction.html">binaryninja.plugin.MainThreadAction</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.MainThreadActionHandler.html">binaryninja.plugin.MainThreadActionHandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.PluginCommand.html">binaryninja.plugin.PluginCommand</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.PluginCommandContext.html">binaryninja.plugin.PluginCommandContext</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.range.html">binaryninja.plugin.range</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.plugin.with_metaclass.html">binaryninja.plugin.with_metaclass</a></li>
</ul>
</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>plugin module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.plugin-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="plugin-module">
<h1>plugin module<a class="headerlink" href="#plugin-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.plugin.BackgroundTask.html#binaryninja.plugin.BackgroundTask" title="binaryninja.plugin.BackgroundTask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.BackgroundTask</span></code></a>([…])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.plugin.BackgroundTaskThread.html#binaryninja.plugin.BackgroundTaskThread" title="binaryninja.plugin.BackgroundTaskThread"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.BackgroundTaskThread</span></code></a>([…])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.plugin.MainThreadAction.html#binaryninja.plugin.MainThreadAction" title="binaryninja.plugin.MainThreadAction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.MainThreadAction</span></code></a>(handle)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.plugin.MainThreadActionHandler.html#binaryninja.plugin.MainThreadActionHandler" title="binaryninja.plugin.MainThreadActionHandler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.MainThreadActionHandler</span></code></a>()</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.plugin.PluginCommand.html#binaryninja.plugin.PluginCommand" title="binaryninja.plugin.PluginCommand"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.PluginCommand</span></code></a>(cmd)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.plugin.PluginCommandContext.html#binaryninja.plugin.PluginCommandContext" title="binaryninja.plugin.PluginCommandContext"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.PluginCommandContext</span></code></a>(view)</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.plugin.range.html#binaryninja.plugin.range" title="binaryninja.plugin.range"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.range</span></code></a>(*args)</td>
<td>A Python2 and Python3 Compatible Range Generator</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.plugin.with_metaclass.html#binaryninja.plugin.with_metaclass" title="binaryninja.plugin.with_metaclass"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.plugin.with_metaclass</span></code></a>(meta,&nbsp;*bases)</td>
<td>Create a base class with a metaclass.</td>
</tr>
</tbody>
</table>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-binaryninja.plugin"></span><dl class="class">
<dt id="binaryninja.plugin.BackgroundTask">
<em class="property">class </em><code class="descname">BackgroundTask</code><span class="sig-paren">(</span><em>initial_progress_text=''</em>, <em>can_cancel=False</em>, <em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#BackgroundTask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.BackgroundTask" 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="method">
<dt id="binaryninja.plugin.BackgroundTask.cancel">
<code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#BackgroundTask.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.BackgroundTask.cancel" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.plugin.BackgroundTask.finish">
<code class="descname">finish</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#BackgroundTask.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.BackgroundTask.finish" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.plugin.BackgroundTask.can_cancel">
<code class="descname">can_cancel</code><a class="headerlink" href="#binaryninja.plugin.BackgroundTask.can_cancel" title="Permalink to this definition"></a></dt>
<dd><p>Whether the task can be cancelled (read-only)</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.plugin.BackgroundTask.cancelled">
<code class="descname">cancelled</code><a class="headerlink" href="#binaryninja.plugin.BackgroundTask.cancelled" title="Permalink to this definition"></a></dt>
<dd><p>Whether the task has been cancelled</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.plugin.BackgroundTask.finished">
<code class="descname">finished</code><a class="headerlink" href="#binaryninja.plugin.BackgroundTask.finished" title="Permalink to this definition"></a></dt>
<dd><p>Whether the task has finished</p>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.plugin.BackgroundTask.list">
<code class="descname">list</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.plugin.BackgroundTask.list" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.plugin.BackgroundTask.progress">
<code class="descname">progress</code><a class="headerlink" href="#binaryninja.plugin.BackgroundTask.progress" title="Permalink to this definition"></a></dt>
<dd><p>Text description of the progress of the background task (displayed in status bar of the UI)</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.plugin.BackgroundTaskThread">
<em class="property">class </em><code class="descname">BackgroundTaskThread</code><span class="sig-paren">(</span><em>initial_progress_text=''</em>, <em>can_cancel=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#BackgroundTaskThread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.BackgroundTaskThread" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="binaryninja.plugin.BackgroundTask.html#binaryninja.plugin.BackgroundTask" title="binaryninja.plugin.BackgroundTask"><code class="xref py py-class docutils literal notranslate"><span class="pre">binaryninja.plugin.BackgroundTask</span></code></a></p>
<dl class="method">
<dt id="binaryninja.plugin.BackgroundTaskThread.join">
<code class="descname">join</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#BackgroundTaskThread.join"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.BackgroundTaskThread.join" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.plugin.BackgroundTaskThread.run">
<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#BackgroundTaskThread.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.BackgroundTaskThread.run" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.plugin.BackgroundTaskThread.start">
<code class="descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#BackgroundTaskThread.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.BackgroundTaskThread.start" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.plugin.MainThreadAction">
<em class="property">class </em><code class="descname">MainThreadAction</code><span class="sig-paren">(</span><em>handle</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#MainThreadAction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.MainThreadAction" 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="method">
<dt id="binaryninja.plugin.MainThreadAction.execute">
<code class="descname">execute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#MainThreadAction.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.MainThreadAction.execute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.plugin.MainThreadAction.wait">
<code class="descname">wait</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#MainThreadAction.wait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.MainThreadAction.wait" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="binaryninja.plugin.MainThreadAction.done">
<code class="descname">done</code><a class="headerlink" href="#binaryninja.plugin.MainThreadAction.done" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.plugin.MainThreadActionHandler">
<em class="property">class </em><code class="descname">MainThreadActionHandler</code><a class="reference internal" href="_modules/binaryninja/plugin.html#MainThreadActionHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.MainThreadActionHandler" 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="method">
<dt id="binaryninja.plugin.MainThreadActionHandler.add_action">
<code class="descname">add_action</code><span class="sig-paren">(</span><em>action</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#MainThreadActionHandler.add_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.MainThreadActionHandler.add_action" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="binaryninja.plugin.MainThreadActionHandler.register">
<code class="descname">register</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#MainThreadActionHandler.register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.MainThreadActionHandler.register" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.plugin.PluginCommand">
<em class="property">class </em><code class="descname">PluginCommand</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand" 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="method">
<dt id="binaryninja.plugin.PluginCommand.execute">
<code class="descname">execute</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.execute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.get_valid_list">
<em class="property">classmethod </em><code class="descname">get_valid_list</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.get_valid_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.get_valid_list" title="Permalink to this definition"></a></dt>
<dd><p>Dict of registered plugins</p>
</dd></dl>
<dl class="method">
<dt id="binaryninja.plugin.PluginCommand.is_valid">
<code class="descname">is_valid</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.is_valid" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register">
<em class="property">classmethod </em><code class="descname">register</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register</span></code> Register a plugin</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> as an argument</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register_for_address">
<em class="property">classmethod </em><code class="descname">register_for_address</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register_for_address"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register_for_address" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register_for_address</span></code> Register a plugin to be called with an address argument</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> and address as arguments</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register_for_address</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register_for_function">
<em class="property">classmethod </em><code class="descname">register_for_function</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register_for_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register_for_function" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register_for_function</span></code> Register a plugin to be called with a function argument</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> and a <code class="docutils literal notranslate"><span class="pre">Function</span></code> as arguments</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register_for_function</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register_for_low_level_il_function">
<em class="property">classmethod </em><code class="descname">register_for_low_level_il_function</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register_for_low_level_il_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register_for_low_level_il_function" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register_for_low_level_il_function</span></code> Register a plugin to be called with a low level IL function argument</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> and a <code class="docutils literal notranslate"><span class="pre">LowLevelILFunction</span></code> as arguments</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register_for_low_level_il_function</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register_for_low_level_il_instruction">
<em class="property">classmethod </em><code class="descname">register_for_low_level_il_instruction</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register_for_low_level_il_instruction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register_for_low_level_il_instruction" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register_for_low_level_il_instruction</span></code> Register a plugin to be called with a low level IL instruction argument</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> and a <code class="docutils literal notranslate"><span class="pre">LowLevelILInstruction</span></code> as arguments</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register_for_low_level_il_instruction</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register_for_medium_level_il_function">
<em class="property">classmethod </em><code class="descname">register_for_medium_level_il_function</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register_for_medium_level_il_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register_for_medium_level_il_function" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register_for_medium_level_il_function</span></code> Register a plugin to be called with a medium level IL function argument</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> and a <code class="docutils literal notranslate"><span class="pre">MediumLevelILFunction</span></code> as arguments</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register_for_medium_level_il_function</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register_for_medium_level_il_instruction">
<em class="property">classmethod </em><code class="descname">register_for_medium_level_il_instruction</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register_for_medium_level_il_instruction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register_for_medium_level_il_instruction" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register_for_medium_level_il_instruction</span></code> Register a plugin to be called with a medium level IL instruction argument</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> and a <code class="docutils literal notranslate"><span class="pre">MediumLevelILInstruction</span></code> as arguments</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register_for_medium_level_il_instruction</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="classmethod">
<dt id="binaryninja.plugin.PluginCommand.register_for_range">
<em class="property">classmethod </em><code class="descname">register_for_range</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>action</em>, <em>is_valid=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommand.register_for_range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommand.register_for_range" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">register_for_range</span></code> Register a plugin to be called with a range argument</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>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) name of the plugin</li>
<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) description of the plugin</li>
<li><strong>action</strong> function to call with the <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> and <code class="docutils literal notranslate"><span class="pre">AddressRange</span></code> as arguments</li>
<li><strong>is_valid</strong> optional argument of a function passed a <code class="docutils literal notranslate"><span class="pre">BinaryView</span></code> to determine whether the plugin should be enabled for that view</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Calling <code class="docutils literal notranslate"><span class="pre">register_for_range</span></code> with the same function name will replace the existing function but will leak the memory of the original plugin.</p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="binaryninja.plugin.PluginCommand.list">
<code class="descname">list</code><em class="property"> = []</em><a class="headerlink" href="#binaryninja.plugin.PluginCommand.list" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="binaryninja.plugin.PluginCommandContext">
<em class="property">class </em><code class="descname">PluginCommandContext</code><span class="sig-paren">(</span><em>view</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/plugin.html#PluginCommandContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.plugin.PluginCommandContext" 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>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.plugin.BackgroundTask.html" class="btn btn-neutral float-right" title="binaryninja.plugin.BackgroundTask" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.platform.with_metaclass.html" class="btn btn-neutral" title="binaryninja.platform.with_metaclass" 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>