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.
Map from acceptable argument types to pattern and converter pairs.
Map from short style option switches to actual switch objects.
Map from long style option switches to actual switch objects.
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 777
def initialize
@atype = {}
@short = OptionMap.new
@long = OptionMap.new
@list = []
end
Just initializes all instance variables.
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 787
def accept(t, pat = /.*/m, &block)
if pat
pat.respond_to?(:match) or
raise TypeError, "has no `match'", ParseError.filter_backtrace(caller(2))
else
pat = t if t.respond_to?(:match)
end
unless block
block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
end
@atype[t] = [pat, block]
end
See OptionParser.accept.
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 851
def append(*args)
update(*args)
@list.push(args[0])
end
Appends switch at the tail of the list, and associates short, long and negated long options. Arguments are:
switch-
OptionParser::Switchinstance to be inserted. short_opts-
Listof short style options. long_opts-
Listof long style options. nolong_opts-
Listof long style options with “no-” prefix.
append(switch, short_opts, long_opts, nolong_opts)
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 873
def complete(id, opt, icase = false, *pat, &block)
__send__(id).complete(opt, icase, *pat, &block)
end
Searches list id for opt and the optional patterns for completion pat. If icase is true, the search is case insensitive. The result is returned or yielded if a block is given. If it isn’t found, nil is returned.
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 884
def each_option(&block)
list.each(&block)
end
Iterates over each option, passing the option to the block.
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 877
def get_candidates(id)
yield __send__(id).keys
end
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 835
def prepend(*args)
update(*args)
@list.unshift(args[0])
end
Inserts switch at the head of the list, and associates short, long and negated long options. Arguments are:
switch-
OptionParser::Switchinstance to be inserted. short_opts-
Listof short style options. long_opts-
Listof long style options. nolong_opts-
Listof long style options with “no-” prefix.
prepend(switch, short_opts, long_opts, nolong_opts)
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 803
def reject(t)
@atype.delete(t)
end
See OptionParser.reject.
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 860
def search(id, key)
if list = __send__(id)
val = list.fetch(key) {return nil}
block_given? ? yield(val) : val
end
end
Searches key in id list. The result is returned or yielded if a block is given. If it isn’t found, nil is returned.
# File tmp/rubies/ruby-3.1.3/lib/optparse.rb, line 893
def summarize(*args, &block)
sum = []
list.reverse_each do |opt|
if opt.respond_to?(:summarize) # perhaps OptionParser::Switch
s = []
opt.summarize(*args) {|l| s << l}
sum.concat(s.reverse)
elsif !opt or opt.empty?
sum << ""
elsif opt.respond_to?(:each_line)
sum.concat([*opt.each_line].reverse)
else
sum.concat([*opt.each].reverse)
end
end
sum.reverse_each(&block)
end
Creates the summary table, passing each line to the block (without newline). The arguments args are passed along to the summarize method which is called on every option.