Class OptConfig
In: lib/optconfig.rb
Parent: Object

Methods

[]   new   option   options=   parse   parse!   parse_file   usage  

Classes and Modules

Class OptConfig::AmbiguousOption
Class OptConfig::ArgumentRequired
Class OptConfig::DuplicatedOption
Class OptConfig::Error
Class OptConfig::InvalidArgument
Class OptConfig::Option
Class OptConfig::UnknownOption
Class OptConfig::UnnecessaryArgument

External Aliases

section -> idlist
section= -> idlist=

Attributes

file  [RW] 
ignore_unknown_file_option  [RW] 
section  [RW] 

Public Class methods

new(default_attr={})

初期化

default_attr には各オプション属性のデフォルト値を Hash で指定可能。 オプション属性以外にも以下のものを指定できる。これらは OptConfig オブジェクト自身に影響する。

:file :オプションファイル名 (String)。デフォルト: なし。
:section :オプションファイル名のセクション名 (String または String の配列)。デフォルト: なし。
:ignore_unknown_file_option :オプションファイル内に未知のオプションがあっtた時に無視するか(true)エラーにするか(false)。デフォルト: true。
:stop_at_non_option_argument :オプションでない引数でオプションの解釈をやめるか(true)、それ以降もオプションの解釈を続けるか(false)。デフォルト: false。

Public Instance methods

[](name)

オプションの値を返す

name:オプション名

例外

UnknownOption

option(*args)

オプション定義

args:オプション名(String) のリスト、オプションの属性(Hash)

戻り値

Option オブジェクト

例外

RuntimeError:オプションが既に定義されている
options=(option)

オプション定義(古いインタフェース)

option:オプション定義(ハッシュ)
parse(argv=[])

argv のオプションを解析する

argv:文字列の配列

戻り値

argv からオプションを取り除いたもの

parse!(argv=[])

argv のオプションを解析し、オプションを取り除いたものに置き換える

argv:配列

戻り値

argv:残りの引数
parse_file(filename)

ファイルからオプションを読み込む

filename:ファイル名

例外

UnknownOption

usage()

オプションの説明文字列を返す

[Validate]