Class: OptionParser::Switch
- Inherits:
-
Object
- Object
- OptionParser::Switch
- Defined in:
- lib/optparse.rb
Overview
Individual switch class. Not important to the user.
Defined within Switch are several Switch-derived classes: NoArgument, RequiredArgument, etc.
Direct Known Subclasses
NoArgument, OptionalArgument, PlacedArgument, RequiredArgument
Defined Under Namespace
Classes: NoArgument, OptionalArgument, PlacedArgument, RequiredArgument
Instance Attribute Summary collapse
-
#arg ⇒ Object
readonly
Returns the value of attribute arg.
-
#block ⇒ Object
readonly
Returns the value of attribute block.
-
#conv ⇒ Object
readonly
Returns the value of attribute conv.
-
#desc ⇒ Object
readonly
Returns the value of attribute desc.
-
#long ⇒ Object
readonly
Returns the value of attribute long.
-
#pattern ⇒ Object
readonly
Returns the value of attribute pattern.
-
#short ⇒ Object
readonly
Returns the value of attribute short.
Class Method Summary collapse
-
.guess(arg) ⇒ Object
Guesses argument style from
arg
. - .incompatible_argument_styles(arg, t) ⇒ Object
- .pattern ⇒ Object
Instance Method Summary collapse
-
#add_banner(to) ⇒ Object
:nodoc:.
-
#compsys(sdone, ldone) ⇒ Object
:nodoc:.
-
#initialize(pattern = nil, conv = nil, short = nil, long = nil, arg = nil, desc = ([] if short or long), block = Proc.new) ⇒ Switch
constructor
A new instance of Switch.
-
#match_nonswitch?(str) ⇒ Boolean
:nodoc:.
-
#summarize(sdone = [], ldone = [], width = 1, max = width - 1, indent = "") ⇒ Object
Produces the summary text.
-
#switch_name ⇒ Object
Main name of the switch.
Constructor Details
#initialize(pattern = nil, conv = nil, short = nil, long = nil, arg = nil, desc = ([] if short or long), block = Proc.new) ⇒ Switch
Returns a new instance of Switch.
327 328 329 330 331 332 333 |
# File 'lib/optparse.rb', line 327 def initialize(pattern = nil, conv = nil, short = nil, long = nil, arg = nil, desc = ([] if short or long), block = Proc.new) raise if Array === pattern @pattern, @conv, @short, @long, @arg, @desc, @block = pattern, conv, short, long, arg, desc, block end |
Instance Attribute Details
#arg ⇒ Object (readonly)
Returns the value of attribute arg
297 298 299 |
# File 'lib/optparse.rb', line 297 def arg @arg end |
#block ⇒ Object (readonly)
Returns the value of attribute block
297 298 299 |
# File 'lib/optparse.rb', line 297 def block @block end |
#conv ⇒ Object (readonly)
Returns the value of attribute conv
297 298 299 |
# File 'lib/optparse.rb', line 297 def conv @conv end |
#desc ⇒ Object (readonly)
Returns the value of attribute desc
297 298 299 |
# File 'lib/optparse.rb', line 297 def desc @desc end |
#long ⇒ Object (readonly)
Returns the value of attribute long
297 298 299 |
# File 'lib/optparse.rb', line 297 def long @long end |
#pattern ⇒ Object (readonly)
Returns the value of attribute pattern
297 298 299 |
# File 'lib/optparse.rb', line 297 def pattern @pattern end |
#short ⇒ Object (readonly)
Returns the value of attribute short
297 298 299 |
# File 'lib/optparse.rb', line 297 def short @short end |
Class Method Details
.guess(arg) ⇒ Object
Guesses argument style from arg
. Returns corresponding OptionParser::Switch class (OptionalArgument, etc.).
303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/optparse.rb', line 303 def self.guess(arg) case arg when "" t = self when /\A=?\[/ t = Switch::OptionalArgument when /\A\s+\[/ t = Switch::PlacedArgument else t = Switch::RequiredArgument end self >= t or incompatible_argument_styles(arg, t) t end |
.incompatible_argument_styles(arg, t) ⇒ Object
318 319 320 321 |
# File 'lib/optparse.rb', line 318 def self.incompatible_argument_styles(arg, t) raise(ArgumentError, "#{arg}: incompatible argument styles\n #{self}, #{t}", ParseError.filter_backtrace(caller(2))) end |
.pattern ⇒ Object
323 324 325 |
# File 'lib/optparse.rb', line 323 def self.pattern NilClass end |
Instance Method Details
#add_banner(to) ⇒ Object
:nodoc:
423 424 425 426 427 428 429 |
# File 'lib/optparse.rb', line 423 def (to) # :nodoc: unless @short or @long s = desc.join to << " [" + s + "]..." unless s.empty? end to end |
#compsys(sdone, ldone) ⇒ Object
:nodoc:
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 |
# File 'lib/optparse.rb', line 442 def compsys(sdone, ldone) # :nodoc: sopts, lopts = [], [] @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 (sopts+lopts).each do |opt| # "(-x -c -r)-l[left justify]" \ if /^--\[no-\](.+)$/ =~ opt o = $1 yield("--#{o}", desc.join("")) yield("--no-#{o}", desc.join("")) else yield("#{opt}", desc.join("")) end end end |
#match_nonswitch?(str) ⇒ Boolean
:nodoc:
431 432 433 |
# File 'lib/optparse.rb', line 431 def match_nonswitch?(str) # :nodoc: @pattern =~ str unless @short or @long end |
#summarize(sdone = [], ldone = [], width = 1, max = width - 1, indent = "") ⇒ Object
Produces the summary text. Each line of the summary is yielded to the block (without newline).
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 words, the right side (description part) starts after
width
columns. max
-
Maximum width of left side -> the options are filled within
max
columns. indent
-
Prefix string indents all summarized lines.
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/optparse.rb', line 386 def summarize(sdone = [], ldone = [], width = 1, max = width - 1, indent = "") sopts, lopts = [], [], 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 l = left[-1].length + s.length l += arg.length if left.size == 1 && arg l < max or sopts.empty? or left << '' left[-1] << if left[-1].empty? then ' ' * 4 else ', ' end << s end if arg left[0] << (left[1] ? arg.sub(/\A(\[?)=/, '\1') + ',' : arg) end mlen = left.collect {|ss| ss.length}.max.to_i while mlen > width and l = left.shift mlen = left.collect {|ss| ss.length}.max.to_i if l.length == mlen if l.length < width and (r = right[0]) and !r.empty? l = l.to_s.ljust(width) + ' ' + r right.shift end yield(indent + l) end while begin l = left.shift; r = right.shift; l or r end l = l.to_s.ljust(width) + ' ' + r if r and !r.empty? yield(indent + l) end self end |
#switch_name ⇒ Object
Main name of the switch.
438 439 440 |
# File 'lib/optparse.rb', line 438 def switch_name (long.first || short.first).sub(/\A-+(?:\[no-\])?/, '') end |