adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
gh-pages
metasploit-gs/api/Metasploit/Framework/Compiler/Mingw/X86.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

1062 lines
24 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Metasploit::Framework::Compiler::Mingw::X86
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Metasploit::Framework::Compiler::Mingw::X86";
relpath = '../../../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../_index.html">Index (X)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../../Metasploit.html" title="Metasploit (module)">Metasploit</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../../Framework.html" title="Metasploit::Framework (module)">Framework</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Compiler.html" title="Metasploit::Framework::Compiler (module)">Compiler</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Mingw.html" title="Metasploit::Framework::Compiler::Mingw (module)">Mingw</a></span></span>
&raquo;
<span class="title">X86</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Metasploit::Framework::Compiler::Mingw::X86
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Metasploit::Framework::Compiler::Mingw::X86</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../Mingw.html" title="Metasploit::Framework::Compiler::Mingw (module)">Metasploit::Framework::Compiler::Mingw</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/metasploit/framework/compiler/mingw.rb</dd>
</dl>
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="../Mingw.html" title="Metasploit::Framework::Compiler::Mingw (module)">Metasploit::Framework::Compiler::Mingw</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Mingw.html#INCLUDE_DIR-constant" title="Metasploit::Framework::Compiler::Mingw::INCLUDE_DIR (constant)">INCLUDE_DIR</a></span>, <span class='object_link'><a href="../Mingw.html#MINGW_X64-constant" title="Metasploit::Framework::Compiler::Mingw::MINGW_X64 (constant)">MINGW_X64</a></span>, <span class='object_link'><a href="../Mingw.html#MINGW_X86-constant" title="Metasploit::Framework::Compiler::Mingw::MINGW_X86 (constant)">MINGW_X86</a></span>, <span class='object_link'><a href="../Mingw.html#OPTIMIZATION_FLAGS-constant" title="Metasploit::Framework::Compiler::Mingw::OPTIMIZATION_FLAGS (constant)">OPTIMIZATION_FLAGS</a></span></p>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#compile_options-instance_method" title="#compile_options (instance method)">#<strong>compile_options</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute compile_options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#file_name-instance_method" title="#file_name (instance method)">#<strong>file_name</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute file_name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#include_dirs-instance_method" title="#include_dirs (instance method)">#<strong>include_dirs</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute include_dirs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#keep_exe-instance_method" title="#keep_exe (instance method)">#<strong>keep_exe</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute keep_exe.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#keep_src-instance_method" title="#keep_src (instance method)">#<strong>keep_src</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute keep_src.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#link_script-instance_method" title="#link_script (instance method)">#<strong>link_script</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute link_script.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#mingw_bin-instance_method" title="#mingw_bin (instance method)">#<strong>mingw_bin</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute mingw_bin.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#opt_lvl-instance_method" title="#opt_lvl (instance method)">#<strong>opt_lvl</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute opt_lvl.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#show_compile_cmd-instance_method" title="#show_compile_cmd (instance method)">#<strong>show_compile_cmd</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute show_compile_cmd.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#strip_syms-instance_method" title="#strip_syms (instance method)">#<strong>strip_syms</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute strip_syms.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#available%3F-class_method" title="available? (class method)">.<strong>available?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) &#x21d2; X86 </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of X86.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Mingw.html" title="Metasploit::Framework::Compiler::Mingw (module)">Metasploit::Framework::Compiler::Mingw</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Mingw.html#build_cmd-instance_method" title="Metasploit::Framework::Compiler::Mingw#build_cmd (method)">#build_cmd</a></span>, <span class='object_link'><a href="../Mingw.html#cleanup_files-instance_method" title="Metasploit::Framework::Compiler::Mingw#cleanup_files (method)">#cleanup_files</a></span>, <span class='object_link'><a href="../Mingw.html#compile_c-instance_method" title="Metasploit::Framework::Compiler::Mingw#compile_c (method)">#compile_c</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Metasploit::Framework::Compiler::Mingw::X86 (class)">X86</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of X86.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
82
83
84
85
86
87
88
89
90
91
92
93</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 82</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='ivar'>@file_name</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:f_name</span><span class='rbracket'>]</span>
<span class='ivar'>@keep_exe</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:keep_exe</span><span class='rbracket'>]</span>
<span class='ivar'>@keep_src</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:keep_src</span><span class='rbracket'>]</span>
<span class='ivar'>@strip_syms</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:strip_symbols</span><span class='rbracket'>]</span>
<span class='ivar'>@show_compile_cmd</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:show_compile_cmd</span><span class='rbracket'>]</span>
<span class='ivar'>@link_script</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:linker_script</span><span class='rbracket'>]</span>
<span class='ivar'>@compile_options</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:compile_options</span><span class='rbracket'>]</span>
<span class='ivar'>@opt_lvl</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:opt_lvl</span><span class='rbracket'>]</span>
<span class='ivar'>@include_dirs</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:include_dirs</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='ivar'>@mingw_bin</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Mingw.html#MINGW_X86-constant" title="Metasploit::Framework::Compiler::Mingw::MINGW_X86 (constant)">MINGW_X86</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="compile_options-instance_method">
#<strong>compile_options</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute compile_options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_compile_options'>compile_options</span>
<span class='ivar'>@compile_options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="file_name-instance_method">
#<strong>file_name</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute file_name.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_file_name'>file_name</span>
<span class='ivar'>@file_name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="include_dirs-instance_method">
#<strong>include_dirs</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute include_dirs.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_include_dirs'>include_dirs</span>
<span class='ivar'>@include_dirs</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="keep_exe-instance_method">
#<strong>keep_exe</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute keep_exe.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_keep_exe'>keep_exe</span>
<span class='ivar'>@keep_exe</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="keep_src-instance_method">
#<strong>keep_src</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute keep_src.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_keep_src'>keep_src</span>
<span class='ivar'>@keep_src</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="link_script-instance_method">
#<strong>link_script</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute link_script.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_link_script'>link_script</span>
<span class='ivar'>@link_script</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="mingw_bin-instance_method">
#<strong>mingw_bin</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute mingw_bin.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mingw_bin'>mingw_bin</span>
<span class='ivar'>@mingw_bin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="opt_lvl-instance_method">
#<strong>opt_lvl</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute opt_lvl.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_opt_lvl'>opt_lvl</span>
<span class='ivar'>@opt_lvl</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="show_compile_cmd-instance_method">
#<strong>show_compile_cmd</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute show_compile_cmd.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_show_compile_cmd'>show_compile_cmd</span>
<span class='ivar'>@show_compile_cmd</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="strip_syms-instance_method">
#<strong>strip_syms</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute strip_syms.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_strip_syms'>strip_syms</span>
<span class='ivar'>@strip_syms</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="available?-class_method">
.<strong>available?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/metasploit/framework/compiler/mingw.rb', line 95</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_available?'>available?</span>
<span class='op'>!</span><span class='op'>!</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../../../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Msf/Util.html" title="Msf::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../../../Msf/Util/Helper.html" title="Msf::Util::Helper (class)">Helper</a></span></span><span class='period'>.</span><span class='id identifier rubyid_which'><span class='object_link'><a href="../../../../Msf/Util/Helper.html#which-class_method" title="Msf::Util::Helper.which (method)">which</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../Mingw.html#MINGW_X86-constant" title="Metasploit::Framework::Compiler::Mingw::MINGW_X86 (constant)">MINGW_X86</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:57 2026 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.1.5).
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink