Class: Como::MainOpt

Inherits:

Opt

• Object
• ComoCommon
• Opt
• Como::MainOpt

Defined in:

lib/como.rb

Overview

Specialized Opt class for program (i.e. highest level subcommand).

Constant Summary

Constants inherited from ComoCommon

ComoCommon::VERSION

Instance Attribute Summary

• #author ⇒ Object readonly

  Program author and year (date).

• #external ⇒ Object

  Program external arguments:.

• #year ⇒ Object readonly

  Program author and year (date).

Attributes inherited from Opt

#config, #doc, #given, #longOpt, #name, #parent, #rules, #shortOpt, #subcmd, #subopt, #type, #value

Instance Method Summary

• #fullCommand ⇒ Object

  Full command name.

• #initialize(author, year, name, opt, type, doc, value = nil) ⇒ MainOpt constructor

  A new instance of MainOpt.

• #usageCommand ⇒ Object

  Usage printout for command.

Methods inherited from Opt

[], #[], addOpt, #apply, #applyConfig, #argById, #argByName, author, #check, #checkAlso, #checkMissing, #checkRule, #cmdline, configGet, configOverlay, configSet, current, default, #default, defaultOpt, #each, each, #each_given, each_given, #error, external, findOpt, #findOpt, full, #givenCount, #givenSubcmd, #hasArg, #hasMany, #isExclusive, #isRequired, #isSwitch, main, #opt, #params, #parse, progname, reset, setMain, #setRuleCheck, setSubcmd, #setSubopt, #setUsageFooter, #setUsageHeader, #silent?, #suball, subcmd, #suboptDoc, #usage, #usageIfHelp, #usageNormal, year, #~

Methods inherited from ComoCommon

getIo, runHook, setHook, setIo

Constructor Details

#initialize(author, year, name, opt, type, doc, value = nil) ⇒ MainOpt

Returns a new instance of MainOpt.

# File 'lib/como.rb', line 1856

def initialize( author, year,
                name, opt, type, doc, value = nil )
    @author = author
    @year = year
    @external = nil
    super( name, opt, type, doc, value = nil )

end

Instance Attribute Details

#author ⇒ Object (readonly)

Program author and year (date).

# File 'lib/como.rb', line 1853

def author
  @author
end

#external ⇒ Object

Program external arguments:

# File 'lib/como.rb', line 1850

def external
  @external
end

#year ⇒ Object (readonly)

Program author and year (date).

# File 'lib/como.rb', line 1853

def year
  @year
end

Instance Method Details

#fullCommand ⇒ Object

Full command name.

# File 'lib/como.rb', line 1867

def fullCommand
    Opt.progname
end

#usageCommand ⇒ Object

Usage printout for command.

# File 'lib/como.rb', line 1873

def usageCommand
    str = "\
  #{fullCommand} #{cmdline.join(" ")}
"
    str += suboptDoc

    if @config[ :copyright ]
        str += "

  Copyright (c) #{Opt.year} by #{Opt.author}
"
    end

    str
end