Class: Como::Opt

Inherits:
ComoCommon show all
Defined in:
lib/como.rb

Overview

Opt includes all options spec information and parsed options and their values. Option instance is accessed with “Opt”. The option status (Opt instance) can be queried with for example “given” and “value” methods.

Direct Known Subclasses

MainOpt

Defined Under Namespace

Classes: ErrorWithData, InvalidOption, MissingArgument

Constant Summary collapse

@@main =

Program i.e. highest level subcommand.

nil
@@opts =

List of parsed option specs and option values.

[]
@@subcmd =

Current subcommand recorded.

nil
@@config =

Set of default configs for printout.

{
    :autohelp      => true,
    :rulehelp      => false,
    :header        => nil,
    :footer        => nil,
    :subcheck      => true,
    :check_missing => true,
    :check_invalid => true,
    :tab           => 12,
    :help_exit     => true,
    :copyright     => true,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ComoCommon

getIo, runHook, setHook, setIo

Constructor Details

#initialize(name, opt, type, doc, value = nil) ⇒ Opt

Create Opt object.

Parameters:

  • name (String) —

    Option name.

  • opt (String) —

    Switch.

  • type (Array<Symbol>, Symbol) —

    Option type in primitives (or :subcmd).

  • doc (String) —

    Option documentation.

  • value (Object) (defaults to: nil) —

    Default value.



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
 
# File 'lib/como.rb', line 1199

def initialize( name, opt, type, doc, value = nil )
    @parent = nil
    @name = name
    @shortOpt = opt
    @longOpt = "--#{name}"
    @type = type

    @value = value

    if @type != :subcmd
        if prim?( :many ) && value == nil
            @value = []
        end
    end

    @doc = doc
    # Whether option was set or not.
    @given = false
    @subopt = []
    @subcmd = []
    @rules = nil

    @config = @@config.dup

    Opt.addOpt( self )
end

Instance Attribute Details

#config ⇒ Object (readonly)

Opt configuration.



1186
1187
1188
 
# File 'lib/como.rb', line 1186

def config
  @config
end

#doc ⇒ Object

Option documentation string.



1174
1175
1176
 
# File 'lib/como.rb', line 1174

def doc
  @doc
end

#given(optArg = false, &prog) ⇒ Object Also known as: given?

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.

Parameters:

  • optArg (Boolean) (defaults to: false) —

    Pass Opt to block instead of its value.



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
 
# File 'lib/como.rb', line 1635

def given( optArg = false, &prog )
    if block_given?
        if @given
            if optArg
                yield( self )
            else
                yield( @value )
            end
        else
            false
        end
    else
        @given
    end
end

#longOpt ⇒ Object

Long option string.



1165
1166
1167
 
# File 'lib/como.rb', line 1165

def longOpt
  @longOpt
end

#name ⇒ Object

Option name.



1159
1160
1161
 
# File 'lib/como.rb', line 1159

def name
  @name
end

#parent ⇒ Object

Subcommand parent (i.e. host).



1155
1156
1157
 
# File 'lib/como.rb', line 1155

def parent
  @parent
end

#rules ⇒ Object (readonly)

Opt rules.



1189
1190
1191
 
# File 'lib/como.rb', line 1189

def rules
  @rules
end

#shortOpt ⇒ Object

Short option string.



1162
1163
1164
 
# File 'lib/como.rb', line 1162

def shortOpt
  @shortOpt
end

#subcmd ⇒ Object (readonly)

List of subcommands.



1183
1184
1185
 
# File 'lib/como.rb', line 1183

def subcmd
  @subcmd
end

#subopt ⇒ Object (readonly)

List of suboptions.



1180
1181
1182
 
# File 'lib/como.rb', line 1180

def subopt
  @subopt
end

#type ⇒ Object

Option type as array of primitives (or :subcmd).



1168
1169
1170
 
# File 'lib/como.rb', line 1168

def type
  @type
end

#value ⇒ Object

Option value.



1171
1172
1173
 
# File 'lib/como.rb', line 1171

def value
  @value
end

Class Method Details

.[](str) ⇒ Object

Select option object by name. Main is searched first and then the flattened list of all options.



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/como.rb', line 1038

def Opt.[](str)

    # Search Main first.
    ret = Opt.main.argByName( str )

    unless ret
        ret = Opt.findOpt( str )
        unless ret
            raise RuntimeError, "Option \"#{str}\" does not exist..."
        end
    end

    ret
end

.addOpt(opt) ⇒ Object

Add option to options list.



1002
1003
1004
 
# File 'lib/como.rb', line 1002

def Opt.addOpt( opt )
    @@opts.push opt
end

.author ⇒ Object

Return author.



1067
1068
1069
 
# File 'lib/como.rb', line 1067

def Opt.author
    @@main.author
end

.configGet ⇒ Object

Return default config for Como options.



1120
1121
1122
 
# File 'lib/como.rb', line 1120

def Opt.configGet
    @@config
end

.configOverlay(config) ⇒ Object

Overlay Opt default configuration options.



1114
1115
1116
 
# File 'lib/como.rb', line 1114

def Opt.configOverlay( config )
    @@config.merge!( config )
end

.configSet(config) ⇒ Object

Set default config for Como options. User can manipulate the defaults with “preHook”.



1127
1128
1129
 
# File 'lib/como.rb', line 1127

def Opt.configSet( config )
    @@config = config
end

.current ⇒ Object

Current subcmd processed.



1014
1015
1016
 
# File 'lib/como.rb', line 1014

def Opt.current
    @@subcmd
end

.default ⇒ Object

Return arguments (options) that have no switch.



1080
1081
1082
 
# File 'lib/como.rb', line 1080

def Opt.default
    Opt.main.default
end

.defaultOpt(doc = "No doc.") ⇒ Object

Create default option spec, no switch.



1096
1097
1098
 
# File 'lib/como.rb', line 1096

def Opt.defaultOpt( doc = "No doc." )
    new( "<default>", "<default>", [ :default, :none, :one, :many, :opt ], doc, [] )
end

.each(&blk) ⇒ Object

Options iterator for all options.



1102
1103
1104
 
# File 'lib/como.rb', line 1102

def Opt.each( &blk )
    Opt.main.each &blk
end

.each_given(&blk) ⇒ Object

Options iterator for given options.



1108
1109
1110
 
# File 'lib/como.rb', line 1108

def Opt.each_given( &blk )
    Opt.main.each_given( &blk )
end

.error(str, nl = false) ⇒ Object

Issue non-fatal user error. See #error.



1133
1134
1135
 
# File 'lib/como.rb', line 1133

def Opt.error( str, nl = false )
    Opt.main.error( str, nl )
end

.external ⇒ Object

Return arguments (options) that are specified as command external (i.e. after ‘–’).



1074
1075
1076
 
# File 'lib/como.rb', line 1074

def Opt.external
    Opt.main.external
end

.fatal(str) ⇒ Object

Issue fatal user error. See #fatal.



1139
1140
1141
 
# File 'lib/como.rb', line 1139

def Opt.fatal( str )
    Opt.main.fatal( str )
end

.findOpt(name) ⇒ Object

Find option by name.



1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/como.rb', line 1020

def Opt.findOpt( name )
    idx = @@opts.index do |i| i.name == name end
    if idx
        @@opts[ idx ]
    else
        nil
    end
end

.full(name, opt, type, doc = "No doc.") ⇒ Object

Create option spec.



1086
1087
1088
 
# File 'lib/como.rb', line 1086

def Opt.full( name, opt, type, doc = "No doc." )
    new( name, opt, type, doc )
end

.main ⇒ Object

Get main option.



996
997
998
 
# File 'lib/como.rb', line 996

def Opt.main
    @@main
end

.progname ⇒ Object

Return program name.



1055
1056
1057
 
# File 'lib/como.rb', line 1055

def Opt.progname
    @@main.name
end

.reset ⇒ Object

Reset “dynamic” class members.



1031
1032
1033
 
# File 'lib/como.rb', line 1031

def Opt.reset
    @@opts = []
end

.setMain(main) ⇒ Object

Set main option.



990
991
992
993
 
# File 'lib/como.rb', line 990

def Opt.setMain( main )
    @@main = main
    Opt.setSubcmd( main )
end

.setSubcmd(opt) ⇒ Object

Set current subcmd.



1008
1009
1010
 
# File 'lib/como.rb', line 1008

def Opt.setSubcmd( opt )
    @@subcmd = opt
end

.subcmd(name, doc = "No doc.") ⇒ Object

Create sub-command option spec.



1091
1092
1093
 
# File 'lib/como.rb', line 1091

def Opt.subcmd( name, doc = "No doc." )
    new( name, nil, :subcmd, doc, false )
end

.warn(str, nl = false) ⇒ Object

Issue user warning. See #warn.



1145
1146
1147
 
# File 'lib/como.rb', line 1145

def Opt.warn( str, nl = false )
    Opt.main.warn( str, nl )
end

.year ⇒ Object

Return program year.



1061
1062
1063
 
# File 'lib/como.rb', line 1061

def Opt.year
    @@main.year
end

Instance Method Details

#[](str) ⇒ Object

Select option object by name operator.



1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/como.rb', line 1561

def []( str )
    ret = argByName( str )
    unless ret
        raise RuntimeError, "Subopt \"#{str}\" does not exist for \"#{@name}\"!"
    end
    ret
end

#addOption(opt) ⇒ Object

Add subcommand option.

Parameters:

  • opt (Option) —

    Option to add.



1244
1245
1246
1247
 
# File 'lib/como.rb', line 1244

def addOption( opt )
    opt.parent = self
    @subopt.push opt
end

#addSubcmd(cmd) ⇒ Object

Add subcommand subcmd.

Parameters:

  • cmd (Option) —

    Subcmd to add.



1253
1254
1255
1256
 
# File 'lib/como.rb', line 1253

def addSubcmd( cmd )
    cmd.parent = self
    @subcmd.push cmd
end

#apply(default = nil) ⇒ Object

Return option value if given otherwise the default. Example usage: fileName = Opt.apply( “no_name.txt” )



1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
 
# File 'lib/como.rb', line 1616

def apply( default = nil )
    if given
        if prim?( :none )
            true
        else
            value
        end
    else
        default
    end
end

#applyConfig(config) ⇒ Object

Merge config to base config.

Parameters:

  • config (Hash) —

    Configuration Hash to merge.



1262
1263
1264
 
# File 'lib/como.rb', line 1262

def applyConfig( config )
    @config.merge!( config )
end

#argById(str) ⇒ Object

Select option object by name/opt/longOpt.



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'lib/como.rb', line 1707

def argById( str )
    if str == nil || str == :default
        @subopt.each do |o|
            if o.prim?( :default )
                return o
            end
        end
        nil
    else
        suball.each do |o|
            if str == o.name || str == o.opt || str == o.longOpt
                return o
            end
        end
        nil
    end
end

#argByName(str) ⇒ Object

Select option object by name.



1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
 
# File 'lib/como.rb', line 1687

def argByName( str )
    if str == nil || str == :default
        @subopt.each do |o|
            if o.prim?( :default )
                return o
            end
        end
        nil
    else
        suball.each do |o|
            if str == o.name
                return o
            end
        end
        nil
    end
end

#check(argsState) ⇒ Object

Check provided args.



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
 
# File 'lib/como.rb', line 1279

def check( argsState )

    # Start at top.
    top = self

    parse = Proc.new do
        # Parse and check for invalid arguments.
        begin
            top = top.parse( argsState, top.config[ :check_invalid ] )
        end while( top )

        # Check for any missing valid arguments.
        checkMissing
    end

    error = Proc.new do |err|
        errornl( err.to_s )

        # Display subcmd specific usage info.
        err.data.usage

        exit( 1 )
    end

    begin
        parse.call
    rescue Opt::MissingArgument, Opt::InvalidOption => err
        error.call( err )
    end

    # Revert back to top after hierarchy travelsal.
    usageIfHelp

    # Check rules.
    cur = self
    while cur
        cur.checkRule
        cur = cur.givenSubcmd
    end

    self
end

#checkAlso(opt, error, &check) ⇒ Object

Additional option check.

Parameters:

  • opt (String) —

    Option name.

  • error (String) —

    Error string for false return values (from check).

  • check (Proc) —

    Checker proc run for the option. Either

Returns:

  • false or generate an exception when errors found.



1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/como.rb', line 1541

def checkAlso( opt, error, &check )
    begin
        if self[opt].evalCheck( &check ) != true
            raise Opt::InvalidOption.new( error, self )
        end
    rescue Opt::MissingArgument, Opt::InvalidOption => err
        @@io.puts
        errornl( err.to_s )
        err.data.usage
        exit( 1 )
    end
end

#checkMissing ⇒ Object

Check for any non-given required arguments recursively through hierarchy of subcommands. MissingArgument Exception is generated if argument is missing.

Raises:



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
 
# File 'lib/como.rb', line 1461

def checkMissing

    return unless config[ :check_missing ]

    # Full cmd name.
    cmd = ( getParents.map do |i| i.name end ).join( ' ' )

    # Check for any exclusive args first.
    @subopt.each do |o|
        if o.prim?( :mutex ) && o.given
            return
        end
    end


    # Check for required arguments for this level before
    # subcmds.
    @subopt.each do |o|
        if !o.prim?( :opt )
            unless o.given
                raise MissingArgument.new(
                    "Option \"#{o.opt}\" missing for \"#{cmd}\"...",
                    self )
            end
        end
    end

    if hasSubcmd
        if @config[ :subcheck ]
            # Compulsory Subcommand checking enabled.
            subcmdMissing = true
        else
            subcmdMissing = false
        end
    else
        subcmdMissing = false
    end

    # Check for any subcmd args.
    sub = givenSubcmd
    if sub
        subcmdMissing = false
        # Use recursion to examine the next level.
        return sub.checkMissing
    end

    # If no subcmds are given, issue error.
    raise MissingArgument.new(
        "Subcommand required for \"#{cmd}\"...",
        self ) if subcmdMissing

end

#checkRule ⇒ Object

Check option combination rules.



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'lib/como.rb', line 1517

def checkRule

    return unless @rules

    begin
        raise Opt::InvalidOption.new( "Option combination mismatch!", self ) unless
            RuleCheck.check( self, &@rules )

    rescue Opt::MissingArgument, Opt::InvalidOption => err
        @@io.puts
        errornl( err.to_s )

        usage( nil, true )

    end
end

#cmdline ⇒ Object

Return cmdline usage strings for options in an Array.



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
 
# File 'lib/como.rb', line 1827

def cmdline
    opts = []

    @subopt.each do |o|

        next if o.prim?( :hidden )

        prural = nil
        if o.prim?( :none ) && o.prim?( :many )
            prural = "*"
        elsif o.prim?( :one ) && o.prim?( :many )
            prural = "+"
        else
            prural = ""
        end

        if !( o.hasSwitchStyleDoc )
            name = " <#{o.name}>#{prural}"
        else
            name = ""
        end

        if o.shortOpt == nil
            opt = o.longOpt
        else
            opt = o.shortOpt
        end

        if !o.prim?( :opt )
            opts.push "#{opt}#{name}"
        else
            opts.push "[#{opt}#{name}]"
        end
    end


    if hasSubcmd
        opts.push "<<subcommand>>"
    end

    opts

end

#default ⇒ Object

Return default options.



1681
1682
1683
 
# File 'lib/como.rb', line 1681

def default
    argByName( nil )
end

#each(&blk) ⇒ Object

Options list iterator.



1583
1584
1585
1586
1587
 
# File 'lib/como.rb', line 1583

def each( &blk )
    suball.each do |o|
        yield o
    end
end

#each_given(&blk) ⇒ Object

Options iterator for given options.



1591
1592
1593
1594
1595
 
# File 'lib/como.rb', line 1591

def each_given( &blk )
    suball.each do |o|
        yield o if o.given
    end
end

#error(str, nl = false) ⇒ Object

Como error printout.

Parameters:

  • str (String) —

    Error message.

  • nl (Boolean) (defaults to: false) —

    Prepend msg with newline.



1951
1952
1953
1954
 
# File 'lib/como.rb', line 1951

def error( str, nl = false )
    nl = nl ? "\n" : ""
    STDERR.puts( "#{nl}#{Opt.progname} error: #{str}" )
end

#errornl(str) ⇒ Object

Como error printout with pre-newline.



1958
1959
1960
 
# File 'lib/como.rb', line 1958

def errornl( str )
    error( str, true )
end

#evalCheck(&check) ⇒ Object

Custom check for the option. User has to know some Como internals.



1982
1983
1984
 
# File 'lib/como.rb', line 1982

def evalCheck( &check )
    instance_eval &check
end

#fatal(str) ⇒ Object

Como error printout with immediate exit.



1964
1965
1966
1967
 
# File 'lib/como.rb', line 1964

def fatal( str )
    error( str )
    exit( false )
end

#findOpt(str) ⇒ Object

Find option object by option str.



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/como.rb', line 1898

def findOpt( str )
    if str == nil
        subopt.detect { |i| i.prim?( :default ) }
    elsif str[0..1] == "--"
        subopt.detect { |i| i.longOpt == str }
    elsif str[0..0] == "-"
        subopt.detect { |i| i.opt == str }
    else
        suball.detect { |i| i.name == str }
    end
end

#givenCount ⇒ Object

Number of given options.



1599
1600
1601
1602
1603
1604
1605
 
# File 'lib/como.rb', line 1599

def givenCount
    cnt = 0
    each_given do |i|
        cnt += 1
    end
    cnt
end

#givenSubcmd ⇒ Object

Return the selected subcommand.



1657
1658
1659
 
# File 'lib/como.rb', line 1657

def givenSubcmd
    ( @subcmd.select do |o| o.given end )[0]
end

#hasSwitchStyleDoc ⇒ Object

Test if option is of switch type.



1733
1734
1735
1736
1737
1738
1739
1740
 
# File 'lib/como.rb', line 1733

def hasSwitchStyleDoc
    if ( prim?( :none ) && !prim?( :many ) ) ||
       prim?( :default )
        true
    else
        false
    end
end

#opt ⇒ Object

Option’s opt id. Short if exists otherwise long.



1571
1572
1573
 
# File 'lib/como.rb', line 1571

def opt
    @shortOpt ? @shortOpt : @longOpt
end

#params ⇒ Hash

Returns Hash of option value parameters. Example command line content:

-p rounds=10 length=5

Option value content in this case would be (Array of param settings):

[ "rounds=10", "length=5" ]

Returns:

  • (Hash) —

    Parameter settings included in the option.



1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'lib/como.rb', line 1669

def params
    map = {}
    @value.each do |i|
        name, value = i.split('=')
        value = str_to_num( value )
        map[ name ] = value
    end
    map
end

#parse(args, checkInvalids = true) ⇒ Object

Parse cmdline options from args.



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
 
# File 'lib/como.rb', line 1325

def parse( args, checkInvalids = true )

    while args.get

        # puts "Opt.parse (#{@name}): #{args.get}"

        if args.isOptTerm

            # Rest of the args do not belong to this program.
            args.next
            Opt.main.external = args.rest
            break

        elsif args.isOpt

            o = findOpt( args.get )

            if !o
                if checkInvalids
                    raise \
                    InvalidOption.new( "Unknown option \"#{args.get}\"...",
                        self )
                else
                    o = findOpt( nil )
                    if !o
                        raise \
                        InvalidOption.new(
                            "No default option specified to allow \"#{args.get}\"...",
                           self )
                    else
                        # Default option.
                        o.value.push args.toValue
                        args.next
                    end
                end

            elsif o && ( o.prim?( :one ) || o.prim?( :many ) )

                args.next

                if ( !args.get || args.isOpt ) &&
                   !o.prim?( :none )

                    raise MissingArgument.new(
                        "No argument given for \"#{o.opt}\"...",
                        self )

                else

                    if o.prim?( :many )

                        # Get all argument for multi-option.
                        o.value = [] if !o.given
                        while args.get && !args.isOpt
                            o.value.push args.toValue
                            args.next
                        end

                    else

                        # Get one argument for single-option.

                        if o.given
                            raise \
                            InvalidOption.new(
                                "Too many arguments for option (\"#{o.name}\")...",
                                self )
                        else
                            o.value = args.toValue
                        end
                        args.next
                    end
                end

                o.given = true

            else

                if !o
                    raise InvalidOption.new( "No valid options specified...",
                        self )
                else
                    o.given = true
                    args.next
                end
            end

        else

            # Subcmd or default. Check for Subcmd first.

            # Search for Subcmd.
            o = findOpt( args.get )

            if !o

                # Search for default option.
                o = findOpt( nil )
                if !o
                    if @subcmd.any?
                        raise \
                            InvalidOption.new(
                            "Unknown subcmd: \"#{args.get}\"...",
                            self )
                    else
                        raise \
                            InvalidOption.new(
                            "No default option specified to allow \"#{args.get}\"...",
                            self )
                    end
                else
                    # Default option.
                    o.given = true
                    o.value.push args.toValue
                    args.next
                end

            else

                # Subcmd.
                o.given = true
                args.next
                return o

            end

        end
    end

    nil
end

#prim?(prim) ⇒ Boolean

Check for primitive.

Returns:

  • (Boolean) 


1727
1728
1729
 
# File 'lib/como.rb', line 1727

def prim?( prim )
    @type.index( prim )
end

#setOptionSubcmd(opts, subs) ⇒ Object

Set command (subcommand) suboptions and subcmds.

Parameters:

  • opts (Array<Opt>) 


1230
1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/como.rb', line 1230

def setOptionSubcmd( opts, subs )
    opts.each do |i|
        addOption( i )
    end

    subs.each do |i|
        addSubcmd( i )
    end
end

#setRuleCheck(&rule) ⇒ Object

Set rule checks for the option.

Parameters:

  • rule (Proc) —

    Rule to check after command line parsing.



1270
1271
1272
 
# File 'lib/como.rb', line 1270

def setRuleCheck( &rule )
    @rules = rule
end

#setUsageFooter(str) ⇒ Object

Set optional footer for “usage”.



1753
1754
1755
 
# File 'lib/como.rb', line 1753

def setUsageFooter( str )
    @config[ :footer ] = str
end

#setUsageHeader(str) ⇒ Object

Set optional header for “usage”.



1747
1748
1749
 
# File 'lib/como.rb', line 1747

def setUsageHeader( str )
    @config[ :header ] = str
end

#suball ⇒ Object

All subcommand options, options and subcommands.



1577
1578
1579
 
# File 'lib/como.rb', line 1577

def suball
    @subopt + @subcmd
end

#suboptDoc ⇒ Object

Return document strings for options.



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
 
# File 'lib/como.rb', line 1873

def suboptDoc

    str = ""
    # format = Proc.new do |s,d| ( "  %-#{@config[ :tab ]}s%s\n" % [ s, d ] ) end

    str += "\n"

    str += "  Options:\n" if hasSubcmd && hasVisibleOptions

    @subopt.each do |o|
        next if o.prim?( :hidden )
        str += suboptDocFormat( o.opt, o.doc )
    end

    str += "\n" + suboptDocFormat( "Subcommands:", "" ) if hasSubcmd

    @subcmd.each do |o|
        str += suboptDocFormat( o.name, o.doc )
    end

    str
end

#to_hash ⇒ Object

Convert to hash representation.

Keys are symbols: name, type, given, value, subopt, subcmd.



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/como.rb', line 1914

def to_hash
    h = {}
    h[ :name ] = @name
    h[ :type ] = @type
    h[ :given ] = @given
    h[ :value ] = @value
    h[ :subopt ] = @subopt.map{|i| i.to_hash }
    h[ :subcmd ] = @subcmd.map{|i| i.to_hash }
    h
end

#to_hopt ⇒ Object

Convert to hash representation with opt name keys.

Keys are symbols: name, type, given, value, subopt, subcmd.



1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
 
# File 'lib/como.rb', line 1929

def to_hopt
    h = {}
    h[ :name ] = @name
    h[ :type ] = @type
    h[ :given ] = @given
    h[ :value ] = @value
    h[ :subopt ] = {}
    @subopt.each do |i|
        h[ :subopt ][ i.name ] = i.to_hopt
    end
    h[ :subcmd ] = {}
    @subcmd.each do |i|
        h[ :subcmd ][ i.name ] = i.to_hopt
    end
    h
end

#usage(doExit = nil, ruleHelp = nil) ⇒ Object

Display program usage (and optionally exit).

Parameters:

  • doExit (Boolean) (defaults to: nil) —

    Exit program after help display. Default to help_exit config if nil.

  • ruleHelp (Boolean) (defaults to: nil) —

    Include rule help to help display. Default to rulehelp config if nil.



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
 
# File 'lib/como.rb', line 1766

def usage( doExit = nil, ruleHelp = nil )

    doExit = @config[ :help_exit ] if doExit == nil
    ruleHelp = @config[ :rulehelp ] if ruleHelp == nil

    @@io.puts usageNormal

    if ruleHelp
        @@io.puts "\n  Option Combinations:"
        @@io.puts RuleDisplay.print( &@rules )
    end

    exit( 1 ) if doExit
end

#usageCommand ⇒ Object

Usage printout for command.



1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/como.rb', line 1793

def usageCommand
    str = ""
    str += "\
  Subcommand \"#{@name}\" usage:
    #{fullCommand} #{cmdline.join(" ")}
"
    str += suboptDoc

    str += "\n"
end

#usageIfHelp ⇒ Object

Display program usage (and optionally exit).



1783
1784
1785
1786
1787
1788
1789
 
# File 'lib/como.rb', line 1783

def usageIfHelp
    if self.argByName( 'help' ) && self['help'].given
        usage
    elsif hasSubcmd && givenSubcmd
        givenSubcmd.usageIfHelp
    end
end

#usageNormal ⇒ Object

Usage info for Opt:s.



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
 
# File 'lib/como.rb', line 1805

def usageNormal
    str = ""

    if @config[ :header ]
        str += @config[ :header ]
    else
        str += "\n"
    end

    str += usageCommand

    if @config[ :footer ]
        str += @config[ :footer ]
    else
        str += "\n"
    end

    str
end

#warn(str, nl = false) ⇒ Object

Como warning printout.

Parameters:

  • str (String) —

    Warning message.

  • nl (Boolean) (defaults to: false) —

    Prepend msg with newline.



1974
1975
1976
1977
 
# File 'lib/como.rb', line 1974

def warn( str, nl = false )
    nl = nl ? "\n" : ""
    STDERR.puts( "#{nl}#{Opt.progname} warning: #{str}" )
end

#~ ⇒ Object

Short syntax for value reference. Example: “~Opt”.



1609
1610
1611
 
# File 'lib/como.rb', line 1609

def ~()
    @value
end