Class: Trollop::Parser

Inherits:
Object
  • Object
show all
Defined in:
lib/trollop.rb

Overview

The commandline parser. In typical usage, the methods in this class will be handled internally by Trollop::options. In this case, only the #opt, #banner and #version, #depends, and #conflicts methods will typically be called.

If you want to instantiate this class yourself (for more complicated argument-parsing logic), call #parse to actually produce the output hash, and consider calling it from within Trollop::with_standard_exception_handling.

Constant Summary collapse

FLAG_TYPES =

The set of values that indicate a flag option when passed as the :type parameter of #opt.

[:flag, :bool, :boolean]
SINGLE_ARG_TYPES =

The set of values that indicate a single-parameter (normal) option when passed as the :type parameter of #opt.

A value of io corresponds to a readable IO resource, including a filename, URI, or the strings ‘stdin’ or ‘-’.

[:int, :integer, :string, :double, :float, :io, :date]
MULTI_ARG_TYPES =

The set of values that indicate a multiple-parameter option (i.e., that takes multiple space-separated values on the commandline) when passed as the :type parameter of #opt.

[:ints, :integers, :strings, :doubles, :floats, :ios, :dates]
TYPES =

The complete set of legal values for the :type parameter of #opt.

FLAG_TYPES + SINGLE_ARG_TYPES + MULTI_ARG_TYPES
INVALID_SHORT_ARG_REGEX =

:nodoc:

/[\d-]/

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*a, &b) ⇒ Parser

Initializes the parser, and instance-evaluates any block given.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/trollop.rb', line 84

def initialize(*a, &b)
  @version = nil
  @leftovers = []
  @specs = {}
  @long = {}
  @short = {}
  @order = []
  @constraints = []
  @stop_words = []
  @stop_on_unknown = false
  @educate_on_error = false

  # instance_eval(&b) if b # can't take arguments
  cloaker(&b).bind(self).call(*a) if b
end

Instance Attribute Details

#ignore_invalid_options ⇒ Object

A flag that determines whether or not to raise an error if the parser is passed one or more

options that were not registered ahead of time.  If 'true', then the parser will simply
ignore options that it does not recognize.



81
82
83
 
# File 'lib/trollop.rb', line 81

def ignore_invalid_options
  @ignore_invalid_options
end

#leftovers ⇒ Object (readonly)

The values from the commandline that were not interpreted by #parse.



72
73
74
 
# File 'lib/trollop.rb', line 72

def leftovers
  @leftovers
end

#specs ⇒ Object (readonly)

The complete configuration hashes for each option. (Mainly useful for testing.)



76
77
78
 
# File 'lib/trollop.rb', line 76

def specs
  @specs
end

Instance Method Details

Adds text to the help display. Can be interspersed with calls to #opt to build a multi-section help page.



276
277
278
 
# File 'lib/trollop.rb', line 276

def banner(s)
  @order << [:text, s]
end

#conflicts(*syms) ⇒ Object

Marks two (or more!) options as conflicting.



290
291
292
293
 
# File 'lib/trollop.rb', line 290

def conflicts(*syms)
  syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
  @constraints << [:conflicts, syms]
end

#depends(*syms) ⇒ Object

Marks two (or more!) options as requiring each other. Only handles undirected (i.e., mutual) dependencies. Directed dependencies are better modeled with Trollop::die.



284
285
286
287
 
# File 'lib/trollop.rb', line 284

def depends(*syms)
  syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
  @constraints << [:depends, syms]
end

#die(arg, msg = nil, error_code = nil) ⇒ Object

The per-parser version of Trollop::die (see that for documentation).



580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/trollop.rb', line 580

def die(arg, msg = nil, error_code = nil)
  if msg
    $stderr.puts "Error: argument --#{@specs[arg][:long]} #{msg}."
  else
    $stderr.puts "Error: #{arg}."
  end
  if @educate_on_error
    $stderr.puts
    educate $stderr
  else
    $stderr.puts "Try --help for help."
  end
  exit(error_code || -1)
end

#educate(stream = $stdout) ⇒ Object

Print the help message to stream.



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/trollop.rb', line 476

def educate(stream = $stdout)
  width # hack: calculate it now; otherwise we have to be careful not to
        # call this unless the cursor's at the beginning of a line.
  left = {}
  @specs.each do |name, spec|
    left[name] =
      (spec[:short] && spec[:short] != :none ? "-#{spec[:short]}" : "") +
      (spec[:short] && spec[:short] != :none ? ", " : "") + "--#{spec[:long]}" +
      case spec[:type]
      when :flag    then ""
      when :int     then "=<i>"
      when :ints    then "=<i+>"
      when :string  then "=<s>"
      when :strings then "=<s+>"
      when :float   then "=<f>"
      when :floats  then "=<f+>"
      when :io      then "=<filename/uri>"
      when :ios     then "=<filename/uri+>"
      when :date    then "=<date>"
      when :dates   then "=<date+>"
      end +
      (spec[:type] == :flag && spec[:default] ? ", --no-#{spec[:long]}" : "")
  end

  leftcol_width = left.values.map(&:length).max || 0
  rightcol_start = leftcol_width + 6 # spaces

  unless @order.size > 0 && @order.first.first == :text
    command_name = File.basename($0).gsub(/\.[^.]+$/, '')
    stream.puts "Usage: #{command_name} #{@usage}\n" if @usage
    stream.puts "#{@synopsis}\n" if @synopsis
    stream.puts if @usage || @synopsis
    stream.puts "#{@version}\n" if @version
    stream.puts "Options:"
  end

  @order.each do |what, opt|
    if what == :text
      stream.puts wrap(opt)
      next
    end

    spec = @specs[opt]
    stream.printf "  %-#{leftcol_width}s    ", left[opt]
    desc = spec[:desc] + begin
      default_s = case spec[:default]
      when $stdout   then "<stdout>"
      when $stdin    then "<stdin>"
      when $stderr   then "<stderr>"
      when Array
        spec[:default].join(", ")
      else
        spec[:default].to_s
      end

      if spec[:default]
        if spec[:desc] =~ /\.$/
          " (Default: #{default_s})"
        else
          " (default: #{default_s})"
        end
      else
        ""
      end
    end
    stream.puts wrap(desc, :width => width - rightcol_start - 1, :prefix => rightcol_start)
  end
end

#educate_on_error ⇒ Object

Instead of displaying “Try –help for help.” on an error display the usage (via educate)



318
319
320
 
# File 'lib/trollop.rb', line 318

def educate_on_error
  @educate_on_error = true
end

#opt(name, desc = "", opts = {}, &b) ⇒ Object

Define an option. name is the option name, a unique identifier for the option that you will use internally, which should be a symbol or a string. desc is a string description which will be displayed in help messages.

Takes the following optional arguments:

:long

Specify the long form of the argument, i.e. the form with two dashes. If unspecified, will be automatically derived based on the argument name by turning the name option into a string, and replacing any _’s by -‘s.

:short

Specify the short form of the argument, i.e. the form with one dash. If unspecified, will be automatically derived from name. Use :none: to not have a short value.

:type

Require that the argument take a parameter or parameters of type type. For a single parameter, the value can be a member of SINGLE_ARG_TYPES, or a corresponding Ruby class (e.g. Integer for :int). For multiple-argument parameters, the value can be any member of MULTI_ARG_TYPES constant. If unset, the default argument type is :flag, meaning that the argument does not take a parameter. The specification of :type is not necessary if a :default is given.

:default

Set the default value for an argument. Without a default value, the hash returned by #parse (and thus Trollop::options) will have a nil value for this key unless the argument is given on the commandline. The argument type is derived automatically from the class of the default value given, so specifying a :type is not necessary if a :default is given. (But see below for an important caveat when :multi: is specified too.) If the argument is a flag, and the default is set to true, then if it is specified on the the commandline the value will be false.

:required

If set to true, the argument must be provided on the commandline.

:multi

If set to true, allows multiple occurrences of the option on the commandline. Otherwise, only a single instance of the option is allowed. (Note that this is different from taking multiple parameters. See below.)

Note that there are two types of argument multiplicity: an argument can take multiple values, e.g. “–arg 1 2 3”. An argument can also be allowed to occur multiple times, e.g. “–arg 1 –arg 2”.

Arguments that take multiple values should have a :type parameter drawn from MULTI_ARG_TYPES (e.g. :strings), or a :default: value of an array of the correct type (e.g. [String]). The value of this argument will be an array of the parameters on the commandline.

Arguments that can occur multiple times should be marked with :multi => true. The value of this argument will also be an array. In contrast with regular non-multi options, if not specified on the commandline, the default value will be [], not nil.

These two attributes can be combined (e.g. :type => :strings, :multi => true), in which case the value of the argument will be an array of arrays.

There’s one ambiguous case to be aware of: when :multi: is true and a :default is set to an array (of something), it’s ambiguous whether this is a multi-value argument as well as a multi-occurrence argument. In thise case, Trollop assumes that it’s not a multi-value argument. If you want a multi-value, multi-occurrence argument with a default value, you must specify :type as well.

Raises:

  • (ArgumentError) 


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/trollop.rb', line 140

def opt(name, desc = "", opts = {}, &b)
  raise ArgumentError, "you already have an argument named '#{name}'" if @specs.member? name

  ## fill in :type
  opts[:type] = # normalize
    case opts[:type]
    when :boolean, :bool then :flag
    when :integer        then :int
    when :integers       then :ints
    when :double         then :float
    when :doubles        then :floats
    when Class
      case opts[:type].name
      when 'TrueClass',
           'FalseClass'  then :flag
      when 'String'      then :string
      when 'Integer'     then :int
      when 'Float'       then :float
      when 'IO'          then :io
      when 'Date'        then :date
      else
        raise ArgumentError, "unsupported argument type '#{opts[:type].class.name}'"
      end
    when nil             then nil
    else
      raise ArgumentError, "unsupported argument type '#{opts[:type]}'" unless TYPES.include?(opts[:type])
      opts[:type]
    end

  ## for options with :multi => true, an array default doesn't imply
  ## a multi-valued argument. for that you have to specify a :type
  ## as well. (this is how we disambiguate an ambiguous situation;
  ## see the docs for Parser#opt for details.)
  disambiguated_default = if opts[:multi] && opts[:default].kind_of?(Array) && !opts[:type]
    opts[:default].first
  else
    opts[:default]
  end

  type_from_default =
    case disambiguated_default
    when Integer     then :int
    when Numeric     then :float
    when TrueClass,
         FalseClass  then :flag
    when String      then :string
    when IO          then :io
    when Date        then :date
    when Array
      if opts[:default].empty?
        if opts[:type]
          raise ArgumentError, "multiple argument type must be plural" unless MULTI_ARG_TYPES.include?(opts[:type])
          nil
        else
          raise ArgumentError, "multiple argument type cannot be deduced from an empty array for '#{opts[:default][0].class.name}'"
        end
      else
        case opts[:default][0]    # the first element determines the types
        when Integer then :ints
        when Numeric then :floats
        when String  then :strings
        when IO      then :ios
        when Date    then :dates
        else
          raise ArgumentError, "unsupported multiple argument type '#{opts[:default][0].class.name}'"
        end
      end
    when nil         then nil
    else
      raise ArgumentError, "unsupported argument type '#{opts[:default].class.name}'"
    end

  raise ArgumentError, ":type specification and default type don't match (default type is #{type_from_default})" if opts[:type] && type_from_default && opts[:type] != type_from_default

  opts[:type] = opts[:type] || type_from_default || :flag

  ## fill in :long
  opts[:long] = opts[:long] ? opts[:long].to_s : name.to_s.gsub("_", "-")
  opts[:long] = case opts[:long]
    when /^--([^-].*)$/ then $1
    when /^[^-]/        then opts[:long]
    else                     raise ArgumentError, "invalid long option name #{opts[:long].inspect}"
  end
  raise ArgumentError, "long option name #{opts[:long].inspect} is already taken; please specify a (different) :long" if @long[opts[:long]]

  ## fill in :short
  opts[:short] = opts[:short].to_s if opts[:short] && opts[:short] != :none
  opts[:short] = case opts[:short]
    when /^-(.)$/          then $1
    when nil, :none, /^.$/ then opts[:short]
    else                   raise ArgumentError, "invalid short option name '#{opts[:short].inspect}'"
  end

  if opts[:short]
    raise ArgumentError, "short option name #{opts[:short].inspect} is already taken; please specify a (different) :short" if @short[opts[:short]]
    raise ArgumentError, "a short option name can't be a number or a dash" if opts[:short] =~ INVALID_SHORT_ARG_REGEX
  end

  ## fill in :default for flags
  opts[:default] = false if opts[:type] == :flag && opts[:default].nil?

  ## autobox :default for :multi (multi-occurrence) arguments
  opts[:default] = [opts[:default]] if opts[:default] && opts[:multi] && !opts[:default].kind_of?(Array)

  ## fill in :multi
  opts[:multi] ||= false
  opts[:callback] ||= b if block_given?
  opts[:desc] ||= desc
  @long[opts[:long]] = name
  @short[opts[:short]] = name if opts[:short] && opts[:short] != :none
  @specs[name] = opts
  @order << [:opt, name]
end

#parse(cmdline = ARGV) ⇒ Object

Parses the commandline. Typically called by Trollop::options, but you can call it directly if you need more control.

throws CommandlineError, HelpNeeded, and VersionNeeded exceptions.

Raises:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/trollop.rb', line 326

def parse(cmdline = ARGV)
  vals = {}
  required = {}

  opt :version, "Print version and exit" if @version && ! (@specs[:version] || @long["version"])
  opt :help, "Show this message" unless @specs[:help] || @long["help"]

  @specs.each do |sym, opts|
    required[sym] = true if opts[:required]
    vals[sym] = opts[:default]
    vals[sym] = [] if opts[:multi] && !opts[:default] # multi arguments default to [], not nil
  end

  resolve_default_short_options!

  ## resolve symbols
  given_args = {}
  @leftovers = each_arg cmdline do |arg, params|
    ## handle --no- forms
    arg, negative_given = if arg =~ /^--no-([^-]\S*)$/
      ["--#{$1}", true]
    else
      [arg, false]
    end

    sym = case arg
      when /^-([^-])$/      then @short[$1]
      when /^--([^-]\S*)$/  then @long[$1] || @long["no-#{$1}"]
      else                       raise CommandlineError, "invalid argument syntax: '#{arg}'"
    end

    sym = nil if arg =~ /--no-/ # explicitly invalidate --no-no- arguments

    next 0 if ignore_invalid_options && !sym
    raise CommandlineError, "unknown argument '#{arg}'" unless sym

    if given_args.include?(sym) && !@specs[sym][:multi]
      raise CommandlineError, "option '#{arg}' specified multiple times"
    end

    given_args[sym] ||= {}
    given_args[sym][:arg] = arg
    given_args[sym][:negative_given] = negative_given
    given_args[sym][:params] ||= []

    # The block returns the number of parameters taken.
    num_params_taken = 0

    unless params.nil?
      if SINGLE_ARG_TYPES.include?(@specs[sym][:type])
        given_args[sym][:params] << params[0, 1]  # take the first parameter
        num_params_taken = 1
      elsif MULTI_ARG_TYPES.include?(@specs[sym][:type])
        given_args[sym][:params] << params        # take all the parameters
        num_params_taken = params.size
      end
    end

    num_params_taken
  end

  ## check for version and help args
  raise VersionNeeded if given_args.include? :version
  raise HelpNeeded if given_args.include? :help

  ## check constraint satisfaction
  @constraints.each do |type, syms|
    constraint_sym = syms.find { |sym| given_args[sym] }
    next unless constraint_sym

    case type
    when :depends
      syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym][:long]} requires --#{@specs[sym][:long]}" unless given_args.include? sym }
    when :conflicts
      syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym][:long]} conflicts with --#{@specs[sym][:long]}" if given_args.include?(sym) && (sym != constraint_sym) }
    end
  end

  required.each do |sym, val|
    raise CommandlineError, "option --#{@specs[sym][:long]} must be specified" unless given_args.include? sym
  end

  ## parse parameters
  given_args.each do |sym, given_data|
    arg, params, negative_given = given_data.values_at :arg, :params, :negative_given

    opts = @specs[sym]
    if params.empty? && opts[:type] != :flag
      raise CommandlineError, "option '#{arg}' needs a parameter" unless opts[:default]
      params << (opts[:default].kind_of?(Array) ? opts[:default].clone : [opts[:default]])
    end

    vals["#{sym}_given".intern] = true # mark argument as specified on the commandline

    case opts[:type]
    when :flag
      vals[sym] = (sym.to_s =~ /^no_/ ? negative_given : !negative_given)
    when :int, :ints
      vals[sym] = params.map { |pg| pg.map { |p| parse_integer_parameter p, arg } }
    when :float, :floats
      vals[sym] = params.map { |pg| pg.map { |p| parse_float_parameter p, arg } }
    when :string, :strings
      vals[sym] = params.map { |pg| pg.map(&:to_s) }
    when :io, :ios
      vals[sym] = params.map { |pg| pg.map { |p| parse_io_parameter p, arg } }
    when :date, :dates
      vals[sym] = params.map { |pg| pg.map { |p| parse_date_parameter p, arg } }
    end

    if SINGLE_ARG_TYPES.include?(opts[:type])
      if opts[:multi]       # multiple options, each with a single parameter
        vals[sym] = vals[sym].map { |p| p[0] }
      else                  # single parameter
        vals[sym] = vals[sym][0][0]
      end
    elsif MULTI_ARG_TYPES.include?(opts[:type]) && !opts[:multi]
      vals[sym] = vals[sym][0]  # single option, with multiple parameters
    end
    # else: multiple options, with multiple parameters

    opts[:callback].call(vals[sym]) if opts.key?(:callback)
  end

  ## modify input in place with only those
  ## arguments we didn't process
  cmdline.clear
  @leftovers.each { |l| cmdline << l }

  ## allow openstruct-style accessors
  class << vals
    def method_missing(m, *_args)
      self[m] || self[m.to_s]
    end
  end
  vals
end

#parse_date_parameter(param, arg) ⇒ Object

:nodoc:



463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/trollop.rb', line 463

def parse_date_parameter(param, arg) #:nodoc:
  begin
    require 'chronic'
    time = Chronic.parse(param)
  rescue LoadError
    # chronic is not available
  end
  time ? Date.new(time.year, time.month, time.day) : Date.parse(param)
rescue ArgumentError
  raise CommandlineError, "option '#{arg}' needs a date"
end

#stop_on(*words) ⇒ Object

Defines a set of words which cause parsing to terminate when encountered, such that any options to the left of the word are parsed as usual, and options to the right of the word are left intact.

A typical use case would be for subcommand support, where these would be set to the list of subcommands. A subsequent Trollop invocation would then be used to parse subcommand options, after shifting the subcommand off of ARGV.



304
305
306
 
# File 'lib/trollop.rb', line 304

def stop_on(*words)
  @stop_words = [*words].flatten
end

#stop_on_unknown ⇒ Object

Similar to #stop_on, but stops on any unknown word when encountered (unless it is a parameter for an argument). This is useful for cases where you don’t know the set of subcommands ahead of time, i.e., without first parsing the global options.



312
313
314
 
# File 'lib/trollop.rb', line 312

def stop_on_unknown
  @stop_on_unknown = true
end

#synopsis(s = nil) ⇒ Object

Adds a synopsis (command summary description) right below the usage line, or as the first line if usage isn’t specified.



270
271
272
 
# File 'lib/trollop.rb', line 270

def synopsis(s = nil)
  s ? @synopsis = s : @synopsis
end

#usage(s = nil) ⇒ Object

Sets the usage string. If set the message will be printed as the first line in the help (educate) output and ending in two new lines.



264
265
266
 
# File 'lib/trollop.rb', line 264

def usage(s = nil)
  s ? @usage = s : @usage
end

#version(s = nil) ⇒ Object

Sets the version string. If set, the user can request the version on the commandline. Should probably be of the form “<program name> <version number>”.



257
258
259
 
# File 'lib/trollop.rb', line 257

def version(s = nil)
  s ? @version = s : @version
end

#width ⇒ Object

:nodoc:



545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/trollop.rb', line 545

def width #:nodoc:
  @width ||= if $stdout.tty?
    begin
      require 'io/console'
      IO.console.winsize.last
    rescue LoadError, NoMethodError, Errno::ENOTTY, Errno::EBADF, Errno::EINVAL
      legacy_width
    end
  else
    80
  end
end

#wrap(str, opts = {}) ⇒ Object

:nodoc:



566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/trollop.rb', line 566

def wrap(str, opts = {}) # :nodoc:
  if str == ""
    [""]
  else
    inner = false
    str.split("\n").map do |s|
      line = wrap_line s, opts.merge(:inner => inner)
      inner = true
      line
    end.flatten
  end
end