File: C:/Ruby27-x64/share/doc/ruby/html/IRB/ExtendCommandBundle.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module IRB::ExtendCommandBundle - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-def_extend_command">::def_extend_command</a>
<li class="calls-super" ><a href="#method-c-extend_object">::extend_object</a>
<li ><a href="#method-c-install_extend_commands">::install_extend_commands</a>
<li ><a href="#method-i-install_alias_method">#install_alias_method</a>
<li ><a href="#method-i-irb_context">#irb_context</a>
<li ><a href="#method-i-irb_exit">#irb_exit</a>
<li ><a href="#method-i-irb_load">#irb_load</a>
<li ><a href="#method-i-irb_require">#irb_require</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-IRB::ExtendCommandBundle">
<h1 id="module-IRB::ExtendCommandBundle" class="module">
module IRB::ExtendCommandBundle
</h1>
<section class="description">
<p>Installs the default irb extensions command bundle.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="NO_OVERRIDE">NO_OVERRIDE
<dd><p>See <a href="ExtendCommandBundle.html#method-i-install_alias_method"><code>install_alias_method</code></a>.</p>
<dt id="OVERRIDE_ALL">OVERRIDE_ALL
<dd><p>See <a href="ExtendCommandBundle.html#method-i-install_alias_method"><code>install_alias_method</code></a>.</p>
<dt id="OVERRIDE_PRIVATE_ONLY">OVERRIDE_PRIVATE_ONLY
<dd><p>See <a href="ExtendCommandBundle.html#method-i-install_alias_method"><code>install_alias_method</code></a>.</p>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-def_extend_command" class="method-detail ">
<div class="method-heading">
<span class="method-name">def_extend_command</span><span
class="method-args">(cmd_name, cmd_class, load_file = nil, *aliases)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Evaluate the given <code>cmd_name</code> on the given <code>cmd_class</code> <a href="../Class.html"><code>Class</code></a>.</p>
<p>Will also define any given <code>aliases</code> for the method.</p>
<p>The optional <code>load_file</code> parameter will be required within the method definition.</p>
<div class="method-source-code" id="def_extend_command-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 157</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">def_extend_command</span>(<span class="ruby-identifier">cmd_name</span>, <span class="ruby-identifier">cmd_class</span>, <span class="ruby-identifier">load_file</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">aliases</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">cmd_class</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Symbol</span>
<span class="ruby-identifier">cmd_class</span> = <span class="ruby-identifier">cmd_class</span>.<span class="ruby-identifier">id2name</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">String</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Class</span>
<span class="ruby-identifier">cmd_class</span> = <span class="ruby-identifier">cmd_class</span>.<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">load_file</span>
<span class="ruby-identifier">line</span> = <span class="ruby-keyword">__LINE__</span>; <span class="ruby-identifier">eval</span> <span class="ruby-node">%[
def #{cmd_name}(*opts, &b)
require "#{load_file}"
arity = ExtendCommand::#{cmd_class}.instance_method(:execute).arity
args = (1..(arity < 0 ? ~arity : arity)).map {|i| "arg" + i.to_s }
args << "*opts" if arity < 0
args << "&block"
args = args.join(", ")
line = __LINE__; eval %[
unless self.class.class_variable_defined?(:@@#{cmd_name}_)
self.class.class_variable_set(:@@#{cmd_name}_, true)
def #{cmd_name}_(\#{args})
ExtendCommand::#{cmd_class}.execute(irb_context, \#{args})
end
end
], nil, __FILE__, line
send :#{cmd_name}_, *opts, &b
end
]</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">__FILE__</span>, <span class="ruby-identifier">line</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">line</span> = <span class="ruby-keyword">__LINE__</span>; <span class="ruby-identifier">eval</span> <span class="ruby-node">%[
def #{cmd_name}(*opts, &b)
ExtendCommand::#{cmd_class}.execute(irb_context, *opts, &b)
end
]</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">__FILE__</span>, <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">for</span> <span class="ruby-identifier">ali</span>, <span class="ruby-identifier">flag</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">aliases</span>
<span class="ruby-ivar">@ALIASES</span>.<span class="ruby-identifier">push</span> [<span class="ruby-identifier">ali</span>, <span class="ruby-identifier">cmd_name</span>, <span class="ruby-identifier">flag</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-extend_object" class="method-detail ">
<div class="method-heading">
<span class="method-name">extend_object</span><span
class="method-args">(obj)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Installs alias methods for the default irb commands on the given object using <a href="ExtendCommandBundle.html#method-i-install_alias_method"><code>install_alias_method</code></a>.</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="extend_object-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 227</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">extend_object</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword">unless</span> (<span class="ruby-keyword">class</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">obj</span>; <span class="ruby-identifier">ancestors</span>; <span class="ruby-keyword">end</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-constant">EXCB</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">for</span> <span class="ruby-identifier">ali</span>, <span class="ruby-identifier">com</span>, <span class="ruby-identifier">flg</span> <span class="ruby-keyword">in</span> <span class="ruby-ivar">@ALIASES</span>
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">install_alias_method</span>(<span class="ruby-identifier">ali</span>, <span class="ruby-identifier">com</span>, <span class="ruby-identifier">flg</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-install_extend_commands" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_extend_commands</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Installs the default irb commands:</p>
<dl class="rdoc-list note-list"><dt><code>irb_current_working_workspace</code>
<dd>
<p><a href="Context.html#method-i-main"><code>Context#main</code></a></p>
</dd><dt><code>irb_change_workspace</code>
<dd>
<p><a href="Context.html#method-i-change_workspace"><code>Context#change_workspace</code></a></p>
</dd><dt><code>irb_workspaces</code>
<dd>
<p><a href="Context.html#method-i-workspaces"><code>Context#workspaces</code></a></p>
</dd><dt><code>irb_push_workspace</code>
<dd>
<p><a href="Context.html#method-i-push_workspace"><code>Context#push_workspace</code></a></p>
</dd><dt><code>irb_pop_workspace</code>
<dd>
<p><a href="Context.html#method-i-pop_workspace"><code>Context#pop_workspace</code></a></p>
</dd><dt><code>irb_load</code>
<dd>
<p><a href="ExtendCommandBundle.html#method-i-irb_load"><code>irb_load</code></a></p>
</dd><dt><code>irb_require</code>
<dd>
<p><a href="ExtendCommandBundle.html#method-i-irb_require"><code>irb_require</code></a></p>
</dd><dt><code>irb_source</code>
<dd>
<p><a href="IrbLoader.html#method-i-source_file"><code>IrbLoader#source_file</code></a></p>
</dd><dt><code>irb</code>
<dd>
<p><a href="../IRB.html#method-c-irb"><code>IRB.irb</code></a></p>
</dd><dt><code>irb_jobs</code>
<dd>
<p><a href="JobManager.html"><code>JobManager</code></a></p>
</dd><dt><code>irb_fg</code>
<dd>
<p><a href="JobManager.html#method-i-switch"><code>JobManager#switch</code></a></p>
</dd><dt><code>irb_kill</code>
<dd>
<p><a href="JobManager.html#method-i-kill"><code>JobManager#kill</code></a></p>
</dd><dt><code>irb_help</code>
<dd>
<p>Command line options at <code>IRB</code></p>
</dd></dl>
<div class="method-source-code" id="install_extend_commands-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 145</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">install_extend_commands</span>
<span class="ruby-keyword">for</span> <span class="ruby-identifier">args</span> <span class="ruby-keyword">in</span> <span class="ruby-ivar">@EXTEND_COMMANDS</span>
<span class="ruby-identifier">def_extend_command</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-install_alias_method" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_alias_method</span><span
class="method-args">(to, from, override = NO_OVERRIDE)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Installs alias methods for the default irb commands, see <a href="ExtendCommandBundle.html#method-c-install_extend_commands"><code>::install_extend_commands</code></a>.</p>
<div class="method-source-code" id="install_alias_method-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 201</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_alias_method</span>(<span class="ruby-identifier">to</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">override</span> = <span class="ruby-constant">NO_OVERRIDE</span>)
<span class="ruby-identifier">to</span> = <span class="ruby-identifier">to</span>.<span class="ruby-identifier">id2name</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">to</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-identifier">from</span> = <span class="ruby-identifier">from</span>.<span class="ruby-identifier">id2name</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">from</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">override</span> <span class="ruby-operator">==</span> <span class="ruby-constant">OVERRIDE_ALL</span> <span class="ruby-keyword">or</span>
(<span class="ruby-identifier">override</span> <span class="ruby-operator">==</span> <span class="ruby-constant">OVERRIDE_PRIVATE_ONLY</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">to</span>) <span class="ruby-keyword">or</span>
(<span class="ruby-identifier">override</span> <span class="ruby-operator">==</span> <span class="ruby-constant">NO_OVERRIDE</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">to</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">target</span> = <span class="ruby-keyword">self</span>
(<span class="ruby-keyword">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">self</span>; <span class="ruby-keyword">self</span>; <span class="ruby-keyword">end</span>).<span class="ruby-identifier">instance_eval</span>{
<span class="ruby-keyword">if</span> <span class="ruby-identifier">target</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">to</span>, <span class="ruby-keyword">true</span>) <span class="ruby-operator">&&</span>
<span class="ruby-operator">!</span><span class="ruby-identifier">target</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-constant">EXCB</span>.<span class="ruby-identifier">irb_original_method_name</span>(<span class="ruby-identifier">to</span>), <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">alias_method</span>(<span class="ruby-constant">EXCB</span>.<span class="ruby-identifier">irb_original_method_name</span>(<span class="ruby-identifier">to</span>), <span class="ruby-identifier">to</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">alias_method</span> <span class="ruby-identifier">to</span>, <span class="ruby-identifier">from</span>
}
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">print</span> <span class="ruby-node">"irb: warn: can't alias #{to} from #{from}.\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-irb_context" class="method-detail ">
<div class="method-heading">
<span class="method-name">irb_context</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays current configuration.</p>
<p>Modifying the configuration is achieved by sending a message to <a href="../IRB.html#method-c-conf"><code>IRB.conf</code></a>.</p>
<div class="method-source-code" id="irb_context-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 36</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">irb_context</span>
<span class="ruby-constant">IRB</span>.<span class="ruby-constant">CurrentContext</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-irb_exit" class="method-detail ">
<div class="method-heading">
<span class="method-name">irb_exit</span><span
class="method-args">(ret = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Quits the current irb context</p>
<p><code>ret</code> is the optional signal or message to send to <a href="Context.html#method-i-exit"><code>Context#exit</code></a></p>
<p>Same as <code>IRB.CurrentContext.exit</code>.</p>
<div class="method-source-code" id="irb_exit-source">
<pre><span class="ruby-comment"># File lib/irb/extend-command.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">irb_exit</span>(<span class="ruby-identifier">ret</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">irb_context</span>.<span class="ruby-identifier">exit</span>(<span class="ruby-identifier">ret</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-irb_load" class="method-detail ">
<div class="method-heading">
<span class="method-name">irb_load</span><span
class="method-args">(*opts, &b)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Loads the given file similarly to <a href="../Kernel.html#method-i-load"><code>Kernel#load</code></a>, see <a href="IrbLoader.html#method-i-irb_load"><code>IrbLoader#irb_load</code></a></p>
<div class="method-source-code" id="irb_load-source">
<pre><span class="ruby-comment"># File lib/irb/ext/use-loader.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">irb_load</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-constant">ExtendCommand</span><span class="ruby-operator">::</span><span class="ruby-constant">Load</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-identifier">irb_context</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-irb_require" class="method-detail ">
<div class="method-heading">
<span class="method-name">irb_require</span><span
class="method-args">(*opts, &b)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Loads the given file similarly to <a href="../Kernel.html#method-i-require"><code>Kernel#require</code></a></p>
<div class="method-source-code" id="irb_require-source">
<pre><span class="ruby-comment"># File lib/irb/ext/use-loader.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">irb_require</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-constant">ExtendCommand</span><span class="ruby-operator">::</span><span class="ruby-constant">Require</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-identifier">irb_context</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>