File: C:/Ruby27-x64/share/doc/ruby/html/OptionParser/List.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class OptionParser::List - 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="class">
<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">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-accept">#accept</a>
<li ><a href="#method-i-append">#append</a>
<li ><a href="#method-i-complete">#complete</a>
<li ><a href="#method-i-each_option">#each_option</a>
<li ><a href="#method-i-get_candidates">#get_candidates</a>
<li ><a href="#method-i-prepend">#prepend</a>
<li ><a href="#method-i-reject">#reject</a>
<li ><a href="#method-i-search">#search</a>
<li ><a href="#method-i-summarize">#summarize</a>
<li ><a href="#method-i-update">#update</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-OptionParser::List">
<h1 id="class-OptionParser::List" class="class">
class OptionParser::List
</h1>
<section class="description">
<p>Simple option list providing mapping from short and/or long option string to <a href="Switch.html"><code>OptionParser::Switch</code></a> and mapping from acceptable argument to matching pattern and converter pair. Also provides summary feature.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-atype" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">atype</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Map from acceptable argument types to pattern and converter pairs.</p>
</div>
</div>
<div id="attribute-i-list" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">list</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p><a href="List.html"><code>List</code></a> of all switches and summary string.</p>
</div>
</div>
<div id="attribute-i-long" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">long</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Map from long style option switches to actual switch objects.</p>
</div>
</div>
<div id="attribute-i-short" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">short</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Map from short style option switches to actual switch objects.</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Just initializes all instance variables.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 769</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@atype</span> = {}
<span class="ruby-ivar">@short</span> = <span class="ruby-constant">OptionMap</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@long</span> = <span class="ruby-constant">OptionMap</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@list</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-accept" class="method-detail ">
<div class="method-heading">
<span class="method-name">accept</span><span
class="method-args">(t, pat = /.*/m, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="../OptionParser.html#method-c-accept"><code>OptionParser.accept</code></a>.</p>
<div class="method-source-code" id="accept-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 779</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">accept</span>(<span class="ruby-identifier">t</span>, <span class="ruby-identifier">pat</span> = <span class="ruby-regexp">/.*/m</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">pat</span>
<span class="ruby-identifier">pat</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:match</span>) <span class="ruby-keyword">or</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-string">"has no `match'"</span>, <span class="ruby-constant">ParseError</span>.<span class="ruby-identifier">filter_backtrace</span>(<span class="ruby-identifier">caller</span>(<span class="ruby-value">2</span>))
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">pat</span> = <span class="ruby-identifier">t</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:match</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">block</span> = <span class="ruby-identifier">pat</span>.<span class="ruby-identifier">method</span>(<span class="ruby-value">:convert</span>).<span class="ruby-identifier">to_proc</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">pat</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:convert</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@atype</span>[<span class="ruby-identifier">t</span>] = [<span class="ruby-identifier">pat</span>, <span class="ruby-identifier">block</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-append" class="method-detail ">
<div class="method-heading">
<span class="method-name">append</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Appends <code>switch</code> at the tail of the list, and associates short, long and negated long options. Arguments are:</p>
<dl class="rdoc-list note-list"><dt><code>switch</code>
<dd>
<p><a href="Switch.html"><code>OptionParser::Switch</code></a> instance to be inserted.</p>
</dd><dt><code>short_opts</code>
<dd>
<p><a href="List.html"><code>List</code></a> of short style options.</p>
</dd><dt><code>long_opts</code>
<dd>
<p><a href="List.html"><code>List</code></a> of long style options.</p>
</dd><dt><code>nolong_opts</code>
<dd>
<p><a href="List.html"><code>List</code></a> of long style options with “no-” prefix.</p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">append</span>(<span class="ruby-identifier">switch</span>, <span class="ruby-identifier">short_opts</span>, <span class="ruby-identifier">long_opts</span>, <span class="ruby-identifier">nolong_opts</span>)
</pre>
<div class="method-source-code" id="append-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 843</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">append</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">update</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-ivar">@list</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-complete" class="method-detail ">
<div class="method-heading">
<span class="method-name">complete</span><span
class="method-args">(id, opt, icase = false, *pat, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Searches list <code>id</code> for <code>opt</code> and the optional patterns for completion <code>pat</code>. If <code>icase</code> is true, the search is case insensitive. The result is returned or yielded if a block is given. If it isn't found, nil is returned.</p>
<div class="method-source-code" id="complete-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 865</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">complete</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opt</span>, <span class="ruby-identifier">icase</span> = <span class="ruby-keyword">false</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">pat</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">id</span>).<span class="ruby-identifier">complete</span>(<span class="ruby-identifier">opt</span>, <span class="ruby-identifier">icase</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">pat</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each_option" class="method-detail ">
<div class="method-heading">
<span class="method-name">each_option</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Iterates over each option, passing the option to the <code>block</code>.</p>
<div class="method-source-code" id="each_option-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 876</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_option</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_candidates" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_candidates</span><span
class="method-args">(id) { |__send__(id).keys| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="get_candidates-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 869</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_candidates</span>(<span class="ruby-identifier">id</span>)
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">id</span>).<span class="ruby-identifier">keys</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-prepend" class="method-detail ">
<div class="method-heading">
<span class="method-name">prepend</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Inserts <code>switch</code> at the head of the list, and associates short, long and negated long options. Arguments are:</p>
<dl class="rdoc-list note-list"><dt><code>switch</code>
<dd>
<p><a href="Switch.html"><code>OptionParser::Switch</code></a> instance to be inserted.</p>
</dd><dt><code>short_opts</code>
<dd>
<p><a href="List.html"><code>List</code></a> of short style options.</p>
</dd><dt><code>long_opts</code>
<dd>
<p><a href="List.html"><code>List</code></a> of long style options.</p>
</dd><dt><code>nolong_opts</code>
<dd>
<p><a href="List.html"><code>List</code></a> of long style options with “no-” prefix.</p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">prepend</span>(<span class="ruby-identifier">switch</span>, <span class="ruby-identifier">short_opts</span>, <span class="ruby-identifier">long_opts</span>, <span class="ruby-identifier">nolong_opts</span>)
</pre>
<div class="method-source-code" id="prepend-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 827</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prepend</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">update</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-ivar">@list</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reject" class="method-detail ">
<div class="method-heading">
<span class="method-name">reject</span><span
class="method-args">(t)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="../OptionParser.html#method-c-reject"><code>OptionParser.reject</code></a>.</p>
<div class="method-source-code" id="reject-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 795</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reject</span>(<span class="ruby-identifier">t</span>)
<span class="ruby-ivar">@atype</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">t</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-search" class="method-detail ">
<div class="method-heading">
<span class="method-name">search</span><span
class="method-args">(id, key) { |val| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Searches <code>key</code> in <code>id</code> list. The result is returned or yielded if a block is given. If it isn't found, nil is returned.</p>
<div class="method-source-code" id="search-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 852</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">key</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">list</span> = <span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">id</span>)
<span class="ruby-identifier">val</span> = <span class="ruby-identifier">list</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>) {<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>}
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">val</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-summarize" class="method-detail ">
<div class="method-heading">
<span class="method-name">summarize</span><span
class="method-args">(*args, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates the summary table, passing each line to the <code>block</code> (without newline). The arguments <code>args</code> are passed along to the summarize method which is called on every option.</p>
<div class="method-source-code" id="summarize-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 885</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">summarize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">sum</span> = []
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">reverse_each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opt</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">opt</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:summarize</span>) <span class="ruby-comment"># perhaps OptionParser::Switch</span>
<span class="ruby-identifier">s</span> = []
<span class="ruby-identifier">opt</span>.<span class="ruby-identifier">summarize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">l</span>}
<span class="ruby-identifier">sum</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">s</span>.<span class="ruby-identifier">reverse</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-operator">!</span><span class="ruby-identifier">opt</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">opt</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">sum</span> <span class="ruby-operator"><<</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">opt</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:each_line</span>)
<span class="ruby-identifier">sum</span>.<span class="ruby-identifier">concat</span>([<span class="ruby-operator">*</span><span class="ruby-identifier">opt</span>.<span class="ruby-identifier">each_line</span>].<span class="ruby-identifier">reverse</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">sum</span>.<span class="ruby-identifier">concat</span>([<span class="ruby-operator">*</span><span class="ruby-identifier">opt</span>.<span class="ruby-identifier">each</span>].<span class="ruby-identifier">reverse</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">sum</span>.<span class="ruby-identifier">reverse_each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-update" class="method-detail ">
<div class="method-heading">
<span class="method-name">update</span><span
class="method-args">(sw, sopts, lopts, nsw = nil, nlopts = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>sw</code> according to <code>sopts</code>, <code>lopts</code> and <code>nlopts</code>.</p>
<dl class="rdoc-list note-list"><dt><code>sw</code>
<dd>
<p><a href="Switch.html"><code>OptionParser::Switch</code></a> instance to be added.</p>
</dd><dt><code>sopts</code>
<dd>
<p>Short style option list.</p>
</dd><dt><code>lopts</code>
<dd>
<p>Long style option list.</p>
</dd><dt><code>nlopts</code>
<dd>
<p>Negated long style options list.</p>
</dd></dl>
<div class="method-source-code" id="update-source">
<pre><span class="ruby-comment"># File lib/optparse.rb, line 807</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update</span>(<span class="ruby-identifier">sw</span>, <span class="ruby-identifier">sopts</span>, <span class="ruby-identifier">lopts</span>, <span class="ruby-identifier">nsw</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">nlopts</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">sopts</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@short</span>[<span class="ruby-identifier">o</span>] = <span class="ruby-identifier">sw</span>} <span class="ruby-keyword">if</span> <span class="ruby-identifier">sopts</span>
<span class="ruby-identifier">lopts</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@long</span>[<span class="ruby-identifier">o</span>] = <span class="ruby-identifier">sw</span>} <span class="ruby-keyword">if</span> <span class="ruby-identifier">lopts</span>
<span class="ruby-identifier">nlopts</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@long</span>[<span class="ruby-identifier">o</span>] = <span class="ruby-identifier">nsw</span>} <span class="ruby-keyword">if</span> <span class="ruby-identifier">nsw</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">nlopts</span>
<span class="ruby-identifier">used</span> = <span class="ruby-ivar">@short</span>.<span class="ruby-identifier">invert</span>.<span class="ruby-identifier">update</span>(<span class="ruby-ivar">@long</span>.<span class="ruby-identifier">invert</span>)
<span class="ruby-ivar">@list</span>.<span class="ruby-identifier">delete_if</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-constant">Switch</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">o</span> <span class="ruby-keyword">and</span> <span class="ruby-operator">!</span><span class="ruby-identifier">used</span>[<span class="ruby-identifier">o</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>