# frozen_string_literal: true
# Copyright (C) 1998, 1999, 2000 Motoyuki Kasahara.
# You may redistribute and/or modify this library under the same license
# See GetoptLong for documentation.
# Additional documents and the latest version of `getoptlong.rb' can be
# found at http://www.sra.co.jp/people/m-kasahr/ruby/getoptlong/
# The GetoptLong class allows you to parse command line options similarly to
# the GNU getopt_long() C library call. Note, however, that GetoptLong is a
# pure Ruby implementation.
# GetoptLong allows for POSIX-style options like <tt>--file</tt> as well
# as single letter options like <tt>-f</tt>
# The empty option <tt>--</tt> (two minus symbols) is used to end option
# processing. This can be particularly important if options have optional
# Here is a simple example of usage:
# [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
# [ '--repeat', '-n', GetoptLong::REQUIRED_ARGUMENT ],
# [ '--name', GetoptLong::OPTIONAL_ARGUMENT ]
# opts.each do |opt, arg|
# greet user by name, if name not supplied default is John
# DIR: The directory in which to issue the greeting.
# puts "Missing dir argument (try --help)"
# for i in (1..repetitions)
# hello -n 6 --name -- /tmp
ORDERINGS = [REQUIRE_ORDER = 0, PERMUTE = 1, RETURN_IN_ORDER = 2]
ARGUMENT_FLAGS = [NO_ARGUMENT = 0, REQUIRED_ARGUMENT = 1,
STATUS_YET, STATUS_STARTED, STATUS_TERMINATED = 0, 1, 2
class Error < StandardError; end
class AmbiguousOption < Error; end
class NeedlessArgument < Error; end
class MissingArgument < Error; end
class InvalidOption < Error; end
# Set up option processing.
# The options to support are passed to new() as an array of arrays.
# Each sub-array contains any number of String option names which carry
# the same meaning, and one of the following flags:
# GetoptLong::NO_ARGUMENT :: Option does not take an argument.
# GetoptLong::REQUIRED_ARGUMENT :: Option always takes an argument.
# GetoptLong::OPTIONAL_ARGUMENT :: Option may or may not take an argument.
# The first option name is considered to be the preferred (canonical) name.
# Other than that, the elements of each sub-array can be in any order.
def initialize(*arguments)
if ENV.include?('POSIXLY_CORRECT')
@ordering = REQUIRE_ORDER
# Hash table of option names.
# Keys of the table are option names, and their values are canonical
@canonical_names = Hash.new
# Hash table of argument flags.
# Keys of the table are option names, and their values are argument
@argument_flags = Hash.new
# Whether error messages are output to $stderr.
# Rest of catenated short options.
# List of non-option-arguments.
# Append them to ARGV when option processing is terminated.
@non_option_arguments = Array.new
# Set the handling of the ordering of options and arguments.
# A RuntimeError is raised if option processing has already started.
# The supplied value must be a member of GetoptLong::ORDERINGS. It alters
# the processing of options as follows:
# Options are required to occur before non-options.
# Processing of options ends as soon as a word is encountered that has not
# been preceded by an appropriate option flag.
# For example, if -a and -b are options which do not take arguments,
# parsing command line arguments of '-a one -b two' would result in
# 'one', '-b', 'two' being left in ARGV, and only ('-a', '') being
# processed as an option/arg pair.
# This is the default ordering, if the environment variable
# POSIXLY_CORRECT is set. (This is for compatibility with GNU getopt_long.)
# Options can occur anywhere in the command line parsed. This is the
# Every sequence of words which can be interpreted as an option (with or
# without argument) is treated as an option; non-option words are skipped.
# For example, if -a does not require an argument and -b optionally takes
# an argument, parsing '-a one -b two three' would result in ('-a','') and
# ('-b', 'two') being processed as option/arg pairs, and 'one','three'
# If the ordering is set to PERMUTE but the environment variable
# POSIXLY_CORRECT is set, REQUIRE_ORDER is used instead. This is for
# compatibility with GNU getopt_long.
# <b>RETURN_IN_ORDER</b> :
# All words on the command line are processed as options. Words not
# preceded by a short or long option flag are passed as arguments
# with an option of '' (empty string).
# For example, if -a requires an argument but -b does not, a command line
# of '-a one -b two three' would result in option/arg pairs of ('-a', 'one')
# ('-b', ''), ('', 'two'), ('', 'three') being processed.
# The method is failed if option processing has already started.
set_error(ArgumentError, "argument error")
"invoke ordering=, but option processing has already started"
if !ORDERINGS.include?(ordering)
raise ArgumentError, "invalid ordering `#{ordering}'"
if ordering == PERMUTE && ENV.include?('POSIXLY_CORRECT')
@ordering = REQUIRE_ORDER
# Set options. Takes the same argument as GetoptLong.new.
# Raises a RuntimeError if option processing has already started.
def set_options(*arguments)
# The method is failed if option processing has already started.
"invoke set_options, but option processing has already started"
# Clear tables of option names and argument flags.
raise ArgumentError, "the option list contains non-Array argument"
# Find an argument flag and it set to `argument_flag'.
if ARGUMENT_FLAGS.include?(i)
raise ArgumentError, "too many argument-flags"
raise ArgumentError, "no argument-flag" if argument_flag == nil
next if i == argument_flag
if !i.is_a?(String) || i !~ /\A-([^-]|-.+)\z/
raise ArgumentError, "an invalid option `#{i}'"
if (@canonical_names.include?(i))
raise ArgumentError, "option redefined `#{i}'"
# Register the option (`i') to the `@canonical_names' and
# `@canonical_names' Hashes.
@canonical_names[i] = canonical_name
@argument_flags[i] = argument_flag
raise ArgumentError, "no option name" if canonical_name == nil
# Set/Unset `quiet' mode.
# Return the flag of `quiet' mode.
# `quiet?' is an alias of `quiet'.
# Explicitly terminate option processing.
return nil if @status == STATUS_TERMINATED
raise RuntimeError, "an error has occurred" if @error != nil
@status = STATUS_TERMINATED
@non_option_arguments.reverse_each do |argument|
@non_option_arguments = nil
# Returns true if option processing has terminated, false otherwise.
return @status == STATUS_TERMINATED
# Set an error (a protected method).
def set_error(type, message)
$stderr.print("#{$0}: #{message}\n") if !@quiet
@non_option_arguments = nil
# Examine whether an option processing is failed.
# `error?' is an alias of `error'.
# Return the appropriate error message in POSIX-defined format.
# If no error has occurred, returns nil.
# Get next option name and its argument, as an Array of two elements.
# The option name is always converted to the first (preferred)
# name given in the original options to GetoptLong.new.
# Example: ['--option', 'value']
# Returns nil if the processing is complete (as determined by
option_name, option_argument = nil, ''
return nil if @error != nil
# Get next option argument.
if 0 < @rest_singles.length
argument = '-' + @rest_singles
elsif @ordering == PERMUTE
while 0 < ARGV.length && ARGV[0] !~ /\A-./
@non_option_arguments.push(ARGV.shift)
elsif @ordering == REQUIRE_ORDER
# Check the special argument `--'.
# `--' indicates the end of the option list.
if argument == '--' && @rest_singles.length == 0
# Check for long and short options.
if argument =~ /\A(--[^=]+)/ && @rest_singles.length == 0
# This is a long style option, which start with `--'.
if @canonical_names.include?(pattern)
# The option `option_name' is not registered in `@canonical_names'.
# It may be an abbreviated.
@canonical_names.each_key do |key|
if key.index(pattern) == 0
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
