コマンドラインオプション解析用ライブラリ。
サポートしている機能:
短い形式と長い形式のオプションスイッチを混在可能。 短形式のスイッチは一つにまとめることも可能。
スイッチの指定とハンドラをそれぞれ一箇所にまとめて書ける。
スイッチの引数は自動的に指定したクラスに変換される。
オプションサマリを作れる。
後から、あるいは途中でオプションを追加できる。
OptionParser フロントエンド
OptionParser::Switch それぞれのスイッチ
OptionParser::List オプションリスト
OptionParser::ParseError オプション解析時のエラー
+--------------+
| OptionParser |<>-----+
+--------------+ | +--------+
| ,-| Switch |
on_head -------->+-------------+ / +--------+
accept/reject -->| List |<|>-
| |<|>- +----------+
on ------------->+-------------+ `-| argument |
: : | class |
+-------------+ |==========|
on_tail -------->| | |pattern |
+-------------+ |----------|
OptionParser.accept ->| DefaultList | |converter |
reject |(全インスタン| +----------+
| スで共有) |
+-------------+
各スイッチのクラス。
OptionParser::Switch#parse(arg, val) {semi-error handler}
引数をパース、変換してarg、block、変換結果を返す。
@patternにマッチした部分文字列のリスト、 $&, $1, $2 など。
@pattern @pattern にマッチした部分文字列のリスト、 $& $& , $1 $1 , $2 $2 など。スイッチに直に指定されていた引数の文字列。
スイッチに直に指定されていた引数の文字列。スイッチ以降の引数。
スイッチ以降の引数。block
エラーかも知れないときに例外をyieldする。
yield
yield
する。
OptionParser::Switch#summarize(sdone, ldone, width, max, indent)
オプションサマリを作る。
すでにサマリに入っている短形式オプションをキーとするハッシュ。
すでにサマリに入っている短形式オプションをキーとするハッシュ。すでにサマリに入っている長形式オプションをキーとするハッシュ。
すでにサマリに入っている長形式オプションをキーとするハッシュ。左側のオプションリスト部分の幅。オプションの説明はその右側、width桁目から始まる。
左側のオプションリスト部分の幅。オプションの説明はその右側、 width width 桁目から始まる。左側の最大幅。オプションはmax桁以内に詰められる。
左側の最大幅。オプションは max max 桁以内に詰められる。各行をインデントするための文字列。
各行をインデントするための文字列。block
各行ごとに渡される(改行は付かない)。
各行ごとに渡される(改行は付かない)。OptionParser::Switch#-@
反転したブーリアンスイッチ(@blockに渡される引数が反転さ れる)を作る
反転したブーリアンスイッチ( @block @block に渡される引数が反転さ れる)を作る単一のオプションリスト、短／長形式のオプション文字列からスイッチへのマッ ピング、受け付けられる引数タイプからパターンとコンバータへのマッピングを 提供する。サマリもここで提供される。
OptionParser::List#atype
引数タイプからパターン／コンバータのペアへのマップ。
引数タイプからパターン／コンバータのペアへのマップ。OptionParser::List#short
短形式のオプションスイッチからスイッチオブジェクトへのマップ。
短形式のオプションスイッチからスイッチオブジェクトへのマップ。OptionParser::List#long
長形式のオプションスイッチからスイッチオブジェクトへのマップ。
長形式のオプションスイッチからスイッチオブジェクトへのマップ。OptionParser::List#list
全スイッチとサマリ文字列のリスト。
全スイッチとサマリ文字列のリスト。OptionParser::List#prepend(switch, short_opts, long_opts, nolong_opts)
switchをリストの頭に挿入して、短／長／否定形式のオプションに対応させる。
switch switch をリストの頭に挿入して、短／長／否定形式のオプションに対応させる。OptionParser::List#append(switch, short_opts, long_opts, nolong_opts)
switchをリストの最後に追加して、短／長／否定形式のオプションに対応させる。
挿入するOptionParser::Switchインスタンス。
挿入する OptionParser::Switch OptionParser::Switch インスタンス。switchに対応する短形式オプションのリスト。
switch switch に対応する短形式オプションのリスト。switchに対応する長形式オプションのリスト。
switch switch に対応する長形式オプションのリスト。
"no-"のつく否定形式のオプションのリスト。
"no-"
"no-"
のつく否定形式のオプションのリスト。
OptionParser::List#search(id, key) [{block}]
keyをidのリストから検索する。
検索するリスト。
検索するリスト。検索するキー。
検索するキー。Block
見付かったときにその値で呼び出される。
見付かったときにその値で呼び出される。OptionParser::List#complete(id, opt, *pat, &block)
optをidのリストから*patで補完して検索する。
検索するリスト。
検索するリスト。検索するキー。
検索するキー。補完に使うパターン。
補完に使うパターン。Block
見付かったときにその値で呼び出される。
見付かったときにその値で呼び出される。OptionParser::List#summarize(*args) {...}
サマリテーブルを作る。一行ごとにblockを呼び出す。
@listの要素はsummarizeできる必要がある。
そのまま各要素の summarize に渡される。
そのまま各要素の summarize に渡される。block
各行ごとに渡される(改行は付かない)。
各行ごとに渡される(改行は付かない)。オプションパーサのフロントエンド。
OptionParser::ArgumentStyle
取りうる引数のスタイルの種類。値はそれぞれ:
OptionParser::NO_ARGUMENT
引数を取らないスイッチ。
引数を取らないスイッチ。OptionParser::REQUIRED_ARGUMENT
引数が必須のスイッチ。直後に引数が=で指定されていなければ、次の文字列を引数とみなす。
空の引数を指定するときは、=だけをつける。
=
=
で指定されていなければ、次の文字列を引数とみなす。
空の引数を指定するときは、
=
=
だけをつける。
OptionParser::OPTIONAL_ARGUMENT
オプショナルな引数を取るスイッチ。つまり引数を付けても付けなくてもよい。
引数を指定するときは--switch=argument(長形式)か、
-Xargument(短形式)とする。短形式では、引数パターンにマッ
チする部分だけが引数として認識される。
OptionParser::DefaultList
'--'のように全OptionParserインスタンスで共有するスイッチや、デフォル トの引数クラスを持つ。
'--'のように全OptionParserインスタンスで共有するスイッチや、デフォル トの引数クラスを持つ。OptionParser.with([banner[, width[, indent]]]) [{...}]
新しいインスタンスを作成して、イテレータとして呼ばれているときに
はブロックをそのインスタンスのコンテクストで評価してから、返す。
この動作は以前のnewと同じだが、depricatedなメソッド。
cf. OptionParser#initialize
バナーメッセージ。
バナーメッセージ。サマリの幅。
サマリの幅。サマリのインデント文字列。
サマリのインデント文字列。Block
作成したインスタンスのコンテクストで評価される。
作成したインスタンスのコンテクストで評価される。OptionParser.new([banner[, width[, indent]]]) [{...}]
インスタンスを初期化する。イテレータとして呼ばれている場合は、自分自 身を渡す。
バナーメッセージ。デフォルトはnil。
nil
nil
。
サマリの幅。デフォルトは32
サマリの幅。デフォルトは32サマリのインデント。デフォルトは空白4個。
サマリのインデント。デフォルトは空白4個。Block
selfが渡される。
self self が渡される。OptionParser.terminate([arg])
オプションの解析を終了させる。省略可能なargが与えられていると、 コマンドライン引数に戻される。
最初のオプションでない引数として戻される文字列。
最初のオプションでない引数として戻される文字列。OptionParser.accept(t, [pat]) {...}
OptionParser#accept(t, [pat]) {...}
指定したクラスのオプション引数を受け付けられるようにする。
引数クラスを指定するオブジェクト、通常はClass。
Class
Class
。
引数のパターン。tがmatchを持っていればそれがデフォルト。
match
match
を持っていればそれがデフォルト。
Block
引数の文字列を受け取って要求されるクラスに変換する。
引数の文字列を受け取って要求されるクラスに変換する。OptionParser.reject(t)
OptionParser#reject(t)
指定したクラスのオプション引数を受け付けないようにする。
引数クラスを指定するオブジェクト。
引数クラスを指定するオブジェクト。OptionParser#banner
OptionParser#banner=(heading)
サマリの先頭に出力されるバナー。
サマリの先頭に出力されるバナー。OptionParser#summary_width
OptionParser#summary_width=(width)
サマリのオプションリスト部分の幅。Numericである要がある。
Numeric
Numeric
である要がある。
OptionParser#summary_indent
OptionParser#summary_indent=(indent)
サマリのインデント。Stringでなければならない(もしくは
Stringを+できるモノ)。
String
String
でなければならない(もしくは
String
String
を
+
+
できるモノ)。
OptionParser#program_name
OptionParser#program_name=(name)
エラーメッセージやデフォルトのバナーで出力されるプログラム名。
デフォルトは$0。
$0
$0
。
OptionParser#top
on/on_head、accept/rejectの対象。
on on / on_head on_head 、 accept accept / reject reject の対象。OptionParser#base
on_tailの対象。
on_tail on_tail の対象。OptionParser#new
新しいListを追加する。
List
List
を追加する。
OptionParser#remove
最後のListを削除する。
List
List
を削除する。
OptionParser#summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent)
オプションサマリをtoに作る。toを返す。
出力先。<<メソッドが必要。デフォルトは[]。
[]
[]
。
左側、オプションリスト部の幅。デフォルトは@summary_width。
左側、オプションリスト部の幅。デフォルトは @summary_width @summary_width 。
左側で使える最大幅。デフォルトはwidth - 1。
width - 1
width
width
- 1
。
インデント。デフォルトは@summary_indent。
インデント。デフォルトは @summary_indent @summary_indent 。Block
イテレータとして呼ばれていると、各行ごとに呼び出される。
イテレータとして呼ばれていると、各行ごとに呼び出される。OptionParser#to_str
OptionParser#to_s
オプションサマリ文字列を返す。
オプションサマリ文字列を返す。OptionParser#to_a
オプションサマリを配列として返す。
オプションサマリを配列として返す。OptionParser#switch
オプション定義。
受け付けられるオプション引数の形式。OptionParser.acceptや
OptionParser#acceptであらかじめ定義されているか、
Regexpなどのmatchメソッドを持つオブジェクトでなけれ
ばならない。これは一度だけ指定できる(もしなければObjectと
みなされる)が、さもなければArgumentErrorを起こす。
cf. 引数として受け付けられるクラス.
取り得る引数の値。
取り得る引数の値。handlerを与える別の手段。
handler handler を与える別の手段。それぞれ引数が必須、省略可能、無しの長形式スイッチ。
それぞれ引数が必須、省略可能、無しの長形式スイッチ。それぞれ引数が必須、省略可能、無しの短形式スイッチ。
それぞれ引数が必須、省略可能、無しの短形式スイッチ。キャラクタクラスにマッチする短形式のスイッチ (正規表現全てが使えるわけではない)。
キャラクタクラスにマッチする短形式のスイッチ (正規表現全てが使えるわけではない)。引数スタイル。
引数スタイル。このスイッチの説明。
このスイッチの説明。Block
このスイッチが指定されたときに呼び出されるhandler。
このスイッチが指定されたときに呼び出される handler handler 。OptionParser#on(*opts) [{...}]
OptionParser#on_head(*opts) [{...}]
OptionParser#on_tail(*opts) [{...}]
オプションスイッチとハンドラを定義する。on_headと
on_tailはそれぞれスイッチをサマリの最初と最後におく。
cf. OptionParser#switch.
OptionParser#order(*argv) [{...}]
OptionParser#order!([argv = ARGV]) [{...}]
argvを出て来る順番にしたがって解析する。オプションでない引数が あると、イテレータとして呼ばれていればそれを渡して呼び出す。さもなけ れば解析を終了する。 解析されずに残ったargvを返す。
order!は配列自身を受け取って、スイッチを破壊的に取り除く。
デフォルトではARGVを解析する。
解析するコマンドライン引数の配列。
解析するコマンドライン引数の配列。Block
オプションでない引数があると呼び出される。
オプションでない引数があると呼び出される。OptionParser#permute(*argv)
OptionParser#permute!([argv = ARGV])
argvを並び変えモードで解析して、オプションでない引数のリストを 返す。
permute!は配列自身を受け取って、スイッチを破壊的に取り除く。
デフォルトではARGVを解析する。
解析するコマンドライン引数の配列。
解析するコマンドライン引数の配列。OptionParser#parse(*argv)
OptionParser#parse!([argv = ARGV])
環境変数POSIXLY_CORRECTがセットされているときは順序通りに、そ
れ以外は並べ変えモードで、argvを解析する。
parse!は配列自身を受け取って、スイッチを破壊的に取り除く。
デフォルトではARGVを解析する。
解析するコマンドライン引数の配列。
解析するコマンドライン引数の配列。任意の文字列、変換されない。何も指定しないとこれになる。
任意の文字列、変換されない。何も指定しないとこれになる。任意の空でない文字列、変換されない。
任意の空でない文字列、変換されない。
Ruby/C的な整数、0で始まれば8進数、0bで始まれば2進数、
0xで始まれば16進数、それ以外は10進数とみなす。符号も付けられる。
Integerに変換される。
0
0
で始まれば8進数、
0b
0b
で始まれば2進数、
0x
0x
で始まれば16進数、それ以外は10進数とみなす。符号も付けられる。
Integer
Integer
に変換される。
実数形式、Floatに変換される。
Float
Float
に変換される。
汎用の数値、整数形式ならInteger、実数形式なら
Floatに変換される。
Integer
Integer
、実数形式なら
Float
Float
に変換される。
10進整数、Integerに変換される。
Integer
Integer
に変換される。
Ruby/C的な 8/16/2進整数、Integerに変換される。
Integer
Integer
に変換される。
10進整数／実数形式。整数形式ならInteger、実数形式なら
Floatに変換される。
Integer
Integer
、実数形式なら
Float
Float
に変換される。
ブーリアンスイッチ、存在すれば真、またはno-が前に付いていれば偽。
もしくはyes/no/true/falseで示される値。
no-
no-
が前に付いていれば偽。
もしくは
yes/no/true/false
yes/no/true/false
で示される値。
TrueClassと似ているが、デフォルトの値はfalse。
false
false
。
","区切り文字列。
","区切り文字列。OptionParserで発生する例外のベースクラス。
RuntimeError
エラー原因。
エラー原因。OptionParser::ParseError#reason
エラーの理由を返す。
エラーの理由を返す。OptionParser::ParseError#inspect
可読形式の文字列を返す。
可読形式の文字列を返す。OptionParser::ParseError#message
OptionParser::ParseError#to_s
OptionParser::ParseError#to_str
デフォルトの文字列化メソッド、標準的なエラーメッセージ用。
デフォルトの文字列化メソッド、標準的なエラーメッセージ用。補完が一意に決められないときに発生する。
引数を取らないスイッチに引数が指定されていたときに発生する。
引数が必要なスイッチに引数が無かったときに発生する。
定義されていないスイッチで発生する。
与えられた引数がフォーマットに合わなかったときに発生する。
与えられた引数が一意に決定できなかったときに発生する。
コマンドライン引数の配列に、自分自身をパースする機能を拡張する。
optparse.rbをrequireすると、ARGVが拡張されている。
OptionParser::Arguable#options=
OptionParserオブジェクトをセットする。
optがfalseかnilなら、
OptionParser::Arguable#optionsメソッドと
OptionParser::Arguable#options=メソッドが未定義にされる。
つまり、このレシーバ経由でOptionParserオブジェクトにアクセス
する方法は無くなる。
false
false
か
nil
nil
なら、
OptionParser::Arguable#options
OptionParser::Arguable#options
メソッドと
OptionParser::Arguable#options=
OptionParser::Arguable#options=
メソッドが未定義にされる。
つまり、このレシーバ経由で
OptionParser
OptionParser
オブジェクトにアクセス
する方法は無くなる。
OptionParser::Arguable#options [{...}]
実際のOptionParserオブジェクト。 設定されていなければ自動的に作られる。
イテレータとして呼ばれると、OptionParserオブジェクトと共に呼び出して、
その結果を戻り値とする。このとき、OptionParser::ParseError例外は補足され、
エラーメッセージをSTDERRに表示するだけでnilを返す。
block
設定されているOptionParserのインスタンスとともに呼ばれる。
設定されている OptionParser OptionParser のインスタンスとともに呼ばれる。OptionParser::Arguable#order!
OptionParser::Arguable#permute!
OptionParser::Arguable#parse!
selfを破壊的にパースして、selfを返す。パースされなかった 文字列だけを残す。
self self を破壊的にパースして、 self self を返す。パースされなかった 文字列だけを残す。
OptionParserで定義されている、引数として受け付けられるパターンの定数を含んでいる。
今のところDecimalInteger、OctalInteger、DecimalNumeric。
引数として受け付けられるクラス参照。