File: C:/Ruby27-x64/share/doc/ruby/html/OptionParser/AC.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class OptionParser::AC - 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="../OptionParser.html">OptionParser</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-i-_ac_arg_enable">#_ac_arg_enable</a>
<li ><a href="#method-i-_check_ac_args">#_check_ac_args</a>
<li ><a href="#method-i-ac_arg_disable">#ac_arg_disable</a>
<li ><a href="#method-i-ac_arg_enable">#ac_arg_enable</a>
<li ><a href="#method-i-ac_arg_with">#ac_arg_with</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-OptionParser::AC">
<h1 id="class-OptionParser::AC" class="class">
class OptionParser::AC
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="ARG_CONV">ARG_CONV
<dd>
</dl>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-ac_arg_disable" class="method-detail ">
<div class="method-heading">
<span class="method-name">ac_arg_disable</span><span
class="method-args">(name, help_string, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="ac_arg_disable-source">
<pre><span class="ruby-comment"># File lib/optparse/ac.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ac_arg_disable</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">help_string</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">_ac_arg_enable</span>(<span class="ruby-string">"disable"</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">help_string</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ac_arg_enable" class="method-detail ">
<div class="method-heading">
<span class="method-name">ac_arg_enable</span><span
class="method-args">(name, help_string, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="ac_arg_enable-source">
<pre><span class="ruby-comment"># File lib/optparse/ac.rb, line 34</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ac_arg_enable</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">help_string</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">_ac_arg_enable</span>(<span class="ruby-string">"enable"</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">help_string</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ac_arg_with" class="method-detail ">
<div class="method-heading">
<span class="method-name">ac_arg_with</span><span
class="method-args">(name, help_string, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="ac_arg_with-source">
<pre><span class="ruby-comment"># File lib/optparse/ac.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ac_arg_with</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">help_string</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">_check_ac_args</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-identifier">sdesc</span> = []
<span class="ruby-identifier">ldesc</span> = [<span class="ruby-node">"--with-#{name}"</span>]
<span class="ruby-identifier">desc</span> = [<span class="ruby-identifier">help_string</span>]
<span class="ruby-identifier">q</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">downcase</span>
<span class="ruby-identifier">with</span> = <span class="ruby-constant">Switch</span><span class="ruby-operator">::</span><span class="ruby-constant">PlacedArgument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">search</span>(<span class="ruby-value">:atype</span>, <span class="ruby-constant">String</span>), <span class="ruby-identifier">sdesc</span>, <span class="ruby-identifier">ldesc</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-identifier">without</span> = <span class="ruby-constant">Switch</span><span class="ruby-operator">::</span><span class="ruby-constant">NoArgument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">proc</span> {}, <span class="ruby-identifier">sdesc</span>, <span class="ruby-identifier">ldesc</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-identifier">top</span>.<span class="ruby-identifier">append</span>(<span class="ruby-identifier">with</span>, [], [<span class="ruby-string">"with-"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">q</span>], <span class="ruby-identifier">without</span>, [<span class="ruby-string">'without-'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">q</span>])
<span class="ruby-identifier">with</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-_ac_arg_enable" class="method-detail ">
<div class="method-heading">
<span class="method-name">_ac_arg_enable</span><span
class="method-args">(prefix, name, help_string, block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="_ac_arg_enable-source">
<pre><span class="ruby-comment"># File lib/optparse/ac.rb, line 18</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_ac_arg_enable</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">help_string</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-identifier">_check_ac_args</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-identifier">sdesc</span> = []
<span class="ruby-identifier">ldesc</span> = [<span class="ruby-node">"--#{prefix}-#{name}"</span>]
<span class="ruby-identifier">desc</span> = [<span class="ruby-identifier">help_string</span>]
<span class="ruby-identifier">q</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">downcase</span>
<span class="ruby-identifier">ac_block</span> = <span class="ruby-identifier">proc</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">val</span><span class="ruby-operator">|</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-constant">ARG_CONV</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">val</span>))}
<span class="ruby-identifier">enable</span> = <span class="ruby-constant">Switch</span><span class="ruby-operator">::</span><span class="ruby-constant">PlacedArgument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">nil</span>, <span class="ruby-constant">ARG_CONV</span>, <span class="ruby-identifier">sdesc</span>, <span class="ruby-identifier">ldesc</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">ac_block</span>)
<span class="ruby-identifier">disable</span> = <span class="ruby-constant">Switch</span><span class="ruby-operator">::</span><span class="ruby-constant">NoArgument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">proc</span> {<span class="ruby-keyword">false</span>}, <span class="ruby-identifier">sdesc</span>, <span class="ruby-identifier">ldesc</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">desc</span>, <span class="ruby-identifier">ac_block</span>)
<span class="ruby-identifier">top</span>.<span class="ruby-identifier">append</span>(<span class="ruby-identifier">enable</span>, [], [<span class="ruby-string">"enable-"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">q</span>], <span class="ruby-identifier">disable</span>, [<span class="ruby-string">'disable-'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">q</span>])
<span class="ruby-identifier">enable</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-_check_ac_args" class="method-detail ">
<div class="method-heading">
<span class="method-name">_check_ac_args</span><span
class="method-args">(name, block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="_check_ac_args-source">
<pre><span class="ruby-comment"># File lib/optparse/ac.rb, line 7</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_check_ac_args</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">block</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-regexp">/\A\w[-\w]*\z/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"no block given"</span>, <span class="ruby-constant">ParseError</span>.<span class="ruby-identifier">filter_backtrace</span>(<span class="ruby-identifier">caller</span>)
<span class="ruby-keyword">end</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>