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 which case only the methods #opt, #banner and #version, #depends, and #conflicts will typically be called.

Constant Summary collapse

FLAG_TYPES =

The set of values that indicate a flag type of option when one of the values is given to the :type parameter to #opt.

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

The set of values that indicate an option that takes a single parameter when one of the values is given to the :type parameter to #opt.

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

The set of values that indicate an option that takes multiple parameters when one of the values is given to the :type parameter to #opt.

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

The set of values specifiable as the :type parameter to #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.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/trollop.rb', line 61

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

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

Instance Attribute Details

#leftovers ⇒ Object (readonly)

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



54
55
56
 
# File 'lib/trollop.rb', line 54

def leftovers
  @leftovers
end

#specs ⇒ Object (readonly)

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



58
59
60
 
# File 'lib/trollop.rb', line 58

def specs
  @specs
end

Instance Method Details

Adds text to the help display.



214
 
# File 'lib/trollop.rb', line 214

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

#cloaker(&b) ⇒ Object

instance_eval but with ability to handle block arguments thanks to why: redhanded.hobix.com/inspect/aBlockCostume.html



543
544
545
546
547
548
549
550
 
# File 'lib/trollop.rb', line 543

def cloaker &b #:nodoc:
  (class << self; self; end).class_eval do
    define_method :cloaker_, &b
    meth = instance_method :cloaker_
    remove_method :cloaker_
    meth
  end
end

#collect_argument_parameters(args, start_at) ⇒ Object

:nodoc:



436
437
438
439
440
441
442
443
444
 
# File 'lib/trollop.rb', line 436

def collect_argument_parameters args, start_at #:nodoc:
  params = []
  pos = start_at
  while args[pos] && args[pos] !~ PARAM_RE && !@stop_words.member?(args[pos]) do
    params << args[pos]
    pos += 1
  end
  params
end

#conflicts(*syms) ⇒ Object

Marks two (or more!) options as conflicting.



226
227
228
229
 
# File 'lib/trollop.rb', line 226

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.



220
221
222
223
 
# File 'lib/trollop.rb', line 220

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

#each_arg(args) ⇒ Object

yield successive arg, parameter pairs



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/trollop.rb', line 249

def each_arg args # :nodoc:
  remains = []
  i = 0

  until i >= args.length
    if @stop_words.member? args[i]
      remains += args[i .. -1]
      return remains
    end
    case args[i]
    when /^--$/ # arg terminator
      remains += args[(i + 1) .. -1]
      return remains
    when /^--(\S+?)=(\S+)$/ # long argument with equals
      yield "--#{$1}", [$2]
      i += 1
    when /^--(\S+)$/ # long argument
      params = collect_argument_parameters(args, i + 1)
      unless params.empty?
        num_params_taken = yield args[i], params
        unless num_params_taken
          if @stop_on_unknown
            remains += args[i + 1 .. -1]
            return remains
          else
            remains += params
          end
        end
        i += 1 + num_params_taken
      else # long argument no parameter
        yield args[i], nil
        i += 1
      end
    when /^-(\S+)$/ # one or more short arguments
      shortargs = $1.split(//)
      shortargs.each_with_index do |a, j|
        if j == (shortargs.length - 1)
          params = collect_argument_parameters(args, i + 1)
          unless params.empty?
            num_params_taken = yield "-#{a}", params
            unless num_params_taken
              if @stop_on_unknown
                remains += args[i + 1 .. -1]
                return remains
              else
                remains += params
              end
            end
            i += 1 + num_params_taken
          else # argument no parameter
            yield "-#{a}", nil
            i += 1
          end
        else
          yield "-#{a}", nil
        end
      end
    else
      if @stop_on_unknown
        remains += args[i .. -1]
        return remains
      else
        remains << args[i]
        i += 1
      end
    end
  end

  remains
end

#educate(stream = $stdout) ⇒ Object

Print the help message to ‘stream’.



464
465
466
467
468
469
470
471
472
473
474
475
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
 
# File 'lib/trollop.rb', line 464

def educate stream=$stdout
  width # just 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[:long]}" +
      (spec[:short] ? ", -#{spec[:short]}" : "") +
      case spec[:type]
      when :flag; ""
      when :int; " <i>"
      when :ints; " <i+>"
      when :string; " <s>"
      when :strings; " <s+>"
      when :float; " <f>"
      when :floats; " <f+>"
      end
  end

  leftcol_width = left.values.map { |s| s.length }.max || 0
  rightcol_start = leftcol_width + 6 # spaces

  unless @order.size > 0 && @order.first.first == :text
    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] + 
      if spec[:default]
        if spec[:desc] =~ /\.$/
          " (Default: #{spec[:default]})"
        else
          " (default: #{spec[:default]})"
        end
      else
        ""
      end
    stream.puts wrap(desc, :width => width - rightcol_start - 1, :prefix => rightcol_start)
  end
end

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

Add an option. ‘name’ is the argument name, a unique identifier for the option that you will use internally. ‘desc’ 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.

  • :short: Specify the short form of the argument, i.e. the form with one dash. If unspecified, will be automatically derived based on the argument name.

  • :type: Require that the argument take a parameter or parameters of type ‘type’. For a single parameter, the value can be a member of the SINGLE_ARG_TYPES constant or a corresponding class (e.g. Integer for :int). For multiple parameters, the value can be a member of the 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 :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 not contain the argument unless it is given on the commandline. The argument type is derived automatically from the class of the default value given, if any. Specifying a :flag argument on the commandline whose default value is true will change its value to false.

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

  • :multi: If set to true, allows multiple instances of the option. Otherwise, only a single instance of the option is allowed.

Raises:

  • (ArgumentError) 


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
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
 
# File 'lib/trollop.rb', line 107

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

  ## fill in :type
  opts[:type] = 
    case opts[:type]
    when :flag, :boolean, :bool; :flag
    when :int, :integer; :int
    when :ints, :integers; :ints
    when :string; :string
    when :strings; :strings
    when :double, :float; :float
    when :doubles, :floats; :floats
    when Class
      case opts[:type].to_s # sigh... there must be a better way to do this
      when 'TrueClass', 'FalseClass'; :flag
      when 'String'; :string
      when 'Integer'; :int
      when 'Float'; :float
      else
        raise ArgumentError, "unsupported argument type '#{opts[:type].class.name}'"
      end
    when nil; nil
    else
      raise ArgumentError, "unsupported argument type '#{opts[:type]}'" unless TYPES.include?(opts[:type])
    end

  type_from_default =
    case opts[:default]
    when Integer; :int
    when Numeric; :float
    when TrueClass, FalseClass; :flag
    when String; :string
    when Array
      if opts[:default].empty?
        raise ArgumentError, "multiple argument type cannot be deduced from an empty array for '#{opts[:default][0].class.name}'"
      end
      case opts[:default][0]    # the first element determines the types
      when Integer; :ints
      when Numeric; :floats
      when String; :strings
      else
        raise ArgumentError, "unsupported multiple argument type '#{opts[:default][0].class.name}'"
      end
    when nil; nil
    else
      raise ArgumentError, "unsupported argument type '#{opts[:default].class.name}'"
    end

  raise ArgumentError, ":type specification and default type don't match" 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 /^--([^-].*)$/
      $1
    when /^[^-]/
      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] unless opts[:short] == :none
  opts[:short] =
    case opts[:short]
    when nil
      c = opts[:long].split(//).find { |c| c !~ INVALID_SHORT_ARG_REGEX && !@short.member?(c) }
      raise ArgumentError, "can't generate a short option name for #{opts[:long].inspect}: out of unique characters" unless c
      c
    when /^-(.)$/
      $1
    when /^.$/
      opts[:short]
    when :none
      nil
    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?

  ## fill in :multi
  opts[:multi] ||= false

  opts[:desc] ||= desc
  @long[opts[:long]] = name
  @short[opts[:short]] = name if opts[:short]
  @specs[name] = opts
  @order << [:opt, name]
end

#parse(cmdline) ⇒ Object

:nodoc:

Raises:



320
321
322
323
324
325
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
 
# File 'lib/trollop.rb', line 320

def parse cmdline #:nodoc:
  vals = {}
  required = {}

  opt :version, "Print version and exit" if @version unless @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]
  end

  ## resolve symbols
  given_args = {}
  @leftovers = each_arg cmdline do |arg, params|
    sym = 
      case arg
      when /^-([^-])$/
        @short[$1]
      when /^--([^-]\S*)$/
        @long[$1]
      else
        raise CommandlineError, "invalid argument syntax: '#{arg}'"
      end
    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][: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 '#{sym}' must be specified" unless given_args.include? sym
  end

  ## parse parameters
  given_args.each do |sym, given_data|
    arg = given_data[:arg]
    params = given_data[:params]

    opts = @specs[sym]
    raise CommandlineError, "option '#{arg}' needs a parameter" if params.empty? && opts[:type] != :flag

    case opts[:type]
    when :flag
      vals[sym] = !opts[:default]
    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 { |p| p.to_s } }
    end

    if SINGLE_ARG_TYPES.include?(opts[:type])
      unless opts[:multi]       # single parameter
        vals[sym] = vals[sym][0][0]
      else                      # multiple options, each with a single parameter
        vals[sym] = vals[sym].map { |p| p[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
  end

  vals
end

#parse_float_parameter(param, arg) ⇒ Object

:nodoc:

Raises:



431
432
433
434
 
# File 'lib/trollop.rb', line 431

def parse_float_parameter param, arg #:nodoc:
  raise CommandlineError, "option '#{arg}' needs a floating-point number" unless param =~ FLOAT_RE
  param.to_f
end

#parse_integer_parameter(param, arg) ⇒ Object

:nodoc:

Raises:



426
427
428
429
 
# File 'lib/trollop.rb', line 426

def parse_integer_parameter param, arg #:nodoc:
  raise CommandlineError, "option '#{arg}' needs an integer" unless param =~ /^\d+$/
  param.to_i
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.



238
239
240
 
# File 'lib/trollop.rb', line 238

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).



244
245
246
 
# File 'lib/trollop.rb', line 244

def stop_on_unknown
  @stop_on_unknown = true
end

#version(s = nil) ⇒ Object

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



211
 
# File 'lib/trollop.rb', line 211

def version s=nil; @version = s if s; @version end

#width ⇒ Object

:nodoc:



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/trollop.rb', line 446

def width #:nodoc:
  @width ||= 
    if $stdout.tty?
      begin
        require 'curses'
        Curses::init_screen
        x = Curses::cols
        Curses::close_screen
        x
      rescue Exception
        80
      end
    else
      80
    end
end

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

:nodoc:



533
534
535
536
537
538
539
 
# File 'lib/trollop.rb', line 533

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

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

:nodoc:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/trollop.rb', line 513

def wrap_line str, opts={} # :nodoc:
  prefix = opts[:prefix] || 0
  width = opts[:width] || (self.width - 1)
  start = 0
  ret = []
  until start > str.length
    nextt = 
      if start + width >= str.length
        str.length
      else
        x = str.rindex(/\s/, start + width)
        x = str.index(/\s/, start) if x && x < start
        x || str.length
      end
    ret << (ret.empty? ? "" : " " * prefix) + str[start ... nextt]
    start = nextt + 1
  end
  ret
end