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

353 lines
17 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>demangle 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.demangle.demangle_gnu3" href="binaryninja.demangle.demangle_gnu3.html"/>
<link rel="prev" title="binaryninja.datarender.log_error" href="binaryninja.datarender.log_error.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 current"><a class="current reference internal" href="#">demangle</a><ul>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.demangle.demangle_gnu3.html">binaryninja.demangle.demangle_gnu3</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.demangle.demangle_ms.html">binaryninja.demangle.demangle_ms</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.demangle.get_qualified_name.html">binaryninja.demangle.get_qualified_name</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.demangle.pyNativeStr.html">binaryninja.demangle.pyNativeStr</a></li>
<li class="toctree-l2"><a class="reference internal" href="binaryninja.demangle.range.html">binaryninja.demangle.range</a></li>
</ul>
</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>demangle module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/binaryninja.demangle-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="demangle-module">
<h1>demangle module<a class="headerlink" href="#demangle-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.demangle.demangle_gnu3.html#binaryninja.demangle.demangle_gnu3" title="binaryninja.demangle.demangle_gnu3"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.demangle.demangle_gnu3</span></code></a>(arch,&nbsp;…)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.demangle.demangle_ms.html#binaryninja.demangle.demangle_ms" title="binaryninja.demangle.demangle_ms"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.demangle.demangle_ms</span></code></a>(arch,&nbsp;…)</td>
<td><code class="docutils literal notranslate"><span class="pre">demangle_ms</span></code> demangles a mangled Microsoft Visual Studio C++ name to a Type object.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.demangle.get_qualified_name.html#binaryninja.demangle.get_qualified_name" title="binaryninja.demangle.get_qualified_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.demangle.get_qualified_name</span></code></a>(names)</td>
<td><code class="docutils literal notranslate"><span class="pre">get_qualified_name</span></code> gets a qualified name for the provided name list.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="binaryninja.demangle.pyNativeStr.html#binaryninja.demangle.pyNativeStr" title="binaryninja.demangle.pyNativeStr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.demangle.pyNativeStr</span></code></a>(arg)</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="binaryninja.demangle.range.html#binaryninja.demangle.range" title="binaryninja.demangle.range"><code class="xref py py-obj docutils literal notranslate"><span class="pre">binaryninja.demangle.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.demangle"></span><dl class="function">
<dt id="binaryninja.demangle.demangle_gnu3">
<code class="descname">demangle_gnu3</code><span class="sig-paren">(</span><em>arch</em>, <em>mangled_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/demangle.html#demangle_gnu3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.demangle.demangle_gnu3" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="binaryninja.demangle.demangle_ms">
<code class="descname">demangle_ms</code><span class="sig-paren">(</span><em>arch</em>, <em>mangled_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/demangle.html#demangle_ms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.demangle.demangle_ms" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">demangle_ms</span></code> demangles a mangled Microsoft Visual Studio C++ name to a Type object.</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>arch</strong> (<a class="reference internal" href="binaryninja.architecture.Architecture.html#binaryninja.architecture.Architecture" title="binaryninja.architecture.Architecture"><em>Architecture</em></a>) Architecture for the symbol. Required for pointer and integer sizes.</li>
<li><strong>mangled_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>) a mangled Microsoft Visual Studio C++ name</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">returns tuple of (Type, demangled_name) or (None, mangled_name) on error</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Tuple</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">&gt;&gt;&gt; </span><span class="n">demangle_ms</span><span class="p">(</span><span class="n">Architecture</span><span class="p">[</span><span class="s2">&quot;x86_64&quot;</span><span class="p">],</span> <span class="s2">&quot;?testf@Foobar@@SA?AW4foo@1@W421@@Z&quot;</span><span class="p">)</span>
<span class="go">(&lt;type: public: static enum Foobar::foo __cdecl (enum Foobar::foo)&gt;, [&#39;Foobar&#39;, &#39;testf&#39;])</span>
<span class="go">&gt;&gt;&gt;</span>
</pre></div>
</div>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="binaryninja.demangle.get_qualified_name">
<code class="descname">get_qualified_name</code><span class="sig-paren">(</span><em>names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/demangle.html#get_qualified_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.demangle.get_qualified_name" title="Permalink to this definition"></a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">get_qualified_name</span></code> gets a qualified name for the provided name list.</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"><p class="first"><strong>names</strong> (<em>list</em><em>(</em><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a><em>)</em>) name list to qualify</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a qualified name</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></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">&gt;&gt;&gt; </span><span class="nb">type</span><span class="p">,</span> <span class="n">name</span> <span class="o">=</span> <span class="n">demangle_ms</span><span class="p">(</span><span class="n">Architecture</span><span class="p">[</span><span class="s2">&quot;x86_64&quot;</span><span class="p">],</span> <span class="s2">&quot;?testf@Foobar@@SA?AW4foo@1@W421@@Z&quot;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">get_qualified_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="go">&#39;Foobar::testf&#39;</span>
<span class="go">&gt;&gt;&gt;</span>
</pre></div>
</div>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="binaryninja.demangle.demangle_gnu3.html" class="btn btn-neutral float-right" title="binaryninja.demangle.demangle_gnu3" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="binaryninja.datarender.log_error.html" class="btn btn-neutral" title="binaryninja.datarender.log_error" 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>