808 lines
25 KiB
HTML
808 lines
25 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="generator" content="Crystal Docs 1.20.3">
|
|
<meta name="crystal_docs.project_version" content="object_rework-dev">
|
|
<meta name="crystal_docs.project_name" content="CliGenerator">
|
|
|
|
|
|
|
|
<link href="../css/style.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="../js/doc.js"></script>
|
|
|
|
<meta name="repository-name" content="CliGenerator">
|
|
<title>CliGen::App - CliGenerator object_rework-dev</title>
|
|
<script type="text/javascript">
|
|
CrystalDocs.base_path = "../";
|
|
</script>
|
|
</head>
|
|
<body>
|
|
|
|
<svg class="hidden">
|
|
<symbol id="octicon-link" viewBox="0 0 16 16">
|
|
<path fill="currentColor" fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
|
|
</symbol>
|
|
</svg>
|
|
<input type="checkbox" id="sidebar-btn">
|
|
<label for="sidebar-btn" id="sidebar-btn-label">
|
|
<svg class="open" xmlns="http://www.w3.org/2000/svg" height="2em" width="2em" viewBox="0 0 512 512"><title>Open Sidebar</title><path fill="currentColor" d="M80 96v64h352V96H80zm0 112v64h352v-64H80zm0 112v64h352v-64H80z"></path></svg>
|
|
<svg class="close" xmlns="http://www.w3.org/2000/svg" width="2em" height="2em" viewBox="0 0 512 512"><title>Close Sidebar</title><path fill="currentColor" d="m118.6 73.4-45.2 45.2L210.7 256 73.4 393.4l45.2 45.2L256 301.3l137.4 137.3 45.2-45.2L301.3 256l137.3-137.4-45.2-45.2L256 210.7Z"></path></svg>
|
|
</label>
|
|
<div class="sidebar">
|
|
<div class="sidebar-header">
|
|
<div class="search-box">
|
|
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
|
|
</div>
|
|
|
|
<div class="project-summary">
|
|
<h1 class="project-name">
|
|
<a href="../index.html">
|
|
CliGenerator
|
|
</a>
|
|
</h1>
|
|
|
|
<span class="project-version">
|
|
object_rework-dev
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="search-results hidden">
|
|
<ul class="search-list"></ul>
|
|
</div>
|
|
|
|
<div class="types-list">
|
|
<ul>
|
|
|
|
<li class="parent open current" data-id="CliGenerator/CliGen" data-name="cligen">
|
|
<a href="../CliGen.html">CliGen</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" current" data-id="CliGenerator/CliGen/App" data-name="cligen::app">
|
|
<a href="../CliGen/App.html">App</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Arg" data-name="cligen::arg">
|
|
<a href="../CliGen/Arg.html">Arg</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/ArgReprocessedError" data-name="cligen::argreprocessederror">
|
|
<a href="../CliGen/ArgReprocessedError.html">ArgReprocessedError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Argument" data-name="cligen::argument">
|
|
<a href="../CliGen/Argument.html">Argument</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/BaseCommandNode" data-name="cligen::basecommandnode">
|
|
<a href="../CliGen/BaseCommandNode.html">BaseCommandNode</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/BaseFlag" data-name="cligen::baseflag">
|
|
<a href="../CliGen/BaseFlag.html">BaseFlag</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Coercable" data-name="cligen::coercable">
|
|
<a href="../CliGen/Coercable.html">Coercable</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Command" data-name="cligen::command">
|
|
<a href="../CliGen/Command.html">Command</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/CommandInfo" data-name="cligen::commandinfo">
|
|
<a href="../CliGen/CommandInfo.html">CommandInfo</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/CommandMeta" data-name="cligen::commandmeta">
|
|
<a href="../CliGen/CommandMeta.html">CommandMeta</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/CommandNode" data-name="cligen::commandnode(t)">
|
|
<a href="../CliGen/CommandNode.html">CommandNode</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Common" data-name="cligen::common">
|
|
<a href="../CliGen/Common.html">Common</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/ConfigurationError" data-name="cligen::configurationerror">
|
|
<a href="../CliGen/ConfigurationError.html">ConfigurationError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/DuplicateCommandError" data-name="cligen::duplicatecommanderror">
|
|
<a href="../CliGen/DuplicateCommandError.html">DuplicateCommandError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/DuplicateFlagError" data-name="cligen::duplicateflagerror">
|
|
<a href="../CliGen/DuplicateFlagError.html">DuplicateFlagError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Error" data-name="cligen::error">
|
|
<a href="../CliGen/Error.html">Error</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Flag" data-name="cligen::flag(t)">
|
|
<a href="../CliGen/Flag.html">Flag</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/FlagArgumentError" data-name="cligen::flagargumenterror">
|
|
<a href="../CliGen/FlagArgumentError.html">FlagArgumentError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/FlagBundleError" data-name="cligen::flagbundleerror">
|
|
<a href="../CliGen/FlagBundleError.html">FlagBundleError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/FlagMeta" data-name="cligen::flagmeta">
|
|
<a href="../CliGen/FlagMeta.html">FlagMeta</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/FlagMissingArgumentError" data-name="cligen::flagmissingargumenterror">
|
|
<a href="../CliGen/FlagMissingArgumentError.html">FlagMissingArgumentError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/FlagNotFoundError" data-name="cligen::flagnotfounderror">
|
|
<a href="../CliGen/FlagNotFoundError.html">FlagNotFoundError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Format" data-name="cligen::format">
|
|
<a href="../CliGen/Format.html">Format</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/HelpRequestedError" data-name="cligen::helprequestederror">
|
|
<a href="../CliGen/HelpRequestedError.html">HelpRequestedError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/InternalError" data-name="cligen::internalerror">
|
|
<a href="../CliGen/InternalError.html">InternalError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/InternalVar" data-name="cligen::internalvar">
|
|
<a href="../CliGen/InternalVar.html">InternalVar</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/InvalidFlagValueError" data-name="cligen::invalidflagvalueerror">
|
|
<a href="../CliGen/InvalidFlagValueError.html">InvalidFlagValueError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/InvalidOptionError" data-name="cligen::invalidoptionerror">
|
|
<a href="../CliGen/InvalidOptionError.html">InvalidOptionError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/MatchType" data-name="cligen::matchtype">
|
|
<a href="../CliGen/MatchType.html">MatchType</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/MissingDispatchError" data-name="cligen::missingdispatcherror">
|
|
<a href="../CliGen/MissingDispatchError.html">MissingDispatchError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/MissingRequiredFlagError" data-name="cligen::missingrequiredflagerror">
|
|
<a href="../CliGen/MissingRequiredFlagError.html">MissingRequiredFlagError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Parsable" data-name="cligen::parsable">
|
|
<a href="../CliGen/Parsable.html">Parsable</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/ParseableInvariantError" data-name="cligen::parseableinvarianterror">
|
|
<a href="../CliGen/ParseableInvariantError.html">ParseableInvariantError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/PreRunCommand" data-name="cligen::preruncommand">
|
|
<a href="../CliGen/PreRunCommand.html">PreRunCommand</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/ProxyCommand" data-name="cligen::proxycommand">
|
|
<a href="../CliGen/ProxyCommand.html">ProxyCommand</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Regex" data-name="cligen::regex">
|
|
<a href="../CliGen/Regex.html">Regex</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/RegexInvariantError" data-name="cligen::regexinvarianterror">
|
|
<a href="../CliGen/RegexInvariantError.html">RegexInvariantError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/ReservedFlagError" data-name="cligen::reservedflagerror">
|
|
<a href="../CliGen/ReservedFlagError.html">ReservedFlagError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/RunCommand" data-name="cligen::runcommand">
|
|
<a href="../CliGen/RunCommand.html">RunCommand</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/RuntimeError" data-name="cligen::runtimeerror">
|
|
<a href="../CliGen/RuntimeError.html">RuntimeError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/SubCommand" data-name="cligen::subcommand">
|
|
<a href="../CliGen/SubCommand.html">SubCommand</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/SubCommandInfo" data-name="cligen::subcommandinfo">
|
|
<a href="../CliGen/SubCommandInfo.html">SubCommandInfo</a>
|
|
|
|
</li>
|
|
|
|
<li class="parent " data-id="CliGenerator/CliGen/Timeparse" data-name="cligen::timeparse">
|
|
<a href="../CliGen/Timeparse.html">Timeparse</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Timeparse/OperationUnit" data-name="cligen::timeparse::operationunit">
|
|
<a href="../CliGen/Timeparse/OperationUnit.html">OperationUnit</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Timeparse/RelativeOperation" data-name="cligen::timeparse::relativeoperation">
|
|
<a href="../CliGen/Timeparse/RelativeOperation.html">RelativeOperation</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/TimeParseError" data-name="cligen::timeparseerror">
|
|
<a href="../CliGen/TimeParseError.html">TimeParseError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/Trigger" data-name="cligen::trigger">
|
|
<a href="../CliGen/Trigger.html">Trigger</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/UnknownCommandNodeError" data-name="cligen::unknowncommandnodeerror">
|
|
<a href="../CliGen/UnknownCommandNodeError.html">UnknownCommandNodeError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/UnknownFlagError" data-name="cligen::unknownflagerror">
|
|
<a href="../CliGen/UnknownFlagError.html">UnknownFlagError</a>
|
|
|
|
</li>
|
|
|
|
<li class=" " data-id="CliGenerator/CliGen/ValidationError" data-name="cligen::validationerror">
|
|
<a href="../CliGen/ValidationError.html">ValidationError</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="main-content">
|
|
<h1 class="type-name">
|
|
|
|
<span class="kind">
|
|
class
|
|
</span> CliGen::<wbr>App
|
|
|
|
</h1>
|
|
|
|
|
|
<ul class="superclass-hierarchy"><li class="superclass"><a href="../CliGen/App.html">CliGen::App</a></li><li class="superclass"><a href="../CliGen/CommandNode.html">CliGen::CommandNode(Nil)</a></li><li class="superclass"><a href="../CliGen/BaseCommandNode.html">CliGen::BaseCommandNode</a></li><li class="superclass">Reference</li><li class="superclass">Object</li></ul>
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="overview" class="anchor" href="#overview">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Overview
|
|
</h2>
|
|
|
|
<p>Root entry point. Holds a flattened copy of all flags from every command
|
|
for global-flag matching, then hands off to the matched child CommandNode.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="defined-in" class="anchor" href="#defined-in">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Defined in:
|
|
</h2>
|
|
|
|
|
|
cligen/app.cr
|
|
|
|
<br/>
|
|
|
|
|
|
cligen/app/generate.cr
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="constructors" class="anchor" href="#constructors">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Constructors
|
|
</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#new%28name%2Cflags%3AArray%28BaseFlag%29%2Ccommands%3AArray%28BaseCommandNode%29%2Cpre_run_commands%3AArray%28RunCommand%29%2Cpost_run_commands%3AArray%28RunCommand%29%29-class-method" class="signature"><strong>.new</strong>(name, flags : Array(BaseFlag), commands : Array(BaseCommandNode), pre_run_commands : Array(RunCommand), post_run_commands : Array(RunCommand))</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="class-method-summary" class="anchor" href="#class-method-summary">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Class Method Summary
|
|
</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#get-class-method" class="signature"><strong>.get</strong></a>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#handle_command_raises%28%26%29%3ANil-class-method" class="signature"><strong>.handle_command_raises</strong>(&) : Nil</a>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#process%28args%3AArray%28String%29%3DARGV.to_a%29%3ANil-class-method" class="signature"><strong>.process</strong>(args : Array(String) = <span class="t">ARGV</span>.to_a) : Nil</a>
|
|
|
|
<div class="summary"><p>Convenience entry point; defaults to ARGV</p></div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="instance-method-summary" class="anchor" href="#instance-method-summary">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Instance Method Summary
|
|
</h2>
|
|
<ul class="list-summary">
|
|
|
|
<li class="entry-summary">
|
|
<a href="#check%21-instance-method" class="signature"><strong>#check!</strong></a>
|
|
|
|
</li>
|
|
|
|
<li class="entry-summary">
|
|
<a href="#check_for_env_duplicates%28flags%3AArray%28BaseFlag%29%29-instance-method" class="signature"><strong>#check_for_env_duplicates</strong>(flags : Array(BaseFlag))</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
<div class="methods-inherited">
|
|
|
|
|
|
|
|
<h3>Instance methods inherited from class <code><a href="../CliGen/CommandNode.html">CliGen::CommandNode(Nil)</a></code></h3>
|
|
|
|
|
|
<a href="../CliGen/CommandNode.html#check%21%3ANil-instance-method" class="tooltip">
|
|
<span>check! : Nil</span>
|
|
check!</a>,
|
|
|
|
|
|
<a href="../CliGen/CommandNode.html#help%3AString-instance-method" class="tooltip">
|
|
<span>help : String</span>
|
|
help</a>,
|
|
|
|
|
|
<a href="../CliGen/CommandNode.html#process%28args%3AArray%28CliGen%3A%3AArg%29%29%3ANil-instance-method" class="tooltip">
|
|
<span>process(args : Array(CliGen::Arg)) : Nil</span>
|
|
process</a>,
|
|
|
|
|
|
<a href="../CliGen/CommandNode.html#subcommands%3AArray%28SubCommandInfo%29-instance-method" class="tooltip">
|
|
<span>subcommands : Array(SubCommandInfo)</span>
|
|
subcommands</a>,
|
|
|
|
|
|
<a href="../CliGen/CommandNode.html#verbose%3F%3ABool-instance-method" class="tooltip">
|
|
<span>verbose? : Bool</span>
|
|
verbose?</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Constructor methods inherited from class <code><a href="../CliGen/CommandNode.html">CliGen::CommandNode(Nil)</a></code></h3>
|
|
|
|
|
|
<a href="../CliGen/CommandNode.html#new%28name%3AString%2Cflags%3AArray%28BaseFlag%29%2Ccommands%3AArray%28BaseCommandNode%29%2Cpre_run_commands%3AArray%28RunCommand%29%2Cpost_run_commands%3AArray%28RunCommand%29%2Cparent%3ABaseCommandNode%7CNil%3Dnil%2Cdescription%3AString%7CNil%3Dnil%29-class-method" class="tooltip">
|
|
<span>new(name : String, flags : Array(BaseFlag), commands : Array(BaseCommandNode), pre_run_commands : Array(RunCommand), post_run_commands : Array(RunCommand), parent : BaseCommandNode | Nil = <span class="n">nil</span>, description : String | Nil = <span class="n">nil</span>)</span>
|
|
new</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Instance methods inherited from class <code><a href="../CliGen/BaseCommandNode.html">CliGen::BaseCommandNode</a></code></h3>
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#all_commands%3AArray%28BaseCommandNode%29-instance-method" class="tooltip">
|
|
<span>all_commands : Array(BaseCommandNode)</span>
|
|
all_commands</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#all_flags%3AArray%28BaseFlag%29-instance-method" class="tooltip">
|
|
<span>all_flags : Array(BaseFlag)</span>
|
|
all_flags</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#check%21%3ANil-instance-method" class="tooltip">
|
|
<span>check! : Nil</span>
|
|
check!</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#check_for_duplicate_flags%21%28flags%3AArray%28BaseFlag%29%29%3ANil-instance-method" class="tooltip">
|
|
<span>check_for_duplicate_flags!(flags : Array(BaseFlag)) : Nil</span>
|
|
check_for_duplicate_flags!</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#check_for_duplicate_subcommands%21-instance-method" class="tooltip">
|
|
<span>check_for_duplicate_subcommands!</span>
|
|
check_for_duplicate_subcommands!</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#commands%3AArray%28BaseCommandNode%29-instance-method" class="tooltip">
|
|
<span>commands : Array(BaseCommandNode)</span>
|
|
commands</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#description%3AString%7CNil-instance-method" class="tooltip">
|
|
<span>description : String | Nil</span>
|
|
description</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#find_match%28arg%3AString%29-instance-method" class="tooltip">
|
|
<span>find_match(arg : String)</span>
|
|
find_match</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#flag%3F%28arg%3AString%29%3ABaseFlag%7CNil-instance-method" class="tooltip">
|
|
<span>flag?(arg : String) : BaseFlag | Nil</span>
|
|
flag?</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#flags%3AArray%28BaseFlag%29-instance-method" class="tooltip">
|
|
<span>flags : Array(BaseFlag)</span>
|
|
flags</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#get%28%2A%2Clong%3AString%29%3ABaseFlag%7CNil-instance-method" class="tooltip">
|
|
<span>get(*, long : String) : BaseFlag | Nil<br/>get(*, short : String) : BaseFlag | Nil</span>
|
|
get</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#handle_flag_raises%28%26%29%3ANil-instance-method" class="tooltip">
|
|
<span>handle_flag_raises(&) : Nil</span>
|
|
handle_flag_raises</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#meta%3ACommandMeta-instance-method" class="tooltip">
|
|
<span>meta : CommandMeta</span>
|
|
meta</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#name%3AString-instance-method" class="tooltip">
|
|
<span>name : String</span>
|
|
name</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#parent%3F%3ABaseCommandNode%7CNil-instance-method" class="tooltip">
|
|
<span>parent? : BaseCommandNode | Nil</span>
|
|
parent?</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#process%28args%3AArray%28String%29%29%3ANil-instance-method" class="tooltip">
|
|
<span>process(args : Array(String)) : Nil<br/>process(args : Array(CliGen::Arg)) : Nil</span>
|
|
process</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#subcommand%3F%28arg%3AString%29%3ABool-instance-method" class="tooltip">
|
|
<span>subcommand?(arg : String) : Bool</span>
|
|
subcommand?</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#subcommands%3AArray%28SubCommandInfo%29-instance-method" class="tooltip">
|
|
<span>subcommands : Array(SubCommandInfo)</span>
|
|
subcommands</a>,
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#subcommands%3F%3ABool-instance-method" class="tooltip">
|
|
<span>subcommands? : Bool</span>
|
|
subcommands?</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Constructor methods inherited from class <code><a href="../CliGen/BaseCommandNode.html">CliGen::BaseCommandNode</a></code></h3>
|
|
|
|
|
|
<a href="../CliGen/BaseCommandNode.html#new%28name%3AString%2Cflags%3AArray%28BaseFlag%29%2Ccommands%3AArray%28BaseCommandNode%29%2Cpre_run_commands%3AArray%28RunCommand%29%2Cpost_run_commands%3AArray%28RunCommand%29%2Cmeta%3ACommandMeta%2Cparent%3ABaseCommandNode%7CNil%3Dnil%2Cdescription%3AString%7CNil%3Dnil%29-class-method" class="tooltip">
|
|
<span>new(name : String, flags : Array(BaseFlag), commands : Array(BaseCommandNode), pre_run_commands : Array(RunCommand), post_run_commands : Array(RunCommand), meta : CommandMeta, parent : BaseCommandNode | Nil = <span class="n">nil</span>, description : String | Nil = <span class="n">nil</span>)</span>
|
|
new</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2>
|
|
<a id="constructor-detail" class="anchor" href="#constructor-detail">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Constructor Detail
|
|
</h2>
|
|
|
|
<div class="entry-detail" id="new(name,flags:Array(BaseFlag),commands:Array(BaseCommandNode),pre_run_commands:Array(RunCommand),post_run_commands:Array(RunCommand))-class-method">
|
|
<div class="signature">
|
|
|
|
def self.<strong>new</strong>(name, flags : Array(<a href="../CliGen/BaseFlag.html">BaseFlag</a>), commands : Array(<a href="../CliGen/BaseCommandNode.html">BaseCommandNode</a>), pre_run_commands : Array(<a href="../CliGen/RunCommand.html">RunCommand</a>), post_run_commands : Array(<a href="../CliGen/RunCommand.html">RunCommand</a>))
|
|
|
|
<a class="method-permalink" href="#new%28name%2Cflags%3AArray%28BaseFlag%29%2Ccommands%3AArray%28BaseCommandNode%29%2Cpre_run_commands%3AArray%28RunCommand%29%2Cpost_run_commands%3AArray%28RunCommand%29%29-class-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="class-method-detail" class="anchor" href="#class-method-detail">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Class Method Detail
|
|
</h2>
|
|
|
|
<div class="entry-detail" id="get-class-method">
|
|
<div class="signature">
|
|
|
|
def self.<strong>get</strong>
|
|
|
|
<a class="method-permalink" href="#get-class-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="handle_command_raises(&):Nil-class-method">
|
|
<div class="signature">
|
|
|
|
def self.<strong>handle_command_raises</strong>(&) : Nil
|
|
|
|
<a class="method-permalink" href="#handle_command_raises%28%26%29%3ANil-class-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="process(args:Array(String)=ARGV.to_a):Nil-class-method">
|
|
<div class="signature">
|
|
|
|
def self.<strong>process</strong>(args : Array(String) = <span class="t">ARGV</span>.to_a) : Nil
|
|
|
|
<a class="method-permalink" href="#process%28args%3AArray%28String%29%3DARGV.to_a%29%3ANil-class-method">#</a>
|
|
</div>
|
|
|
|
<div class="doc">
|
|
|
|
<p>Convenience entry point; defaults to ARGV</p>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
<a id="instance-method-detail" class="anchor" href="#instance-method-detail">
|
|
<svg class="octicon-link" aria-hidden="true">
|
|
<use href="#octicon-link"/>
|
|
</svg>
|
|
</a>
|
|
Instance Method Detail
|
|
</h2>
|
|
|
|
<div class="entry-detail" id="check!-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>check!</strong>
|
|
|
|
<a class="method-permalink" href="#check%21-instance-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="entry-detail" id="check_for_env_duplicates(flags:Array(BaseFlag))-instance-method">
|
|
<div class="signature">
|
|
|
|
def <strong>check_for_env_duplicates</strong>(flags : Array(<a href="../CliGen/BaseFlag.html">BaseFlag</a>))
|
|
|
|
<a class="method-permalink" href="#check_for_env_duplicates%28flags%3AArray%28BaseFlag%29%29-instance-method">#</a>
|
|
</div>
|
|
|
|
<br/>
|
|
<div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|