<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Como::Opt
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!Como/Opt.html";
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (O)</a> »
<span class='title'><span class='object_link'><a href="../Como.html" title="Como (module)">Como</a></span></span>
»
<span class="title">Opt</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Como::Opt
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><span class='object_link'><a href="ComoCommon.html" title="Como::ComoCommon (class)">ComoCommon</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="ComoCommon.html" title="Como::ComoCommon (class)">ComoCommon</a></span></li>
<li class="next">Como::Opt</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/como.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Opt includes all options spec information and parsed options and their
values. Option instance is accessed with “<a href="'name'">Opt</a>”. The
option status (Opt instance) can be queried with for example “given” and
“value” methods.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="MainOpt.html" title="Como::MainOpt (class)">MainOpt</a></span></p>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Opt/ErrorWithData.html" title="Como::Opt::ErrorWithData (class)">ErrorWithData</a></span>, <span class='object_link'><a href="Opt/InvalidOption.html" title="Como::Opt::InvalidOption (class)">InvalidOption</a></span>, <span class='object_link'><a href="Opt/MissingArgument.html" title="Como::Opt::MissingArgument (class)">MissingArgument</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="main-classvariable" class="">@@main =
<div class="docstring">
<div class="discussion">
<p>Program i.e. highest level subcommand.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
<dt id="opts-classvariable" class="">@@opts =
<div class="docstring">
<div class="discussion">
<p>List of parsed option specs and option values.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbracket'>[</span><span class='rbracket'>]</span></pre></dd>
<dt id="subcmd-classvariable" class="">@@subcmd =
<div class="docstring">
<div class="discussion">
<p>Current subcommand recorded.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
<dt id="config-classvariable" class="">@@config =
<div class="docstring">
<div class="discussion">
<p>Set of default configs for printout.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='symbol'>:autohelp</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:rulehelp</span> <span class='op'>=></span> <span class='kw'>false</span><span class='comma'>,</span>
<span class='symbol'>:header</span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='symbol'>:footer</span> <span class='op'>=></span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='symbol'>:subcheck</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:check_missing</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:check_invalid</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:tab</span> <span class='op'>=></span> <span class='int'>12</span><span class='comma'>,</span>
<span class='symbol'>:help_exit</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='symbol'>:copyright</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='rbrace'>}</span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#config-instance_method" title="#config (instance method)">- (Object) <strong>config</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Opt configuration.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#doc-instance_method" title="#doc (instance method)">- (Object) <strong>doc</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Option documentation string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#given-instance_method" title="#given (instance method)">- (Object) <strong>given</strong>(optArg = false, &prog) </a>
(also: #given?)
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns true if option is given, and block is not present.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#longOpt-instance_method" title="#longOpt (instance method)">- (Object) <strong>longOpt</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Long option string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Option name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parent-instance_method" title="#parent (instance method)">- (Object) <strong>parent</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Subcommand parent (i.e. host).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rules-instance_method" title="#rules (instance method)">- (Object) <strong>rules</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Opt rules.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#shortOpt-instance_method" title="#shortOpt (instance method)">- (Object) <strong>shortOpt</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Short option string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#subcmd-instance_method" title="#subcmd (instance method)">- (Object) <strong>subcmd</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>List of subcommands.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#subopt-instance_method" title="#subopt (instance method)">- (Object) <strong>subopt</strong> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>List of suboptions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Option type as array of primitives (or :subcmd).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#value-instance_method" title="#value (instance method)">- (Object) <strong>value</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Option value.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#%5B%5D-class_method" title="[] (class method)">+ (Object) <strong>[]</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Select option object by name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#addOpt-class_method" title="addOpt (class method)">+ (Object) <strong>addOpt</strong>(opt) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Add option to options list.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#author-class_method" title="author (class method)">+ (Object) <strong>author</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return author.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configGet-class_method" title="configGet (class method)">+ (Object) <strong>configGet</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return default config for Como options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configOverlay-class_method" title="configOverlay (class method)">+ (Object) <strong>configOverlay</strong>(config) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Overlay Opt default configuration options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configSet-class_method" title="configSet (class method)">+ (Object) <strong>configSet</strong>(config) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set default config for Como options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#current-class_method" title="current (class method)">+ (Object) <strong>current</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Current subcmd processed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default-class_method" title="default (class method)">+ (Object) <strong>default</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return arguments (options) that have no switch.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#defaultOpt-class_method" title="defaultOpt (class method)">+ (Object) <strong>defaultOpt</strong>(doc = "No doc.") </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create default option spec, no switch.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#each-class_method" title="each (class method)">+ (Object) <strong>each</strong>(&blk) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Options iterator for all options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#each_given-class_method" title="each_given (class method)">+ (Object) <strong>each_given</strong>(&blk) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Options iterator for given options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error-class_method" title="error (class method)">+ (Object) <strong>error</strong>(str, nl = false) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issue non-fatal user error.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#external-class_method" title="external (class method)">+ (Object) <strong>external</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return arguments (options) that are specified as command external (i.e.
after '–').</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fatal-class_method" title="fatal (class method)">+ (Object) <strong>fatal</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issue fatal user error.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#findOpt-class_method" title="findOpt (class method)">+ (Object) <strong>findOpt</strong>(name) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Find option by name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#full-class_method" title="full (class method)">+ (Object) <strong>full</strong>(name, opt, type, doc = "No doc.") </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create option spec.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#main-class_method" title="main (class method)">+ (Object) <strong>main</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get main option.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#progname-class_method" title="progname (class method)">+ (Object) <strong>progname</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return program name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reset-class_method" title="reset (class method)">+ (Object) <strong>reset</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Reset “dynamic” class members.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setMain-class_method" title="setMain (class method)">+ (Object) <strong>setMain</strong>(main) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set main option.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setSubcmd-class_method" title="setSubcmd (class method)">+ (Object) <strong>setSubcmd</strong>(opt) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set current subcmd.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#subcmd-class_method" title="subcmd (class method)">+ (Object) <strong>subcmd</strong>(name, doc = "No doc.") </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create sub-command option spec.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#warn-class_method" title="warn (class method)">+ (Object) <strong>warn</strong>(str, nl = false) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issue user warning.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#year-class_method" title="year (class method)">+ (Object) <strong>year</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return program year.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Object) <strong>[]</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Select option object by name operator.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#addOption-instance_method" title="#addOption (instance method)">- (Object) <strong>addOption</strong>(opt) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Add subcommand option.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#addSubcmd-instance_method" title="#addSubcmd (instance method)">- (Object) <strong>addSubcmd</strong>(cmd) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Add subcommand subcmd.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#apply-instance_method" title="#apply (instance method)">- (Object) <strong>apply</strong>(default = nil) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return option value if given otherwise the default.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#applyConfig-instance_method" title="#applyConfig (instance method)">- (Object) <strong>applyConfig</strong>(config) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Merge config to base config.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#argById-instance_method" title="#argById (instance method)">- (Object) <strong>argById</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Select option object by name/opt/longOpt.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#argByName-instance_method" title="#argByName (instance method)">- (Object) <strong>argByName</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Select option object by name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#check-instance_method" title="#check (instance method)">- (Object) <strong>check</strong>(argsState) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Check provided args.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#checkAlso-instance_method" title="#checkAlso (instance method)">- (Object) <strong>checkAlso</strong>(opt, error, &check) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Additional option check.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#checkMissing-instance_method" title="#checkMissing (instance method)">- (Object) <strong>checkMissing</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Check for any non-given required arguments recursively through hierarchy of
subcommands.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#checkRule-instance_method" title="#checkRule (instance method)">- (Object) <strong>checkRule</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Check option combination rules.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cmdline-instance_method" title="#cmdline (instance method)">- (Object) <strong>cmdline</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return cmdline usage strings for options in an Array.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default-instance_method" title="#default (instance method)">- (Object) <strong>default</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return default options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#each-instance_method" title="#each (instance method)">- (Object) <strong>each</strong>(&blk) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Options list iterator.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#each_given-instance_method" title="#each_given (instance method)">- (Object) <strong>each_given</strong>(&blk) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Options iterator for given options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong>(str, nl = false) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Como error printout.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#errornl-instance_method" title="#errornl (instance method)">- (Object) <strong>errornl</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Como error printout with pre-newline.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#evalCheck-instance_method" title="#evalCheck (instance method)">- (Object) <strong>evalCheck</strong>(&check) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Custom check for the option.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fatal-instance_method" title="#fatal (instance method)">- (Object) <strong>fatal</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Como error printout with immediate exit.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#findOpt-instance_method" title="#findOpt (instance method)">- (Object) <strong>findOpt</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Find option object by option str.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#givenCount-instance_method" title="#givenCount (instance method)">- (Object) <strong>givenCount</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Number of given options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#givenSubcmd-instance_method" title="#givenSubcmd (instance method)">- (Object) <strong>givenSubcmd</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return the selected subcommand.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#hasSwitchStyleDoc-instance_method" title="#hasSwitchStyleDoc (instance method)">- (Object) <strong>hasSwitchStyleDoc</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Test if option is of switch type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Opt) <strong>initialize</strong>(name, opt, type, doc, value = nil) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Create Opt object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#opt-instance_method" title="#opt (instance method)">- (Object) <strong>opt</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Option's opt id.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#params-instance_method" title="#params (instance method)">- (Hash) <strong>params</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns Hash of option value parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse-instance_method" title="#parse (instance method)">- (Object) <strong>parse</strong>(args, checkInvalids = true) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Parse cmdline options from args.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prim%3F-instance_method" title="#prim? (instance method)">- (Boolean) <strong>prim?</strong>(prim) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Check for primitive.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setOptionSubcmd-instance_method" title="#setOptionSubcmd (instance method)">- (Object) <strong>setOptionSubcmd</strong>(opts, subs) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set command (subcommand) suboptions and subcmds.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setRuleCheck-instance_method" title="#setRuleCheck (instance method)">- (Object) <strong>setRuleCheck</strong>(&rule) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set rule checks for the option.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setUsageFooter-instance_method" title="#setUsageFooter (instance method)">- (Object) <strong>setUsageFooter</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set optional footer for “usage”.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#setUsageHeader-instance_method" title="#setUsageHeader (instance method)">- (Object) <strong>setUsageHeader</strong>(str) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set optional header for “usage”.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#suball-instance_method" title="#suball (instance method)">- (Object) <strong>suball</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>All subcommand options, options and subcommands.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#suboptDoc-instance_method" title="#suboptDoc (instance method)">- (Object) <strong>suboptDoc</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return document strings for options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_hash-instance_method" title="#to_hash (instance method)">- (Object) <strong>to_hash</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Convert to hash representation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_hopt-instance_method" title="#to_hopt (instance method)">- (Object) <strong>to_hopt</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Convert to hash representation with opt name keys.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#usage-instance_method" title="#usage (instance method)">- (Object) <strong>usage</strong>(doExit = nil, ruleHelp = nil) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Display program usage (and optionally exit).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#usageCommand-instance_method" title="#usageCommand (instance method)">- (Object) <strong>usageCommand</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Usage printout for command.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#usageIfHelp-instance_method" title="#usageIfHelp (instance method)">- (Object) <strong>usageIfHelp</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Display program usage (and optionally exit).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#usageNormal-instance_method" title="#usageNormal (instance method)">- (Object) <strong>usageNormal</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Usage info for Opt:s.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#warn-instance_method" title="#warn (instance method)">- (Object) <strong>warn</strong>(str, nl = false) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Como warning printout.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#%7E-instance_method" title="#~ (instance method)">- (Object) <strong>~</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Short syntax for value reference.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="ComoCommon.html" title="Como::ComoCommon (class)">ComoCommon</a></span></h3>
<p class="inherited"><span class='object_link'><a href="ComoCommon.html#getIo-class_method" title="Como::ComoCommon.getIo (method)">getIo</a></span>, <span class='object_link'><a href="ComoCommon.html#runHook-class_method" title="Como::ComoCommon.runHook (method)">runHook</a></span>, <span class='object_link'><a href="ComoCommon.html#setHook-class_method" title="Como::ComoCommon.setHook (method)">setHook</a></span>, <span class='object_link'><a href="ComoCommon.html#setIo-class_method" title="Como::ComoCommon.setIo (method)">setIo</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Como::Opt (class)">Opt</a></span></tt>) <strong>initialize</strong>(name, opt, type, doc, value = nil)
</h3><div class="docstring">
<div class="discussion">
<p>Create Opt object.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>Option name.</p>
</div>
</li>
<li>
<span class='name'>opt</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>Switch.</p>
</div>
</li>
<li>
<span class='name'>type</span>
<span class='type'>(<tt>Array<Symbol></tt>, <tt>Symbol</tt>)</span>
—
<div class='inline'>
<p>Option type in primitives (or :subcmd).</p>
</div>
</li>
<li>
<span class='name'>doc</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>Option documentation.</p>
</div>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
<p>Default value.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1199</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_opt'>opt</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
<span class='ivar'>@parent</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@shortOpt</span> <span class='op'>=</span> <span class='id identifier rubyid_opt'>opt</span>
<span class='ivar'>@longOpt</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>if</span> <span class='ivar'>@type</span> <span class='op'>!=</span> <span class='symbol'>:subcmd</span>
<span class='kw'>if</span> <span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:many</span> <span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='ivar'>@doc</span> <span class='op'>=</span> <span class='id identifier rubyid_doc'>doc</span>
<span class='comment'># Whether option was set or not.
</span> <span class='ivar'>@given</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='ivar'>@subopt</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='ivar'>@subcmd</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='ivar'>@rules</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@config</span> <span class='op'>=</span> <span class='cvar'>@@config</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_addOpt'>addOpt</span><span class='lparen'>(</span> <span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="config-instance_method">
- (<tt>Object</tt>) <strong>config</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Opt configuration.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1186
1187
1188</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1186</span>
<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
<span class='ivar'>@config</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="doc=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="doc-instance_method">
- (<tt>Object</tt>) <strong>doc</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Option documentation string.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1174
1175
1176</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1174</span>
<span class='kw'>def</span> <span class='id identifier rubyid_doc'>doc</span>
<span class='ivar'>@doc</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="given=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="given-instance_method">
- (<tt>Object</tt>) <strong>given</strong>(optArg = false, &prog)
<span class="aliases">Also known as:
<span class="names"><span id='given?-instance_method'>given?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns true if option is given, and block is not present. When block is
present, the block is executed (with value as parameter) if option has been
given.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>optArg</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'>
<p>Pass Opt to block instead of its value.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1635</span>
<span class='kw'>def</span> <span class='id identifier rubyid_given'>given</span><span class='lparen'>(</span> <span class='id identifier rubyid_optArg'>optArg</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_prog'>prog</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
<span class='kw'>if</span> <span class='ivar'>@given</span>
<span class='kw'>if</span> <span class='id identifier rubyid_optArg'>optArg</span>
<span class='kw'>yield</span><span class='lparen'>(</span> <span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='kw'>yield</span><span class='lparen'>(</span> <span class='ivar'>@value</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='ivar'>@given</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="longOpt=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="longOpt-instance_method">
- (<tt>Object</tt>) <strong>longOpt</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Long option string.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1165
1166
1167</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1165</span>
<span class='kw'>def</span> <span class='id identifier rubyid_longOpt'>longOpt</span>
<span class='ivar'>@longOpt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="name=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
- (<tt>Object</tt>) <strong>name</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Option name.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1159
1160
1161</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1159</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="parent=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="parent-instance_method">
- (<tt>Object</tt>) <strong>parent</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Subcommand parent (i.e. host).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1155
1156
1157</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1155</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='ivar'>@parent</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="rules-instance_method">
- (<tt>Object</tt>) <strong>rules</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Opt rules.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1189
1190
1191</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1189</span>
<span class='kw'>def</span> <span class='id identifier rubyid_rules'>rules</span>
<span class='ivar'>@rules</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="shortOpt=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="shortOpt-instance_method">
- (<tt>Object</tt>) <strong>shortOpt</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Short option string.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1162
1163
1164</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1162</span>
<span class='kw'>def</span> <span class='id identifier rubyid_shortOpt'>shortOpt</span>
<span class='ivar'>@shortOpt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="subcmd-instance_method">
- (<tt>Object</tt>) <strong>subcmd</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>List of subcommands.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1183
1184
1185</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1183</span>
<span class='kw'>def</span> <span class='id identifier rubyid_subcmd'>subcmd</span>
<span class='ivar'>@subcmd</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="subopt-instance_method">
- (<tt>Object</tt>) <strong>subopt</strong> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>List of suboptions.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1180
1181
1182</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1180</span>
<span class='kw'>def</span> <span class='id identifier rubyid_subopt'>subopt</span>
<span class='ivar'>@subopt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="type=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
- (<tt>Object</tt>) <strong>type</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Option type as array of primitives (or :subcmd).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1168
1169
1170</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1168</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="value=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="value-instance_method">
- (<tt>Object</tt>) <strong>value</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Option value.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1171
1172
1173</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1171</span>
<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
<span class='ivar'>@value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="[]-class_method">
+ (<tt>Object</tt>) <strong>[]</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Select option object by name. Main is searched first and then the flattened
list of all options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1038</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
<span class='comment'># Search Main first.
</span> <span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_argByName'>argByName</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_ret'>ret</span>
<span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_findOpt'>findOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_ret'>ret</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>RuntimeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Option \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str'>str</span><span class='embexpr_end'>}</span><span class='tstring_content'>\" does not exist...</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ret'>ret</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="addOpt-class_method">
+ (<tt>Object</tt>) <strong>addOpt</strong>(opt)
</h3><div class="docstring">
<div class="discussion">
<p>Add option to options list.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1002
1003
1004</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1002</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_addOpt'>addOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_opt'>opt</span> <span class='rparen'>)</span>
<span class='cvar'>@@opts</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_opt'>opt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="author-class_method">
+ (<tt>Object</tt>) <strong>author</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return author.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1067
1068
1069</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1067</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_author'>author</span>
<span class='cvar'>@@main</span><span class='period'>.</span><span class='id identifier rubyid_author'>author</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="configGet-class_method">
+ (<tt>Object</tt>) <strong>configGet</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return default config for Como options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1120
1121
1122</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1120</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_configGet'>configGet</span>
<span class='cvar'>@@config</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="configOverlay-class_method">
+ (<tt>Object</tt>) <strong>configOverlay</strong>(config)
</h3><div class="docstring">
<div class="discussion">
<p>Overlay Opt default configuration options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1114
1115
1116</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1114</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_configOverlay'>configOverlay</span><span class='lparen'>(</span> <span class='id identifier rubyid_config'>config</span> <span class='rparen'>)</span>
<span class='cvar'>@@config</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span> <span class='id identifier rubyid_config'>config</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="configSet-class_method">
+ (<tt>Object</tt>) <strong>configSet</strong>(config)
</h3><div class="docstring">
<div class="discussion">
<p>Set default config for Como options. User can manipulate the defaults with
“preHook”.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1127
1128
1129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1127</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_configSet'>configSet</span><span class='lparen'>(</span> <span class='id identifier rubyid_config'>config</span> <span class='rparen'>)</span>
<span class='cvar'>@@config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="current-class_method">
+ (<tt>Object</tt>) <strong>current</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Current subcmd processed.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1014
1015
1016</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1014</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span>
<span class='cvar'>@@subcmd</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="default-class_method">
+ (<tt>Object</tt>) <strong>default</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return arguments (options) that have no switch.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1080
1081
1082</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1080</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="defaultOpt-class_method">
+ (<tt>Object</tt>) <strong>defaultOpt</strong>(doc = "No doc.")
</h3><div class="docstring">
<div class="discussion">
<p>Create default option spec, no switch.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1096
1097
1098</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1096</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_defaultOpt'>defaultOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_doc'>doc</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No doc.</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><default></span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><default></span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span> <span class='symbol'>:default</span><span class='comma'>,</span> <span class='symbol'>:none</span><span class='comma'>,</span> <span class='symbol'>:one</span><span class='comma'>,</span> <span class='symbol'>:many</span><span class='comma'>,</span> <span class='symbol'>:opt</span> <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="each-class_method">
+ (<tt>Object</tt>) <strong>each</strong>(&blk)
</h3><div class="docstring">
<div class="discussion">
<p>Options iterator for all options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1102
1103
1104</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1102</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="each_given-class_method">
+ (<tt>Object</tt>) <strong>each_given</strong>(&blk)
</h3><div class="docstring">
<div class="discussion">
<p>Options iterator for given options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1108
1109
1110</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1108</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_each_given'>each_given</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_each_given'>each_given</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="error-class_method">
+ (<tt>Object</tt>) <strong>error</strong>(str, nl = false)
</h3><div class="docstring">
<div class="discussion">
<p>Issue non-fatal user error. See <span class='object_link'><a href="#error-instance_method" title="Como::Opt#error (method)">#error</a></span>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1133
1134
1135</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1133</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='id identifier rubyid_nl'>nl</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='rparen'>)</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='id identifier rubyid_nl'>nl</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="external-class_method">
+ (<tt>Object</tt>) <strong>external</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return arguments (options) that are specified as command external (i.e.
after '–').</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1074
1075
1076</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1074</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_external'>external</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_external'>external</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fatal-class_method">
+ (<tt>Object</tt>) <strong>fatal</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Issue fatal user error. See <span class='object_link'><a href="#fatal-instance_method" title="Como::Opt#fatal (method)">#fatal</a></span>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1139
1140
1141</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1139</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_fatal'>fatal</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_fatal'>fatal</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="findOpt-class_method">
+ (<tt>Object</tt>) <strong>findOpt</strong>(name)
</h3><div class="docstring">
<div class="discussion">
<p>Find option by name.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1020
1021
1022
1023
1024
1025
1026
1027</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1020</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_findOpt'>findOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_idx'>idx</span> <span class='op'>=</span> <span class='cvar'>@@opts</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_idx'>idx</span>
<span class='cvar'>@@opts</span><span class='lbracket'>[</span> <span class='id identifier rubyid_idx'>idx</span> <span class='rbracket'>]</span>
<span class='kw'>else</span>
<span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="full-class_method">
+ (<tt>Object</tt>) <strong>full</strong>(name, opt, type, doc = "No doc.")
</h3><div class="docstring">
<div class="discussion">
<p>Create option spec.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1086
1087
1088</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1086</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_full'>full</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_opt'>opt</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No doc.</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_opt'>opt</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="main-class_method">
+ (<tt>Object</tt>) <strong>main</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Get main option.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
996
997
998</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 996</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span>
<span class='cvar'>@@main</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="progname-class_method">
+ (<tt>Object</tt>) <strong>progname</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return program name.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1055
1056
1057</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1055</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_progname'>progname</span>
<span class='cvar'>@@main</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reset-class_method">
+ (<tt>Object</tt>) <strong>reset</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Reset “dynamic” class members.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1031
1032
1033</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1031</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span>
<span class='cvar'>@@opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setMain-class_method">
+ (<tt>Object</tt>) <strong>setMain</strong>(main)
</h3><div class="docstring">
<div class="discussion">
<p>Set main option.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
990
991
992
993</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 990</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_setMain'>setMain</span><span class='lparen'>(</span> <span class='id identifier rubyid_main'>main</span> <span class='rparen'>)</span>
<span class='cvar'>@@main</span> <span class='op'>=</span> <span class='id identifier rubyid_main'>main</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_setSubcmd'>setSubcmd</span><span class='lparen'>(</span> <span class='id identifier rubyid_main'>main</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setSubcmd-class_method">
+ (<tt>Object</tt>) <strong>setSubcmd</strong>(opt)
</h3><div class="docstring">
<div class="discussion">
<p>Set current subcmd.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1008
1009
1010</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1008</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_setSubcmd'>setSubcmd</span><span class='lparen'>(</span> <span class='id identifier rubyid_opt'>opt</span> <span class='rparen'>)</span>
<span class='cvar'>@@subcmd</span> <span class='op'>=</span> <span class='id identifier rubyid_opt'>opt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="subcmd-class_method">
+ (<tt>Object</tt>) <strong>subcmd</strong>(name, doc = "No doc.")
</h3><div class="docstring">
<div class="discussion">
<p>Create sub-command option spec.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1091
1092
1093</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1091</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_subcmd'>subcmd</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No doc.</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='symbol'>:subcmd</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span><span class='comma'>,</span> <span class='kw'>false</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="warn-class_method">
+ (<tt>Object</tt>) <strong>warn</strong>(str, nl = false)
</h3><div class="docstring">
<div class="discussion">
<p>Issue user warning. See <span class='object_link'><a href="#warn-instance_method" title="Como::Opt#warn (method)">#warn</a></span>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1145
1146
1147</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1145</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='id identifier rubyid_nl'>nl</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='rparen'>)</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='id identifier rubyid_nl'>nl</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="year-class_method">
+ (<tt>Object</tt>) <strong>year</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return program year.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1061
1062
1063</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1061</span>
<span class='kw'>def</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_year'>year</span>
<span class='cvar'>@@main</span><span class='period'>.</span><span class='id identifier rubyid_year'>year</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="[]-instance_method">
- (<tt>Object</tt>) <strong>[]</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Select option object by name operator.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1561
1562
1563
1564
1565
1566
1567</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1561</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='id identifier rubyid_argByName'>argByName</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_ret'>ret</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>RuntimeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Subopt \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str'>str</span><span class='embexpr_end'>}</span><span class='tstring_content'>\" does not exist for \"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"!</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_ret'>ret</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="addOption-instance_method">
- (<tt>Object</tt>) <strong>addOption</strong>(opt)
</h3><div class="docstring">
<div class="discussion">
<p>Add subcommand option.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt>Option</tt>)</span>
—
<div class='inline'>
<p>Option to add.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1244
1245
1246
1247</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1244</span>
<span class='kw'>def</span> <span class='id identifier rubyid_addOption'>addOption</span><span class='lparen'>(</span> <span class='id identifier rubyid_opt'>opt</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_opt'>opt</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_opt'>opt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="addSubcmd-instance_method">
- (<tt>Object</tt>) <strong>addSubcmd</strong>(cmd)
</h3><div class="docstring">
<div class="discussion">
<p>Add subcommand subcmd.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>cmd</span>
<span class='type'>(<tt>Option</tt>)</span>
—
<div class='inline'>
<p>Subcmd to add.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1253
1254
1255
1256</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1253</span>
<span class='kw'>def</span> <span class='id identifier rubyid_addSubcmd'>addSubcmd</span><span class='lparen'>(</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='ivar'>@subcmd</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_cmd'>cmd</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="apply-instance_method">
- (<tt>Object</tt>) <strong>apply</strong>(default = nil)
</h3><div class="docstring">
<div class="discussion">
<p>Return option value if given otherwise the default. Example usage: fileName
= <a href=""file"">Opt</a>.apply( “no_name.txt” )</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1616</span>
<span class='kw'>def</span> <span class='id identifier rubyid_apply'>apply</span><span class='lparen'>(</span> <span class='id identifier rubyid_default'>default</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_given'>given</span>
<span class='kw'>if</span> <span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:none</span> <span class='rparen'>)</span>
<span class='kw'>true</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_default'>default</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="applyConfig-instance_method">
- (<tt>Object</tt>) <strong>applyConfig</strong>(config)
</h3><div class="docstring">
<div class="discussion">
<p>Merge config to base config.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>config</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>Configuration Hash to merge.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1262
1263
1264</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1262</span>
<span class='kw'>def</span> <span class='id identifier rubyid_applyConfig'>applyConfig</span><span class='lparen'>(</span> <span class='id identifier rubyid_config'>config</span> <span class='rparen'>)</span>
<span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span> <span class='id identifier rubyid_config'>config</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="argById-instance_method">
- (<tt>Object</tt>) <strong>argById</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Select option object by name/opt/longOpt.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1707</span>
<span class='kw'>def</span> <span class='id identifier rubyid_argById'>argById</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='symbol'>:default</span>
<span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:default</span> <span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_o'>o</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>nil</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_suball'>suball</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>||</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_opt'>opt</span> <span class='op'>||</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_longOpt'>longOpt</span>
<span class='kw'>return</span> <span class='id identifier rubyid_o'>o</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="argByName-instance_method">
- (<tt>Object</tt>) <strong>argByName</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Select option object by name.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1687</span>
<span class='kw'>def</span> <span class='id identifier rubyid_argByName'>argByName</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='symbol'>:default</span>
<span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:default</span> <span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_o'>o</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>nil</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_suball'>suball</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='kw'>return</span> <span class='id identifier rubyid_o'>o</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="check-instance_method">
- (<tt>Object</tt>) <strong>check</strong>(argsState)
</h3><div class="docstring">
<div class="discussion">
<p>Check provided args.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1279</span>
<span class='kw'>def</span> <span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span> <span class='id identifier rubyid_argsState'>argsState</span> <span class='rparen'>)</span>
<span class='comment'># Start at top.
</span> <span class='id identifier rubyid_top'>top</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='id identifier rubyid_parse'>parse</span> <span class='op'>=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
<span class='comment'># Parse and check for invalid arguments.
</span> <span class='kw'>begin</span>
<span class='id identifier rubyid_top'>top</span> <span class='op'>=</span> <span class='id identifier rubyid_top'>top</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span> <span class='id identifier rubyid_argsState'>argsState</span><span class='comma'>,</span> <span class='id identifier rubyid_top'>top</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span> <span class='symbol'>:check_invalid</span> <span class='rbracket'>]</span> <span class='rparen'>)</span>
<span class='kw'>end</span> <span class='kw'>while</span><span class='lparen'>(</span> <span class='id identifier rubyid_top'>top</span> <span class='rparen'>)</span>
<span class='comment'># Check for any missing valid arguments.
</span> <span class='id identifier rubyid_checkMissing'>checkMissing</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='const'>Proc</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_err'>err</span><span class='op'>|</span>
<span class='id identifier rubyid_errornl'>errornl</span><span class='lparen'>(</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rparen'>)</span>
<span class='comment'># Display subcmd specific usage info.
</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_usage'>usage</span>
<span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span> <span class='int'>1</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_parse'>parse</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
<span class='kw'>rescue</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>MissingArgument</span><span class='comma'>,</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>InvalidOption</span> <span class='op'>=></span> <span class='id identifier rubyid_err'>err</span>
<span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span> <span class='id identifier rubyid_err'>err</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='comment'># Revert back to top after hierarchy travelsal.
</span> <span class='id identifier rubyid_usageIfHelp'>usageIfHelp</span>
<span class='comment'># Check rules.
</span> <span class='id identifier rubyid_cur'>cur</span> <span class='op'>=</span> <span class='kw'>self</span>
<span class='kw'>while</span> <span class='id identifier rubyid_cur'>cur</span>
<span class='id identifier rubyid_cur'>cur</span><span class='period'>.</span><span class='id identifier rubyid_checkRule'>checkRule</span>
<span class='id identifier rubyid_cur'>cur</span> <span class='op'>=</span> <span class='id identifier rubyid_cur'>cur</span><span class='period'>.</span><span class='id identifier rubyid_givenSubcmd'>givenSubcmd</span>
<span class='kw'>end</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="checkAlso-instance_method">
- (<tt>Object</tt>) <strong>checkAlso</strong>(opt, error, &check)
</h3><div class="docstring">
<div class="discussion">
<p>Additional option check.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opt</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>Option name.</p>
</div>
</li>
<li>
<span class='name'>error</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>Error string for false return values (from check).</p>
</div>
</li>
<li>
<span class='name'>check</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'>
<p>Checker proc run for the option. Either</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>false or generate an exception when errors found.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1541</span>
<span class='kw'>def</span> <span class='id identifier rubyid_checkAlso'>checkAlso</span><span class='lparen'>(</span> <span class='id identifier rubyid_opt'>opt</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_check'>check</span> <span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='kw'>if</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_opt'>opt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_evalCheck'>evalCheck</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_check'>check</span> <span class='rparen'>)</span> <span class='op'>!=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_error'>error</span><span class='comma'>,</span> <span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>rescue</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>MissingArgument</span><span class='comma'>,</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>InvalidOption</span> <span class='op'>=></span> <span class='id identifier rubyid_err'>err</span>
<span class='cvar'>@@io</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span>
<span class='id identifier rubyid_errornl'>errornl</span><span class='lparen'>(</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_usage'>usage</span>
<span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span> <span class='int'>1</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="checkMissing-instance_method">
- (<tt>Object</tt>) <strong>checkMissing</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Check for any non-given required arguments recursively through hierarchy of
subcommands. MissingArgument Exception is generated if argument is missing.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Opt/MissingArgument.html" title="Como::Opt::MissingArgument (class)">MissingArgument</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1461</span>
<span class='kw'>def</span> <span class='id identifier rubyid_checkMissing'>checkMissing</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span> <span class='symbol'>:check_missing</span> <span class='rbracket'>]</span>
<span class='comment'># Full cmd name.
</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>=</span> <span class='lparen'>(</span> <span class='id identifier rubyid_getParents'>getParents</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='kw'>end</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span> <span class='rparen'>)</span>
<span class='comment'># Check for any exclusive args first.
</span> <span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:mutex</span> <span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
<span class='kw'>return</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='comment'># Check for required arguments for this level before
</span> <span class='comment'># subcmds.
</span> <span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:opt</span> <span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>MissingArgument</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Option \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'>\" missing for \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_hasSubcmd'>hasSubcmd</span>
<span class='kw'>if</span> <span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:subcheck</span> <span class='rbracket'>]</span>
<span class='comment'># Compulsory Subcommand checking enabled.
</span> <span class='id identifier rubyid_subcmdMissing'>subcmdMissing</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_subcmdMissing'>subcmdMissing</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_subcmdMissing'>subcmdMissing</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='kw'>end</span>
<span class='comment'># Check for any subcmd args.
</span> <span class='id identifier rubyid_sub'>sub</span> <span class='op'>=</span> <span class='id identifier rubyid_givenSubcmd'>givenSubcmd</span>
<span class='kw'>if</span> <span class='id identifier rubyid_sub'>sub</span>
<span class='id identifier rubyid_subcmdMissing'>subcmdMissing</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='comment'># Use recursion to examine the next level.
</span> <span class='kw'>return</span> <span class='id identifier rubyid_sub'>sub</span><span class='period'>.</span><span class='id identifier rubyid_checkMissing'>checkMissing</span>
<span class='kw'>end</span>
<span class='comment'># If no subcmds are given, issue error.
</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>MissingArgument</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Subcommand required for \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_subcmdMissing'>subcmdMissing</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="checkRule-instance_method">
- (<tt>Object</tt>) <strong>checkRule</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Check option combination rules.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1517</span>
<span class='kw'>def</span> <span class='id identifier rubyid_checkRule'>checkRule</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@rules</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Option combination mismatch!</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>self</span> <span class='rparen'>)</span> <span class='kw'>unless</span>
<span class='const'>RuleCheck</span><span class='period'>.</span><span class='id identifier rubyid_check'>check</span><span class='lparen'>(</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='op'>&</span><span class='ivar'>@rules</span> <span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>MissingArgument</span><span class='comma'>,</span> <span class='const'>Opt</span><span class='op'>::</span><span class='const'>InvalidOption</span> <span class='op'>=></span> <span class='id identifier rubyid_err'>err</span>
<span class='cvar'>@@io</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span>
<span class='id identifier rubyid_errornl'>errornl</span><span class='lparen'>(</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_usage'>usage</span><span class='lparen'>(</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>true</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="cmdline-instance_method">
- (<tt>Object</tt>) <strong>cmdline</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return cmdline usage strings for options in an Array.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1827</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cmdline'>cmdline</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:hidden</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_prural'>prural</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:none</span> <span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:many</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_prural'>prural</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*</span><span class='tstring_end'>"</span></span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:one</span> <span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:many</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_prural'>prural</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>+</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_prural'>prural</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='lparen'>(</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_hasSwitchStyleDoc'>hasSwitchStyleDoc</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> <</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prural'>prural</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_shortOpt'>shortOpt</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_opt'>opt</span> <span class='op'>=</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_longOpt'>longOpt</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_opt'>opt</span> <span class='op'>=</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_shortOpt'>shortOpt</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:opt</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>]</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_hasSubcmd'>hasSubcmd</span>
<span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><<subcommand>></span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_opts'>opts</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="default-instance_method">
- (<tt>Object</tt>) <strong>default</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return default options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1681
1682
1683</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1681</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default'>default</span>
<span class='id identifier rubyid_argByName'>argByName</span><span class='lparen'>(</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="each-instance_method">
- (<tt>Object</tt>) <strong>each</strong>(&blk)
</h3><div class="docstring">
<div class="discussion">
<p>Options list iterator.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1583
1584
1585
1586
1587</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1583</span>
<span class='kw'>def</span> <span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_suball'>suball</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>yield</span> <span class='id identifier rubyid_o'>o</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="each_given-instance_method">
- (<tt>Object</tt>) <strong>each_given</strong>(&blk)
</h3><div class="docstring">
<div class="discussion">
<p>Options iterator for given options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1591
1592
1593
1594
1595</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1591</span>
<span class='kw'>def</span> <span class='id identifier rubyid_each_given'>each_given</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_suball'>suball</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>yield</span> <span class='id identifier rubyid_o'>o</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="error-instance_method">
- (<tt>Object</tt>) <strong>error</strong>(str, nl = false)
</h3><div class="docstring">
<div class="discussion">
<p>Como error printout.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>str</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>Error message.</p>
</div>
</li>
<li>
<span class='name'>nl</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'>
<p>Prepend msg with newline.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1951
1952
1953
1954</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1951</span>
<span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='id identifier rubyid_nl'>nl</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_nl'>nl</span> <span class='op'>=</span> <span class='id identifier rubyid_nl'>nl</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='const'>STDERR</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_nl'>nl</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_progname'>progname</span><span class='embexpr_end'>}</span><span class='tstring_content'> error: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str'>str</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="errornl-instance_method">
- (<tt>Object</tt>) <strong>errornl</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Como error printout with pre-newline.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1958
1959
1960</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1958</span>
<span class='kw'>def</span> <span class='id identifier rubyid_errornl'>errornl</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='kw'>true</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="evalCheck-instance_method">
- (<tt>Object</tt>) <strong>evalCheck</strong>(&check)
</h3><div class="docstring">
<div class="discussion">
<p>Custom check for the option. User has to know some Como internals.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1982
1983
1984</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1982</span>
<span class='kw'>def</span> <span class='id identifier rubyid_evalCheck'>evalCheck</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_check'>check</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_instance_eval'>instance_eval</span> <span class='op'>&</span><span class='id identifier rubyid_check'>check</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fatal-instance_method">
- (<tt>Object</tt>) <strong>fatal</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Como error printout with immediate exit.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1964
1965
1966
1967</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1964</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fatal'>fatal</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span> <span class='kw'>false</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="findOpt-instance_method">
- (<tt>Object</tt>) <strong>findOpt</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Find option object by option str.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1898</span>
<span class='kw'>def</span> <span class='id identifier rubyid_findOpt'>findOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_subopt'>subopt</span><span class='period'>.</span><span class='id identifier rubyid_detect'>detect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:default</span> <span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>--</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_subopt'>subopt</span><span class='period'>.</span><span class='id identifier rubyid_detect'>detect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_longOpt'>longOpt</span> <span class='op'>==</span> <span class='id identifier rubyid_str'>str</span> <span class='rbrace'>}</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_subopt'>subopt</span><span class='period'>.</span><span class='id identifier rubyid_detect'>detect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_opt'>opt</span> <span class='op'>==</span> <span class='id identifier rubyid_str'>str</span> <span class='rbrace'>}</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_suball'>suball</span><span class='period'>.</span><span class='id identifier rubyid_detect'>detect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='id identifier rubyid_str'>str</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="givenCount-instance_method">
- (<tt>Object</tt>) <strong>givenCount</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Number of given options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1599
1600
1601
1602
1603
1604
1605</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1599</span>
<span class='kw'>def</span> <span class='id identifier rubyid_givenCount'>givenCount</span>
<span class='id identifier rubyid_cnt'>cnt</span> <span class='op'>=</span> <span class='int'>0</span>
<span class='id identifier rubyid_each_given'>each_given</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_cnt'>cnt</span> <span class='op'>+=</span> <span class='int'>1</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_cnt'>cnt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="givenSubcmd-instance_method">
- (<tt>Object</tt>) <strong>givenSubcmd</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return the selected subcommand.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1657
1658
1659</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1657</span>
<span class='kw'>def</span> <span class='id identifier rubyid_givenSubcmd'>givenSubcmd</span>
<span class='lparen'>(</span> <span class='ivar'>@subcmd</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span> <span class='kw'>end</span> <span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="hasSwitchStyleDoc-instance_method">
- (<tt>Object</tt>) <strong>hasSwitchStyleDoc</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Test if option is of switch type.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1733
1734
1735
1736
1737
1738
1739
1740</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1733</span>
<span class='kw'>def</span> <span class='id identifier rubyid_hasSwitchStyleDoc'>hasSwitchStyleDoc</span>
<span class='kw'>if</span> <span class='lparen'>(</span> <span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:none</span> <span class='rparen'>)</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:many</span> <span class='rparen'>)</span> <span class='rparen'>)</span> <span class='op'>||</span>
<span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:default</span> <span class='rparen'>)</span>
<span class='kw'>true</span>
<span class='kw'>else</span>
<span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="opt-instance_method">
- (<tt>Object</tt>) <strong>opt</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Option's opt id. Short if exists otherwise long.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1571
1572
1573</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1571</span>
<span class='kw'>def</span> <span class='id identifier rubyid_opt'>opt</span>
<span class='ivar'>@shortOpt</span> <span class='op'>?</span> <span class='ivar'>@shortOpt</span> <span class='op'>:</span> <span class='ivar'>@longOpt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="params-instance_method">
- (<tt>Hash</tt>) <strong>params</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Hash of option value parameters. Example command line content:</p>
<pre class="code ruby"><code class="ruby">-p rounds=10 length=5</code></pre>
<p>Option value content in this case would be (Array of param settings):</p>
<pre class="code ruby"><code class="ruby"><span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rounds=10</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>length=5</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span>
</code></pre>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'>
<p>Parameter settings included in the option.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1669
1670
1671
1672
1673
1674
1675
1676
1677</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1669</span>
<span class='kw'>def</span> <span class='id identifier rubyid_params'>params</span>
<span class='id identifier rubyid_map'>map</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@value</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>=</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_str_to_num'>str_to_num</span><span class='lparen'>(</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_map'>map</span><span class='lbracket'>[</span> <span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_map'>map</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse-instance_method">
- (<tt>Object</tt>) <strong>parse</strong>(args, checkInvalids = true)
</h3><div class="docstring">
<div class="discussion">
<p>Parse cmdline options from args.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1325</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span> <span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='id identifier rubyid_checkInvalids'>checkInvalids</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='rparen'>)</span>
<span class='kw'>while</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span>
<span class='comment'># puts "Opt.parse (#{@name}): #{args.get}"
</span>
<span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_isOptTerm'>isOptTerm</span>
<span class='comment'># Rest of the args do not belong to this program.
</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_external'>external</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_rest'>rest</span>
<span class='kw'>break</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_isOpt'>isOpt</span>
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='id identifier rubyid_findOpt'>findOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span>
<span class='kw'>if</span> <span class='id identifier rubyid_checkInvalids'>checkInvalids</span>
<span class='id identifier rubyid_raise'>raise</span> \
<span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unknown option \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='id identifier rubyid_findOpt'>findOpt</span><span class='lparen'>(</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span>
<span class='id identifier rubyid_raise'>raise</span> \
<span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No default option specified to allow \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='comment'># Default option.
</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_toValue'>toValue</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_o'>o</span> <span class='op'>&&</span> <span class='lparen'>(</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:one</span> <span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:many</span> <span class='rparen'>)</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='kw'>if</span> <span class='lparen'>(</span> <span class='op'>!</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='op'>||</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_isOpt'>isOpt</span> <span class='rparen'>)</span> <span class='op'>&&</span>
<span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:none</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>MissingArgument</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No argument given for \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_opt'>opt</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:many</span> <span class='rparen'>)</span>
<span class='comment'># Get all argument for multi-option.
</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
<span class='kw'>while</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_isOpt'>isOpt</span>
<span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_toValue'>toValue</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='comment'># Get one argument for single-option.
</span>
<span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
<span class='id identifier rubyid_raise'>raise</span> \
<span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Too many arguments for option (\"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>\")...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_toValue'>toValue</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='kw'>else</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No valid options specified...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='comment'># Subcmd or default. Check for Subcmd first.
</span>
<span class='comment'># Search for Subcmd.
</span> <span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='id identifier rubyid_findOpt'>findOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span>
<span class='comment'># Search for default option.
</span> <span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='id identifier rubyid_findOpt'>findOpt</span><span class='lparen'>(</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span>
<span class='kw'>if</span> <span class='ivar'>@subcmd</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
<span class='id identifier rubyid_raise'>raise</span> \
<span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unknown subcmd: \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> \
<span class='const'>InvalidOption</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>No default option specified to allow \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='kw'>self</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='comment'># Default option.
</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_toValue'>toValue</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='comment'># Subcmd.
</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
<span class='kw'>return</span> <span class='id identifier rubyid_o'>o</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="prim?-instance_method">
- (<tt>Boolean</tt>) <strong>prim?</strong>(prim)
</h3><div class="docstring">
<div class="discussion">
<p>Check for primitive.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1727
1728
1729</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1727</span>
<span class='kw'>def</span> <span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='id identifier rubyid_prim'>prim</span> <span class='rparen'>)</span>
<span class='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span> <span class='id identifier rubyid_prim'>prim</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setOptionSubcmd-instance_method">
- (<tt>Object</tt>) <strong>setOptionSubcmd</strong>(opts, subs)
</h3><div class="docstring">
<div class="discussion">
<p>Set command (subcommand) suboptions and subcmds.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>opts</span>
<span class='type'>(<tt>Array<<span class='object_link'><a href="" title="Como::Opt (class)">Opt</a></span>></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1230
1231
1232
1233
1234
1235
1236
1237
1238</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1230</span>
<span class='kw'>def</span> <span class='id identifier rubyid_setOptionSubcmd'>setOptionSubcmd</span><span class='lparen'>(</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='id identifier rubyid_subs'>subs</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_addOption'>addOption</span><span class='lparen'>(</span> <span class='id identifier rubyid_i'>i</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_subs'>subs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_addSubcmd'>addSubcmd</span><span class='lparen'>(</span> <span class='id identifier rubyid_i'>i</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setRuleCheck-instance_method">
- (<tt>Object</tt>) <strong>setRuleCheck</strong>(&rule)
</h3><div class="docstring">
<div class="discussion">
<p>Set rule checks for the option.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>rule</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'>
<p>Rule to check after command line parsing.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1270
1271
1272</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1270</span>
<span class='kw'>def</span> <span class='id identifier rubyid_setRuleCheck'>setRuleCheck</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_rule'>rule</span> <span class='rparen'>)</span>
<span class='ivar'>@rules</span> <span class='op'>=</span> <span class='id identifier rubyid_rule'>rule</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setUsageFooter-instance_method">
- (<tt>Object</tt>) <strong>setUsageFooter</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Set optional footer for “usage”.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1753
1754
1755</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1753</span>
<span class='kw'>def</span> <span class='id identifier rubyid_setUsageFooter'>setUsageFooter</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:footer</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="setUsageHeader-instance_method">
- (<tt>Object</tt>) <strong>setUsageHeader</strong>(str)
</h3><div class="docstring">
<div class="discussion">
<p>Set optional header for “usage”.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1747
1748
1749</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1747</span>
<span class='kw'>def</span> <span class='id identifier rubyid_setUsageHeader'>setUsageHeader</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
<span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:header</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="suball-instance_method">
- (<tt>Object</tt>) <strong>suball</strong>
</h3><div class="docstring">
<div class="discussion">
<p>All subcommand options, options and subcommands.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1577
1578
1579</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1577</span>
<span class='kw'>def</span> <span class='id identifier rubyid_suball'>suball</span>
<span class='ivar'>@subopt</span> <span class='op'>+</span> <span class='ivar'>@subcmd</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="suboptDoc-instance_method">
- (<tt>Object</tt>) <strong>suboptDoc</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Return document strings for options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1873</span>
<span class='kw'>def</span> <span class='id identifier rubyid_suboptDoc'>suboptDoc</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='comment'># format = Proc.new do |s,d| ( " %-#{@config[ :tab ]}s%s\n" % [ s, d ] ) end
</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> Options:\n</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_hasSubcmd'>hasSubcmd</span> <span class='op'>&&</span> <span class='id identifier rubyid_hasVisibleOptions'>hasVisibleOptions</span>
<span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_prim?'>prim?</span><span class='lparen'>(</span> <span class='symbol'>:hidden</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='id identifier rubyid_suboptDocFormat'>suboptDocFormat</span><span class='lparen'>(</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_opt'>opt</span><span class='comma'>,</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_suboptDocFormat'>suboptDocFormat</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Subcommands:</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_hasSubcmd'>hasSubcmd</span>
<span class='ivar'>@subcmd</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_o'>o</span><span class='op'>|</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='id identifier rubyid_suboptDocFormat'>suboptDocFormat</span><span class='lparen'>(</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_str'>str</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_hash-instance_method">
- (<tt>Object</tt>) <strong>to_hash</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Convert to hash representation.</p>
<p>Keys are symbols: name, type, given, value, subopt, subcmd.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1914</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_hash'>to_hash</span>
<span class='id identifier rubyid_h'>h</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:name</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@name</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:type</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@type</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:given</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@given</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:value</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@value</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:subopt</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:subcmd</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@subcmd</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_h'>h</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_hopt-instance_method">
- (<tt>Object</tt>) <strong>to_hopt</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Convert to hash representation with opt name keys.</p>
<p>Keys are symbols: name, type, given, value, subopt, subcmd.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1929</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_hopt'>to_hopt</span>
<span class='id identifier rubyid_h'>h</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:name</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@name</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:type</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@type</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:given</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@given</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:value</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@value</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:subopt</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@subopt</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:subopt</span> <span class='rbracket'>]</span><span class='lbracket'>[</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_to_hopt'>to_hopt</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:subcmd</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='ivar'>@subcmd</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
<span class='id identifier rubyid_h'>h</span><span class='lbracket'>[</span> <span class='symbol'>:subcmd</span> <span class='rbracket'>]</span><span class='lbracket'>[</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_to_hopt'>to_hopt</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_h'>h</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="usage-instance_method">
- (<tt>Object</tt>) <strong>usage</strong>(doExit = nil, ruleHelp = nil)
</h3><div class="docstring">
<div class="discussion">
<p>Display program usage (and optionally exit).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>doExit</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
<p>Exit program after help display. Default to help_exit config if nil.</p>
</div>
</li>
<li>
<span class='name'>ruleHelp</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'>
<p>Include rule help to help display. Default to rulehelp config if nil.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1766</span>
<span class='kw'>def</span> <span class='id identifier rubyid_usage'>usage</span><span class='lparen'>(</span> <span class='id identifier rubyid_doExit'>doExit</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_ruleHelp'>ruleHelp</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_doExit'>doExit</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:help_exit</span> <span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_doExit'>doExit</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_ruleHelp'>ruleHelp</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:rulehelp</span> <span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_ruleHelp'>ruleHelp</span> <span class='op'>==</span> <span class='kw'>nil</span>
<span class='cvar'>@@io</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_usageNormal'>usageNormal</span>
<span class='kw'>if</span> <span class='id identifier rubyid_ruleHelp'>ruleHelp</span>
<span class='cvar'>@@io</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n Option Combinations:</span><span class='tstring_end'>"</span></span>
<span class='cvar'>@@io</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='const'>RuleDisplay</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span><span class='lparen'>(</span> <span class='op'>&</span><span class='ivar'>@rules</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span> <span class='int'>1</span> <span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_doExit'>doExit</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="usageCommand-instance_method">
- (<tt>Object</tt>) <strong>usageCommand</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Usage printout for command.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1793</span>
<span class='kw'>def</span> <span class='id identifier rubyid_usageCommand'>usageCommand</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\
Subcommand \"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</span><span class='tstring_content'>\" usage:
</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_fullCommand'>fullCommand</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmdline'>cmdline</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>
</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='id identifier rubyid_suboptDoc'>suboptDoc</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="usageIfHelp-instance_method">
- (<tt>Object</tt>) <strong>usageIfHelp</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Display program usage (and optionally exit).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1783
1784
1785
1786
1787
1788
1789</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1783</span>
<span class='kw'>def</span> <span class='id identifier rubyid_usageIfHelp'>usageIfHelp</span>
<span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_argByName'>argByName</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>help</span><span class='tstring_end'>'</span></span> <span class='rparen'>)</span> <span class='op'>&&</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>help</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
<span class='id identifier rubyid_usage'>usage</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_hasSubcmd'>hasSubcmd</span> <span class='op'>&&</span> <span class='id identifier rubyid_givenSubcmd'>givenSubcmd</span>
<span class='id identifier rubyid_givenSubcmd'>givenSubcmd</span><span class='period'>.</span><span class='id identifier rubyid_usageIfHelp'>usageIfHelp</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="usageNormal-instance_method">
- (<tt>Object</tt>) <strong>usageNormal</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Usage info for Opt:s.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1805</span>
<span class='kw'>def</span> <span class='id identifier rubyid_usageNormal'>usageNormal</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='kw'>if</span> <span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:header</span> <span class='rbracket'>]</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:header</span> <span class='rbracket'>]</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='id identifier rubyid_usageCommand'>usageCommand</span>
<span class='kw'>if</span> <span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:footer</span> <span class='rbracket'>]</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='ivar'>@config</span><span class='lbracket'>[</span> <span class='symbol'>:footer</span> <span class='rbracket'>]</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_str'>str</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="warn-instance_method">
- (<tt>Object</tt>) <strong>warn</strong>(str, nl = false)
</h3><div class="docstring">
<div class="discussion">
<p>Como warning printout.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>str</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>Warning message.</p>
</div>
</li>
<li>
<span class='name'>nl</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'>
<p>Prepend msg with newline.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1974
1975
1976
1977</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1974</span>
<span class='kw'>def</span> <span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='id identifier rubyid_nl'>nl</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='rparen'>)</span>
<span class='id identifier rubyid_nl'>nl</span> <span class='op'>=</span> <span class='id identifier rubyid_nl'>nl</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
<span class='const'>STDERR</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_nl'>nl</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_progname'>progname</span><span class='embexpr_end'>}</span><span class='tstring_content'> warning: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str'>str</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="~-instance_method">
- (<tt>Object</tt>) <strong>~</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Short syntax for value reference. Example: “~<a href="'file'">Opt</a>”.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1609
1610
1611</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/como.rb', line 1609</span>
<span class='kw'>def</span> <span class='op'>~</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='ivar'>@value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jan 1 15:54:18 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.1).
</div>
</body>
</html>