検索結果

getoptlong (114301.0)

• 2.3.0

• ライブラリ

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

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


=== GNU getopt_long() とは?

GNU getopt_long() は、コマンド行オプションの解析を行う C の関数です。多
くの GNU ソフトウェアがこの関数を使用しています。GNU getopt_long() そし
て getoptlong には、以下のような特徴があります。

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

• GetoptLong
• GetoptLong::AmbiguousOption
• GetoptLong::Error
• GetoptLong::InvalidOption
• GetoptLong::MissingArgument
• GetoptLong::NeedlessArgument

GetoptLong#ordering=(ordering) (51253.0)

• 2.3.0

• インスタンスメソッド

順序形式を設定します。

順序形式を設定します。

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

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

@param ordering GetoptLong::REQUIRE_ORDER, GetoptLong::...

• GetoptLong

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

• 2.3.0

• インスタンスメソッド

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

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

配列中のオプション名は、一文字オプション (例: -d) か長いオプ
ション (例: --debug) を表した文字列のいずれかでなければなり
ません。配列の中の一番左端のオプション名が、オプションの正式名
になります。配列中の引数のフラグは、GetoptLong::NO_ARGUMENT,
GetoptLong::REQUIRE_ARGUMENT, GetoptLong::OPTIONAL_ARGUMENT
のいずれかでなくてはなりません。

オ...

• GetoptLong

GetoptLong.new(*arguments) (51115.0)

• 2.3.0

• 特異メソッド

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

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

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

@see GetoptLong#set_options

• GetoptLong

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

• 2.3.0

• インスタンスメソッド

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

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

get と get_option は常にオプション名を正式名
で返します。与えられたオプションが引数を取らないときは、
空の文字列 ('') が optarg にセットされます。オプションが
ARGV に残っていないときは、optname, optarg ともに nil に
セットされます。メソッドから戻る際に、取得したオプションと引数
は自動的に ARGV から取り除...

• GetoptLong
• GetoptLong::AmbiguousOption
• GetoptLong::InvalidOption
• GetoptLong::MissingArgument
• GetoptLong::NeedlessArgument

絞り込み条件を変える

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

• 2.3.0

• インスタンスメソッド

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

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

get と get_option は常にオプション名を正式名
で返します。与えられたオプションが引数を取らないときは、
空の文字列 ('') が optarg にセットされます。オプションが
ARGV に残っていないときは、optname, optarg ともに nil に
セットされます。メソッドから戻る際に、取得したオプションと引数
は自動的に ARGV から取り除...

• GetoptLong
• GetoptLong::AmbiguousOption
• GetoptLong::InvalidOption
• GetoptLong::MissingArgument
• GetoptLong::NeedlessArgument

GetoptLong#quiet=(flag) (51073.0)

• 2.3.0

• インスタンスメソッド

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

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

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

@param flag 真または偽を指定します。

• GetoptLong

GetoptLong::ARGUMENT_FLAGS -> Array (51055.0)

• 2.3.0

• 定数

内部で使用する定数です。

内部で使用する定数です。

GetoptLong::NO_ARGUMENT, GetoptLong::REQUIRE_ARGUMENT,
GetoptLong::OPTIONAL_ARGUMENT がセットされています。

• GetoptLong

GetoptLong::ORDERINGS -> Array (51055.0)

• 2.3.0

• 定数

内部で使用する定数です。

内部で使用する定数です。

GetoptLong::REQUIRE_ORDER, GetoptLong::PERMUTE,
GetoptLong::RETURN_IN_ORDER がセットされています。

• GetoptLong

GetoptLong#each {|optname, optarg|...} (51019.0)

• 2.3.0

• インスタンスメソッド

get メソッドのイテレータ版です。オプションとその引数の取得を 繰り返し行います。

get メソッドのイテレータ版です。オプションとその引数の取得を
繰り返し行います。

@see GetoptLong#get

• GetoptLong

絞り込み条件を変える

GetoptLong#each_option {|optname, optarg|...} (51019.0)

• 2.3.0

• インスタンスメソッド

get メソッドのイテレータ版です。オプションとその引数の取得を 繰り返し行います。

get メソッドのイテレータ版です。オプションとその引数の取得を
繰り返し行います。

@see GetoptLong#get

• GetoptLong

GetoptLong#error -> Class | nil (51001.0)

• 2.3.0

• インスタンスメソッド

現在のエラーの型を返します。エラーが発生していなければ、nil を返します。

現在のエラーの型を返します。エラーが発生していなければ、nil
を返します。

• GetoptLong

GetoptLong#error? -> Class | nil (51001.0)

• 2.3.0

• インスタンスメソッド

現在のエラーの型を返します。エラーが発生していなければ、nil を返します。

現在のエラーの型を返します。エラーが発生していなければ、nil
を返します。

• GetoptLong

GetoptLong#error_message -> String | nil (51001.0)

• 2.3.0

• インスタンスメソッド

現在のエラーのエラーメッセージを返します。エラーが発生していな ければ、nil を返します。

現在のエラーのエラーメッセージを返します。エラーが発生していな
ければ、nil を返します。

• GetoptLong

GetoptLong#ordering -> Integer (51001.0)

• 2.3.0

• インスタンスメソッド

現在の順序形式を返します。

現在の順序形式を返します。

• GetoptLong

絞り込み条件を変える

GetoptLong#quiet -> true | false (51001.0)

• 2.3.0

• インスタンスメソッド

静粛モードが有効であれば、真を返します。そうでなければ、偽を返します。

静粛モードが有効であれば、真を返します。そうでなければ、偽を返します。

• GetoptLong

GetoptLong#quiet? -> true | false (51001.0)

• 2.3.0

• インスタンスメソッド

静粛モードが有効であれば、真を返します。そうでなければ、偽を返します。

静粛モードが有効であれば、真を返します。そうでなければ、偽を返します。

• GetoptLong

GetoptLong#set_error(type, message) -> () (51001.0)

• 2.3.0

• インスタンスメソッド

引数で与えられた例外を発生させます。

引数で与えられた例外を発生させます。

その際、静粛モードでなければ標準エラー出力に与えられたメッセージを出力します。

@param type 例外クラスを指定します。

@param message 例外にセットするメッセージを指定します。

• GetoptLong

GetoptLong#terminate -> self (51001.0)

• 2.3.0

• インスタンスメソッド

オプションの処理を、強制的に終了させます。ただし、エラーが起き ている状態でこのメソッドを起動しても、終了させることはできません。

オプションの処理を、強制的に終了させます。ただし、エラーが起き
ている状態でこのメソッドを起動しても、終了させることはできません。

すでにオプションの処理が終了しているときは、このメソッドは何も行いません。

@raise RuntimeError エラーが起きている状態でこのメソッドを起動すると、発生します

• GetoptLong

GetoptLong#terminated? -> true | false (51001.0)

• 2.3.0

• インスタンスメソッド

エラーが起きずにオプションの処理が終了しているときは真が 返ります。それ以外のときは、偽が返ります。

エラーが起きずにオプションの処理が終了しているときは真が
返ります。それ以外のときは、偽が返ります。

• GetoptLong

絞り込み条件を変える

GetoptLong::NO_ARGUMENT -> 0 (51001.0)

• 2.3.0

• 定数

オプションに引数が無いことを表す定数です。

オプションに引数が無いことを表す定数です。

• GetoptLong

GetoptLong::OPTIONAL_ARGUMENT -> 2 (51001.0)

• 2.3.0

• 定数

オプションにはオプショナル引数があることを表す定数です。

オプションにはオプショナル引数があることを表す定数です。

• GetoptLong

GetoptLong::PERMUTE -> 1 (51001.0)

• 2.3.0

• 定数

コマンド行引数の内容を、走査した順に入れ替え、最終的にはすべての非オプ ションを末尾に寄せます。この方式では、オプションはどの順序で書いても良 いことになります。これは、たとえプログラム側でそうなることを期待しなく ても、そうなります。この方式がデフォルトです。

コマンド行引数の内容を、走査した順に入れ替え、最終的にはすべての非オプ
ションを末尾に寄せます。この方式では、オプションはどの順序で書いても良
いことになります。これは、たとえプログラム側でそうなることを期待しなく
ても、そうなります。この方式がデフォルトです。

• GetoptLong

GetoptLong::REQUIRED_ARGUMENT -> 1 (51001.0)

• 2.3.0

• 定数

オプションに必須引数があることを表す定数です。

オプションに必須引数があることを表す定数です。

• GetoptLong

GetoptLong::REQUIRE_ORDER -> 0 (51001.0)

• 2.3.0

• 定数

非オプション引数の後に来たオプションは、オプションとして認識しません。 最初に非オプション引数が現れた時点で、オプションの解析処理を中止します。

非オプション引数の後に来たオプションは、オプションとして認識しません。
最初に非オプション引数が現れた時点で、オプションの解析処理を中止します。

• GetoptLong

絞り込み条件を変える

GetoptLong::RETURN_IN_ORDER -> 2 (51001.0)

• 2.3.0

• 定数

オプションと他の非オプション引数はどんな順序で並んでも良いが、お互いの 順序は保持したままにしたいというプログラムのための形式です。

オプションと他の非オプション引数はどんな順序で並んでも良いが、お互いの
順序は保持したままにしたいというプログラムのための形式です。

• GetoptLong

GetoptLong::STATUS_STARTED -> 1 (51001.0)

• 2.3.0

• 定数

内部状態を管理するための定数です。ユーザが使用することはありません。

内部状態を管理するための定数です。ユーザが使用することはありません。

• GetoptLong

GetoptLong::STATUS_TERMINATED -> 2 (51001.0)

• 2.3.0

• 定数

内部状態を管理するための定数です。ユーザが使用することはありません。

内部状態を管理するための定数です。ユーザが使用することはありません。

• GetoptLong

GetoptLong::STATUS_YET -> 0 (51001.0)

• 2.3.0

• 定数

内部状態を管理するための定数です。ユーザが使用することはありません。

内部状態を管理するための定数です。ユーザが使用することはありません。

• GetoptLong

GetoptLong (42001.0)

• 2.3.0

• クラス

GNU getopt_long() を Ruby で模したクラスです。

GNU getopt_long() を Ruby で模したクラスです。

絞り込み条件を変える

GetoptLong::AmbiguousOption (33001.0)

• 2.3.0

• クラス

与えられたオプションは名前の後方が省略されていると思われるが、一意に決まらない 場合に発生する例外です。

与えられたオプションは名前の後方が省略されていると思われるが、一意に決まらない
場合に発生する例外です。

GetoptLong::Error (33001.0)

• 2.3.0

• クラス

このライブラリで発生する例外の基底クラスです。

このライブラリで発生する例外の基底クラスです。

GetoptLong::InvalidOption (33001.0)

• 2.3.0

• クラス

知らないオプションが与えられた場合に発生する例外です。

知らないオプションが与えられた場合に発生する例外です。

GetoptLong::MissingArgument (33001.0)

• 2.3.0

• クラス

与えられたオプションに引数が欠けている場合に発生する例外です。

与えられたオプションに引数が欠けている場合に発生する例外です。

GetoptLong::NeedlessArgument (33001.0)

• 2.3.0

• クラス

与えられたオプションは引数を伴っているが、そのオプションが 引数をとらない場合に発生する例外です。

与えられたオプションは引数を伴っているが、そのオプションが
引数をとらない場合に発生する例外です。

絞り込み条件を変える