Ruby 2.4.0 リファレンスマニュアル > ライブラリ一覧 > getoptlongライブラリ > GetoptLongクラス

class GetoptLong

クラスの継承リスト: GetoptLong < Object < Kernel < BasicObject

要約

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

特異メソッド

定義 説明
new(*arguments)

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

インスタンスメソッド

定義 説明
each {|optname, optarg|...}
each_option {|optname, optarg|...}

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

error -> Class | nil
error? -> Class | nil

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

error_message -> String | nil

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

get -> [String, String]
get_option -> [String, String]

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

ordering -> Integer

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

ordering=(ordering)

順序形式を設定します。

quiet -> true | false
quiet? -> true | false

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

quiet=(flag)

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

set_error(type, message) -> ()

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

set_options(*arguments) -> self

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

terminate -> self

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

terminated? -> true | false

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

定数

定義 説明
ARGUMENT_FLAGS -> Array

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

NO_ARGUMENT -> 0

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

OPTIONAL_ARGUMENT -> 2

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

ORDERINGS -> Array

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

PERMUTE -> 1

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

REQUIRED_ARGUMENT -> 1

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

REQUIRE_ORDER -> 0

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

RETURN_IN_ORDER -> 2

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

STATUS_STARTED -> 1

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

STATUS_TERMINATED -> 2

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

STATUS_YET -> 0

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

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE