File: C:/Ruby27-x64/share/doc/ruby/html/GetoptLong.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class GetoptLong - 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-each">#each</a>
<li ><a href="#method-i-each_option">#each_option</a>
<li ><a href="#method-i-error_message">#error_message</a>
<li ><a href="#method-i-get">#get</a>
<li ><a href="#method-i-get_option">#get_option</a>
<li ><a href="#method-i-ordering-3D">#ordering=</a>
<li ><a href="#method-i-set_error">#set_error</a>
<li ><a href="#method-i-set_options">#set_options</a>
<li ><a href="#method-i-terminate">#terminate</a>
<li ><a href="#method-i-terminated-3F">#terminated?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-GetoptLong">
<h1 id="class-GetoptLong" class="class">
class GetoptLong
</h1>
<section class="description">
<p>The <a href="GetoptLong.html"><code>GetoptLong</code></a> class allows you to parse command line options similarly to the GNU getopt_long() C library call. Note, however, that <a href="GetoptLong.html"><code>GetoptLong</code></a> is a pure Ruby implementation.</p>
<p><a href="GetoptLong.html"><code>GetoptLong</code></a> allows for POSIX-style options like <code>--file</code> as well as single letter options like <code>-f</code></p>
<p>The empty option <code>--</code> (two minus symbols) is used to end option processing. This can be particularly important if options have optional arguments.</p>
<p>Here is a simple example of usage:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'getoptlong'</span>
<span class="ruby-identifier">opts</span> = <span class="ruby-constant">GetoptLong</span>.<span class="ruby-identifier">new</span>(
[ <span class="ruby-string">'--help'</span>, <span class="ruby-string">'-h'</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">NO_ARGUMENT</span> ],
[ <span class="ruby-string">'--repeat'</span>, <span class="ruby-string">'-n'</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUIRED_ARGUMENT</span> ],
[ <span class="ruby-string">'--name'</span>, <span class="ruby-constant">GetoptLong</span><span class="ruby-operator">::</span><span class="ruby-constant">OPTIONAL_ARGUMENT</span> ]
)
<span class="ruby-identifier">dir</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">repetitions</span> = <span class="ruby-value">1</span>
<span class="ruby-identifier">opts</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">arg</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">opt</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'--help'</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier"><<-EOF</span>
<span class="ruby-value">hello [OPTION] ... DIR
-h, --help:
show help
--repeat x, -n x:
repeat x times
--name [name]:
greet user by name, if name not supplied default is John
DIR: The directory in which to issue the greeting.
</span><span class="ruby-identifier"> EOF</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'--repeat'</span>
<span class="ruby-identifier">repetitions</span> = <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">'--name'</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span> <span class="ruby-operator">==</span> <span class="ruby-string">''</span>
<span class="ruby-identifier">name</span> = <span class="ruby-string">'John'</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">arg</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">!=</span> <span class="ruby-value">1</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"Missing dir argument (try --help)"</span>
<span class="ruby-identifier">exit</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">dir</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">dir</span>)
<span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> (<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-identifier">repetitions</span>)
<span class="ruby-identifier">print</span> <span class="ruby-string">"Hello"</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">print</span> <span class="ruby-node">", #{name}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">puts</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Example command line:</p>
<pre>hello -n 6 --name -- /tmp</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ARGUMENT_FLAGS">ARGUMENT_FLAGS
<dd><p>Argument flags.</p>
<dt id="ORDERINGS">ORDERINGS
<dd><p>Orderings.</p>
<dt id="STATUS_TERMINATED">STATUS_TERMINATED
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-error" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">error</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Examine whether an option processing is failed.</p>
</div>
</div>
<div id="attribute-i-error-3F" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">error?</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Examine whether an option processing is failed.</p>
</div>
</div>
<div id="attribute-i-ordering" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">ordering</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Return ordering.</p>
</div>
</div>
<div id="attribute-i-quiet" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">quiet</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Set/Unset `quiet' mode.</p>
</div>
</div>
<div id="attribute-i-quiet-3F" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">quiet?</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>Set/Unset `quiet' mode.</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">(*arguments)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Set.html"><code>Set</code></a> up option processing.</p>
<p>The options to support are passed to new() as an array of arrays. Each sub-array contains any number of <a href="String.html"><code>String</code></a> option names which carry the same meaning, and one of the following flags:</p>
<dl class="rdoc-list note-list"><dt>GetoptLong::NO_ARGUMENT
<dd>
<p>Option does not take an argument.</p>
</dd><dt>GetoptLong::REQUIRED_ARGUMENT
<dd>
<p>Option always takes an argument.</p>
</dd><dt>GetoptLong::OPTIONAL_ARGUMENT
<dd>
<p>Option may or may not take an argument.</p>
</dd></dl>
<p>The first option name is considered to be the preferred (canonical) name. Other than that, the elements of each sub-array can be in any order.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arguments</span>)
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Current ordering.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'POSIXLY_CORRECT'</span>)
<span class="ruby-ivar">@ordering</span> = <span class="ruby-constant">REQUIRE_ORDER</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@ordering</span> = <span class="ruby-constant">PERMUTE</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Hash table of option names.</span>
<span class="ruby-comment"># Keys of the table are option names, and their values are canonical</span>
<span class="ruby-comment"># names of the options.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@canonical_names</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Hash table of argument flags.</span>
<span class="ruby-comment"># Keys of the table are option names, and their values are argument</span>
<span class="ruby-comment"># flags of the options.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@argument_flags</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Whether error messages are output to $stderr.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@quiet</span> = <span class="ruby-keyword">false</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Status code.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@status</span> = <span class="ruby-constant">STATUS_YET</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Error code.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@error</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Error message.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@error_message</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Rest of catenated short options.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@rest_singles</span> = <span class="ruby-string">''</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># List of non-option-arguments.</span>
<span class="ruby-comment"># Append them to ARGV when option processing is terminated.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@non_option_arguments</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">if</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">set_options</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arguments</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-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">() { |option_name, option_argument| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Iterator version of `get'.</p>
<p>The block is called repeatedly with two arguments: The first is the option name. The second is the argument which followed it (if any). Example: ('–opt', 'value')</p>
<p>The option name is always converted to the first (preferred) name given in the original options to <a href="GetoptLong.html#method-c-new"><code>GetoptLong.new</code></a>.</p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 601</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">option_name</span>, <span class="ruby-identifier">option_argument</span> = <span class="ruby-identifier">get_option</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">option_name</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">option_name</span>, <span class="ruby-identifier">option_argument</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="GetoptLong.html#method-i-each_option">each_option</a>
</div>
</div>
<div id="method-i-each_option" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">each_option</span><span
class="method-args">()</span>
</div>
<div class="method-description">
<p>`each_option' is an alias of `each'.</p>
</div>
<div class="aliases">
Alias for: <a href="GetoptLong.html#method-i-each">each</a>
</div>
</div>
<div id="method-i-error_message" class="method-detail ">
<div class="method-heading">
<span class="method-name">error_message</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the appropriate error message in POSIX-defined format. If no error has occurred, returns nil.</p>
<div class="method-source-code" id="error_message-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 412</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">error_message</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@error_message</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get" class="method-detail ">
<div class="method-heading">
<span class="method-name">get</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Get next option name and its argument, as an <a href="Array.html"><code>Array</code></a> of two elements.</p>
<p>The option name is always converted to the first (preferred) name given in the original options to <a href="GetoptLong.html#method-c-new"><code>GetoptLong.new</code></a>.</p>
<p>Example: ['–option', 'value']</p>
<p>Returns nil if the processing is complete (as determined by <a href="GetoptLong.html#STATUS_TERMINATED"><code>STATUS_TERMINATED</code></a>).</p>
<div class="method-source-code" id="get-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 427</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>
<span class="ruby-identifier">option_name</span>, <span class="ruby-identifier">option_argument</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-string">''</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Check status.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@error</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@status</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">STATUS_YET</span>
<span class="ruby-ivar">@status</span> = <span class="ruby-constant">STATUS_STARTED</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">STATUS_TERMINATED</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Get next option argument.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@rest_singles</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">argument</span> = <span class="ruby-string">'-'</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@rest_singles</span>
<span class="ruby-keyword">elsif</span> (<span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>)
<span class="ruby-identifier">terminate</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@ordering</span> <span class="ruby-operator">==</span> <span class="ruby-constant">PERMUTE</span>
<span class="ruby-keyword">while</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">ARGV</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">!~</span> <span class="ruby-regexp">/\A-./</span>
<span class="ruby-ivar">@non_option_arguments</span>.<span class="ruby-identifier">push</span>(<span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">terminate</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">argument</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@ordering</span> <span class="ruby-operator">==</span> <span class="ruby-constant">REQUIRE_ORDER</span>
<span class="ruby-keyword">if</span> (<span class="ruby-constant">ARGV</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">!~</span> <span class="ruby-regexp">/\A-./</span>)
<span class="ruby-identifier">terminate</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">argument</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">argument</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Check the special argument `--'.</span>
<span class="ruby-comment"># `--' indicates the end of the option list.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">==</span> <span class="ruby-string">'--'</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@rest_singles</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">terminate</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Check for long and short options.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A(--[^=]+)/</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@rest_singles</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># This is a long style option, which start with `--'.</span>
<span class="ruby-comment">#</span>
<span class="ruby-identifier">pattern</span> = <span class="ruby-node">$1</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@canonical_names</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">pattern</span>)
<span class="ruby-identifier">option_name</span> = <span class="ruby-identifier">pattern</span>
<span class="ruby-keyword">else</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># The option `option_name' is not registered in `@canonical_names'.</span>
<span class="ruby-comment"># It may be an abbreviated.</span>
<span class="ruby-comment">#</span>
<span class="ruby-identifier">matches</span> = []
<span class="ruby-ivar">@canonical_names</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">pattern</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">option_name</span> = <span class="ruby-identifier">key</span>
<span class="ruby-identifier">matches</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">key</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-value">2</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">AmbiguousOption</span>, <span class="ruby-node">"option `#{argument}' is ambiguous between #{matches.join(', ')}"</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">matches</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">InvalidOption</span>, <span class="ruby-node">"unrecognized option `#{argument}'"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Check an argument to the option.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@argument_flags</span>[<span class="ruby-identifier">option_name</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">REQUIRED_ARGUMENT</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/=(.*)/m</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-node">$1</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">MissingArgument</span>,
<span class="ruby-node">"option `#{argument}' requires an argument"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@argument_flags</span>[<span class="ruby-identifier">option_name</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">OPTIONAL_ARGUMENT</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/=(.*)/m</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-node">$1</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">ARGV</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">!~</span> <span class="ruby-regexp">/\A-./</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-string">''</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/=(.*)/m</span>
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">NeedlessArgument</span>,
<span class="ruby-node">"option `#{option_name}' doesn't allow an argument"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">argument</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A(-(.))(.*)/m</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># This is a short style option, which start with `-' (not `--').</span>
<span class="ruby-comment"># Short options may be catenated (e.g. `-l -g' is equivalent to</span>
<span class="ruby-comment"># `-lg').</span>
<span class="ruby-comment">#</span>
<span class="ruby-identifier">option_name</span>, <span class="ruby-identifier">ch</span>, <span class="ruby-ivar">@rest_singles</span> = <span class="ruby-node">$1</span>, <span class="ruby-node">$2</span>, <span class="ruby-node">$3</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@canonical_names</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">option_name</span>)
<span class="ruby-comment">#</span>
<span class="ruby-comment"># The option `option_name' is found in `@canonical_names'.</span>
<span class="ruby-comment"># Check its argument.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@argument_flags</span>[<span class="ruby-identifier">option_name</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">REQUIRED_ARGUMENT</span>
<span class="ruby-keyword">if</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@rest_singles</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-ivar">@rest_singles</span>
<span class="ruby-ivar">@rest_singles</span> = <span class="ruby-string">''</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">else</span>
<span class="ruby-comment"># 1003.2 specifies the format of this message.</span>
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">MissingArgument</span>, <span class="ruby-node">"option requires an argument -- #{ch}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@argument_flags</span>[<span class="ruby-identifier">option_name</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">OPTIONAL_ARGUMENT</span>
<span class="ruby-keyword">if</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-ivar">@rest_singles</span>.<span class="ruby-identifier">length</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-ivar">@rest_singles</span>
<span class="ruby-ivar">@rest_singles</span> = <span class="ruby-string">''</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-value">0</span> <span class="ruby-operator"><</span> <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">ARGV</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">!~</span> <span class="ruby-regexp">/\A-./</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">option_argument</span> = <span class="ruby-string">''</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># This is an invalid option.</span>
<span class="ruby-comment"># 1003.2 specifies the format of this message.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'POSIXLY_CORRECT'</span>)
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">InvalidOption</span>, <span class="ruby-node">"invalid option -- #{ch}"</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">InvalidOption</span>, <span class="ruby-node">"invalid option -- #{ch}"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># This is a non-option argument.</span>
<span class="ruby-comment"># Only RETURN_IN_ORDER fell into here.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">''</span>, <span class="ruby-identifier">argument</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@canonical_names</span>[<span class="ruby-identifier">option_name</span>], <span class="ruby-identifier">option_argument</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="GetoptLong.html#method-i-get_option">get_option</a>
</div>
</div>
<div id="method-i-get_option" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">get_option</span><span
class="method-args">()</span>
</div>
<div class="method-description">
<p>`get_option' is an alias of `get'.</p>
</div>
<div class="aliases">
Alias for: <a href="GetoptLong.html#method-i-get">get</a>
</div>
</div>
<div id="method-i-ordering-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">ordering=</span><span
class="method-args">(ordering)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Set.html"><code>Set</code></a> the handling of the ordering of options and arguments. A <a href="RuntimeError.html"><code>RuntimeError</code></a> is raised if option processing has already started.</p>
<p>The supplied value must be a member of <a href="GetoptLong.html#ORDERINGS"><code>GetoptLong::ORDERINGS</code></a>. It alters the processing of options as follows:</p>
<p><strong>REQUIRE_ORDER</strong> :</p>
<p>Options are required to occur before non-options.</p>
<p>Processing of options ends as soon as a word is encountered that has not been preceded by an appropriate option flag.</p>
<p>For example, if -a and -b are options which do not take arguments, parsing command line arguments of '-a one -b two' would result in 'one', '-b', 'two' being left in ARGV, and only ('-a', '') being processed as an option/arg pair.</p>
<p>This is the default ordering, if the environment variable POSIXLY_CORRECT is set. (This is for compatibility with GNU getopt_long.)</p>
<p><strong>PERMUTE</strong> :</p>
<p>Options can occur anywhere in the command line parsed. This is the default behavior.</p>
<p>Every sequence of words which can be interpreted as an option (with or without argument) is treated as an option; non-option words are skipped.</p>
<p>For example, if -a does not require an argument and -b optionally takes an argument, parsing '-a one -b two three' would result in ('-a','') and ('-b', 'two') being processed as option/arg pairs, and 'one','three' being left in ARGV.</p>
<p>If the ordering is set to PERMUTE but the environment variable POSIXLY_CORRECT is set, REQUIRE_ORDER is used instead. This is for compatibility with GNU getopt_long.</p>
<p><strong>RETURN_IN_ORDER</strong> :</p>
<p>All words on the command line are processed as options. Words not preceded by a short or long option flag are passed as arguments with an option of '' (empty string).</p>
<p>For example, if -a requires an argument but -b does not, a command line of '-a one -b two three' would result in option/arg pairs of ('-a', 'one') ('-b', ''), ('', 'two'), ('', 'three') being processed.</p>
<div class="method-source-code" id="ordering-3D-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 238</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ordering=</span>(<span class="ruby-identifier">ordering</span>)
<span class="ruby-comment">#</span>
<span class="ruby-comment"># The method is failed if option processing has already started.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">STATUS_YET</span>
<span class="ruby-identifier">set_error</span>(<span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"argument error"</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>,
<span class="ruby-string">"invoke ordering=, but option processing has already started"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Check ordering.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-constant">ORDERINGS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">ordering</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"invalid ordering `#{ordering}'"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ordering</span> <span class="ruby-operator">==</span> <span class="ruby-constant">PERMUTE</span> <span class="ruby-operator">&&</span> <span class="ruby-constant">ENV</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'POSIXLY_CORRECT'</span>)
<span class="ruby-ivar">@ordering</span> = <span class="ruby-constant">REQUIRE_ORDER</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@ordering</span> = <span class="ruby-identifier">ordering</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-set_options" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_options</span><span
class="method-args">(*arguments)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Set.html"><code>Set</code></a> options. Takes the same argument as <a href="GetoptLong.html#method-c-new"><code>GetoptLong.new</code></a>.</p>
<p>Raises a <a href="RuntimeError.html"><code>RuntimeError</code></a> if option processing has already started.</p>
<div class="method-source-code" id="set_options-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 271</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_options</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arguments</span>)
<span class="ruby-comment">#</span>
<span class="ruby-comment"># The method is failed if option processing has already started.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">STATUS_YET</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>,
<span class="ruby-string">"invoke set_options, but option processing has already started"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Clear tables of option names and argument flags.</span>
<span class="ruby-comment">#</span>
<span class="ruby-ivar">@canonical_names</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-ivar">@argument_flags</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">arg</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"the option list contains non-Array argument"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Find an argument flag and it set to `argument_flag'.</span>
<span class="ruby-comment">#</span>
<span class="ruby-identifier">argument_flag</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">ARGUMENT_FLAGS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">i</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">argument_flag</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"too many argument-flags"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">argument_flag</span> = <span class="ruby-identifier">i</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"no argument-flag"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">argument_flag</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">canonical_name</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Check an option name.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">argument_flag</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">i</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">!~</span> <span class="ruby-regexp">/\A-([^-]|-.+)\z/</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"an invalid option `#{i}'"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@canonical_names</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">i</span>))
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"option redefined `#{i}'"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span>
<span class="ruby-ivar">@canonical_names</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-ivar">@argument_flags</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment">#</span>
<span class="ruby-comment"># Register the option (`i') to the `@canonical_names' and</span>
<span class="ruby-comment"># `@canonical_names' Hashes.</span>
<span class="ruby-comment">#</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">canonical_name</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">canonical_name</span> = <span class="ruby-identifier">i</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@canonical_names</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">canonical_name</span>
<span class="ruby-ivar">@argument_flags</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">argument_flag</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"no option name"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">canonical_name</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-terminate" class="method-detail ">
<div class="method-heading">
<span class="method-name">terminate</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Explicitly terminate option processing.</p>
<div class="method-source-code" id="terminate-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 358</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">terminate</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">==</span> <span class="ruby-constant">STATUS_TERMINATED</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-string">"an error has occurred"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@error</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@status</span> = <span class="ruby-constant">STATUS_TERMINATED</span>
<span class="ruby-ivar">@non_option_arguments</span>.<span class="ruby-identifier">reverse_each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">argument</span><span class="ruby-operator">|</span>
<span class="ruby-constant">ARGV</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">argument</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@canonical_names</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@argument_flags</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@rest_singles</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@non_option_arguments</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-terminated-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">terminated?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if option processing has terminated, false otherwise.</p>
<div class="method-source-code" id="terminated-3F-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 378</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">terminated?</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">==</span> <span class="ruby-constant">STATUS_TERMINATED</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Protected Instance Methods</h3>
</header>
<div id="method-i-set_error" class="method-detail ">
<div class="method-heading">
<span class="method-name">set_error</span><span
class="method-args">(type, message)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Set.html"><code>Set</code></a> an error (a protected method).</p>
<div class="method-source-code" id="set_error-source">
<pre><span class="ruby-comment"># File lib/getoptlong.rb, line 385</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_error</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">message</span>)
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">print</span>(<span class="ruby-node">"#{$0}: #{message}\n"</span>) <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@quiet</span>
<span class="ruby-ivar">@error</span> = <span class="ruby-identifier">type</span>
<span class="ruby-ivar">@error_message</span> = <span class="ruby-identifier">message</span>
<span class="ruby-ivar">@canonical_names</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@argument_flags</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@rest_singles</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@non_option_arguments</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">message</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>