308 lines
14 KiB
HTML
308 lines
14 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>binaryninja.types.preprocess_source — Binary Ninja API 1.1.0 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/other.css" type="text/css" />
|
|
|
|
|
|
|
|
<link rel="top" title="Binary Ninja API 1.1.0 documentation" href="index.html"/>
|
|
<link rel="up" title="types module" href="binaryninja.types-module.html"/>
|
|
<link rel="next" title="binaryninja.types.pyNativeStr" href="binaryninja.types.pyNativeStr.html"/>
|
|
<link rel="prev" title="binaryninja.types.TypeParserResult" href="binaryninja.types.TypeParserResult.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">
|
|
1.1
|
|
</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.binaryninja-module.html">binaryninja</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.builtins-module.html">builtins</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.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.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.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.pyopenssl-module.html">pyopenssl</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.requests-module.html">requests</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.setting-module.html">setting</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="binaryninja.transform-module.html">transform</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="binaryninja.types-module.html">types</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.BoolWithConfidence.html">binaryninja.types.BoolWithConfidence</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Enumeration.html">binaryninja.types.Enumeration</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.EnumerationMember.html">binaryninja.types.EnumerationMember</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.FunctionParameter.html">binaryninja.types.FunctionParameter</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.NamedTypeReference.html">binaryninja.types.NamedTypeReference</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.QualifiedName.html">binaryninja.types.QualifiedName</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.ReferenceTypeWithConfidence.html">binaryninja.types.ReferenceTypeWithConfidence</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.RegisterSet.html">binaryninja.types.RegisterSet</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.RegisterStackAdjustmentWithConfidence.html">binaryninja.types.RegisterStackAdjustmentWithConfidence</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.SizeWithConfidence.html">binaryninja.types.SizeWithConfidence</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Structure.html">binaryninja.types.Structure</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.StructureMember.html">binaryninja.types.StructureMember</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Symbol.html">binaryninja.types.Symbol</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.Type.html">binaryninja.types.Type</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.TypeParserResult.html">binaryninja.types.TypeParserResult</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">binaryninja.types.preprocess_source</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.pyNativeStr.html">binaryninja.types.pyNativeStr</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="binaryninja.types.range.html">binaryninja.types.range</a></li>
|
|
</ul>
|
|
</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><a href="binaryninja.types-module.html">types module</a> »</li>
|
|
|
|
<li>binaryninja.types.preprocess_source</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="_sources/binaryninja.types.preprocess_source.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="binaryninja-types-preprocess-source">
|
|
<h1>binaryninja.types.preprocess_source<a class="headerlink" href="#binaryninja-types-preprocess-source" title="Permalink to this headline">¶</a></h1>
|
|
<dl class="function">
|
|
<dt id="binaryninja.types.preprocess_source">
|
|
<code class="descclassname">binaryninja.types.</code><code class="descname">preprocess_source</code><span class="sig-paren">(</span><em>source</em>, <em>filename=None</em>, <em>include_dirs=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/binaryninja/types.html#preprocess_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#binaryninja.types.preprocess_source" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p><code class="docutils literal"><span class="pre">preprocess_source</span></code> run the C preprocessor on the given source or source filename.</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>source</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – source to preprocess</li>
|
|
<li><strong>filename</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 filename to preprocess</li>
|
|
<li><strong>include_dirs</strong> (<em>list(str)</em>) – list of string directorires to use as include directories.</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">returns a tuple of (preprocessed_source, error_string)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">tuple(str,str)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">source</span> <span class="o">=</span> <span class="s2">"#define TEN 10</span><span class="se">\n</span><span class="s2">int x[TEN];</span><span class="se">\n</span><span class="s2">"</span>
|
|
<span class="gp">>>> </span><span class="n">preprocess_source</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
|
|
<span class="go">('#line 1 "input"\n\n#line 2 "input"\n int x [ 10 ] ;\n', '')</span>
|
|
<span class="go">>>></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.types.pyNativeStr.html" class="btn btn-neutral float-right" title="binaryninja.types.pyNativeStr" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="binaryninja.types.TypeParserResult.html" class="btn btn-neutral" title="binaryninja.types.TypeParserResult" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2016, Vector 35 LLC.
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'./',
|
|
VERSION:'1.1.0',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</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/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |