class Gem::OptionParser::List
Simple option list providing mapping from short and/or long option string to Gem::OptionParser::Switch
and mapping from acceptable argument to matching pattern and converter pair. Also provides summary feature.
Attributes
Map from acceptable argument types to pattern and converter pairs.
List
of all switches and summary string.
Map from long style option switches to actual switch objects.
Map from short style option switches to actual switch objects.
Public Class Methods
Just initializes all instance variables.
# File rubygems/vendor/optparse/lib/optparse.rb, line 816 def initialize @atype = {} @short = OptionMap.new @long = OptionMap.new @list = [] end
Public Instance Methods
# File rubygems/vendor/optparse/lib/optparse.rb, line 837 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
Appends switch
at the tail of the list, and associates short, long and negated long options. Arguments are:
switch
-
Gem::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.
append(switch, short_opts, long_opts, nolong_opts)
# File rubygems/vendor/optparse/lib/optparse.rb, line 901 def append(*args) update(*args) @list.push(args[0]) 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 rubygems/vendor/optparse/lib/optparse.rb, line 923 def complete(id, opt, icase = false, *pat, &block) __send__(id).complete(opt, icase, *pat, &block) end
Iterates over each option, passing the option to the block
.
# File rubygems/vendor/optparse/lib/optparse.rb, line 934 def each_option(&block) list.each(&block) end
# File rubygems/vendor/optparse/lib/optparse.rb, line 927 def get_candidates(id) yield __send__(id).keys end
Inserts switch
at the head of the list, and associates short, long and negated long options. Arguments are:
switch
-
Gem::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.
prepend(switch, short_opts, long_opts, nolong_opts)
# File rubygems/vendor/optparse/lib/optparse.rb, line 885 def prepend(*args) update(*args) @list.unshift(args[0]) end
# File rubygems/vendor/optparse/lib/optparse.rb, line 853 def reject(t) @atype.delete(t) 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 rubygems/vendor/optparse/lib/optparse.rb, line 910 def search(id, key) if list = __send__(id) val = list.fetch(key) {return nil} block_given? ? yield(val) : val end 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.
# File rubygems/vendor/optparse/lib/optparse.rb, line 943 def summarize(*args, &block) sum = [] list.reverse_each do |opt| if opt.respond_to?(:summarize) # perhaps Gem::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