クエリ:getoptlong > クエリ:GetoptLong

...getoptlong は、GNU の getopt_long() とまったく同じ方式でコマンド
行オプションの解析を行う Ruby のライブラリです。

=== GNU getopt_long() とは?

GNU getopt_long() は、コマンド行オプションの解析を行う C の関数です。多
くの GNU ソフ...

...トウェアがこの関数を使用しています。GNU getopt_long() そし
て getoptlong には、以下のような特徴があります。

* 伝統的な一文字オプションに加えて、長いオプションに対応しています。長
いオプションは `-' の代わりに `-...

...引数 `--' によって、オプションの解析を強制的に終了します。

=== 順序形式 (ordering)

GNU getopt_long() および getoptlong.rb には、`REQUIRE_ORDER',
`PERMUTE', `RETURN_IN_ORDER' という、3 つの「順序形式」が用
意されています。それぞれの処...

GetoptLong#ordering=(ordering) (38168.0)

インスタンスメソッド

順序形式を設定します。

...されていると、引数に
GetoptLong::PERMUTE を与えてこのメソッドを呼び出しても、実際のところの順
序形式は GetoptLong::REQUIRE_ORDER に設定されます。

環境変数 POSIXLY_CORRECT が定義されていない限り、GetoptLong::PERMUTE
が初期値です...

...になり
ます。

@param ordering GetoptLong::REQUIRE_ORDER, GetoptLong::PERMUTE,
GetoptLong::RETURN_IN_ORDER のいずれかを指定します。

@raise ArgumentError GetoptLong::REQUIRE_ORDER, GetoptLong::PERMUTE,
GetoptLong::RETURN_IN_ORDER 以外の値を指...

...定した場合に発生します。

@raise RuntimeError GetoptLong#get, GetoptLong#get_option,
GetoptLong#each, GetoptLong#each_option メソッドを
呼び出した後にこのメソッドを呼び出した場合に発生します。...

GetoptLong#set_options(*arguments) -> self (38108.0)

インスタンスメソッド

あなたのプログラムで、認識させたいオプションをセットします。個々のオプションは、オプション名と引数のフラグからなる配列でなければいけません。

...番左端のオプション名が、オプションの正式名
になります。配列中の引数のフラグは、GetoptLong::NO_ARGUMENT,
GetoptLong::REQUIRE_ARGUMENT, GetoptLong::OPTIONAL_ARGUMENT
のいずれかでなくてはなりません。

オプションを設定できるのは、get,...

...れるた場合、発生します。

parser.set_options(['-d', '--debug', GetoptLong::NO_ARGUMENT],
['--version', GetoptLong::NO_ARGUMENT],
['--help', GetoptLong::NO_ARGUMENT])

オプション名と引数のフラグの順番に決まり...

...はないので、次のような
形式でも構いません。

parser.set_options([GetoptLong::NO_ARGUMENT, '-d', '--debug'],
[GetoptLong::NO_ARGUMENT, '--version'],
[GetoptLong::NO_ARGUMENT, '--help'])...

GetoptLong.new(*arguments) (38076.0)

特異メソッド

GetoptLong のオブジェクトを生成します。引数が与えられたときは、それを GetoptLong#set_options メソッドに渡します。

...
GetoptLong のオブジェクトを生成します。引数が与えられ
たときは、それを GetoptLong#set_options メソッドに渡します。

@param arguments オプションを定義するための配列の配列を指定します。

@see GetoptLong#set_options...

絞り込み条件を変える

GetoptLong#get -> [String, String] (38048.0)

インスタンスメソッド

ARGV から、次のオプションの名前と、もしあればその引数の組を取得します。メソッドは 2 つの値を返し、1 つ目の値がオプション名 (例: --max-size) で、2 つ目がオプションの引数 (例: 20K) です。

...ない場合は、エラーとなって、以下のいずれかの例外が発生し
ます。

* GetoptLong::AmbiguousOption
* GetoptLong::InvalidOption
* GetoptLong::MissingArgument
* GetoptLong::NeedlessArgument

加えて、静粛 (quiet) フラグが有効になっていない限り、エ...

GetoptLong#get_option -> [String, String] (38048.0)

インスタンスメソッド

GetoptLong#quiet=(flag) (38048.0)

インスタンスメソッド

flag が真なら、静粛 (quiet) モードが有効になります。

...が有効になります。

静粛モードが有効になっていると、レシーバのオブジェクトは、
GetoptLong#get, GetoptLong#get_option,
GetoptLong#each, GetoptLong#each_option メソッドでエラーが
発生しても、エラーメッセージを出力しません。初期値...

GetoptLong::ARGUMENT_FLAGS -> Array (38036.0)