Extends command line arguments array (ARGV) to parse itself.
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2210
def self.extend_object(obj)
super
obj.instance_eval {@optparse = nil}
end
Initializes instance variable.
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2214
def initialize(*args)
super
@optparse = nil
end
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2203
def getopts(*args)
options.getopts(self, *args)
end
Substitution of getopts is possible as follows. Also see OptionParser#getopts
.
def getopts(*args) ($OPT = ARGV.getopts(*args)).each do |opt, val| eval "$OPT_#{opt.gsub(/[^A-Za-z0-9_]/, '_')} = val" end rescue OptionParser::ParseError end
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2162
def options
@optparse ||= OptionParser.new
@optparse.default_argv = self
block_given? or return @optparse
begin
yield @optparse
rescue ParseError
@optparse.warn $!
nil
end
end
Actual OptionParser
object, automatically created if nonexistent.
If called with a block, yields the OptionParser
object and returns the result of the block. If an OptionParser::ParseError
exception occurs in the block, it is rescued, a error message printed to STDERR and nil
returned.
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2145
def options=(opt)
unless @optparse = opt
class << self
undef_method(:options)
undef_method(:options=)
end
end
end
Sets OptionParser
object, when opt
is false
or nil
, methods OptionParser::Arguable#options
and OptionParser::Arguable#options=
are undefined. Thus, there is no ways to access the OptionParser
object via the receiver object.
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2178
def order!(&blk) options.order!(self, &blk) end
Parses self
destructively in order and returns self
containing the rest arguments left unparsed.
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2190
def parse!() options.parse!(self) end
Parses self
destructively and returns self
containing the rest arguments left unparsed.
# File tmp/rubies/ruby-2.7.6/lib/optparse.rb, line 2184
def permute!() options.permute!(self) end
Parses self
destructively in permutation mode and returns self
containing the rest arguments left unparsed.