697 lines
41 KiB
HTML
697 lines
41 KiB
HTML
|
||
|
||
<!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>pluginmanager module — 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.pluginmanager.RepoPlugin" href="binaryninja.pluginmanager.RepoPlugin.html"/>
|
||
<link rel="prev" title="binaryninja.plugin.with_metaclass" href="binaryninja.plugin.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"><a class="reference internal" href="binaryninja.plugin-module.html">plugin</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">pluginmanager</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.pluginmanager.RepoPlugin.html">binaryninja.pluginmanager.RepoPlugin</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.pluginmanager.Repository.html">binaryninja.pluginmanager.Repository</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.pluginmanager.RepositoryManager.html">binaryninja.pluginmanager.RepositoryManager</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="binaryninja.pluginmanager.range.html">binaryninja.pluginmanager.range</a></li>
|
||
</ul>
|
||
</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> »</li>
|
||
|
||
<li>pluginmanager module</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/binaryninja.pluginmanager-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="pluginmanager-module">
|
||
<h1>pluginmanager module<a class="headerlink" href="#pluginmanager-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.pluginmanager.RepoPlugin.html#binaryninja.pluginmanager.RepoPlugin" title="binaryninja.pluginmanager.RepoPlugin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.pluginmanager.RepoPlugin</span></code></a>(handle)</td>
|
||
<td><a href="#id1"><span class="problematic" id="id2">``</span></a>RepoPlugin` is mostly read-only, however you can install/uninstall enable/disable plugins.RepoPlugins are created by parsing the plugins.json in a plugin repository..</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager.Repository.html#binaryninja.pluginmanager.Repository" title="binaryninja.pluginmanager.Repository"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.pluginmanager.Repository</span></code></a>(handle)</td>
|
||
<td><code class="docutils literal notranslate"><span class="pre">Repository</span></code> is a read-only class.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.pluginmanager.RepositoryManager.html#binaryninja.pluginmanager.RepositoryManager" title="binaryninja.pluginmanager.RepositoryManager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.pluginmanager.RepositoryManager</span></code></a>([…])</td>
|
||
<td><code class="docutils literal notranslate"><span class="pre">RepositoryManager</span></code> Keeps track of all the repositories and keeps the enabled_plugins.json file coherent with the plugins that are installed/uninstalled enabled/disabled</td>
|
||
</tr>
|
||
<tr class="row-even"><td><a class="reference internal" href="binaryninja.pluginmanager.range.html#binaryninja.pluginmanager.range" title="binaryninja.pluginmanager.range"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.pluginmanager.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.pluginmanager"></span><dl class="class">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin">
|
||
<em class="property">class </em><code class="descname">RepoPlugin</code><span class="sig-paren">(</span><em>handle</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepoPlugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin" 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>
|
||
<p><a href="#id3"><span class="problematic" id="id4">``</span></a>RepoPlugin` is mostly read-only, however you can install/uninstall enable/disable plugins. RepoPlugins are
|
||
created by parsing the plugins.json in a plugin repository.</p>
|
||
<dl class="class">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginType">
|
||
<em class="property">class </em><code class="descname">PluginType</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">binaryninja.enum.IntEnum</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginType.ArchitecturePluginType">
|
||
<code class="descname">ArchitecturePluginType</code><em class="property"> = <PluginType.ArchitecturePluginType: 2></em><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginType.ArchitecturePluginType" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginType.BinaryViewPluginType">
|
||
<code class="descname">BinaryViewPluginType</code><em class="property"> = <PluginType.BinaryViewPluginType: 3></em><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginType.BinaryViewPluginType" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginType.CorePluginType">
|
||
<code class="descname">CorePluginType</code><em class="property"> = <PluginType.CorePluginType: 0></em><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginType.CorePluginType" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginType.UiPluginType">
|
||
<code class="descname">UiPluginType</code><em class="property"> = <PluginType.UiPluginType: 1></em><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginType.UiPluginType" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginUpdateStatus">
|
||
<em class="property">class </em><code class="descname">PluginUpdateStatus</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginUpdateStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">binaryninja.enum.IntEnum</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginUpdateStatus.UpToDatePluginStatus">
|
||
<code class="descname">UpToDatePluginStatus</code><em class="property"> = <PluginUpdateStatus.UpToDatePluginStatus: 0></em><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginUpdateStatus.UpToDatePluginStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.PluginUpdateStatus.UpdatesAvailablePluginStatus">
|
||
<code class="descname">UpdatesAvailablePluginStatus</code><em class="property"> = <PluginUpdateStatus.UpdatesAvailablePluginStatus: 1></em><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.PluginUpdateStatus.UpdatesAvailablePluginStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.api">
|
||
<code class="descname">api</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.api" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>string indicating the API used by the plugin</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.description">
|
||
<code class="descname">description</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String short description of the plugin</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.enabled">
|
||
<code class="descname">enabled</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Boolean True if the plugin is currently enabled, False otherwise</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.installed">
|
||
<code class="descname">installed</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.installed" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Boolean True if the plugin is installed, False otherwise</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.license">
|
||
<code class="descname">license</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.license" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String short license description (ie MIT, BSD, GPLv2, etc)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.license_text">
|
||
<code class="descname">license_text</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.license_text" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String complete license text for the given plugin</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.long_description">
|
||
<code class="descname">long_description</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.long_description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String long description of the plugin</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.minimum_version">
|
||
<code class="descname">minimum_version</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.minimum_version" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String minimum version the plugin was tested on</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.name">
|
||
<code class="descname">name</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String name of the plugin</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.path">
|
||
<code class="descname">path</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Relative path from the base of the repository to the actual plugin</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.plugin_types">
|
||
<code class="descname">plugin_types</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.plugin_types" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List of PluginType enumeration objects indicating the plugin type(s)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.update_status">
|
||
<code class="descname">update_status</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.update_status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PluginUpdateStatus enumeration indicating if the plugin is up to date or not</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.url">
|
||
<code class="descname">url</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.url" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String URL of the plugin’s git repository</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepoPlugin.version">
|
||
<code class="descname">version</code><a class="headerlink" href="#binaryninja.pluginmanager.RepoPlugin.version" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String version of the plugin</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="binaryninja.pluginmanager.Repository">
|
||
<em class="property">class </em><code class="descname">Repository</code><span class="sig-paren">(</span><em>handle</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#Repository"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.Repository" 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>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Repository</span></code> is a read-only class. Use RepositoryManager to Enable/Disable/Install/Uninstall plugins.</p>
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.Repository.full_path">
|
||
<code class="descname">full_path</code><a class="headerlink" href="#binaryninja.pluginmanager.Repository.full_path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String full path the repository</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.Repository.initialized">
|
||
<code class="descname">initialized</code><a class="headerlink" href="#binaryninja.pluginmanager.Repository.initialized" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Boolean True when the repository has been initialized</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.Repository.local_reference">
|
||
<code class="descname">local_reference</code><a class="headerlink" href="#binaryninja.pluginmanager.Repository.local_reference" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String for the local git reference (ie ‘master’)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.Repository.path">
|
||
<code class="descname">path</code><a class="headerlink" href="#binaryninja.pluginmanager.Repository.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String local path to store the given plugin repository</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.Repository.plugins">
|
||
<code class="descname">plugins</code><a class="headerlink" href="#binaryninja.pluginmanager.Repository.plugins" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List of RepoPlugin objects contained within this repository</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.Repository.remote_reference">
|
||
<code class="descname">remote_reference</code><a class="headerlink" href="#binaryninja.pluginmanager.Repository.remote_reference" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String for the remote git reference (ie ‘origin’)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.Repository.url">
|
||
<code class="descname">url</code><a class="headerlink" href="#binaryninja.pluginmanager.Repository.url" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>String URL of the git repository where the plugin repository’s are stored</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager">
|
||
<em class="property">class </em><code class="descname">RepositoryManager</code><span class="sig-paren">(</span><em>handle=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager" 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>
|
||
<p><code class="docutils literal notranslate"><span class="pre">RepositoryManager</span></code> Keeps track of all the repositories and keeps the enabled_plugins.json file coherent with
|
||
the plugins that are installed/uninstalled enabled/disabled</p>
|
||
<dl class="method">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.add_repository">
|
||
<code class="descname">add_repository</code><span class="sig-paren">(</span><em>url=None</em>, <em>repopath=None</em>, <em>localreference='master'</em>, <em>remotereference='origin'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager.add_repository"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.add_repository" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">add_repository</span></code> adds a new plugin repository for the manager to track.</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>url</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – URL to the git repository where the plugins are stored.</li>
|
||
<li><strong>repopath</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – path to where the repository will be stored on disk locally</li>
|
||
<li><strong>localreference</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Optional reference to the local tracking branch typically “master”</li>
|
||
<li><strong>remotereference</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Optional reference to the remote tracking branch typically “origin”</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Boolean value True if the repository was successfully added, False otherwise.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Boolean</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mgr</span> <span class="o">=</span> <span class="n">RepositoryManager</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">mgr</span><span class="o">.</span><span class="n">add_repository</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="s2">"https://github.com/vector35/community-plugins.git"</span><span class="p">,</span>
|
||
<span class="go"> repopath="myrepo",</span>
|
||
<span class="go"> localreference="master", remotereference="origin")</span>
|
||
<span class="go">True</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.check_for_updates">
|
||
<code class="descname">check_for_updates</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager.check_for_updates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.check_for_updates" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Check for updates for all managed Repository objects</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.disable_plugin">
|
||
<code class="descname">disable_plugin</code><span class="sig-paren">(</span><em>plugin</em>, <em>repo=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager.disable_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.disable_plugin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">disable_plugin</span></code> Disable the specified plugin, pluginpath</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>or str repo</strong> (<a class="reference internal" href="binaryninja.pluginmanager.Repository.html#binaryninja.pluginmanager.Repository" title="binaryninja.pluginmanager.Repository"><em>Repository</em></a>) – Repository containing the plugin to disable</li>
|
||
<li><strong>or str plugin</strong> (<a class="reference internal" href="binaryninja.pluginmanager.RepoPlugin.html#binaryninja.pluginmanager.RepoPlugin" title="binaryninja.pluginmanager.RepoPlugin"><em>RepoPlugin</em></a>) – RepoPlugin to disable</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Boolean value True if the plugin was successfully disabled, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Boolean</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mgr</span> <span class="o">=</span> <span class="n">RepositoryManager</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">mgr</span><span class="o">.</span><span class="n">disable_plugin</span><span class="p">(</span><span class="s1">'binaryninja-bookmarks'</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.enable_plugin">
|
||
<code class="descname">enable_plugin</code><span class="sig-paren">(</span><em>plugin</em>, <em>install=True</em>, <em>repo=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager.enable_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.enable_plugin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">enable_plugin</span></code> Enables the installed plugin ‘plugin’, optionally installing the plugin if <cite>install</cite> is set to
|
||
True (default), and optionally using the non-default repository.</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 to enable</li>
|
||
<li><strong>install</strong> (<em>Boolean</em>) – Optionally install the repo, defaults to True.</li>
|
||
<li><strong>repo</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Optional, specify a repository other than the default repository.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Boolean value True if the plugin was successfully enabled, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Boolean</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mgr</span> <span class="o">=</span> <span class="n">RepositoryManager</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">mgr</span><span class="o">.</span><span class="n">enable_plugin</span><span class="p">(</span><span class="s1">'binaryninja-bookmarks'</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.install_plugin">
|
||
<code class="descname">install_plugin</code><span class="sig-paren">(</span><em>plugin</em>, <em>repo=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager.install_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.install_plugin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">install_plugin</span></code> install the specified plugin, pluginpath</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>or str repo</strong> (<a class="reference internal" href="binaryninja.pluginmanager.Repository.html#binaryninja.pluginmanager.Repository" title="binaryninja.pluginmanager.Repository"><em>Repository</em></a>) – Repository containing the plugin to install</li>
|
||
<li><strong>or str plugin</strong> (<a class="reference internal" href="binaryninja.pluginmanager.RepoPlugin.html#binaryninja.pluginmanager.RepoPlugin" title="binaryninja.pluginmanager.RepoPlugin"><em>RepoPlugin</em></a>) – RepoPlugin to install</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Boolean value True if the plugin was successfully installed, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Boolean</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mgr</span> <span class="o">=</span> <span class="n">RepositoryManager</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">mgr</span><span class="o">.</span><span class="n">install_plugin</span><span class="p">(</span><span class="s1">'binaryninja-bookmarks'</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.uninstall_plugin">
|
||
<code class="descname">uninstall_plugin</code><span class="sig-paren">(</span><em>plugin</em>, <em>repo=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager.uninstall_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.uninstall_plugin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">uninstall_plugin</span></code> uninstall the specified plugin, pluginpath</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>or str repo</strong> (<a class="reference internal" href="binaryninja.pluginmanager.Repository.html#binaryninja.pluginmanager.Repository" title="binaryninja.pluginmanager.Repository"><em>Repository</em></a>) – Repository containing the plugin to uninstall</li>
|
||
<li><strong>or str plugin</strong> (<a class="reference internal" href="binaryninja.pluginmanager.RepoPlugin.html#binaryninja.pluginmanager.RepoPlugin" title="binaryninja.pluginmanager.RepoPlugin"><em>RepoPlugin</em></a>) – RepoPlugin to uninstall</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Boolean value True if the plugin was successfully uninstalled, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Boolean</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mgr</span> <span class="o">=</span> <span class="n">RepositoryManager</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">mgr</span><span class="o">.</span><span class="n">uninstall_plugin</span><span class="p">(</span><span class="s1">'binaryninja-bookmarks'</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.update_plugin">
|
||
<code class="descname">update_plugin</code><span class="sig-paren">(</span><em>plugin</em>, <em>repo=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/pluginmanager.html#RepositoryManager.update_plugin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.update_plugin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">update_plugin</span></code> update the specified plugin, pluginpath</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>or str repo</strong> (<a class="reference internal" href="binaryninja.pluginmanager.Repository.html#binaryninja.pluginmanager.Repository" title="binaryninja.pluginmanager.Repository"><em>Repository</em></a>) – Repository containing the plugin to update</li>
|
||
<li><strong>or str plugin</strong> (<a class="reference internal" href="binaryninja.pluginmanager.RepoPlugin.html#binaryninja.pluginmanager.RepoPlugin" title="binaryninja.pluginmanager.RepoPlugin"><em>RepoPlugin</em></a>) – RepoPlugin to update</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Boolean value True if the plugin was successfully updated, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Boolean</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">mgr</span> <span class="o">=</span> <span class="n">RepositoryManager</span><span class="p">()</span>
|
||
<span class="gp">>>> </span><span class="n">mgr</span><span class="o">.</span><span class="n">update_plugin</span><span class="p">(</span><span class="s1">'binaryninja-bookmarks'</span><span class="p">)</span>
|
||
<span class="go">True</span>
|
||
<span class="go">>>></span>
|
||
</pre></div>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.default_repository">
|
||
<code class="descname">default_repository</code><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.default_repository" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets the default Repository</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.plugins">
|
||
<code class="descname">plugins</code><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.plugins" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List of all RepoPlugins in each repository</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="binaryninja.pluginmanager.RepositoryManager.repositories">
|
||
<code class="descname">repositories</code><a class="headerlink" href="#binaryninja.pluginmanager.RepositoryManager.repositories" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List of Repository objects being managed</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="binaryninja.pluginmanager.RepoPlugin.html" class="btn btn-neutral float-right" title="binaryninja.pluginmanager.RepoPlugin" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="binaryninja.plugin.with_metaclass.html" class="btn btn-neutral" title="binaryninja.plugin.with_metaclass" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© 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> |