2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
|
|
|
|
# optparse.rb - command-line option analysis with the OptionParser class.
|
|
|
|
|
#
|
|
|
|
|
# Author:: Nobu Nakada
|
|
|
|
|
# Documentation:: Nobu Nakada and Gavin Sinclair.
|
|
|
|
|
#
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# See OptionParser for documentation.
|
|
|
|
|
#
|
2003-12-23 08:27:42 -05:00
|
|
|
|
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# == Developer Documentation (not for RDoc output)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
|
|
|
|
# === Class tree
|
|
|
|
|
#
|
|
|
|
|
# - OptionParser:: front end
|
|
|
|
|
# - OptionParser::Switch:: each switches
|
|
|
|
|
# - OptionParser::List:: options list
|
|
|
|
|
# - OptionParser::ParseError:: errors on parsing
|
|
|
|
|
# - OptionParser::AmbiguousOption
|
|
|
|
|
# - OptionParser::NeedlessArgument
|
|
|
|
|
# - OptionParser::MissingArgument
|
|
|
|
|
# - OptionParser::InvalidOption
|
|
|
|
|
# - OptionParser::InvalidArgument
|
|
|
|
|
# - OptionParser::AmbiguousArgument
|
|
|
|
|
#
|
|
|
|
|
# === Object relationship diagram
|
|
|
|
|
#
|
|
|
|
|
# +--------------+
|
|
|
|
|
# | OptionParser |<>-----+
|
|
|
|
|
# +--------------+ | +--------+
|
|
|
|
|
# | ,-| Switch |
|
|
|
|
|
# on_head -------->+---------------+ / +--------+
|
|
|
|
|
# accept/reject -->| List |<|>-
|
|
|
|
|
# | |<|>- +----------+
|
|
|
|
|
# on ------------->+---------------+ `-| argument |
|
|
|
|
|
# : : | class |
|
|
|
|
|
# +---------------+ |==========|
|
|
|
|
|
# on_tail -------->| | |pattern |
|
|
|
|
|
# +---------------+ |----------|
|
|
|
|
|
# OptionParser.accept ->| DefaultList | |converter |
|
|
|
|
|
# reject |(shared between| +----------+
|
|
|
|
|
# | all instances)|
|
|
|
|
|
# +---------------+
|
2003-12-28 12:31:10 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# == OptionParser
|
|
|
|
|
#
|
|
|
|
|
# === Introduction
|
|
|
|
|
#
|
|
|
|
|
# OptionParser is a class for command-line option analysis. It is much more
|
|
|
|
|
# advanced, yet also easier to use, than GetoptLong, and is a more Ruby-oriented
|
|
|
|
|
# solution.
|
|
|
|
|
#
|
|
|
|
|
# === Features
|
|
|
|
|
#
|
|
|
|
|
# 1. The argument specification and the code to handle it are written in the same
|
|
|
|
|
# place.
|
|
|
|
|
# 2. It can output an option summary; you don't need to maintain this string
|
|
|
|
|
# separately.
|
|
|
|
|
# 3. Optional and mandatory arguments are specified very gracefully.
|
|
|
|
|
# 4. Arguments can be automatically converted to a specified class.
|
|
|
|
|
# 5. Arguments can be restricted to a certain set.
|
|
|
|
|
#
|
|
|
|
|
# All of these features are demonstrated in the example below.
|
|
|
|
|
#
|
2003-12-23 08:27:42 -05:00
|
|
|
|
# === Example
|
|
|
|
|
#
|
|
|
|
|
# The following example is a complete Ruby program. You can run it and see the
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# effect of specifying various options. This is probably the best way to learn
|
|
|
|
|
# the features of +optparse+.
|
2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
|
|
|
|
# require 'optparse'
|
|
|
|
|
# require 'optparse/time'
|
|
|
|
|
# require 'ostruct'
|
|
|
|
|
# require 'pp'
|
|
|
|
|
#
|
|
|
|
|
# class OptparseExample
|
|
|
|
|
#
|
|
|
|
|
# CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# CODE_ALIASES = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
|
2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
|
|
|
|
# #
|
|
|
|
|
# # Return a structure describing the options.
|
|
|
|
|
# #
|
|
|
|
|
# def self.parse(args)
|
|
|
|
|
# # The options specified on the command line will be collected in *options*.
|
|
|
|
|
# # We set default values here.
|
|
|
|
|
# options = OpenStruct.new
|
|
|
|
|
# options.library = []
|
|
|
|
|
# options.inplace = false
|
|
|
|
|
# options.encoding = "utf8"
|
|
|
|
|
# options.transfer_type = :auto
|
|
|
|
|
# options.verbose = false
|
|
|
|
|
#
|
|
|
|
|
# opts = OptionParser.new do |opts|
|
|
|
|
|
# opts.banner = "Usage: example.rb [options]"
|
|
|
|
|
#
|
|
|
|
|
# opts.separator ""
|
|
|
|
|
# opts.separator "Specific options:"
|
|
|
|
|
#
|
|
|
|
|
# # Mandatory argument.
|
|
|
|
|
# opts.on("-r", "--require LIBRARY",
|
|
|
|
|
# "Require the LIBRARY before executing your script") do |lib|
|
|
|
|
|
# options.library << lib
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Optional argument; multi-line description.
|
|
|
|
|
# opts.on("-i", "--inplace [EXTENSION]",
|
|
|
|
|
# "Edit ARGV files in place",
|
|
|
|
|
# " (make backup if EXTENSION supplied)") do |ext|
|
|
|
|
|
# options.inplace = true
|
|
|
|
|
# options.extension = ext || ''
|
|
|
|
|
# options.extension.sub!(/\A\.?(?=.)/, ".") # Ensure extension begins with dot.
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Cast 'delay' argument to a Float.
|
|
|
|
|
# opts.on("--delay N", Float, "Delay N seconds before executing") do |n|
|
|
|
|
|
# options.delay = n
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Cast 'time' argument to a Time object.
|
|
|
|
|
# opts.on("-t", "--time [TIME]", Time, "Begin execution at given time") do |time|
|
|
|
|
|
# options.time = time
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Cast to octal integer.
|
|
|
|
|
# opts.on("-F", "--irs [OCTAL]", OptionParser::OctalInteger,
|
|
|
|
|
# "Specify record separator (default \\0)") do |rs|
|
|
|
|
|
# options.record_separator = rs
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # List of arguments.
|
|
|
|
|
# opts.on("--list x,y,z", Array, "Example 'list' of arguments") do |list|
|
|
|
|
|
# options.list = list
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Keyword completion. We are specifying a specific set of arguments (CODES
|
|
|
|
|
# # and CODE_ALIASES - notice the latter is a Hash), and the user may provide
|
|
|
|
|
# # the shortest unambiguous text.
|
|
|
|
|
# code_list = (CODE_ALIASES.keys + CODES).join(',')
|
|
|
|
|
# opts.on("--code CODE", CODES, CODE_ALIASES, "Select encoding",
|
|
|
|
|
# " (#{code_list})") do |encoding|
|
|
|
|
|
# options.encoding = encoding
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Optional argument with keyword completion.
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# opts.on("--type [TYPE]", [:text, :binary, :auto],
|
|
|
|
|
# "Select transfer type (text, binary, auto)") do |t|
|
2003-12-23 08:27:42 -05:00
|
|
|
|
# options.transfer_type = t
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Boolean switch.
|
|
|
|
|
# opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
|
|
|
|
|
# options.verbose = v
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# opts.separator ""
|
|
|
|
|
# opts.separator "Common options:"
|
|
|
|
|
#
|
|
|
|
|
# # No argument, shows at tail. This will print an options summary.
|
|
|
|
|
# # Try it and see!
|
|
|
|
|
# opts.on_tail("-h", "--help", "Show this message") do
|
|
|
|
|
# puts opts
|
|
|
|
|
# exit
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# # Another typical switch to print the version.
|
|
|
|
|
# opts.on_tail("--version", "Show version") do
|
|
|
|
|
# puts OptionParser::Version.join('.')
|
|
|
|
|
# exit
|
|
|
|
|
# end
|
|
|
|
|
# end
|
|
|
|
|
#
|
|
|
|
|
# opts.parse!(args)
|
|
|
|
|
# options
|
|
|
|
|
# end # parse()
|
|
|
|
|
#
|
|
|
|
|
# end # class OptparseExample
|
|
|
|
|
#
|
|
|
|
|
# options = OptparseExample.parse(ARGV)
|
|
|
|
|
# pp options
|
|
|
|
|
#
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# Note: some bugs were fixed between 1.8.0 and 1.8.1. If you experience trouble
|
|
|
|
|
# with the above code, keep this in mind.
|
|
|
|
|
#
|
|
|
|
|
# === Further documentation
|
|
|
|
|
#
|
|
|
|
|
# The methods are not individually documented at this stage. The above example
|
|
|
|
|
# should be enough to learn how to use this class. If you have any questions,
|
|
|
|
|
# email me (gsinclair@soyabean.com.au) and I will update this document.
|
2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class OptionParser
|
2003-12-23 08:27:42 -05:00
|
|
|
|
# :stopdoc:
|
2002-07-12 12:34:02 -04:00
|
|
|
|
RCSID = %w$Id$[1..-1].each {|s| s.freeze}.freeze
|
|
|
|
|
Version = (RCSID[1].split('.').collect {|s| s.to_i}.extend(Comparable).freeze if RCSID[1])
|
|
|
|
|
LastModified = (Time.gm(*RCSID[2, 2].join('-').scan(/\d+/).collect {|s| s.to_i}) if RCSID[2])
|
|
|
|
|
Release = RCSID[2]
|
|
|
|
|
|
|
|
|
|
NoArgument = [NO_ARGUMENT = :NONE, nil].freeze
|
|
|
|
|
RequiredArgument = [REQUIRED_ARGUMENT = :REQUIRED, true].freeze
|
|
|
|
|
OptionalArgument = [OPTIONAL_ARGUMENT = :OPTIONAL, false].freeze
|
2003-12-23 08:27:42 -05:00
|
|
|
|
# :startdoc:
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Keyword completion module. This allows partial arguments to be specified
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# and resolved against a list of acceptable values.
|
2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
2003-12-28 12:31:10 -05:00
|
|
|
|
module Completion
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def complete(key, pat = nil)
|
2003-12-20 02:07:19 -05:00
|
|
|
|
pat ||= Regexp.new('\A' + Regexp.quote(key).gsub(/\w+\b/, '\&\w*'),
|
2003-11-05 21:01:23 -05:00
|
|
|
|
ignore_case?)
|
2003-11-12 21:31:17 -05:00
|
|
|
|
canon, sw, k, v, cn = nil
|
2003-11-16 20:50:31 -05:00
|
|
|
|
candidates = []
|
2002-07-12 12:34:02 -04:00
|
|
|
|
each do |k, *v|
|
2003-12-23 08:27:42 -05:00
|
|
|
|
(if Regexp === k
|
|
|
|
|
kn = nil
|
|
|
|
|
k === key
|
|
|
|
|
else
|
|
|
|
|
kn = defined?(k.id2name) ? k.id2name : k
|
|
|
|
|
pat === kn
|
|
|
|
|
end) or next
|
|
|
|
|
v << k if v.empty?
|
2003-11-16 20:50:31 -05:00
|
|
|
|
candidates << [k, v, kn]
|
|
|
|
|
end
|
|
|
|
|
candidates = candidates.sort_by {|k, v, kn| kn.size}
|
|
|
|
|
if candidates.size == 1
|
|
|
|
|
canon, sw, * = candidates[0]
|
|
|
|
|
elsif candidates.size > 1
|
|
|
|
|
canon, sw, cn = candidates.shift
|
|
|
|
|
candidates.each do |k, v, kn|
|
|
|
|
|
next if sw == v
|
2003-12-23 08:27:42 -05:00
|
|
|
|
if String === cn and String === kn
|
|
|
|
|
if cn.rindex(kn, 0)
|
|
|
|
|
canon, sw, cn = k, v, kn
|
|
|
|
|
next
|
|
|
|
|
elsif kn.rindex(cn, 0)
|
|
|
|
|
next
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
throw :ambiguous, key
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
if canon
|
2003-12-23 08:27:42 -05:00
|
|
|
|
block_given? or return key, *sw
|
|
|
|
|
yield(key, *sw)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2002-08-07 09:00:10 -04:00
|
|
|
|
def convert(opt = nil, val = nil, *)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
val
|
|
|
|
|
end
|
2003-11-05 21:01:23 -05:00
|
|
|
|
|
|
|
|
|
def ignore_case?
|
|
|
|
|
false
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
2003-12-23 08:27:42 -05:00
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Map from option/keyword string to object with completion.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class OptionMap < Hash
|
|
|
|
|
include Completion
|
|
|
|
|
end
|
2003-11-05 21:01:23 -05:00
|
|
|
|
class OptionCaseMap < OptionMap
|
|
|
|
|
def ignore_case?
|
|
|
|
|
true
|
|
|
|
|
end
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
2003-12-23 08:27:42 -05:00
|
|
|
|
|
|
|
|
|
#
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# Individual switch class. Not important to the user.
|
|
|
|
|
#
|
|
|
|
|
# Defined within Switch are several Switch-derived classes: NoArgument,
|
|
|
|
|
# RequiredArgument, etc.
|
2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class Switch
|
|
|
|
|
attr_reader :pattern, :conv, :short, :long, :arg, :desc, :block
|
|
|
|
|
|
2003-12-23 08:27:42 -05:00
|
|
|
|
#
|
|
|
|
|
# Guesses argument style from +arg+. Returns corresponding
|
|
|
|
|
# OptionParser::Switch class (OptionalArgument, etc.).
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def self.guess(arg)
|
|
|
|
|
case arg
|
|
|
|
|
when ""
|
2003-01-30 03:11:21 -05:00
|
|
|
|
t = self
|
|
|
|
|
when /\A=?\[/
|
|
|
|
|
t = Switch::OptionalArgument
|
|
|
|
|
when /\A\s+\[/
|
|
|
|
|
t = Switch::PlacedArgument
|
2002-07-12 12:34:02 -04:00
|
|
|
|
else
|
2003-01-30 03:11:21 -05:00
|
|
|
|
t = Switch::RequiredArgument
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
2003-01-30 03:11:21 -05:00
|
|
|
|
self >= t or incompatible_argument_styles(arg, t)
|
|
|
|
|
t
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def self.incompatible_argument_styles(arg, t)
|
|
|
|
|
raise ArgumentError, "#{arg}: incompatible argument styles\n #{self}, #{t}"
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
2003-01-30 19:41:40 -05:00
|
|
|
|
def self.pattern
|
|
|
|
|
NilClass
|
|
|
|
|
end
|
|
|
|
|
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def initialize(pattern = nil, conv = nil,
|
2003-12-23 08:27:42 -05:00
|
|
|
|
short = nil, long = nil, arg = nil,
|
|
|
|
|
desc = ([] if short or long), block = Proc.new)
|
2003-10-29 12:47:24 -05:00
|
|
|
|
raise if Array === pattern
|
2002-07-12 12:34:02 -04:00
|
|
|
|
@pattern, @conv, @short, @long, @arg, @desc, @block =
|
2003-12-23 08:27:42 -05:00
|
|
|
|
pattern, conv, short, long, arg, desc, block
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::Switch#parse_arg(arg) {non-serious error handler}
|
|
|
|
|
#
|
|
|
|
|
# Parses argument and returns rest of ((|arg|)), and matched portion
|
|
|
|
|
# to the argument pattern.
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|arg|))
|
|
|
|
|
# option argument to be parsed.
|
|
|
|
|
# : (({block}))
|
|
|
|
|
# yields when the pattern doesn't match sub-string.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def parse_arg(arg)
|
|
|
|
|
pattern or return nil, arg
|
|
|
|
|
unless m = pattern.match(arg)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
yield(InvalidArgument, arg)
|
|
|
|
|
return arg, nil
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
if String === m
|
2003-12-23 08:27:42 -05:00
|
|
|
|
m = [s = m]
|
2002-07-12 12:34:02 -04:00
|
|
|
|
else
|
2003-12-23 08:27:42 -05:00
|
|
|
|
m = m.to_a
|
|
|
|
|
s = m[0]
|
|
|
|
|
return nil, m unless String === s
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
raise InvalidArgument, arg unless arg.rindex(s, 0)
|
2003-05-30 01:55:50 -04:00
|
|
|
|
return nil, m if s.length == arg.length
|
2002-07-12 12:34:02 -04:00
|
|
|
|
yield(InvalidArgument, arg) # didn't match whole arg
|
2003-05-30 01:55:50 -04:00
|
|
|
|
return arg[s.length..-1], m
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
private :parse_arg
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::Switch#conv_arg(arg, val) {semi-error handler}
|
|
|
|
|
#
|
|
|
|
|
# Parses argument, convert and returns ((|arg|)), ((|block|)) and
|
|
|
|
|
# result of conversion.
|
|
|
|
|
# : Arguments to ((|@conv|))
|
|
|
|
|
# substrings matched to ((|@pattern|)), ((|$&|)), ((|$1|)),
|
|
|
|
|
# ((|$2|)) and so on.
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|arg|))
|
|
|
|
|
# argument string follows the switch.
|
|
|
|
|
# : ((|val|))
|
|
|
|
|
# following argument.
|
|
|
|
|
# : (({block}))
|
|
|
|
|
# (({yields})) at semi-error condition, instead of raises exception.
|
|
|
|
|
#
|
2003-05-30 01:55:50 -04:00
|
|
|
|
def conv_arg(arg, val = nil)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
if block
|
2003-05-30 01:55:50 -04:00
|
|
|
|
if conv
|
|
|
|
|
val = conv.call(*val)
|
|
|
|
|
else
|
|
|
|
|
val = *val
|
|
|
|
|
end
|
2003-12-23 08:27:42 -05:00
|
|
|
|
return arg, block, val
|
2002-07-12 12:34:02 -04:00
|
|
|
|
else
|
2003-12-23 08:27:42 -05:00
|
|
|
|
return arg, nil
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
2003-05-30 01:55:50 -04:00
|
|
|
|
private :conv_arg
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::Switch#summarize(sdone, ldone, width, max, indent)
|
|
|
|
|
#
|
|
|
|
|
# Makes summary strings.
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|sdone|))
|
|
|
|
|
# already summarized short style options keyed hash.
|
|
|
|
|
# : ((|ldone|))
|
|
|
|
|
# already summarized long style options keyed hash.
|
|
|
|
|
# : ((|width|))
|
|
|
|
|
# width of left side, option part. in other word, right side,
|
|
|
|
|
# description part strings start at ((|width|)) column.
|
|
|
|
|
# : ((|max|))
|
|
|
|
|
# maximum width of left side, options are filled within ((|max|)) columns.
|
|
|
|
|
# : ((|indent|))
|
|
|
|
|
# prefix string indents each summarized lines.
|
|
|
|
|
# : (({block}))
|
|
|
|
|
# to be passed each lines(without newline).
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def summarize(sdone = [], ldone = [], width = 1, max = width - 1, indent = "")
|
|
|
|
|
sopts, lopts, s = [], [], nil
|
|
|
|
|
@short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short
|
|
|
|
|
@long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long
|
|
|
|
|
return if sopts.empty? and lopts.empty? # completely hidden
|
|
|
|
|
|
|
|
|
|
left = [sopts.join(', ')]
|
|
|
|
|
right = desc.dup
|
|
|
|
|
|
|
|
|
|
while s = lopts.shift
|
2003-12-23 08:27:42 -05:00
|
|
|
|
l = left[-1].length + s.length
|
|
|
|
|
l += arg.length if left.size == 1 && arg
|
|
|
|
|
l < max or left << ''
|
|
|
|
|
left[-1] << if left[-1].empty? then ' ' * 4 else ', ' end << s
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
left[0] << arg if arg
|
|
|
|
|
mlen = left.collect {|s| s.length}.max.to_i
|
|
|
|
|
while mlen > width and l = left.shift
|
2003-12-23 08:27:42 -05:00
|
|
|
|
mlen = left.collect {|s| s.length}.max.to_i if l.length == mlen
|
|
|
|
|
yield(indent + l)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
2004-03-20 11:45:41 -05:00
|
|
|
|
while begin l = left.shift; r = right.shift; l or r end
|
2003-12-23 08:27:42 -05:00
|
|
|
|
l = l.to_s.ljust(width) + ' ' + r if r and !r.empty?
|
|
|
|
|
yield(indent + l)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
self
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Switch that takes no arguments.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class NoArgument < self
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Raises an exception if any arguments given.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def parse(arg, argv, &error)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
yield(NeedlessArgument, arg) if arg
|
|
|
|
|
conv_arg(arg)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
2003-01-30 03:11:21 -05:00
|
|
|
|
def self.incompatible_argument_styles(*)
|
|
|
|
|
end
|
2003-01-30 19:41:40 -05:00
|
|
|
|
def self.pattern
|
2003-12-23 08:27:42 -05:00
|
|
|
|
Object
|
2003-01-30 19:41:40 -05:00
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Switch that takes an argument.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class RequiredArgument < self
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Raises an exception if argument is not present.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def parse(arg, argv, &error)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
unless arg
|
|
|
|
|
raise MissingArgument if argv.empty?
|
|
|
|
|
arg = argv.shift
|
|
|
|
|
end
|
|
|
|
|
conv_arg(*parse_arg(arg, &error))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Switch that can omit argument.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class OptionalArgument < self
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Parses argument if given, or uses default value.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def parse(arg, argv, &error)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
if arg
|
|
|
|
|
conv_arg(*parse_arg(arg, &error))
|
|
|
|
|
else
|
|
|
|
|
conv_arg(arg)
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
2003-01-30 03:11:21 -05:00
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# ?
|
|
|
|
|
#
|
2003-01-30 03:11:21 -05:00
|
|
|
|
class PlacedArgument < self
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# ?
|
|
|
|
|
#
|
2003-01-30 03:11:21 -05:00
|
|
|
|
def parse(arg, argv, &error)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
|
|
|
|
|
return nil, block, nil
|
|
|
|
|
end
|
2003-05-30 01:55:50 -04:00
|
|
|
|
opt = (val = parse_arg(val, &error))[1]
|
|
|
|
|
val = conv_arg(*val)
|
2003-11-05 05:09:58 -05:00
|
|
|
|
if opt and !arg
|
2003-05-30 01:55:50 -04:00
|
|
|
|
argv.shift
|
* eval.c (ev_const_defined, ev_const_get), variable.c
(rb_const_get_at, rb_const_get, rb_mod_remove_const): use Qundef
as autoload marker. [ruby-dev:18103], [ruby-dev:18184]
* eval.c (rb_mod_autoload, rb_mod_autoload_p): new method;
Module#autoload, Module#autoload?.
* variable.c (rb_autoload, rb_autoload_load, rb_autoload_p):
manage autoload constants per classes/modules.
* variable.c (rb_const_defined_at, rb_const_defined): return false
for autoloading constants.
* class.c (rb_define_class, rb_define_module), eval.c (rb_eval),
variable.c (rb_mod_const_at, rb_const_assign): removed autoload
stuff.
* intern.h: prototypes; rb_autoload, rb_autoload_load,
rb_autoload_p.
* lib/optparse.rb (OptionParser::Switch::PlacedArgument::parse):
do not treat unmatched argument as an option.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@3874 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2003-05-28 20:11:11 -04:00
|
|
|
|
else
|
2003-05-30 01:55:50 -04:00
|
|
|
|
val[0] = nil
|
* eval.c (ev_const_defined, ev_const_get), variable.c
(rb_const_get_at, rb_const_get, rb_mod_remove_const): use Qundef
as autoload marker. [ruby-dev:18103], [ruby-dev:18184]
* eval.c (rb_mod_autoload, rb_mod_autoload_p): new method;
Module#autoload, Module#autoload?.
* variable.c (rb_autoload, rb_autoload_load, rb_autoload_p):
manage autoload constants per classes/modules.
* variable.c (rb_const_defined_at, rb_const_defined): return false
for autoloading constants.
* class.c (rb_define_class, rb_define_module), eval.c (rb_eval),
variable.c (rb_mod_const_at, rb_const_assign): removed autoload
stuff.
* intern.h: prototypes; rb_autoload, rb_autoload_load,
rb_autoload_p.
* lib/optparse.rb (OptionParser::Switch::PlacedArgument::parse):
do not treat unmatched argument as an option.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@3874 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2003-05-28 20:11:11 -04:00
|
|
|
|
end
|
|
|
|
|
val
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Simple option list providing mapping from short and/or long option
|
|
|
|
|
# string to ((<OptionParser::Switch>)), and mapping from acceptable
|
|
|
|
|
# argument to matching pattern and converter pair. Also provides
|
|
|
|
|
# summary feature.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class List
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# Map from acceptable argument types to pattern and converter pairs.
|
|
|
|
|
attr_reader :atype
|
|
|
|
|
|
|
|
|
|
# Map from short style option switches to actual switch objects.
|
|
|
|
|
attr_reader :short
|
|
|
|
|
|
|
|
|
|
# Map from long style option switches to actual switch objects.
|
|
|
|
|
attr_reader :long
|
|
|
|
|
|
|
|
|
|
# List of all switches and summary string.
|
|
|
|
|
attr_reader :list
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Just initializes all instance variables.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def initialize
|
|
|
|
|
@atype = {}
|
|
|
|
|
@short = OptionMap.new
|
2003-11-05 21:01:23 -05:00
|
|
|
|
@long = OptionCaseMap.new
|
2002-07-12 12:34:02 -04:00
|
|
|
|
@list = []
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# See OptionParser.accept.
|
|
|
|
|
#
|
2003-01-30 12:50:37 -05:00
|
|
|
|
def accept(t, pat = /.*/, &block)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
if pat
|
2003-12-23 08:27:42 -05:00
|
|
|
|
pat.respond_to?(:match) or raise TypeError, "has no `match'"
|
2002-07-12 12:34:02 -04:00
|
|
|
|
else
|
2003-12-23 08:27:42 -05:00
|
|
|
|
pat = t if t.respond_to?(:match)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
unless block
|
2003-12-23 08:27:42 -05:00
|
|
|
|
block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
@atype[t] = [pat, block]
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# See OptionParser.reject.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def reject(t)
|
|
|
|
|
@atype.delete(t)
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::List#update(sw, sopts, lopts, nlopts = nil)
|
|
|
|
|
#
|
|
|
|
|
# Adds ((|sw|)) according to ((|sopts|)), ((|lopts|)) and
|
|
|
|
|
# ((|nlopts|)).
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|sw|))
|
|
|
|
|
# ((<OptionParser::Switch>)) instance to be added.
|
|
|
|
|
# : ((|sopts|))
|
|
|
|
|
# short style options list.
|
|
|
|
|
# : ((|lopts|))
|
|
|
|
|
# long style options list.
|
|
|
|
|
# : ((|nlopts|))
|
|
|
|
|
# negated long style options list.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def update(sw, sopts, lopts, nsw = nil, nlopts = nil)
|
|
|
|
|
o = nil
|
|
|
|
|
sopts.each {|o| @short[o] = sw} if sopts
|
|
|
|
|
lopts.each {|o| @long[o] = sw} if lopts
|
|
|
|
|
nlopts.each {|o| @long[o] = nsw} if nsw and nlopts
|
|
|
|
|
used = @short.invert.update(@long.invert)
|
|
|
|
|
@list.delete_if {|o| Switch === o and !used[o]}
|
|
|
|
|
end
|
|
|
|
|
private :update
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::List#prepend(switch, short_opts, long_opts, nolong_opts)
|
|
|
|
|
#
|
|
|
|
|
# Inserts ((|switch|)) at head of the list, and associates short,
|
|
|
|
|
# long and negated long options.
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def prepend(*args)
|
|
|
|
|
update(*args)
|
|
|
|
|
@list.unshift(args[0])
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::List#append(switch, short_opts, long_opts, nolong_opts)
|
|
|
|
|
#
|
|
|
|
|
# Appends ((|switch|)) at tail of the list, and associates short,
|
|
|
|
|
# long and negated long options.
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|switch|))
|
|
|
|
|
# ((<OptionParser::Switch>)) instance to be inserted.
|
|
|
|
|
# : ((|short_opts|))
|
|
|
|
|
# list of short style options.
|
|
|
|
|
# : ((|long_opts|))
|
|
|
|
|
# list of long style options.
|
|
|
|
|
# : ((|nolong_opts|))
|
|
|
|
|
# list of long style options with (({"no-"})) prefix.
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def append(*args)
|
|
|
|
|
update(*args)
|
|
|
|
|
@list.push(args[0])
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::List#search(id, key) [{block}]
|
|
|
|
|
#
|
|
|
|
|
# Searches ((|key|)) in ((|id|)) list.
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|id|))
|
|
|
|
|
# searching list.
|
|
|
|
|
# : ((|k|))
|
|
|
|
|
# searching key.
|
|
|
|
|
# : (({block}))
|
|
|
|
|
# yielded with the found value when succeeded.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def search(id, key)
|
|
|
|
|
if list = __send__(id)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
val = list.fetch(key) {return nil}
|
|
|
|
|
return val unless block_given?
|
|
|
|
|
yield(val)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::List#complete(id, opt, *pat, &block)
|
|
|
|
|
#
|
|
|
|
|
# Searches list ((|id|)) for ((|opt|)) and ((|*pat|)).
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|id|))
|
|
|
|
|
# searching list.
|
|
|
|
|
# : ((|opt|))
|
|
|
|
|
# searching key.
|
|
|
|
|
# : ((|*pat|))
|
|
|
|
|
# optional pattern for completion.
|
|
|
|
|
# : (({block}))
|
|
|
|
|
# yielded with the found value when succeeded.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def complete(id, opt, *pat, &block)
|
|
|
|
|
__send__(id).complete(opt, *pat, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::List#summarize(*args) {...}
|
|
|
|
|
#
|
|
|
|
|
# Making summary table, yields the (({block})) with each lines.
|
|
|
|
|
# Each elements of (({@list})) should be able to (({summarize})).
|
|
|
|
|
# :Parameters:
|
|
|
|
|
# : ((|args|))
|
|
|
|
|
# passed to elements#summarize through.
|
|
|
|
|
# : (({block}))
|
|
|
|
|
# to be passed each lines(without newline).
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def summarize(*args, &block)
|
|
|
|
|
list.each do |opt|
|
2003-12-23 08:27:42 -05:00
|
|
|
|
if opt.respond_to?(:summarize) # perhaps OptionParser::Switch
|
|
|
|
|
opt.summarize(*args, &block)
|
|
|
|
|
elsif opt.empty?
|
|
|
|
|
yield("")
|
|
|
|
|
else
|
|
|
|
|
opt.each(&block)
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Hash with completion search feature. See Completion module.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
class CompletingHash < Hash
|
|
|
|
|
include Completion
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::CompletingHash#match(key)
|
|
|
|
|
#
|
|
|
|
|
# Completion for hash key.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def match(key)
|
|
|
|
|
return key, *fetch(key) {
|
2003-12-23 08:27:42 -05:00
|
|
|
|
raise AmbiguousArgument, catch(:ambiguous) {return complete(key)}
|
2003-11-12 21:31:17 -05:00
|
|
|
|
}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::ArgumentStyle
|
|
|
|
|
# Enumeration of acceptable argument styles; possible values are:
|
|
|
|
|
# : OptionParser::NO_ARGUMENT
|
|
|
|
|
# the switch takes no arguments. ((({:NONE})))
|
|
|
|
|
# : OptionParser::REQUIRED_ARGUMENT
|
|
|
|
|
# the switch requires an argument. ((({:REQUIRED})))
|
|
|
|
|
# : OptionParser::OPTIONAL_ARGUMENT
|
|
|
|
|
# the switch requires an optional argument, that is, may take or
|
|
|
|
|
# not. ((({:OPTIONAL})))
|
|
|
|
|
#
|
|
|
|
|
# Use like (({--switch=argument}))(long style) or
|
|
|
|
|
# (({-Xargument}))(short style). For short style, only portion
|
|
|
|
|
# matched to ((<argument pattern>)) is dealed as argument.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# :stopdoc:
|
2002-07-12 12:34:02 -04:00
|
|
|
|
ArgumentStyle = {}
|
|
|
|
|
NoArgument.each {|el| ArgumentStyle[el] = Switch::NoArgument}
|
|
|
|
|
RequiredArgument.each {|el| ArgumentStyle[el] = Switch::RequiredArgument}
|
|
|
|
|
OptionalArgument.each {|el| ArgumentStyle[el] = Switch::OptionalArgument}
|
|
|
|
|
ArgumentStyle.freeze
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# OptionParser::DefaultList
|
|
|
|
|
#
|
|
|
|
|
# Switches common used such as '--', and also provides default
|
|
|
|
|
# argument classes
|
|
|
|
|
#
|
|
|
|
|
|
2002-07-12 12:34:02 -04:00
|
|
|
|
DefaultList = List.new
|
|
|
|
|
DefaultList.short['-'] = Switch::NoArgument.new {}
|
|
|
|
|
DefaultList.long[''] = Switch::NoArgument.new {throw :terminate}
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
#
|
|
|
|
|
# Default options, which never appear in option summary.
|
|
|
|
|
# --help
|
|
|
|
|
# Shows option summary.
|
|
|
|
|
# --version
|
|
|
|
|
# Shows version string if (({::Version})) is defined.
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
DefaultList.long['help'] = Switch::NoArgument.new do
|
|
|
|
|
puts ARGV.options
|
|
|
|
|
exit
|
|
|
|
|
end
|
2003-08-30 23:25:11 -04:00
|
|
|
|
DefaultList.long['version'] = Switch::OptionalArgument.new do |pkg|
|
|
|
|
|
if pkg
|
|
|
|
|
begin
|
|
|
|
|
require 'optparse/version'
|
|
|
|
|
rescue LoadError
|
|
|
|
|
pkg = nil
|
|
|
|
|
else
|
|
|
|
|
show_version(*pkg.split(/,/))
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
2003-08-30 23:25:11 -04:00
|
|
|
|
unless pkg
|
2003-09-04 22:32:24 -04:00
|
|
|
|
v = ARGV.options.ver and puts v
|
2003-08-30 23:25:11 -04:00
|
|
|
|
end
|
|
|
|
|
exit
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
2003-12-28 12:31:10 -05:00
|
|
|
|
# :startdoc:
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# Class methods
|
|
|
|
|
#
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser.with([banner[, width[, indent]]]) [{...}]
|
|
|
|
|
Initializes new instance, and evaluates the block in context of
|
|
|
|
|
the instance if called as iterator. This behavior is equivalent
|
|
|
|
|
to older (({new})). This is ((*deprecated*)) method.
|
|
|
|
|
|
|
|
|
|
cf. ((<OptionParser.new>))
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|banner|))
|
|
|
|
|
banner message.
|
|
|
|
|
: ((|width|))
|
|
|
|
|
summary width.
|
|
|
|
|
: ((|indent|))
|
|
|
|
|
summary indent.
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
to be evaluated in the new instance context.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def self.with(*args, &block)
|
|
|
|
|
opts = new(*args)
|
|
|
|
|
opts.instance_eval(&block)
|
|
|
|
|
opts
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser.inc(arg[, default])
|
|
|
|
|
--- OptionParser#inc(arg[, default])
|
|
|
|
|
Returns incremented value of ((|default|)) according to ((|arg|)).
|
|
|
|
|
=end
|
|
|
|
|
def self.inc(arg, default = nil)
|
|
|
|
|
case arg
|
|
|
|
|
when Integer
|
|
|
|
|
arg.nonzero?
|
|
|
|
|
when nil
|
|
|
|
|
default.to_i + 1
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
def inc(*args)
|
2002-10-02 12:45:35 -04:00
|
|
|
|
self.class.inc(*args)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser.new([banner[, width[, indent]]]) [{...}]
|
|
|
|
|
Initializes the instance, and yields itself if called as iterator.
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|banner|))
|
|
|
|
|
banner message.
|
|
|
|
|
: ((|width|))
|
|
|
|
|
summary width.
|
|
|
|
|
: ((|indent|))
|
|
|
|
|
summary indent.
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
to be evaluated in the new instance context.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def initialize(banner = nil, width = 32, indent = ' ' * 4)
|
|
|
|
|
@stack = [DefaultList, List.new, List.new]
|
|
|
|
|
@program_name = nil
|
|
|
|
|
@banner = banner
|
|
|
|
|
@summary_width = width
|
|
|
|
|
@summary_indent = indent
|
|
|
|
|
yield self if block_given?
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser.terminate([arg])
|
|
|
|
|
Terminates option parsing. Optional parameter ((|arg|)) would be
|
|
|
|
|
pushed back if given.
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|arg|))
|
|
|
|
|
string pushed back to be first non-option argument
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def terminate(arg = nil)
|
2002-10-02 12:45:35 -04:00
|
|
|
|
self.class.terminate(arg)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
def self.terminate(arg = nil)
|
|
|
|
|
throw :terminate, arg
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
@stack = [DefaultList]
|
|
|
|
|
def self.top() DefaultList end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser.accept(t, [pat]) {...}
|
|
|
|
|
--- OptionParser#accept(t, [pat]) {...}
|
|
|
|
|
Directs to accept specified class argument.
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|t|))
|
|
|
|
|
argument class specifier, any object including Class.
|
|
|
|
|
: ((|pat|))
|
|
|
|
|
pattern for argument, defaulted to ((|t|)) if it respond to (({match})).
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
receives argument string and should be convert to desired class.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def accept(*args, &blk) top.accept(*args, &blk) end
|
|
|
|
|
def self.accept(*args, &blk) top.accept(*args, &blk) end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser.reject(t)
|
|
|
|
|
--- OptionParser#reject(t)
|
|
|
|
|
Directs to reject specified class argument.
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|t|))
|
|
|
|
|
argument class specifier, any object including Class.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def reject(*args, &blk) top.reject(*args, &blk) end
|
|
|
|
|
def self.reject(*args, &blk) top.reject(*args, &blk) end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
=== Instance methods
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#banner
|
|
|
|
|
--- OptionParser#banner=(heading)
|
|
|
|
|
Heading banner preceding summary.
|
|
|
|
|
--- OptionParser#summary_width
|
|
|
|
|
--- OptionParser#summary_width=(width)
|
|
|
|
|
Width for option list portion of summary. Must be (({Numeric})).
|
|
|
|
|
--- OptionParser#summary_indent
|
|
|
|
|
--- OptionParser#summary_indent=(indent)
|
|
|
|
|
Indentation for summary. Must be (({String})) (or have (({+ String}))).
|
|
|
|
|
--- OptionParser#program_name
|
|
|
|
|
--- OptionParser#program_name=(name)
|
|
|
|
|
Program name to be emitted in error message and default banner,
|
|
|
|
|
defaulted to (({$0})).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
attr_writer :banner, :program_name
|
|
|
|
|
attr_accessor :summary_width, :summary_indent
|
|
|
|
|
|
|
|
|
|
def banner
|
|
|
|
|
@banner ||= "Usage: #{program_name} [options]"
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def program_name
|
|
|
|
|
@program_name || File.basename($0, '.*')
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# for experimental cascading :-)
|
|
|
|
|
alias set_banner banner=
|
|
|
|
|
alias set_program_name program_name=
|
|
|
|
|
alias set_summary_width summary_width=
|
|
|
|
|
alias set_summary_indent summary_indent=
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#version
|
|
|
|
|
--- OptionParser#version=(ver)
|
|
|
|
|
Version.
|
|
|
|
|
--- OptionParser#release
|
|
|
|
|
--- OptionParser#release=(rel)
|
|
|
|
|
Release code.
|
|
|
|
|
--- OptionParser#ver
|
|
|
|
|
Returns version string from ((<program_name>)), (({version})) and
|
|
|
|
|
(({release})).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
attr_writer :version, :release
|
|
|
|
|
|
|
|
|
|
def version
|
2003-09-08 07:00:17 -04:00
|
|
|
|
@version || (defined?(::Version) && ::Version) || (defined?(::VERSION) && ::VERSION)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def release
|
2003-09-08 07:00:17 -04:00
|
|
|
|
@release || (defined?(::Release) && ::Release) || (defined?(::RELEASE) && ::RELEASE)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def ver
|
|
|
|
|
if v = version
|
|
|
|
|
str = "#{program_name} #{[v].join('.')}"
|
|
|
|
|
str << " (#{v})" if v = release
|
|
|
|
|
str
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2003-09-05 11:15:43 -04:00
|
|
|
|
def warn(mesg = $!)
|
|
|
|
|
super(program_name + ': ' + mesg)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def abort(mesg = $!)
|
|
|
|
|
super(program_name + ': ' + mesg)
|
|
|
|
|
end
|
|
|
|
|
|
2002-07-12 12:34:02 -04:00
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#top
|
|
|
|
|
Subject of ((<on>))/((<on_head>)), ((<accept>))/((<reject>)).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def top
|
|
|
|
|
@stack[-1]
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#base
|
|
|
|
|
Subject of ((<on_tail>)).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def base
|
|
|
|
|
@stack[1]
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#new
|
|
|
|
|
Pushes a new (({List})).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def new
|
|
|
|
|
@stack.push(List.new)
|
|
|
|
|
if block_given?
|
|
|
|
|
yield self
|
|
|
|
|
else
|
|
|
|
|
self
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#remove
|
|
|
|
|
Removes the last (({List})).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def remove
|
|
|
|
|
@stack.pop
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent)
|
|
|
|
|
Puts option summary into ((|to|)), and returns ((|to|)).
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|to|))
|
|
|
|
|
output destination, which must have method ((|<<|)). Defaulted to (({[]})).
|
|
|
|
|
: ((|width|))
|
|
|
|
|
width of left side. Defaulted to ((|@summary_width|))
|
|
|
|
|
: ((|max|))
|
|
|
|
|
maximum length allowed for left side. Defaulted to (({((|width|)) - 1}))
|
|
|
|
|
: ((|indent|))
|
|
|
|
|
indentation. Defaulted to ((|@summary_indent|))
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
yields with each line if called as iterator.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent, &blk)
|
|
|
|
|
visit(:summarize, {}, {}, width, max, indent, &(blk || proc {|l| to << l + $/}))
|
|
|
|
|
to
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
2003-09-04 22:32:24 -04:00
|
|
|
|
--- OptionParser#help
|
2002-07-12 12:34:02 -04:00
|
|
|
|
--- OptionParser#to_s
|
|
|
|
|
Returns option summary string.
|
|
|
|
|
=end #'#"#`#
|
2003-09-04 22:32:24 -04:00
|
|
|
|
def help; summarize(banner.to_s.sub(/\n?\z/, "\n")) end
|
|
|
|
|
alias to_s help
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#to_a
|
|
|
|
|
Returns option summary list.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def to_a; summarize(banner.to_a.dup) end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#switch
|
|
|
|
|
Creates ((<OptionParser::Switch>)).
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|*opts|))
|
|
|
|
|
option definition:
|
|
|
|
|
: argument style
|
|
|
|
|
see ((<OptionParser::ArgumentStyle>))
|
|
|
|
|
: argument pattern
|
|
|
|
|
acceptable option argument format, must pre-defined with
|
|
|
|
|
((<OptionParser.accept>)) or ((<OptionParser#accept>)), or
|
|
|
|
|
(({Regexp})). This can appear once or assigned as (({String}))
|
|
|
|
|
if not present, otherwise causes exception (({ArgumentError})).
|
|
|
|
|
|
|
|
|
|
cf. ((<Acceptable argument classes>)).
|
|
|
|
|
: Hash
|
|
|
|
|
: Array
|
|
|
|
|
possible argument values.
|
|
|
|
|
: Proc
|
|
|
|
|
: Method
|
|
|
|
|
alternative way to give the ((*handler*)).
|
|
|
|
|
: "--switch=MANDATORY", "--switch[=OPTIONAL]", "--switch"
|
|
|
|
|
specifies long style switch that takes ((*mandatory*)),
|
|
|
|
|
((*optional*)) and ((*no*)) argument, respectively.
|
|
|
|
|
: "-xMANDATORY", "-x[OPTIONAL]", "-x"
|
|
|
|
|
specifies short style switch that takes ((*mandatory*)),
|
|
|
|
|
((*optional*)) and ((*no*)) argument, respectively.
|
|
|
|
|
: "-[a-z]MANDATORY", "-[a-z][OPTIONAL]", "-[a-z]"
|
|
|
|
|
special form short style switch that matches character
|
|
|
|
|
range(not fullset of regular expression).
|
|
|
|
|
: "=MANDATORY", "=[OPTIONAL]"
|
|
|
|
|
argument style and description.
|
|
|
|
|
: "description", ...
|
|
|
|
|
((*description*)) for this option.
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
((*handler*)) to convert option argument to arbitrary (({Class})).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
=begin private
|
|
|
|
|
--- OptionParser#notwice(obj, prv, msg)
|
|
|
|
|
Checks never given twice an argument.
|
|
|
|
|
((*Called from OptionParser#switch only*))
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|obj|))
|
|
|
|
|
new argument.
|
|
|
|
|
: ((|prv|))
|
|
|
|
|
previously specified argument.
|
|
|
|
|
: ((|msg|))
|
|
|
|
|
exception message
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def notwice(obj, prv, msg)
|
|
|
|
|
unless !prv or prv == obj
|
|
|
|
|
begin
|
2003-12-23 08:27:42 -05:00
|
|
|
|
raise ArgumentError, "argument #{msg} given twice: #{obj}"
|
2002-07-12 12:34:02 -04:00
|
|
|
|
rescue
|
2003-12-23 08:27:42 -05:00
|
|
|
|
$@[0, 2] = nil
|
|
|
|
|
raise
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
obj
|
|
|
|
|
end
|
|
|
|
|
private :notwice
|
|
|
|
|
|
2002-12-01 09:10:51 -05:00
|
|
|
|
def make_switch(*opts, &block)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
short, long, nolong, style, pattern, conv, not_pattern, not_conv, not_style = [], [], []
|
|
|
|
|
ldesc, sdesc, desc, arg = [], [], []
|
|
|
|
|
default_style = Switch::NoArgument
|
|
|
|
|
default_pattern = nil
|
|
|
|
|
klass = nil
|
|
|
|
|
o = nil
|
|
|
|
|
n, q, a = nil
|
|
|
|
|
|
|
|
|
|
opts.each do |o|
|
|
|
|
|
# argument class
|
|
|
|
|
next if search(:atype, o) do |pat, c|
|
2003-12-23 08:27:42 -05:00
|
|
|
|
klass = notwice(o, klass, 'type')
|
|
|
|
|
if not_style and not_style != Switch::NoArgument
|
|
|
|
|
not_pattern, not_conv = pat, c
|
|
|
|
|
else
|
|
|
|
|
default_pattern, conv = pat, c
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# directly specified pattern(any object possible to match)
|
|
|
|
|
if !(String === o) and o.respond_to?(:match)
|
2003-12-23 08:27:42 -05:00
|
|
|
|
pattern = notwice(o, pattern, 'pattern')
|
|
|
|
|
conv = (pattern.method(:convert).to_proc if pattern.respond_to?(:convert))
|
|
|
|
|
next
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# anything others
|
|
|
|
|
case o
|
|
|
|
|
when Proc, Method
|
2003-12-23 08:27:42 -05:00
|
|
|
|
block = notwice(o, block, 'block')
|
2002-07-12 12:34:02 -04:00
|
|
|
|
when Array, Hash
|
2003-12-23 08:27:42 -05:00
|
|
|
|
case pattern
|
|
|
|
|
when CompletingHash
|
|
|
|
|
when nil
|
|
|
|
|
pattern = CompletingHash.new
|
|
|
|
|
conv = (pattern.method(:convert).to_proc if pattern.respond_to?(:convert))
|
|
|
|
|
else
|
|
|
|
|
raise ArgumentError, "argument pattern given twice"
|
|
|
|
|
end
|
|
|
|
|
o.each {|(o, *v)| pattern[o] = v.fetch(0) {o}}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
when Module
|
2003-12-23 08:27:42 -05:00
|
|
|
|
raise ArgumentError, "unsupported argument type: #{o}"
|
2002-07-12 12:34:02 -04:00
|
|
|
|
when *ArgumentStyle.keys
|
2003-12-23 08:27:42 -05:00
|
|
|
|
style = notwice(ArgumentStyle[o], style, 'style')
|
2003-03-21 23:31:24 -05:00
|
|
|
|
when /^--no-([^\[\]=\s]*)(.+)?/
|
2003-12-23 08:27:42 -05:00
|
|
|
|
q, a = $1, $2
|
|
|
|
|
o = notwice(a ? Object : TrueClass, klass, 'type')
|
|
|
|
|
not_pattern, not_conv = search(:atype, o) unless not_style
|
|
|
|
|
not_style = (not_style || default_style).guess(arg = a) if a
|
|
|
|
|
default_style = Switch::NoArgument
|
|
|
|
|
default_pattern, conv = search(:atype, FalseClass) unless default_pattern
|
|
|
|
|
ldesc << "--no-#{q}"
|
|
|
|
|
long << 'no-' + (q = q.downcase)
|
|
|
|
|
nolong << q
|
2003-03-21 23:31:24 -05:00
|
|
|
|
when /^--\[no-\]([^\[\]=\s]*)(.+)?/
|
2003-12-23 08:27:42 -05:00
|
|
|
|
q, a = $1, $2
|
|
|
|
|
o = notwice(a ? Object : TrueClass, klass, 'type')
|
|
|
|
|
if a
|
|
|
|
|
default_style = default_style.guess(arg = a)
|
|
|
|
|
default_pattern, conv = search(:atype, o) unless default_pattern
|
|
|
|
|
end
|
|
|
|
|
ldesc << "--[no-]#{q}"
|
|
|
|
|
long << (o = q.downcase)
|
|
|
|
|
not_pattern, not_conv = search(:atype, FalseClass) unless not_style
|
|
|
|
|
not_style = Switch::NoArgument
|
|
|
|
|
nolong << 'no-' + o
|
2003-03-21 23:31:24 -05:00
|
|
|
|
when /^--([^\[\]=\s]*)(.+)?/
|
2003-12-23 08:27:42 -05:00
|
|
|
|
q, a = $1, $2
|
|
|
|
|
if a
|
|
|
|
|
o = notwice(NilClass, klass, 'type')
|
|
|
|
|
default_style = default_style.guess(arg = a)
|
|
|
|
|
default_pattern, conv = search(:atype, o) unless default_pattern
|
|
|
|
|
end
|
|
|
|
|
ldesc << "--#{q}"
|
|
|
|
|
long << (o = q.downcase)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
when /^-(\[\^?\]?(?:[^\\\]]|\\.)*\])(.+)?/
|
2003-12-23 08:27:42 -05:00
|
|
|
|
q, a = $1, $2
|
|
|
|
|
o = notwice(Object, klass, 'type')
|
|
|
|
|
if a
|
|
|
|
|
default_style = default_style.guess(arg = a)
|
|
|
|
|
default_pattern, conv = search(:atype, o) unless default_pattern
|
|
|
|
|
end
|
|
|
|
|
sdesc << "-#{q}"
|
|
|
|
|
short << Regexp.new(q)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
when /^-(.)(.+)?/
|
2003-12-23 08:27:42 -05:00
|
|
|
|
q, a = $1, $2
|
|
|
|
|
if a
|
|
|
|
|
o = notwice(NilClass, klass, 'type')
|
|
|
|
|
default_style = default_style.guess(arg = a)
|
|
|
|
|
default_pattern, conv = search(:atype, o) unless default_pattern
|
|
|
|
|
end
|
|
|
|
|
sdesc << "-#{q}"
|
|
|
|
|
short << q
|
2002-07-12 12:34:02 -04:00
|
|
|
|
when /^=/
|
2003-12-23 08:27:42 -05:00
|
|
|
|
style = notwice(default_style.guess(arg = o), style, 'style')
|
|
|
|
|
default_pattern, conv = search(:atype, Object) unless default_pattern
|
2002-07-12 12:34:02 -04:00
|
|
|
|
else
|
2003-12-23 08:27:42 -05:00
|
|
|
|
desc.push(o)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2003-01-30 19:41:40 -05:00
|
|
|
|
default_pattern, conv = search(:atype, default_style.pattern) unless default_pattern
|
2002-07-12 12:34:02 -04:00
|
|
|
|
s = if short.empty? and long.empty?
|
2003-12-23 08:27:42 -05:00
|
|
|
|
raise ArgumentError, "no switch given" if style or pattern or block
|
|
|
|
|
desc
|
|
|
|
|
else
|
|
|
|
|
(style || default_style).new(pattern || default_pattern,
|
|
|
|
|
conv, sdesc, ldesc, arg, desc, block)
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
return s, short, long,
|
|
|
|
|
(not_style.new(not_pattern, not_conv, sdesc, ldesc, nil, desc, block) if not_style),
|
|
|
|
|
nolong
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#on(*opts) [{...}]
|
|
|
|
|
--- OptionParser#def_option(*opts) [{...}]
|
|
|
|
|
--- OptionParser#on_head(*opts) [{...}]
|
|
|
|
|
--- OptionParser#def_head_option(*opts) [{...}]
|
|
|
|
|
--- OptionParser#on_tail(*opts) [{...}]
|
|
|
|
|
--- OptionParser#def_tail_option(*opts) [{...}]
|
|
|
|
|
Defines option switch and handler. (({on_head})), (({def_head_option}))
|
|
|
|
|
and (({on_tail})), (({def_tail_option})) put the switch at head
|
|
|
|
|
and tail of summary, respectively.
|
|
|
|
|
|
|
|
|
|
cf. ((<OptionParser#switch>)).
|
|
|
|
|
=end #'#"#`#
|
2002-12-02 04:40:44 -05:00
|
|
|
|
def define(*opts, &block)
|
2002-12-01 09:10:51 -05:00
|
|
|
|
top.append(*(sw = make_switch(*opts, &block)))
|
|
|
|
|
sw[0]
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def on(*opts, &block)
|
2002-12-02 04:40:44 -05:00
|
|
|
|
define(*opts, &block)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
self
|
|
|
|
|
end
|
2002-12-02 04:40:44 -05:00
|
|
|
|
alias def_option define
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
2002-12-02 04:40:44 -05:00
|
|
|
|
def define_head(*opts, &block)
|
2002-12-01 09:10:51 -05:00
|
|
|
|
top.prepend(*(sw = make_switch(*opts, &block)))
|
|
|
|
|
sw[0]
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def on_head(*opts, &block)
|
2002-12-02 04:40:44 -05:00
|
|
|
|
define_head(*opts, &block)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
self
|
|
|
|
|
end
|
2002-12-02 04:40:44 -05:00
|
|
|
|
alias def_head_option define_head
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
2002-12-02 04:40:44 -05:00
|
|
|
|
def define_tail(*opts, &block)
|
2002-12-01 09:10:51 -05:00
|
|
|
|
base.append(*(sw = make_switch(*opts, &block)))
|
|
|
|
|
sw[0]
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
def on_tail(*opts, &block)
|
2002-12-02 04:40:44 -05:00
|
|
|
|
define_tail(*opts, &block)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
self
|
|
|
|
|
end
|
2002-12-02 04:40:44 -05:00
|
|
|
|
alias def_tail_option define_tail
|
2002-12-01 09:10:51 -05:00
|
|
|
|
|
|
|
|
|
def separator(string)
|
|
|
|
|
top.append(string, nil, nil)
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#order(*argv) [{...}]
|
|
|
|
|
--- OptionParser#order!([argv = ARGV]) [{...}]
|
|
|
|
|
Parses ((|argv|)) in order. When non-option argument encountered,
|
|
|
|
|
yields it if called as iterator, otherwise terminates the parse
|
|
|
|
|
process.
|
|
|
|
|
Returns rest of ((|argv|)) left unparsed.
|
|
|
|
|
|
|
|
|
|
(({order!})) takes argument array itself, and removes switches
|
|
|
|
|
destructively.
|
|
|
|
|
Defaults to parse ((|ARGV|)).
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|argv|))
|
|
|
|
|
command line arguments to be parsed.
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
called with each non-option argument.
|
|
|
|
|
=end #'#"#`#
|
2003-09-05 11:15:43 -04:00
|
|
|
|
def order(*argv, &block)
|
|
|
|
|
argv = argv[0].dup if argv.size == 1 and Array === argv[0]
|
|
|
|
|
order!(argv, &block)
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
def order!(argv = ARGV, &nonopt)
|
|
|
|
|
opt, arg, sw, val, rest = nil
|
|
|
|
|
nonopt ||= proc {|arg| throw :terminate, arg}
|
|
|
|
|
argv.unshift(arg) if arg = catch(:terminate) {
|
|
|
|
|
while arg = argv.shift
|
2003-12-23 08:27:42 -05:00
|
|
|
|
case arg
|
|
|
|
|
# long option
|
|
|
|
|
when /\A--([^=]*)(?:=(.*))?/
|
|
|
|
|
opt, rest = $1, $2
|
|
|
|
|
begin
|
|
|
|
|
sw, = complete(:long, opt)
|
|
|
|
|
rescue ParseError
|
|
|
|
|
raise $!.set_option(arg, true)
|
|
|
|
|
end
|
|
|
|
|
begin
|
|
|
|
|
opt, sw, val = sw.parse(rest, argv) {|*exc| raise(*exc)}
|
|
|
|
|
sw.call(val) if sw
|
|
|
|
|
rescue ParseError
|
|
|
|
|
raise $!.set_option(arg, rest)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# short option
|
|
|
|
|
when /\A-(.)((=).*|.+)?/
|
|
|
|
|
opt, has_arg, eq, val, rest = $1, $3, $3, $2, $2
|
|
|
|
|
begin
|
|
|
|
|
unless sw = search(:short, opt)
|
|
|
|
|
begin
|
|
|
|
|
sw, = complete(:short, opt)
|
|
|
|
|
# short option matched.
|
|
|
|
|
val = arg.sub(/\A-/, '')
|
|
|
|
|
has_arg = true
|
|
|
|
|
rescue InvalidOption
|
|
|
|
|
# if no short options match, try completion with long
|
|
|
|
|
# options.
|
|
|
|
|
sw, = complete(:long, opt)
|
|
|
|
|
eq ||= !rest
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
rescue ParseError
|
|
|
|
|
raise $!.set_option(arg, true)
|
|
|
|
|
end
|
|
|
|
|
begin
|
|
|
|
|
opt, sw, val = sw.parse(val, argv) {|*exc| raise(*exc) if eq}
|
|
|
|
|
raise InvalidOption, arg if has_arg and !eq and arg == "-#{opt}"
|
|
|
|
|
argv.unshift(opt) if opt and (opt = opt.sub(/\A-*/, '-')) != '-'
|
|
|
|
|
sw.call(val) if sw
|
|
|
|
|
rescue ParseError
|
|
|
|
|
raise $!.set_option(arg, arg.length > 2)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# non-option argument
|
|
|
|
|
else
|
|
|
|
|
nonopt.call(arg)
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
argv
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#permute(*argv)
|
|
|
|
|
--- OptionParser#permute!([argv = ARGV])
|
|
|
|
|
Parses ((|argv|)) in permutation mode, and returns list of
|
|
|
|
|
non-option arguments.
|
|
|
|
|
|
|
|
|
|
(({permute!})) takes argument array itself, and removes switches
|
|
|
|
|
destructively.
|
|
|
|
|
Defaults to parse ((|ARGV|)).
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|argv|))
|
|
|
|
|
command line arguments to be parsed.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def permute(*argv)
|
2003-09-05 11:15:43 -04:00
|
|
|
|
argv = argv[0].dup if argv.size == 1 and Array === argv[0]
|
2002-07-12 12:34:02 -04:00
|
|
|
|
permute!(argv)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def permute!(argv = ARGV)
|
|
|
|
|
nonopts = []
|
|
|
|
|
arg = nil
|
|
|
|
|
order!(argv) {|arg| nonopts << arg}
|
|
|
|
|
argv[0, 0] = nonopts
|
|
|
|
|
argv
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser#parse(*argv)
|
|
|
|
|
--- OptionParser#parse!([argv = ARGV])
|
|
|
|
|
Parses ((|argv|)) in order when environment variable (({POSIXLY_CORRECT}))
|
|
|
|
|
is set, otherwise permutation mode
|
|
|
|
|
|
|
|
|
|
(({parse!})) takes argument array itself, and removes switches
|
|
|
|
|
destructively.
|
|
|
|
|
Defaults to parse ((|ARGV|)).
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|argv|))
|
|
|
|
|
command line arguments to be parsed.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def parse(*argv)
|
2003-09-05 11:15:43 -04:00
|
|
|
|
argv = argv[0].dup if argv.size == 1 and Array === argv[0]
|
2002-07-12 12:34:02 -04:00
|
|
|
|
parse!(argv)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def parse!(argv = ARGV)
|
|
|
|
|
if ENV.include?('POSIXLY_CORRECT')
|
|
|
|
|
order!(argv)
|
|
|
|
|
else
|
|
|
|
|
permute!(argv)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin private
|
|
|
|
|
--- OptionParser#visit(id, *args) {block}
|
|
|
|
|
Traverses (({stack}))s calling method ((|id|)) with ((|*args|)).
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|id|))
|
|
|
|
|
called method in each elements of (({stack}))s.
|
|
|
|
|
: ((|*args|))
|
|
|
|
|
passed to ((|id|)).
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
passed to ((|id|)).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def visit(id, *args, &block)
|
|
|
|
|
el = nil
|
|
|
|
|
@stack.reverse_each do |el|
|
|
|
|
|
el.send(id, *args, &block)
|
|
|
|
|
end
|
|
|
|
|
nil
|
|
|
|
|
end
|
|
|
|
|
private :visit
|
|
|
|
|
|
|
|
|
|
=begin private
|
|
|
|
|
--- OptionParser#search(id, k)
|
|
|
|
|
Searches ((|k|)) in stack for ((|id|)) hash, and returns it or yielded
|
|
|
|
|
value if called as iterator.
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|id|))
|
|
|
|
|
searching table.
|
|
|
|
|
: ((|k|))
|
|
|
|
|
searching key.
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
yielded with the found value when succeeded.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def search(id, k)
|
|
|
|
|
visit(:search, id, k) do |k|
|
|
|
|
|
return k unless block_given?
|
|
|
|
|
return yield(k)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
private :search
|
|
|
|
|
|
|
|
|
|
=begin private
|
|
|
|
|
--- OptionParser#complete(typ, opt, *etc)
|
|
|
|
|
Completes shortened long style option switch, and returns pair of
|
|
|
|
|
canonical switch and switch descriptor((<OptionParser::Switch>)).
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|id|))
|
|
|
|
|
searching table.
|
|
|
|
|
: ((|opt|))
|
|
|
|
|
searching key.
|
|
|
|
|
: ((|*pat|))
|
|
|
|
|
optional pattern for completion.
|
2003-06-16 03:14:50 -04:00
|
|
|
|
: (({block}))
|
2002-07-12 12:34:02 -04:00
|
|
|
|
yielded with the found value when succeeded.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def complete(typ, opt, *pat)
|
|
|
|
|
if pat.empty?
|
|
|
|
|
search(typ, opt) {|sw| return [sw, opt]} # exact match or...
|
|
|
|
|
end
|
|
|
|
|
raise AmbiguousOption, catch(:ambiguous) {
|
|
|
|
|
visit(:complete, typ, opt, *pat) {|opt, *sw| return sw}
|
|
|
|
|
raise InvalidOption, opt
|
|
|
|
|
}
|
|
|
|
|
end
|
|
|
|
|
private :complete
|
|
|
|
|
|
|
|
|
|
=begin undocumented
|
|
|
|
|
--- OptionParser#load([filename])
|
|
|
|
|
Loads options from file named as ((|filename|)). Does nothing when
|
|
|
|
|
the file is not present. Returns whether successfuly loaded.
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|filename|))
|
|
|
|
|
option file name. defaulted to basename of the program without
|
|
|
|
|
suffix in a directory ((%~/.options%)).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def load(filename = nil)
|
|
|
|
|
begin
|
|
|
|
|
filename ||= File.expand_path(File.basename($0, '.*'), '~/.options')
|
|
|
|
|
rescue
|
|
|
|
|
return false
|
|
|
|
|
end
|
|
|
|
|
begin
|
|
|
|
|
parse(*IO.readlines(filename).each {|s| s.chomp!})
|
|
|
|
|
true
|
|
|
|
|
rescue Errno::ENOENT, Errno::ENOTDIR
|
|
|
|
|
false
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin undocumented
|
|
|
|
|
--- OptionParser#environment([env])
|
|
|
|
|
Parses environment variable ((|env|)) or its uppercase with spliting
|
|
|
|
|
like as shell.
|
|
|
|
|
:Parameters:
|
|
|
|
|
: ((|env|))
|
|
|
|
|
defaulted to basename of the program.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def environment(env = File.basename($0, '.*'))
|
|
|
|
|
env = ENV[env] || ENV[env.upcase] or return
|
|
|
|
|
parse(*Shellwords.shellwords(env))
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
= Acceptable argument classes
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: Object
|
|
|
|
|
any string, and no conversion. this is fall-back.
|
|
|
|
|
=end #'#"#`#
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(Object) {|s,|s or s.nil?}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(NilClass) {|s,|s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: String
|
|
|
|
|
any none-empty string, and no conversion.
|
|
|
|
|
=end #'#"#`#
|
2002-08-07 20:38:28 -04:00
|
|
|
|
accept(String, /.+/) {|s,*|s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: Integer
|
|
|
|
|
Ruby/C-like integer, octal for (({0-7})) sequence, binary for
|
|
|
|
|
(({0b})), hexadecimal for (({0x})), and decimal for others; with
|
|
|
|
|
optional sign prefix. Converts to (({Integer})).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
decimal = '\d+(?:_\d+)*'
|
|
|
|
|
binary = 'b[01]+(?:_[01]+)*'
|
|
|
|
|
hex = 'x[\da-f]+(?:_[\da-f]+)*'
|
|
|
|
|
octal = "0(?:[0-7]*(?:_[0-7]+)*|#{binary}|#{hex})"
|
|
|
|
|
integer = "#{octal}|#{decimal}"
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(Integer, %r"\A[-+]?(?:#{integer})"io) {|s,| Integer(s) if s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: Float
|
|
|
|
|
Float number format, and converts to (({Float})).
|
|
|
|
|
=end #'#"#`#
|
2003-03-29 01:39:50 -05:00
|
|
|
|
float = "(?:#{decimal}(?:\\.(?:#{decimal})?)?|\\.#{decimal})(?:E[-+]?#{decimal})?"
|
|
|
|
|
floatpat = %r"\A[-+]?#{float}"io
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(Float, floatpat) {|s,| s.to_f if s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: Numeric
|
|
|
|
|
Generic numeric format, and converts to (({Integer})) for integer
|
|
|
|
|
format, (({Float})) for float format.
|
|
|
|
|
=end #'#"#`#
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(Numeric, %r"\A[-+]?(?:#{octal}|#{float})"io) {|s,| eval(s) if s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: OptionParser::DecimalInteger
|
|
|
|
|
Decimal integer format, to be converted to (({Integer})).
|
|
|
|
|
=end #'#"#`#
|
2003-03-29 01:39:50 -05:00
|
|
|
|
DecimalInteger = /\A[-+]?#{decimal}/io
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(DecimalInteger) {|s,| s.to_i if s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: OptionParser::OctalInteger
|
|
|
|
|
Ruby/C like octal/hexadecimal/binary integer format, to be converted
|
|
|
|
|
to (({Integer})).
|
|
|
|
|
=end #'#"#`#
|
2003-03-29 01:39:50 -05:00
|
|
|
|
OctalInteger = /\A[-+]?(?:[0-7]+(?:_[0-7]+)*|0(?:#{binary}|#{hex}))/io
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(OctalInteger) {|s,| s.oct if s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: OptionParser::DecimalNumeric
|
|
|
|
|
Decimal integer/float number format, to be converted to
|
|
|
|
|
(({Integer})) for integer format, (({Float})) for float format.
|
|
|
|
|
=end #'#"#`#
|
2003-12-23 08:27:42 -05:00
|
|
|
|
DecimalNumeric = floatpat # decimal integer is allowed as float also.
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(DecimalNumeric) {|s,| eval(s) if s}
|
2002-07-12 12:34:02 -04:00
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: TrueClass
|
|
|
|
|
Boolean switch, which means whether it is present or not, whether it
|
|
|
|
|
is absent or not with prefix (({no-})), or it takes an argument
|
|
|
|
|
(({yes/no/true/false/+/-})).
|
|
|
|
|
: FalseClass
|
|
|
|
|
Similar to ((<TrueClass>)), but defaulted to (({false})).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
yesno = CompletingHash.new
|
|
|
|
|
%w[- no false].each {|el| yesno[el] = false}
|
|
|
|
|
%w[+ yes true].each {|el| yesno[el] = true}
|
2003-12-23 08:27:42 -05:00
|
|
|
|
yesno['nil'] = false # shoud be nil?
|
2002-07-12 12:34:02 -04:00
|
|
|
|
accept(TrueClass, yesno) {|arg, val| val == nil or val}
|
|
|
|
|
accept(FalseClass, yesno) {|arg, val| val != nil and val}
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
: Array
|
|
|
|
|
List of strings separated by ","
|
|
|
|
|
=end #'#"#`#
|
2003-05-21 00:27:06 -04:00
|
|
|
|
accept(Array) do |s,|
|
2002-07-12 12:34:02 -04:00
|
|
|
|
if s
|
|
|
|
|
s = s.split(',').collect {|s| s unless s.empty?}
|
|
|
|
|
end
|
|
|
|
|
s
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
= Exceptions
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::ParseError:))
|
|
|
|
|
Base class of exceptions from ((<OptionParser>))
|
|
|
|
|
=== Superclass
|
|
|
|
|
(({RuntimeError}))
|
|
|
|
|
=== Constants
|
|
|
|
|
: OptionParser::ParseError::Reason
|
|
|
|
|
Reason caused error.
|
|
|
|
|
=== Instance methods
|
|
|
|
|
--- OptionParser::ParseError#recover(argv)
|
|
|
|
|
Push backs erred argument(s) to ((|argv|)).
|
|
|
|
|
--- OptionParser::ParseError#reason
|
|
|
|
|
Returns error reason. Override this to I18N.
|
|
|
|
|
--- OptionParser::ParseError#inspect
|
|
|
|
|
Returns inspection string.
|
|
|
|
|
--- OptionParser::ParseError#message
|
|
|
|
|
--- OptionParser::ParseError#to_s
|
|
|
|
|
Default stringizing method to emit standard error message.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
class ParseError < RuntimeError
|
|
|
|
|
Reason = 'parse error'.freeze
|
|
|
|
|
|
|
|
|
|
def initialize(*args)
|
|
|
|
|
@args = args
|
|
|
|
|
@reason = nil
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
attr_reader :args
|
|
|
|
|
attr_writer :reason
|
|
|
|
|
|
|
|
|
|
def recover(argv)
|
|
|
|
|
argv[0, 0] = @args
|
|
|
|
|
argv
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def set_option(opt, eq)
|
|
|
|
|
if eq
|
2003-12-23 08:27:42 -05:00
|
|
|
|
@args[0] = opt
|
2002-07-12 12:34:02 -04:00
|
|
|
|
else
|
2003-12-23 08:27:42 -05:00
|
|
|
|
@args.unshift(opt)
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
self
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def reason
|
2002-10-02 12:45:35 -04:00
|
|
|
|
@reason || self.class::Reason
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def inspect
|
2002-10-02 12:45:35 -04:00
|
|
|
|
"#<#{self.class.to_s}: #{args.join(' ')}>"
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def message
|
|
|
|
|
reason + ': ' + args.join(' ')
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
alias to_s message
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::AmbiguousOption:))
|
|
|
|
|
Raises when encountered ambiguously completable string.
|
|
|
|
|
=== Superclass
|
|
|
|
|
((<OptionParser::ParseError>))
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
class AmbiguousOption < ParseError
|
|
|
|
|
const_set(:Reason, 'ambiguous option'.freeze)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::NeedlessArgument:))
|
|
|
|
|
Raises when encountered argument for switch defined as which takes no
|
|
|
|
|
argument.
|
|
|
|
|
=== Superclass
|
|
|
|
|
((<OptionParser::ParseError>))
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
class NeedlessArgument < ParseError
|
|
|
|
|
const_set(:Reason, 'needles argument'.freeze)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::MissingArgument:))
|
|
|
|
|
Raises when no argument found for switch defined as which needs
|
|
|
|
|
argument.
|
|
|
|
|
=== Superclass
|
|
|
|
|
((<OptionParser::ParseError>))
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
class MissingArgument < ParseError
|
|
|
|
|
const_set(:Reason, 'missing argument'.freeze)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::InvalidOption:))
|
|
|
|
|
Raises when undefined switch.
|
|
|
|
|
=== Superclass
|
|
|
|
|
((<OptionParser::ParseError>))
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
class InvalidOption < ParseError
|
|
|
|
|
const_set(:Reason, 'invalid option'.freeze)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::InvalidArgument:))
|
|
|
|
|
Raises when the given argument does not match required format.
|
|
|
|
|
=== Superclass
|
|
|
|
|
((<OptionParser::ParseError>))
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
class InvalidArgument < ParseError
|
|
|
|
|
const_set(:Reason, 'invalid argument'.freeze)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::AmbiguousArgument:))
|
|
|
|
|
Raises when the given argument word can't completed uniquely.
|
|
|
|
|
=== Superclass
|
|
|
|
|
((<OptionParser::InvalidArgument>))
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
class AmbiguousArgument < InvalidArgument
|
|
|
|
|
const_set(:Reason, 'ambiguous argument'.freeze)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
= Miscellaneous
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
=begin
|
|
|
|
|
== ((:OptionParser::Arguable:))
|
|
|
|
|
Extends command line arguments array to parse itself.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
module Arguable
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser::Arguable#options=(opt)
|
|
|
|
|
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.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def options=(opt)
|
|
|
|
|
unless @optparse = opt
|
2003-12-23 08:27:42 -05:00
|
|
|
|
class << self
|
|
|
|
|
undef_method(:options)
|
|
|
|
|
undef_method(:options=)
|
|
|
|
|
end
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser::Arguable#options
|
|
|
|
|
Actual ((<OptionParser>)) object, automatically created if not
|
|
|
|
|
yet.
|
|
|
|
|
|
|
|
|
|
If called as iterator, yields with the ((<OptionParser>)) object
|
|
|
|
|
and returns the result of the block. In this case, rescues any
|
|
|
|
|
((<OptionParser::ParseError>)) exceptions in the block, just emits
|
|
|
|
|
error message to ((<STDERR>)) and returns (({nil})).
|
|
|
|
|
|
|
|
|
|
:Parameters:
|
|
|
|
|
: (({block}))
|
|
|
|
|
Yielded with the ((<OptionParser>)) instance.
|
|
|
|
|
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def options
|
|
|
|
|
@optparse ||= OptionParser.new
|
|
|
|
|
block_given? or return @optparse
|
|
|
|
|
begin
|
2003-12-23 08:27:42 -05:00
|
|
|
|
yield @optparse
|
2002-07-12 12:34:02 -04:00
|
|
|
|
rescue ParseError
|
2003-12-23 08:27:42 -05:00
|
|
|
|
@optparse.warn $!
|
|
|
|
|
nil
|
2002-07-12 12:34:02 -04:00
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
--- OptionParser::Arguable#order!
|
|
|
|
|
--- OptionParser::Arguable#permute!
|
|
|
|
|
--- OptionParser::Arguable#parse!
|
|
|
|
|
Parses ((|self|)) destructively, and returns ((|self|)) just contains
|
|
|
|
|
rest arguments left without parsed.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def order!(&blk) options.order!(self, &blk) end
|
|
|
|
|
def permute!() options.permute!(self) end
|
|
|
|
|
def parse!() options.parse!(self) end
|
|
|
|
|
|
|
|
|
|
=begin private
|
|
|
|
|
Initializes instance variable.
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
def self.extend_object(obj)
|
|
|
|
|
super
|
|
|
|
|
obj.instance_eval {@optparse = nil}
|
|
|
|
|
end
|
|
|
|
|
def initialize(*args)
|
|
|
|
|
super
|
|
|
|
|
@optparse = nil
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
=begin
|
|
|
|
|
== OptionParser::Acceptables
|
|
|
|
|
Acceptable argument classes. Now contains (({DecimalInteger})),
|
|
|
|
|
(({OctalInteger})) and (({DecimalNumeric})).
|
|
|
|
|
see ((<Acceptable argument classes>)).
|
|
|
|
|
=end #'#"#`#
|
|
|
|
|
module Acceptables
|
|
|
|
|
const_set(:DecimalInteger, OptionParser::DecimalInteger)
|
|
|
|
|
const_set(:OctalInteger, OptionParser::OctalInteger)
|
|
|
|
|
const_set(:DecimalNumeric, OptionParser::DecimalNumeric)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# ARGV is arguable by OptionParser
|
|
|
|
|
ARGV.extend(OptionParser::Arguable)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if $0 == __FILE__
|
|
|
|
|
Version = OptionParser::Version
|
|
|
|
|
ARGV.options {|q|
|
|
|
|
|
q.parse!.empty? or puts "what's #{ARGV.join(' ')}?"
|
|
|
|
|
} or exit 1
|
|
|
|
|
end
|
|
|
|
|
__END__
|
|
|
|
|
=begin example
|
|
|
|
|
= Example
|
|
|
|
|
<<< opttest.rb
|
|
|
|
|
=end #'#"#`#
|