File: C:/Ruby27-x64/share/doc/ruby/html/OptionParser/Arguable.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module OptionParser::Arguable - 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 class="calls-super" ><a href="#method-c-extend_object">::extend_object</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-getopts">#getopts</a>
<li ><a href="#method-i-options">#options</a>
<li ><a href="#method-i-options-3D">#options=</a>
<li ><a href="#method-i-order-21">#order!</a>
<li ><a href="#method-i-parse-21">#parse!</a>
<li ><a href="#method-i-permute-21">#permute!</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-OptionParser::Arguable">
<h1 id="module-OptionParser::Arguable" class="module">
module OptionParser::Arguable
</h1>
<section class="description">
<p>Extends command line arguments array (ARGV) to parse itself.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<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>Initializes instance variable.</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/optparse.rb, line 2210</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">super</span>
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">instance_eval</span> {<span class="ruby-ivar">@optparse</span> = <span class="ruby-keyword">nil</span>}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2214</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-ivar">@optparse</span> = <span class="ruby-keyword">nil</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-getopts" class="method-detail ">
<div class="method-heading">
<span class="method-name">getopts</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Substitution of getopts is possible as follows. Also see <a href="../OptionParser.html#method-i-getopts"><code>OptionParser#getopts</code></a>.</p>
<pre class="ruby"><span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getopts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
(<span class="ruby-identifier">$OPT</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">getopts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opt</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">eval</span> <span class="ruby-node">"$OPT_#{opt.gsub(/[^A-Za-z0-9_]/, '_')} = val"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">ParseError</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="getopts-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getopts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">options</span>.<span class="ruby-identifier">getopts</span>(<span class="ruby-keyword">self</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-options" class="method-detail ">
<div class="method-heading">
<span class="method-name">options</span><span
class="method-args">() { |optparse| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Actual <a href="../OptionParser.html"><code>OptionParser</code></a> object, automatically created if nonexistent.</p>
<p>If called with a block, yields the <a href="../OptionParser.html"><code>OptionParser</code></a> object and returns the result of the block. If an <a href="ParseError.html"><code>OptionParser::ParseError</code></a> exception occurs in the block, it is rescued, a error message printed to STDERR and <code>nil</code> returned.</p>
<div class="method-source-code" id="options-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2162</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options</span>
<span class="ruby-ivar">@optparse</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@optparse</span>.<span class="ruby-identifier">default_argv</span> = <span class="ruby-keyword">self</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-ivar">@optparse</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">yield</span> <span class="ruby-ivar">@optparse</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">ParseError</span>
<span class="ruby-ivar">@optparse</span>.<span class="ruby-identifier">warn</span> <span class="ruby-identifier">$!</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-options-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">options=</span><span
class="method-args">(opt)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets <a href="../OptionParser.html"><code>OptionParser</code></a> object, when <code>opt</code> is <code>false</code> or <code>nil</code>, methods <a href="Arguable.html#method-i-options"><code>OptionParser::Arguable#options</code></a> and <a href="Arguable.html#method-i-options-3D"><code>OptionParser::Arguable#options=</code></a> are undefined. Thus, there is no ways to access the <a href="../OptionParser.html"><code>OptionParser</code></a> object via the receiver object.</p>
<div class="method-source-code" id="options-3D-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2145</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options=</span>(<span class="ruby-identifier">opt</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@optparse</span> = <span class="ruby-identifier">opt</span>
<span class="ruby-keyword">class</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">self</span>
<span class="ruby-identifier">undef_method</span>(<span class="ruby-value">:options</span>)
<span class="ruby-identifier">undef_method</span>(<span class="ruby-value">:options=</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-i-order-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">order!</span><span
class="method-args">(&blk)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parses <code>self</code> destructively in order and returns <code>self</code> containing the rest arguments left unparsed.</p>
<div class="method-source-code" id="order-21-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2178</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">order!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>) <span class="ruby-identifier">options</span>.<span class="ruby-identifier">order!</span>(<span class="ruby-keyword">self</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">blk</span>) <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parse-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parses <code>self</code> destructively and returns <code>self</code> containing the rest arguments left unparsed.</p>
<div class="method-source-code" id="parse-21-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2190</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse!</span>() <span class="ruby-identifier">options</span>.<span class="ruby-identifier">parse!</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-permute-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">permute!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Parses <code>self</code> destructively in permutation mode and returns <code>self</code> containing the rest arguments left unparsed.</p>
<div class="method-source-code" id="permute-21-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 2184</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">permute!</span>() <span class="ruby-identifier">options</span>.<span class="ruby-identifier">permute!</span>(<span class="ruby-keyword">self</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>