Class: Main::GetoptLong

Inherits:
Object show all
Defined in:
lib/main/getoptlong.rb

Defined Under Namespace

Classes: AmbigousOption, InvalidOption, MissingArgument, NeedlessArgument

Constant Summary collapse

ORDERINGS =

Orderings.

[REQUIRE_ORDER = 0, PERMUTE = 1, RETURN_IN_ORDER = 2]
ARGUMENT_FLAGS =

Argument flags.

[NO_ARGUMENT = 0, REQUIRED_ARGUMENT = 1,
OPTIONAL_ARGUMENT = 2]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv, *arguments) ⇒ GetoptLong

Initializer.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/main/getoptlong.rb', line 45

def initialize(argv, *arguments)
  @argv = argv
  #
  # Current ordering.
  #
  if ENV.include?('POSIXLY_CORRECT')
    @ordering = REQUIRE_ORDER
  else
    @ordering = PERMUTE
  end

  #
  # Hash table of option names.
  # Keyes of the table are option names, and their values are canonical
  # names of the options.
  #
  @canonical_names = Hash.new

  #
  # Hash table of argument flags.
  # Keyes of the table are option names, and their values are argument
  # flags of the options.
  #
  @argument_flags = Hash.new

  #
  # Whether error messages are output to stderr.
  #
  @quiet = false

  #
  # Status code.
  #
  @status = STATUS_YET

  #
  # Error code.
  #
  @error = nil

  #
  # Error message.
  #
  @error_message = nil

  #
  # Rest of catinated short options.
  #
  @rest_singles = ''

  #
  # List of non-option-arguments.
  # Append them to @argv when option processing is terminated.
  #
  @non_option_arguments = Array.new

  if 0 < arguments.length
    set_options(*arguments)
  end
end

Instance Attribute Details

#error ⇒ Object (readonly) Also known as: error?

Examine whether an option processing is failed.



273
274
275
 
# File 'lib/main/getoptlong.rb', line 273

def error
  @error
end

#ordering ⇒ Object

Return ordering.



135
136
137
 
# File 'lib/main/getoptlong.rb', line 135

def ordering
  @ordering
end

#quiet ⇒ Object Also known as: quiet?

Return the flag of ‘quiet’ mode.



219
220
221
 
# File 'lib/main/getoptlong.rb', line 219

def quiet
  @quiet
end

Instance Method Details

#each ⇒ Object Also known as: each_option

Iterator version of ‘get’.



457
458
459
460
461
462
463
 
# File 'lib/main/getoptlong.rb', line 457

def each
  loop do
    option_name, option_argument = get_option
    break if option_name == nil
    yield option_name, option_argument
  end
end

#error_message ⇒ Object

Return an error message.



283
284
285
 
# File 'lib/main/getoptlong.rb', line 283

def error_message
  return @error_message
end

#get ⇒ Object Also known as: get_option

Get next option name and its argument as an array.



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
319
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/main/getoptlong.rb', line 290

def get
  option_name, option_argument = nil, ''

  #
  # Check status.
  #
  return nil if @error != nil
  case @status
  when STATUS_YET
    @status = STATUS_STARTED
  when STATUS_TERMINATED
    return nil
  end

  #
  # Get next option argument.
  #
  if 0 < @rest_singles.length
    argument = '-' + @rest_singles
  elsif (@argv.length == 0)
    terminate
    return nil
  elsif @ordering == PERMUTE
    while 0 < @argv.length && @argv[0] !~ /^-./
	@non_option_arguments.push(@argv.shift)
    end
    if @argv.length == 0
	terminate
	return nil
    end
    argument = @argv.shift
  elsif @ordering == REQUIRE_ORDER 
    if (@argv[0] !~ /^-./)
	terminate
	return nil
    end
    argument = @argv.shift
  else
    argument = @argv.shift
  end

  #
  # Check the special argument `--'.
  # `--' indicates the end of the option list.
  #
  if argument == '--' && @rest_singles.length == 0
    terminate
    return nil
  end

  #
  # Check for long and short options.
  #
  if argument =~ /^(--[^=]+)/ && @rest_singles.length == 0
    #
    # This is a long style option, which start with `--'.
    #
    pattern = $1
    if @canonical_names.include?(pattern)
	option_name = pattern
    else
	#
	# The option `option_name' is not registered in `@canonical_names'.
	# It may be an abbreviated.
	#
	match_count = 0
	@canonical_names.each_key do |key|
 if key.index(pattern) == 0
   option_name = key
   match_count += 1
 end
	end
	if 2 <= match_count
 set_error(AmbigousOption, "option `#{argument}' is ambiguous")
	elsif match_count == 0
 set_error(InvalidOption, "unrecognized option `#{argument}'")
	end
    end

    #
    # Check an argument to the option.
    #
    if @argument_flags[option_name] == REQUIRED_ARGUMENT
	if argument =~ /=(.*)$/
 option_argument = $1
	elsif 0 < @argv.length
 option_argument = @argv.shift
	else
 set_error(MissingArgument,
           "option `#{argument}' requires an argument")
	end
    elsif @argument_flags[option_name] == OPTIONAL_ARGUMENT
	if argument =~ /=(.*)$/
 option_argument = $1
	elsif 0 < @argv.length && @argv[0] !~ /^-./
 option_argument = @argv.shift
	else
 option_argument = ''
	end
    elsif argument =~ /=(.*)$/
	set_error(NeedlessArgument,
  "option `#{option_name}' doesn't allow an argument")
    end

  elsif argument =~ /^(-(.))(.*)/
    #
    # This is a short style option, which start with `-' (not `--').
    # Short options may be catinated (e.g. `-l -g' is equivalent to
    # `-lg').
    #
    option_name, ch, @rest_singles = $1, $2, $3

    if @canonical_names.include?(option_name)
	#
	# The option `option_name' is found in `@canonical_names'.
	# Check its argument.
	#
	if @argument_flags[option_name] == REQUIRED_ARGUMENT
 if 0 < @rest_singles.length
   option_argument = @rest_singles
   @rest_singles = ''
 elsif 0 < @argv.length
   option_argument = @argv.shift
 else
   # 1003.2 specifies the format of this message.
   set_error(MissingArgument, "option requires an argument -- #{ch}")
 end
	elsif @argument_flags[option_name] == OPTIONAL_ARGUMENT
 if 0 < @rest_singles.length
   option_argument = @rest_singles
   @rest_singles = ''
 elsif 0 < @argv.length && @argv[0] !~ /^-./
   option_argument = @argv.shift
 else
   option_argument = ''
 end
	end
    else
	#
	# This is an invalid option.
	# 1003.2 specifies the format of this message.
	#
	if ENV.include?('POSIXLY_CORRECT')
 set_error(InvalidOption, "illegal option -- #{ch}")
	else
 set_error(InvalidOption, "invalid option -- #{ch}")
	end
    end
  else
    #
    # This is a non-option argument.
    # Only RETURN_IN_ORDER falled into here.
    #
    return '', argument
  end

  return @canonical_names[option_name], option_argument
end

#set_options(*arguments) ⇒ Object

Set options



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
 
# File 'lib/main/getoptlong.rb', line 140

def set_options(*arguments)
  #
  # The method is failed if option processing has already started.
  #
  if @status != STATUS_YET
    raise RuntimeError, 
	"invoke set_options, but option processing has already started"
  end

  #
  # Clear tables of option names and argument flags.
  #
  @canonical_names.clear
  @argument_flags.clear

  arguments.each do |arg|
    #
    # Each argument must be an Array.
    #
    if !arg.is_a?(Array)
	raise ArgumentError, "the option list contains non-Array argument"
    end

    #
    # Find an argument flag and it set to `argument_flag'.
    #
    argument_flag = nil
    arg.each do |i|
	if ARGUMENT_FLAGS.include?(i)
 if argument_flag != nil
   raise ArgumentError, "too many argument-flags"
 end
 argument_flag = i
	end
    end
    raise ArgumentError, "no argument-flag" if argument_flag == nil

    canonical_name = nil
    arg.each do |i|
	#
	# Check an option name.
	#
	next if i == argument_flag
	begin
 if !i.is_a?(String) || i !~ /^-([^-]|-.+)$/
   raise ArgumentError, "an invalid option `#{i}'"
 end
 if (@canonical_names.include?(i))
   raise ArgumentError, "option redefined `#{i}'"
 end
	rescue
 @canonical_names.clear
 @argument_flags.clear
 raise
	end

	#
	# Register the option (`i') to the `@canonical_names' and 
	# `@canonical_names' Hashes.
	#
	if canonical_name == nil
 canonical_name = i
	end
	@canonical_names[i] = canonical_name
	@argument_flags[i] = argument_flag
    end
    raise ArgumentError, "no option name" if canonical_name == nil
  end
  return self
end

#terminate ⇒ Object

Termintate option processing.

Raises:

  • (RuntimeError) 


229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/main/getoptlong.rb', line 229

def terminate
  return nil if @status == STATUS_TERMINATED
  raise RuntimeError, "an error has occured" if @error != nil

  @status = STATUS_TERMINATED
  @non_option_arguments.reverse_each do |argument|
    @argv.unshift(argument)
  end

  @canonical_names = nil
  @argument_flags = nil
  @rest_singles = nil
  @non_option_arguments = nil

  return self
end

#terminated? ⇒ Boolean

Examine whether option processing is termintated or not.

Returns:

  • (Boolean) 


249
250
251
 
# File 'lib/main/getoptlong.rb', line 249

def terminated?
  return @status == STATUS_TERMINATED
end