Ruby Reference Manual

はじめに
****

Rubyは, 手軽なオブジェクト指向プログラミングを実現するための種々の機能を持つオブジェクト指向スクリプト言語である．本格的なオブジェクト指向言語であるSmalltalk, EiffelやC++などでは大げさに思われるような領域でのオブジェクト指向プログラミングを支援することを目的とする．その設計の基本原則は, 以下の通りである.

  * 機能性

     単純で例外の少ない文法で，オブジェクト指向プログラミングとスクリプトプログラミングのために必要な機能を十分に備える.

  * 拡張性

     必要に応じて容易に機能を拡張できる．クラスを自由に追加できることは勿論, Cプログラムのリンクによってインタプリタにあらゆる機能を追加できる． さらにプラットフォームによっては, 動的にオブジェクトコードをリンクする機能も提供する.

  * 一貫性

     少数の原則が全体に適用されるような一貫性のある言語仕様を持つ．これによって「パズルの楽しさ」は減少したかも知れない．ただし,一貫性のため使いやすさを犠牲にすることはない.

Rubyは「手軽」ではあるが本格的なオブジェクト指向機能を持つので，perl, tcl, pythonなどスクリプト言語にオブジェクト指向機能を追加したような処理系よりも自然にオブジェクト指向できる．更にガーベージコレクタや例外処理機能はより快適なプログラミングを支援する．

Rubyはテキスト処理関係の機能を豊富に(perlと同じくらい)持ち，OSを直接操作するような処理も記述できる．また, 純粋なオブジェクト指向言語でありながら, 必要であれば手続き型プログラミングも可能である.

Rubyはshやperlを知っている人にとっての常識にできる限り従ったので,それらの言語に精通している人にとっては習得が(多分)容易だろう．プログラマが Rubyのオブジェクト指向機能について学べば，より強力なこともできるようになるだろう．

コマンドラインオプション
************

rubyインタプリタは以下の引数を受け付ける.

-0数字

     入力レコードセパレータ($/)の8進数で指定する．

     数字を指定しない場合はヌルキャラクタがセパレータになる。数の後に他のスイッチがあってもよい。

     -00で, パラグラフモード, -0777で(そのコードを持つ文字は存在しないので) 全ファイルを一度に読み込むモードに設定できる.

-a

     -nや-pとともに用いて, オートスプリットモードをONにする．オートスプリットモードでは各ループの先頭で,

          $F = $_.split

     が実行される．-nか-pオプションが同時に指定されない限り, このオプションは意味を持たない.

-c

     スクリプトの内部形式へのコンパイルのみを行い, 実行しない．コンパイル終了後, 文法エラーが無ければ, "Syntax OK"と出力する.

-K c

     rubyの処理する漢字コードを指定する． rubyは指定された文字が Eまたはeの場合は文字列やアクセスするファイルの内容のコードがEUCであると仮定する．同様にSまたはsの場合はSJISとして処理する． Nは漢字を処理しない．デフォルトはEUC.

          ruby -CE -e 'print "テスト"'
          ruby -Cs -e 'print "テスト"'
          ruby -Cn -e 'print "テスト"'

     このオプションは将来文字コードの自動判別機能が追加された場合等には変更される.

-d
--debug

     デバッグモードをonにする．このフラグがセットされるとシステム変数 $DEBUGがセットされる.

-e SCRIPT

     コマンドラインからスクリプトを指定する．-eオプションを付けた時には引数からスクリプトファイル名を取らない.

-F 文字列

     入力フィールドセパレータ($;)の値を文字列にセットする．awkの同名のオプションと同じ働きをする.

-i EXTENSION

     引数で指定されたファイルの内容を置き換える(in-place edit)ことを指定する．元のファイルは拡張子をつけた形で保存される.

     例:

          % echo matz > /tmp/junk
          % cat /tmp/junk
          matz
          % ruby -p -i.bak -e '$_.upcase' /tmp/junk
          % cat /tmp/junk
          MATZ
          % cat /tmp/junk.bak
          matz

     拡張子がなければ，バックアップはされず，変更されたファイルだけが残る．

-I DIRECTORY

     ファイルをロードするパスを指定(追加)する．指定されたディレクトリはruby の配列変数$:に追加される.

-l

     $\を$/と同じ値に設定し, printでの出力時に改行を付加する．また, -nまたは-pとともに用いられると, 入力された各行の最後の文字をchop!する.

-n

     このフラグがセットされるとプログラム全体が

          while gets
            ...
          end

     で囲まれているように動作する.

-p

     -nフラグと同じだが, 各ループの最後に変数$_の値を出力する.

     例:

          % echo matz | ruby -p -e '$_.tr! "a-z", "A-Z"'
          MATZ

-r ファイル名

     スクリプト実行前にファイル名で指定されるファイルをrequireする． -nオプション，-pオプションとともに使う時に特に有効である．

     See 組み込み関数

-s

     スクリプト名に続く, -で始まる引数を解釈して, 同名の大域変数に値を設定する．--なる引数以降は解釈を行なわない．該当する引数は $ARGVから取り除かれる.

     例:

          #! /usr/local/bin/ruby -s
          # -xyzオプションが与えられると"true"を表示する.
          print "true\n" if $xyz

-S

     スクリプト名が/で始まっていない場合, 環境変数PATHの値を使ってスクリプトを探す． これは、#! をサポートしていないマシンで、#! による実行をエミュレートするために、以下のようにして使うことができる:

     例:

          #! /usr/local/bin/ruby
          # This line makes the next one a comment in ruby \
            exec /usr/local/bin/ruby -S $0 $*

     システムは最初の行を無視し，スクリプトを/bin/shに渡す． /bin/shはrubyスクリプトをシェルスクリプトとして実行しようとする．シェルは2行目だけをコメントであると解釈し，3行目を通常のシェルコマンドとして実行し，rubyインタプリタを起動する．

     システムによっては$0は必ずしもフルパスを含まないので，-S を用いてrubyに必要に応じてスクリプトを探すように指示する．rubyがスクリプトを見つけると、これらの行の解析を始めるが，rubyは2行目の行末にあるバックスラッシュにより，2行目のコメントが3行目まで継続するとみなして， 3行目を無視する．

     ファイル名に含まれるスペースなどを正しく扱うには，$*よりも ${1+"$@"}のほうがよいだろうが，cshが解釈する場合には動作しない．

-v
--verbose

     冗長モード．起動時にバージョン番号の表示を行い, システム変数 $VERBOSEをセットする．この変数がセットされている時, いくつかのメソッドは実行時に冗長なメッセージを出力する．-vオプションが指定されて, それ以外の引数がない時にはバージョンを表示した後, 実行を終了する(標準入力からのスクリプトを待たない).

--version

     rubyのバージョンを表示する.

     表示例:

          ruby - version 0.87 (95/09/23)

-x[directory]

     メッセージ中のスクリプトを取り出して実行する．スクリプトを読み込む時に， #!で始まり, rubyという文字列を含む行までを読み飛ばす．スクリプトの終りはEOF(ファイルの終り), ^D(コントロールD), ^Z(コントロールZ)または予約語__END__で指定する.

     ディレクトリ名を指定すると，スクリプト実行前に指定されたディレクトリに移る.

-X directory

     スクリプト実行前に指定されたディレクトリに移る.

-y
--yydebug

     コンパイラデバッグモード．スクリプトを内部表現にコンパイルする時の構文解析の過程を表示する．この表示は非常に冗長なので, コンパイラそのものをデバッグする人以外は表示させない方が良いと思う.

rubyの文法
*******

Lexical structure
=================

現在のrubyの実装はキャラクタセットとしてASCIIを用いる．rubyは大文字と小文字を区別する．識別子の途中でなければ任意のところに空白文字をおくことが出来る．空白文字はスペース(space)，タブ(tab)，垂直タブ(vertical tab)， CR(carriage return)，改頁(form feed)である．改行(newline)は明らかに式が継続する場合には空白文字として，それ以外では文の区切りとして解釈される．

識別子は英文字("_"を含む)から始まり，英数字が続いたものである． rubyの識別子の長さに制限はない．現在の実装は識別子としてマルチバイトコード(EUC,SJIS)も通すが勧められない．

識別子の例

     foobar
     ruby_is_simple

コメント
----

例

     # this is a comment line

スクリプト言語の習慣にならい，文字列中や文字表現(?#)以外の #から行末まではコメントと見なす．コメント行末のバックスラッシュは次の行へのコメントの継続を意味する．

予約語
---

予約語は以下の通りである

     alias           def             for             redo            undef
     and             defined?        if              rescue          when
     begin           else            in              retry           while
     break           elsif           module          return          yield
     case            end             nil             self            __END__
     class           ensure          not             super           __FILE__
     continue        fail            or              then            __LINE__

予約語はクラス名，メソッド名，変数名などに用いることはできない．ただし， $, @が先頭についたものは予約語と見なされないので，グローバル変数，インスタンス変数については問題ない．

区切り文字
-----

文字列などのリテラルの内部以外の場所の空白文字(タブとスペース)および改行(\n)が区切り記号となる．更に改行は

     a +
     b

のように行が式の途中で終り，次の行に続くことが明白な(最後の非空白文字が演算子あるいは,である)場合を除き，式の区切りとして認識される．

プログラム
=====

例

     print "hello world!\n"

プログラムは式を並べたものである．式と式の間はセミコロン(;)または改行で区切られる．

式
=

例

     TRUE
     (1+2)*3
     foo()
     if test then ok else ng end

Rubyではnilが偽，それ以外が真と評価される．CやPerlなどとは異なり，0や""(空文字列)は偽とは評価されないので気をつけること．

式は括弧によってグルーピングすることができる．

文字列式
----

例

     "this is a string expression\n"
     '文字列式'

ダブルクォート(")で括られた文字列の中はバックスラッシュに続く文字が以下のように解釈される．

バックスラッシュ記法

\t
     タブ(0x09)

\n
     改行文字(0x0a)

\r
     復帰文字(0x0d)

\f
     改ページ文字(0x0c)

\b
     バックスペース(0x08)

\a
     ベル(0x07)

\e
     エスケープ(0x1b)

\nnn
     8進数表記(nは0-7)

\xnn
     16進数表記(nは0-9,a-f)

\cx
     コントロール文字(xはASCII文字)

\x
     文字xそのもの

また，#による変数展開も行われる．

See 変数展開

一方，シングルクォート(')で括られた文字列は，\\(バックスラッシュそのもの)と\'(シングルクォート)を除いて，文字列の中身の解釈を行わない．

文字列式は毎回新しい文字列オブジェクトを生成するので，文字列の内容を変更しても，もともとの文字列は変わらない．

コマンド出力
------

例

     `date`

Rubyではshのようにコマンドの実行結果を文字列リテラルのように使うことができる．``で囲まれた文字列は，ダブルクォートで囲まれた文字列と同様にバックスラッシュ記法の解釈と変数展開が行なわれた後，コマンドとして実行され，その実行結果が文字列として与えられる．コマンドは評価されるたびに実行される．

正規表現式
-----

例

     /^ruby the OOPL/
     /ruby/i

/で囲まれた文字列は正規表現を表す．終りの/の後ろに文字 iが与えられた場合には，その正規表現はマッチ時に大文字小文字の区別をしない．

^
     行頭

$
     行末

.
     任意の1文字

\w
     英数字．[0-9A-Za-z_]と同じ

\W
     非英数字

\s
     空白文字．[ \t\n\r\f]と同じ

\S
     非空白文字

\d
     数字．[0-9] と同じ

\D
     非数字

\b
     語境界文字(文字クラス外)

\B
     非語境界文字

\b
     後退(0x08)(文字クラス内)

[ ]
     文字クラス指定

*
     直前の表現の0回以上の繰り返し

+
     直前の表現の1回以上の繰り返し

m,n
     m回からn回の繰り返し

?
     0または1回

|
     選択

( )
     正規表現をまとめる

その他に文字列と同じバックスラッシュ記法や変数展開も有効である．

変数展開
----

例

     "my name is #{$ruby}"

ダブルクォート(")で囲まれた文字列式，コマンド文字列，正規表現，およびワイルドカード式の中では#変数名という形式で変数の内容を展開することができる．変数が変数記号($,@)で始まる場合には#変数名という形式でも展開できる．文字#に続く文字が {,$,@でなければ，そのまま文字#として解釈される．

数値リテラル
------

123
     整数

-123
     整数(符合つき数)

1_234
     整数(10進数は_を含むことができる)

123.45
     浮動小数点数

1.2e-3
     浮動小数点数

0xffff
     16進整数

0377
     8進整数

?a
     文字aのコード(97)

?\C-a
     コントロールaのコード(1)

?\M-a
     メタaのコード(225)

?\M-\C-a
     メタ-コントロールaのコード(129)

:シンボル
     識別子/変数名/演算子と一対一対応する整数．sendなどでメソッドを指定する時などに使う．

?表現では全てのバックスラッシュ記法が有効である．

変数と定数
-----

Rubyの変数はスコープ(有効範囲)と寿命(有効期限)によって4種類に分類され，その種類は変数名の最初の一文字で決定される．通常の変数の2文字目以降は英数時または_であるが，システム変数の一部は「$+1文字の記号」という変数がある．変数名の長さに関して特別な制限はない．

グローバル変数
-------

例

     $foobar
     $/

$で始まる変数のスコープはグローバルであり，プログラムのどこからでも参照できる．その寿命はプログラムの寿命と等しい．グローバル変数には宣言は必要ない．初期化されていないグローバル変数を参照した時の値は nilである．

インスタンス変数
--------

例

     @foobar

@で始まる変数はインスタンス変数であり，そのクラスまたはサブクラスのメソッドから参照できる．スコープはメソッド内であり，その寿命はオブジェクトの寿命に等しい．インスタンス変数にも宣言は必要ない．初期化されていないインスタンス変数を参照した時の値はnilである．

クラス定数
-----

例

     FOOBAR

大文字で始まる識別子は定数へのアクセスであり，最初に定義されたクラスと全てのサブクラスのスコープ内で参照できる．定数の定義は代入か，定数を定義しているモジュールをインクルードすることによって行なわれる．定数への代入はトップレベル，すなわちメソッドが定義できるレベルでのみ可能である．定数はクラス間で値が共有され，一度代入すると値を変更することができない (代入は例外を発生させる)．クラス定数の寿命はクラスの寿命と等しい．初期化されていないクラス定数を参照した時の値はnilである．

クラス定義は自動的に定数を定義するので，クラス名は定数である．

あるクラスまたはモジュールに属する定数を外部から参照するためには ::演算子を用いる．

例

     Foo::Bar

::演算子を用いた代入はできない．

ローカル変数
------

例

     foobar

小文字または_で始まる識別子はローカル変数またはメソッド呼出しである．ローカル変数スコープにおける小文字で始まる識別子への最初の代入はそのスコープに属するローカル変数の宣言になる．宣言されていない識別子の参照は引数の無いメソッド呼び出しとみなされる．

ローカル変数のスコープは，その変数が宣言されたイテレータブロック，メソッド定義，またはクラス/モジュール定義ブロックの終りまでである．寿命もそのブロックの終りまで(トップレベルのローカル変数はプログラムの終了まで) であるが，例外としてイテレータブロックが手続きオブジェクト化された場合は，そのオブジェクトが消滅するまで存在する．同じスコープを参照する手続きオブジェクト間ではローカル変数は共有される．

疑似変数
----

通常の変数以外に疑似変数と呼ばれる特殊な変数が4つある．

self
     現在のメソッドの実行主体

nil
     Nilクラスの唯一のインスタンス(偽を表す)

__FILE__
     スクリプトのファイル名(文字列)

__LINE__
     現在の行番号(整数)

これらの疑似変数は代入によってその値を変更することはできない．これらの変数への代入は例外を発生させる．

配列式
---

例

     [1, 2, 3]

配列はArrayクラスのインスタンスである．配列を生成する式は以下の形式である．

     [ 式,...]

それぞれの式を評価した結果を含む配列を返す．要素数が0の空配列を生成するためには空の配列式

     [ ]

を用いる．

連想配列式
-----

例

     {1=>2, 2=>4, 3=>6}

連想配列とは任意のオブジェクトをキー(添字)として持つ配列である．Rubyの連想配列はHash(連想配列)クラスのインスタンスである．詳細はクラス Hashの項を参照されたい．See Hash

連想配列を生成する連想配列式は以下の形式である．

     { 式 => 式...}

それぞれの式を評価した結果をキーと値とする連想配列オブジェクトを返す．要素数が0の連想配列を生成するためには空の連想配列式

     { }

を用いる．要素が1つ以上ある場合，曖昧でなければ{, }は省略できる．

メソッド呼出式
-------

例

     foo.bar()
     foo.bar
     bar()
     print "hello world\n"
     print

オブジェクトにメッセージを送る基本的な構文がメッセージ式であり，その基本形式は以下の通りである．

     式1 `.' メソッド名 [`(' 引数...[`*' 引数] `)']

式1を評価して得られるオブジェクトの，識別子で指定されるメソッドを呼び出す．

メソッド名には通常の識別子の他，識別子に?または!の続いたものが許される．慣習として，述語(真偽値を返すメソッド)には?を，同名のメソッドに比べてより破壊的な作用をもつメソッド(例:trと tr!)には!をつける．

メッセージ式で，レシーバがselfの場合，レシーバを省略して通常のプログラミング言語における関数のような形式でメソッドを呼び出すことができる．

     メソッド名 `(' 引数...[`*' 引数]`)'

メソッド呼び出しの引数の周りの括弧を省略できるが，第一引数となる式が以下の文字または予約語で始まる場合は，解釈に曖昧性が生じる．

     (, [, {, /, +, -, if, while, *

rubyは第1引数のように見える部分を，人間にとって自然だと思われるように演算子の前後の空白を見ながら，若干複雑なルールで解釈する．予想通りの結果が得られなかったり，どのように評価されるか分からない場合は省略せずに括弧をつける事．

例

     foo bar+baz     # メソッド呼び出しfoo(bar+baz)
     foo(1+2)*5      # メソッド呼び出し(foo(1+2)) * 5
     foo (1+2)*5     # メソッド呼び出しfoo((1+2) * 5)
     foo 1           # メソッド呼び出しfoo(1)
     foo -1          # メソッド呼び出しfoo(-1)
     foo - 1         # ローカル変数foo - 1

メソッド呼び出しでは引数が1つもない時にも括弧を省略できる．ただし，レシーバを指定しないメソッド呼び出しの場合はローカル変数の参照と解釈されうる．

メソッド名としては任意の識別子を用いることができる．最初の文字は大文字でも小文字でも構わない．変数名とは識別子の名前空間が違うので重複しても構わない．

クラスModuleで定義されているメソッド(public,private)でメソッドの呼び出し方を制御することが出来る．privateで指定された制限されたメソッドは関数形式でしか呼び出すことが出来ない．

SUPER
-----

例

     super
     super(1,2,3)

メッセージ式の特殊なケースとしてスーパークラスのメソッドの呼び出しがある．この形式はメソッドを再定義した時にスーパークラスの定義を利用するために使う．

     super

現在のメソッドに与えられた引数のままスーパクラスの同名のメソッドを呼び出す．引数として与えられた変数の値を変更しても，渡されるのは元の引数の値である．

     super`(' 引数...`)'

引数とともにスーパークラスの同名のメソッドを呼び出す．一番最後の引数が *に続く場合は通常のメソッド呼び出しと同様に展開して渡される．

代入
--

例

     foo = bar
     foo[0] = bar
     foo.bar = baz

代入式は変数などに値を設定するために用いられる．代入式は演算子形式をとっているが，メソッドではないので再定義することはできない．左辺になることが出来るのは以下の3種類の式である．

変数(`$'識別子 | `@'識別子 | 識別子)

     変数 `=' 式

変数への代入は右辺の式を評価して得られた値を左辺で指定された変数に代入する．

配列参照(式[式...])

     式1`[' 式2...`]' `=' 式n

配列参照式への代入は，式1を評価して得られるオブジェクトに，式2から式n までを引数として，[]= というメソッドを呼び出す．

属性参照(式`.'識別子)

     式1 `.' 識別子 `=' 式2

属性参照(引数なしのメソッド呼び出し)への代入は，式1を評価して得られるオブジェクト(レシーバが省略された場合はself)に対して，識別子=というメソッドを，式2を引数として呼び出す．

自己代入
....

例

     foo += 12

式の値そのものに演算を加えるために自己代入形式がある．

     式1 op= 式2     # 式1は代入可能でなければならない．

この形式は内部的に式1 = 式1 op 式2と同様に評価される．ただし，式1は1回しか評価されないので，式1に副作用がある場合は，式1 = 式1 op 式2とは動作が異なる結果となる． opとして使える演算子は

             +, -, *, /, %, **, &, |, ^, <<, >>

の11種類である．演算子と=の間にスペースを空けてはいけない．

多重代入
....

例

     foo, bar, baz = 1, 2, 3
     foo, = list()
     foo, *rest = list2()

同時に複数の変数に代入を行なうことができる．その形式は以下の通りである．

         左辺 `,' [左辺 `,'...] [`*' 左辺]= 式 [, 式...]

左辺には代入式の3種類の式が来る．右辺の式が一つしかない場合は，その値を配列として(必要ならばto_aメソッドで配列に変換して)，要素をそれぞれ左辺に代入する．それ以外の場合には，それぞれの式の値が左辺に代入される．左辺の数と右辺の要素の数が合わない時には足りない変数には nilが代入され，余った要素は無視される．多重代入の最後の要素の前に*がある場合，残りの全て引数が配列として代入される．

例

     foo, bar = [1, 2]	# foo = 1; bar = 2
     foo, bar = 1, 2	# foo = 1; bar = 2
     foo, bar = 1		# foo = 1; bar = nil

     foo, bar, baz = 1, 2	# foo = 1; bar = 2; baz = nil
     foo, bar = 1, 2, 3	# foo = 1; bar = 2
     foo,*bar = 1, 2, 3	# foo = 1; bar = [2, 3]

多重代入の値は(配列に変換された)右辺である．

演算子式
----

例

     1+2*3/4

プログラミングの利便のために一部のメソッド呼び出しと制御構造は演算子形式をとる．Rubyには以下にあげる演算子がある．上のものほど結合順位が強く，同じ列の演算子の結合順位は同じである．

        強   ::
             [](配列参照), []=(配列代入)
             **
             -(unary)  +(unary)  !  ~
             *  /  %
             +  -
             <<  >>
             &
             |  ^
             >  >=  <  <=
             <=> ==  !=  =~  !~
             &&
             ||
             .. ...
             =(代入) 自己代入(+=, -=...)
             and or
             not
        弱   if修飾子 while修飾子

ほとんどの演算式にはメソッド呼び出しとして解釈される(クラス毎に再定義できる)が，一部再定義できない特殊なものがある．再定義できない特殊演算子は

         =, .., ..., !, not, &&, and, |, or, if修飾子, while修飾子

の各演算子と，これらとの組み合わせになる !=, !~ および自己代入演算子である．

上であげた特殊演算子以外の演算子形式は以下のようなメソッド呼び出しと見なされる．

単項演算子(+, -, ~)

     式1. 演算子 ()

配列(連想配列を含む)の要素の参照(式1 `[' 式2...`]')

     式1. `[]' (式2...)

配列要素の代入( 式1 `[' 式2...`]' `=' 式n)

     式1. `[]=' (式2..., 式n)

それ以外の2項演算子(式1 演算子 式2)

     式1. 演算子 (式2)

これはあくまでもそういう形式のメソッド呼び出しとして解釈されるというだけで，rubyプログラムでこういう記述が許されるというわけではない．

制御構造
----

Rubyでは(Cなどとは異なり)制御構造は式であり，何らかの値を持つ．この点で lispなどに似ているといえる．RubyはC言語やPerlから引き継いだ制御構造を持つが，特徴的な制御構造としてイテレータを持つ．イテレータは繰り返しを始めとする制御をユーザが定義する事が出来るものである. See イテレータ(繰り返し子)

IF
..

例

     if age >= 12 then print "adult fee\n" else print "child fee\n" end
     gender = if foo.gender == "male" then "male" else "female" end

構文

     if 式1 [then]
       式...
     [elsif 式2 [then]
       式...]...
     [else
       式...]
     end

条件判断式．Rubyのif式はelse ifでもelifでもなく elsifでifの連続を行なうことに注意すること．条件が成立して実行した式の値を返す．実行しなかった場合の値はnil．

ifの条件判断部の式では文字列と正規表現リテラルは式

     $_=~ リテラル

の省略であるとみなされる．

IF修飾子
.....

例

     print "debug\n" if $debug

構文

     式 if 式

条件修飾子(if)の式は先行する式に先だって評価される．動作も対応するif式と同様である．if修飾子のついた式の値は条件が成立した場合には式の値，不成立の場合にはnilである．

CASE
....

例

     case $age
     when 0 .. 2
       "baby"
     when 3 .. 6
       "little child"
     when 7 .. 12
       "child"
     when 12 .. 18
       "youth"
     else
       "adult"
     end

構文

     case 式0
     [when 式1 [, 式2]...[then]
       式...]...
     [else
       式...]
     end

条件分岐，CのswitchよりもPascalのcaseに似ている． breakで脱出することも後ろの式に継続することもないので注意．

条件の一致は式n =~ 式0で行なわれる．つまり，

     case expr0
     when expr1, expr2
       stmt1
     when expr3, expr4
       stmt2
     else
       stmt3
     end

は以下のif式とほぼ等価である．

     _tmp = expr0
     if expr1 =~ _tmp || expr2 =~ _tmp
       stmt1
     elsif expr3 =~ _tmp || expr4 =~ _tmp
       stmt2
     else
       stmt3
     end

AND
...

例

     test && set
     test and set

構文

     式1 `&&' 式2
     式1 `and' 式2

式1を評価し，その値が真(nil以外)であれば，式2を評価する． andは優先順位が低い別名である．

andの両辺の式では文字列と正規表現リテラルは式 $_ =~ リテラル の省略であるとみなされる．

OR
..

例

     demo || die
     demo or die

構文

     式1 `||' 式2
     式1 'or 式2

式1を評価し，その値が偽であれば，式2を評価する．orは優先順位が低い別名である．

orの両辺の式では文字列と正規表現リテラルは式 $_ =~ リテラルの省略であるとみなされる．

範囲指定式
.....

例

     1 .. 20
     /first/ ... /second/

構文

     式1 `..' 式2
     式1 `...' 式2

条件式以外の場所では式1から式2までの範囲オブジェクトを返す．

条件式として範囲指定式が用いられた場合は，式1が真になるまでは偽を返し，その後は式2が真を返すまでは真を返す．式2が真になれば状態は偽に戻る． ..は式1が真になった時に式2を評価し(awkのように)，...は次の評価まで式2を評価しない(sedのように)．

条件式で範囲指定式の両辺となる式では，文字列と正規表現リテラルは式 $_ =~ リテラルの省略，整数定数は$. == 定数の省略と解釈される．

NOT
...

例

     ! me
     not me
     i != you

構文

     `!' 式
     not 式

式が真であれば偽，偽であれば真を返す．

!式では文字列と正規表現リテラルは式$_ =~ リテラルの省略であるとみなされる．

     式1 `!=' 式2

!(式1 == 式2)の省略形

     式1 `!~' 式2

!(式1 ~= 式2)の省略形

WHILE
.....

例

     while sunshine()
       work()
     end

構文

     while 式
       ...
     end

式を評価した値が真の間，本体を繰り返し実行する．while式の値は nilである．

whileの条件判断部の式では文字列と正規表現リテラルは式 $_ =~ リテラル の省略であるとみなされる．

WHILE修飾子
........

例

     sleep while idle

構文

     単純式 while 式

左の式を評価した値が真の間，右の単純式を繰り返し実行する．右の単純式が begin式である場合はまずbegin式を評価してから条件式を評価する(最低一度はbegin式を実行する)．while修飾子のついた式の値は nilである．

イテレータ(繰り返し子)
............

例

     [1,2,3].each{|i| print i*2, "\n"}

イテレータとは制御構造(特にループ)の抽象化のために用いられるメソッドの一種である．コードの断片(ブロックと呼ばれる)を指定してイテレータを呼び出すと，イテレータは適当な値をセットしてブロックを評価する(おそらくは複数回)．イテレータからのブロックの呼び出しはyield式を用いる(後述)．

イテレータの呼び出しは以下の構文で行なわれる．

     式 `{' [`|' 左辺式...`|'] 式...`}'

「式」をブロックとして設定し，「式」のメソッドをイテレータとして評価する．「式」のトップレベルのメソッドだけがイテレータとして呼び出され，レシーバを表す式や，引数の式はイテレータとしては呼び出されない．「式」が複数の式を含む時，各々がイテレータとして順に呼ばれる．

イテレータ内でyield式が実行されると，そこで指定された値が左辺式で指定された変数に代入され，ブロックが実行される．ブロックの実行が終了するとその値は yield式の値として返される．あるメソッドがイテレータとして呼び出されたかどうかはメソッドiterator?の戻り値で知ることができる．中にはEnumerable:grepメソッドのようにイテレータとして呼ばれた時と普通のメソッドとして呼ばれた時とで動作が異なるメソッドもある．

FOR
...

例

     for i in [1, 2, 3]
       print i*2, "\n"
     end

オブジェクトの各要素に対して操作を行なうための形式も提供されている．形式は以下の通り．

     for 左辺式... in 式
       式
     end

式の各要素に対し式を実行する．これは以下の式とほぼ等価である．「ほぼ」というのは，イテレータブロックは新しいローカル変数の有効範囲を導入するのに対し，for文はローカル変数のスコープに影響を及ぼさない点が異なるからである

     (式).each `{' `|' 左辺式...`|' 式 `}'

よって式の値のオブジェクトがメソッドeachを持たない場合， forを実行すると例外が発生する．

YIELD
.....

例

     yield data

構文

     yield `(' [式 [`,' 式...]])

イテレータの中でブロックの呼び出しを行なう．yieldを実行したメソッドがイテレータとして呼び出されていない時には例外が発生する． yield の値はブロックの戻り値である．

yieldの引数の括弧は曖昧でない限り省略できる．

FAIL
....

例

     fail
     fail "you lose"

構文

     fail `(' [メッセージ] `)'

例外を発生させる．メッセージが与えられた場合には発生したソースファイル名，行番号をシステム変数$@に，メッセージを$!にセットする．

failの引数の括弧は省略できる．

BEGIN
.....

例

     begin
       do_something()
     rescue
       recover()
     ensure
       must_to_do()
     end

複数の式をまとめるためと例外所理のためにbegin式がある． begin式の形式は以下の通りである．

     begin
       式...
     [rescue
       式...]
     [ensure
       式...]
     end

begin式の値は一番最後に評価された式の値である．begin式の処理中に発生した時に例外はrescue節で捕獲することが出来る．この場合の値begin式の値ははrescue部で最後に評価した式の値である．更にensure節が存在する時はbegin式を終了する前に必ず(正常終了時だけでなく，例外, return, break, continue, redoなどによる脱出でも)ensure節の式を評価する．

RETRY
.....

例

     retry

構文

     retry

再実行．begin式のrescue節で使われた場合，begin式を始めからもう一度実行する．例外処理を行なってから再試行するのに使う．

     begin
       何らかの処理(例外が発生する)
     rescue
       例外処理
       retry  # 例外に対応して再実行
     end

イテレータ，イテレータブロックまたはfor文の中で使われた場合には，そのイテレータの評価自体を最初から実行する．イテレータの引数も再評価される．

     for i in 1..5
       retry if some_condition # i == 1 からやり直し
     end

     # ユーザ定義のuntil loop
     def until(cond)
       yield
       retry if not cond
     end

rescue節やイテレータ以外でretryが用いられた場合例外が発生する．

RETURN
......

例

     return
     return 12
     return 1,2,3

構文

     return [式[`,' 式...]]

式の値を戻り値としてメソッドの実行を終了する．式が2つ以上与えられた時には，それらを要素とする配列をメソッドの戻り値とする．式が一つもない場合には nil が戻り値となる．

BREAK
.....

例

     break

構文

     break

break はループを脱出する．Cと違い，breakはもっとも内側のループを脱出する作用だけを持ち，case を抜ける作用は持たない．

CONTINUE
........

例

     continue

構文

     continue

continueはもっとも内側のループの次の繰り返しを始める．

REDO
....

例

     redo

構文

     redo

redoはループ条件のチェックを行なわず，現在の繰り返しをやり直す．

クラス定義
-----

例

     class Foo:Super
       def test
          :
       end
          :
     end

構文

     class クラス名 [`:' スーパークラス名 ]
         定義実体
     end

クラス名は大文字で始まる識別子である．

モジュール定義
-------

例

     module Foo
       def test
          :
       end
          :
     end

構文

     module クラス名
         定義実体
     end

モジュール名は大文字で始まる識別子である．

メソッド定義
------

例

     def fact(n)
       if n == 1 then
          1
       else
         n * fact(n-1)
       end
     end

構文

     def メソッド名 [`(' [引数 [= デフォルト]]...[`,' `*' 引数 ]`)']
         定義実体
     end

引数にデフォルト式が与えられた場合，メソッド呼び出し時に引数が与えられなかった場合にはデフォルト式を評価した結果で初期化される(デフォルト式の評価は呼び出し時に行われる)．一番最後の引数が*に続く(単一の) 式である場合，その式を評価した結果(配列でなければ変換される)を展開して，引数として追加する．

通常メソッド定義はネストできないので，メソッド定義式中ではメソッド定義式を再び呼び出せない．

メソッド名は識別子または文字列である．演算子の再定義をする時には文字列で指定する．仮引数並びの最後に*がある場合，仮引数より多く与えられた実引数は，最後の引数に配列として与えられる(足りない時にはエラー)．

メソッドには呼び出し制限を加えることができ，制限を加えられたメソッドは，関数形式でしか呼び出せない(privateメソッド)．

新規にメソッドを定義する場合，クラス定義式の外にあるdef式はデフォルトではprivateメソッドを定義し，クラス定義式の中にあるdef式はpublicメソッドを定義する．スーパークラスのメソッドを再定義する場合には定義されるメソッドの可視性はスーパークラスのメソッドのものを受け継ぐ．

メソッドの可視性を変更する場合にはModuleクラスで定義されている public, privateの各メソッドを用いる．

特異メソッド定義
--------

例

     def foo.test()
       print "this is foo\n"
     end

構文

     def 式 `.' メソッド名 [`(' [引数 [= デフォルト]]...[`,' `*' 引数 ]`)']
         定義実体
     end

特異メソッドとはある特定のオブジェクトに固有のメソッドである．

この形式は式の値であるオブジェクトに特異メソッドを定義する．式の値は (ビルトインクラスでない)通常オブジェクトか，クラスまたはモジュールである必要がある．通常メソッド定義とは異なり，特異メソッドはメソッド本体内でもネストして定義することができる．

特異メソッドは通常は継承しないが，例外としてクラスの特異メソッドはそのサブクラスにも継承される．言い替えればクラスの特異メソッドは他のオブジェクト指向システムにおけるクラスメソッドの働きをする．

注意: インクルードしたモジュールの特異メソッドは継承しない．

ALIAS
-----

例

     alias foo bar

構文

     alias メソッド名1 メソッド名2

alias文でメソッドに別名をつけることができる．別名を付けられたメソッドは，その時点でのメソッド定義を引き継ぎ，元のメソッドが再定義されても，再定義前の古いメソッドが呼び出されたのと全く同じ働きをする．

UNDEF
-----

例

     undef bar

構文

     undef メソッド名

メソッドの定義を取り消すためにはundefを用いる．

defによる別名定義とundefによる定義取り消しによってクラスのインタフェースをスーパークラスと独立に変更することができる．ただし，メソッドがselfにメッセージを送っている場合もあるので，よく注意しないと既存のメソッドが動作しなくなる可能性がある．

DEFINED?
--------

例

     defined? print
     defined? File.print
     defined?(foobar)
     defined?($foobar)
     defined?(@foobar)
     defined?(Foobar)

構文

     defined? 式

式がメソッド呼び出しの場合，そのメソッドが定義されている時に真を返す．式が変数や定数の参照である場合は，それらの変数や定数が定義されている時に真を返す．それ以外の式の場合は式を評価して，例外が発生しなければ真を返す．

組み込み関数
******

Rubyには厳密な意味では関数はないがKernelクラスの関数メソッドは (全ての通常クラスから関数形式で呼び出せるので)，関数的に用いられる．関数的に用いられるメソッドを以下にあげる．これらのメソッドを再定義する際には互換性を考えて行なうべきである．

autoload(MODULE, FILE)

     MODULEに最初にアクセスした時にFILEをrequireするように設定する．MODULEは文字列またはシンボルで指定する．

caller([LEVEL])

     LEVEL段上の呼出し元の情報を$@の形式で得る．トップレベルではnilを返す．callerの戻り値を$@に代入することで例外の発生位置を設定できる．また，以下のようなコードで呼出し関係のバックトレースを表示できる．

          n = 0
          while c = caller(n)
            print c, "\n"
          end

eof
eof?

     コマンドラインからの入力がEOFに到達している場合，真を返す．

eval(EXPR)

     EXPRとして与えられた文字列をrubyプログラムとして解釈，実行する．

exec(COMMAND)

     プログラムの実行を終了する．STATUSとして整数が与えられた場合，その値をrubyコマンドの終了ステータスとする．デフォルトは0．

exit!(STATUS)

     プログラムの実行を終了する．整数STATUSを終了ステータスとする． exitとは違って，例外処理などは一切行なわない．forkの後，子プロセスを終了させる時などに用いる．

fork

     forkシステムコールを実行し，子プロセスを生成する．詳細は fork(2)を参照のこと．親プロセス側では子プロセスのプロセスidを返し，子プロセス側ではnilを返す．何らかの原因で子プロセスの生成に失敗した時には例外が発生する．イテレータとして呼ばれた時は，生成した子プロセスで与えられたブロックを評価し，ブロックの評価が終了した時点で子プロセスは正常終了する．

format(FORMAT...)

     フォーマットとして与えられた文字列をC言語のsprintfと同じように解釈し，引数を展開した文字列を返す．メソッドsprintfの別名．

     Rubyにおけるformat指定子の拡張についてはsprintfの項を参照のこと．

getc

     標準入力から一文字取り出す．戻り値は読み込んだ文字の文字コード(ASCII) を表すFixnumである．

gets

     引数として与えられたファイル(なければ標準入力)で構成される仮想的なファイル(システム変数$<でアクセスできる)から一行読み込んで，読み込みに成功した時にはその文字列を返す．ファイルの終りに到達した時にはnilを返す．行の区切りはシステム変数$/によって変更できる．読み込んだ文字列はシステム変数$_にもセットされる．

gsub(PATTERN[, REPLACE])
gsub!(PATTERN[, REPLACE])

     システム変数$_の指す文字列内で PATTERNにマッチする部分を全てREPLACEに置き換える．Stringクラスのgsubメソッドの解説を参照のこと．引数REPLACEが省略された時にはイテレータとして動作し，ブロックを評価した結果で置換する．gsubメソッドは $_の値をコピーして，コピーの方を更新し，$_に代入する．

     gsub!は$_の指している文字列そのものを書き換える．

iterator?

     メソッドがイテレータとして呼び出された時には真，そうでない時に偽を返す述語．

kill(SIGNAL, PID...)

     PIDで指定されたプロセスにシグナルを送る．SIGNALはシグナル番号か名前で指定する．負の値を持つシグナル(あるいはシグナル名の前に -)を与えるとプロセスではなくプロセスグループにシグナルを送る．

load(FILE)

     FILEをロードする．FILEをロードするパスはシステム変数 $:で決定される．

loop

     無限ループするイテレータ．(中断されない限り)永久にイテレータブロックを評価し続ける．

open(FILE[, MODE])

     FILEをオープンして，Fileオブジェクトを返す．ファイル名はオープンするファイルを示す．ファイル名が|で始まる時には続く文字列をコマンドとして起動し，パイプラインを生成する．

     コマンド名が"-"である時，openはrubyの子プロセスを生成し，その子プロセスとのパイプを返す．

     MODEはファイルのアクセスモードを指定する．これは以下のうちのいずれかの文字列である．

     r
          読み込み専用．openするファイルはあらかじめ存在している必要がある．

     r+
          読み書き両用．openするファイルはあらかじめ存在している必要がある．

     w
          書き込み専用．ファイルが存在していた場合，長さを0にする．存在していなければ新たにファイルを作成する．

     w+
          読み書き両用．読み込みが行なえること以外は"w"と同じ働きをする．

     a
          追加書き込み専用．ファイルはあらかじめ存在している必要がある．書き込みはファイルの最後に追加される．

     a+
          読み書き両用．ファイルが存在していなければ新たに作成する．アクセス位置はファイルの最後に初期化される．

     モードが省略された場合のデフォルトは"r"である．

print(ARG1...)

     引数を順に出力する．引数が与えられない時には$_の値を出力する．文字列以外のオブジェクトが引数として与えられた場合には，当該オブジェクトのto_sメソッドによって文字列に変換してから出力される．システム変数$;(出力フィールドセパレータ)にnilでない値がセットされている時には，各引数の間にその文字列を出力する．システム変数 $\(出力フィールドセパレータ)にnilでない値がセットされている時には，最後にそれを出力する．

printf([PORT, ]FORMAT, ARG...)

     C言語のprintfと同じようにFORMATに従い引数を文字列に変換し，出力する．第1引数がIOのサブクラスのインスタンスであった場合はそのオブジェクトに対して出力を行なう．デフォルトは$stdoutに出力する．

     Rubyにおけるformat指定子の拡張についてはsprintfの項を参照のこと．

proc
lambda

     与えられたイテレータブロックを手続きオブジェクト(クラスProcのインスタンス)として返す．

rand(MAX)

     0からMAXを越えない範囲の整数の乱数を発生する．戻り値は Fixnum．

require(FEATURE)

     FEATUREで指定されるfileをロードする．FEATUREはロードするファイルを指定する文字列で，拡張子.rbが指定されている時はrubyスクリプト，拡張子.oが指定されている時は，バイナリモジュールをロードする．ただし，いくつかのアーキテクチャではバイナリモジュールのロードは提供されない．バイナリモジュールの実際のファイルの拡張子はアーキテクチャ毎に異なるが，FEATURE名の拡張子はいつも.oを用いる．

     拡張子が指定されない場合は，まず.rb，次に.oを補って，ファイルを検索する．

     requireは実際にロードした時には TRUE，既にロードされている時にはFALSEを返す．またロードしたFEATUREの名前を(拡張子も含めて)，変数$"に追加する．

select(READS[, WRITES[, EXECPTS[, TIMEOUT]]])

     select(2)を実行する．READS/WRITES/EXECPTSには IO(またはそのサブクラス)のインスタンスの配列を与える．TIMEOUTは Fixnum/Float/Timeのいずれかで指定する．戻り値はTIMEOUTが成立した場合にはnil，そうでないときは3要素の配列を返し，その各要素が入力/出力/例外待ちのオブジェクトの配列である(指定した配列のサブセット．待ちオブジェクトの配列を指定しなかった場合はnil)．システムコール実行中に割込みが起こった場合には各配列は空になる．

sleep([SEC])

     SEC秒だけプログラムの実行を停止する．SECが省略された場合，プロセスにSIGALRMが送られない限り，永久にスリープする．実際にスリープした秒数を返す．

sprintf(FORMAT...)

     FORMAT文字列をC言語のsprintfと同じように解釈し，引数を展開した文字列を返す．メソッドformatの別名．

     FORMAT指定子はC言語のsprintf()が受け付けるもの(ただし， Rubyには unsignedがないので，%uは除く)に加えて, %b, %B, %O, %Xを使うことができる．%bは数値の2進表示，%B, %O, %Xはそれぞれ2進，8進，16進数の表示を行なうが，負の数の処理の際に2の補数表現ではなく，その絶対値表記の先頭に-をつけたものを表示する．

srand([SEED])

     乱数のSEEDを設定し，古い初期値を返す．初期値が省略された時には time(3)の返す値をデフォルトとする．

sub(PATTERN[, REPLACE])
sub!(PATTERN[, REPLACE])

     システム変数$_の指す文字列で最初にPATTERNにマッチする部分をREPLACEに置き換える．引数REPLACE が省略された時にはイテレータとして動作し，ブロックを評価した結果で置換する．subメソッドは $_の値をコピーして，コピーの方を更新し，$_に代入する．その他の詳細に関してはStringクラスのsubメソッドの解説を参照のこと．

     sub!は$_の指している文字列そのものを書き換える．

syscall(NUM, ARG...)

     NUMで指定された番号のシステムコールを実行する．第2引数以降をシステムコールの引数として渡す．引数は文字列または整数でなければならない．

system(COMMAND)

     COMMANDを実行し，成功した時(サブプロセスがstatus 0で終了した時) には真を，失敗した時には偽を返す．終了ステータスは変数$?  で参照できる．

test(CMD, FILE [, FILE])

     ファイルテストを行う．CMDは以下に示す文字リテラルである．ファイル名として"&"を指定すると，直前のファイルへのstat(2)の結果を再利用する．

     1つの引数を取るもの

          ?r        ファイルを実効 uid で読むことができる
          ?w        ファイルに実効 uid で書くことができる
          ?x        ファイルを実効 uid で実行することができる
          ?o        ファイルの所有者が実効 uid である

          ?R        ファイルを実 uid で読むことができる
          ?W        ファイルに実 uid で書くことができる
          ?X        ファイルを実 uid で実行することができる
          ?O        ファイルの所有者が実 uid である

          ?e        ファイルが存在する

          ?z        ファイルサイズが 0 である
          ?s        ファイルサイズが 0 でない(ファイルサイズを返す)

          ?f        ファイルはプレーンファイルである
          ?d        ファイルはディレクトリである
          ?l        ファイルはシンボリックリンクである
          ?p        ファイルは名前つきパイプ(FIFO)である
          ?S        ファイルはソケットである
          ?b        ファイルはブロック特殊ファイルである
          ?c        ファイルはキャラクター特殊ファイルである

          ?u        ファイルに setuid ビットがセットされている
          ?g        ファイルに setgid ビットがセットされている
          ?k        ファイルに sticky ビットがセットされている

          ?M        スクリプトの実行を開始した時点でのファイルの古さ
          ?A        スクリプトの実行を開始した時点でのファイルのアクセス時間
          ?C        スクリプトの実行を開始した時点でのファイルの inode 変更時間

     2つの引数を取るもの

          ?=        ファイル1とファイル2のタイムスタンプが等しい
          ?>        ファイル1の方がファイル2より更新時間が新しい
          ?<        ファイル1の方がファイル2より更新時間が古い
          ?-        ファイル1がファイル2にハードリンクされている

trace_var(VAR, COMMAND)

     VARで指定された大域変数の値が変更された時に評価される COMMANDを指定する．COMMANDは文字列，またはブロックで指定する．traceを解除するためにはuntrace_varを用いる．

trap(SIGNAL, COMMAND)
trap(SIGNAL) {...}

     SIGNALの割り込みがかかった時にCOMMANDを実行する． SIGNALはシグナル名かシグナルの番号．COMMANDは文字列，またはブロックで指定する．commandとして"SIG_IGN"または "IGNORE"を指定した時にはそのシグナルを無視する(可能ならば)． "SIG_DFL"または"DEFAULT"を指定した時はデフォルトの動作を行なう．"EXIT"を指定した時はシグナルを受け取ると(終了処理を行った後)，exit status 1で終了する．

untrace_var(VAR)

     VARに対する全てのtraceを解除する．traceとして指定されているオブジェクトを配列にいれて返す．

wait

     子プロセスが終了するのを待ち，終了した子プロセスのpidを返す．子プロセスが一つもなければnilを返す．

waitpid(PID, FLAGS)

     PIDで指定される特定の子プロセスの終了を待ち，そのプロセスが終了した時に真を返す．子プロセスが存在しないか，ノンブロッキングモードで子プロセスがまだ終了していない時にはnilを返す．waitpid(2)か wait4(2)の実装されていないマシンではFLAGSはいつもnilまたは0でなければならない．

組み込み変数と定数
*********

$!
     エラーメッセージ．failで設定する．

$@
     エラーが発生した時点のファイル名と行番号が

          "ファイル:行番号[:メソッド名(あれば)]"

          の形式で格納される．

     $&
          最後に成功したパターンマッチ

     $`
          最後のパターンマッチでマッチした文字列の前の文字列

     $'
          最後のパターンマッチでマッチした文字列の後に続く文字列

     $+
          最後の検索パターンでマッチした最後の括弧

     $1...$9
          最後に成功したパターンマッチでn番目の括弧にマッチした値が格納される．
          該当する括弧がなければnilが入っている．

     $~
          最後のマッチに関する情報．これをセットすると$&や
          $1...$9の値が変化する．

     $=
          この変数の値がnilでない時，パターンマッチや文字列の比較でアルファベッ
          トの大文字小文字を区別しない．デフォルトはnil(区別する)．

     $/
          入力レコードセパレータ．ファイルや文字列に対してeachを行なう時
          の分割文字を指定する．$/に空文字列("")を指定すると段落単位で入
          力を行ない，nilを指定すると全体を一度に読み込む．$/には
          正規表現は使えない．デフォルトは"\n"．

     $\
          出力レコードセパレータ．この変数に文字列を指定するとwriteや
          printの度に最後にこの文字列を付加して出力する．デフォルトは
          nil (なにも追加しない)．

     $,
          Array:joinのデフォルトの区切り文字列．printの各引数の間
          に出力される文字列．

     $;
          String:splitのデフォルトの区切り文字．

     $.
          最後に読んだ入力ファイルの行番号．

     $<
          引数(なければ標準入力)で構成される仮想ファイル．つまりgetsは
          $<.getsと同じ意味である．$<.fileで現在読み込み中のファイ
          ルオブジェクトが，$<.filenameでそのファイル名が得られる．(覚え
          方: <はシェルの入力元指定)

     $>
          printやprintfのデフォルトの出力先．初期値は
          $stdout．-iオプションを指定した場合には読み込み元と同じ
          名前のファイル．(覚え方: >はシェルの出力先指定)

     $_
          最後にgetsなどで読み込んだ文字列．

     $0
          rubyスクリプトの名前．この変数に代入するとps(1)の出力が変化する．

     $*
          rubyスクリプトに与えられた引数．ruby自身に対する引数は取り除かれている．

     $$
          現在実行中のrubyプロセスのpid．

     $?
          最後に実行した子プロセスのstatus．

     $:
          ファイルをロードする時に検索するディレクトリへのパスを含む配列．起動時
          にはデフォルト値(コンパイル時に指定する)に加えて，環境変数
          RUBYLIBの値とruby起動時の-Iオプションで指定された値が追加
          される．(覚え方: コロンは環境変数PATHの区切り文字である)

     $"
          requireでロードされたファイル名を含む配列．requireで同じ
          ファイルを2回ロードしないために用いられる．(覚え方: prevent files to
          be doubly quoted(loaded))

     $ARGF
          $<の別名．

     $ARGV
          $*の別名．

     $DEBUG
          -dフラグの状態(真偽値)．

     $FILENAME
          仮想ファイル$<で現在読み込み中の(メソッドgetsが今読んでいる)ファ
          イル名．$<.filenameと同じ．

     $KCODE
          現在処理対象としている漢字コードを表す文字列．"EUC"，
          "SJIS"または"NONE"．この変数の値を変更すると正規表現のマッ
          チの直前に正規表現の再コンパイルが行われる．

     $LOAD_PATH
          $:の別名．

     $stdin
          標準入力

     $stdout
          標準出力

     $stderr
          標準エラー出力

     $VERBOSE
          -vフラグの状態(真偽値)

     TRUE
     FALSE
          それぞれ真偽値を表す(TRUEの値はt，FALSEの値はnil)．
          条件判断はnilを偽，それ以外の全ての値を真として判断するため，
          TRUEの値は代表的な真の値という以上の意味を持たない．よって，あ
          るメソッドの返値が真であるということと，それがTRUEを返すという
          ことは厳密には同じではない(述語的に用いられるメソッドは大抵真の値とし
          てTRUEを返すようにはなっているが)．つまり

               if some.method() then ... else ... end

          と

               if some.method() == TRUE then ... else ... end

          は完全には同義ではない．FALSEに関しては，このような問題は生じ
          ない．

     STDIN
          標準入力($stdinの初期値)

     STDOUT
          標準出力($stdoutの初期値)

     STDERR
          標準エラー出力($stderrの初期値)

     ENV
          環境変数にアクセスする連想配列．文字列をキーとして与えると対応する環境
          変数の値が得られる．環境変数が存在しない場合はnilが返る．

     VERSION
          rubyのバージョンを示す文字列

組み込みクラスとモジュール
*************

Array
=====

数字を添字とした配列のクラスである．生成は一般的には配列式``[...]''で行なわれる．

SuperClass: Object

Included Modules: Enumerable

Methods:

self[NTH]
self[START..END]
self[START, LENGTH]

     配列の要素にアクセスする．最初の形式では配列のNTH番目の要素を返し，2番目の形式ではSTART番目の要素からEND番目の要素を含む部分配列を返す．3番目の形式ではSTART番目からLENGTH個の要素を含む部分配列を返す．

self[NTH] = VAL
self[START..END] = VAL
self[START, LENGTH] = VAL

     配列の要素を変更する．最初の形式では配列のNTH番目の要素を VALに変更する．2番目の形式はSTART番目の要素からEND番目の要素までをVALに変更する．3番目の形式ではSTART番目から LENGTH個の要素をVALに変更する．

     2番目，3番目の形式ではVALは配列でなければならない．

     例

          ary = [1, 2, 3, 4, 5]
          ary[0..2] = [0, 0] # 配列の内容は [0, 0, 4, 5]
          ary[1, 0] = [7]    # 配列の内容は [0, 7, 0, 6, 5]

self + OTHER

     配列の連結．selfとOTHERの両方の配列の内容を繋げた新しい配列を返す．

self * TIMES

     配列の繰り返し．

self - OTHER

     集合の差演算．selfからOTHERの要素を取り除いた内容の新しい配列を返す．重複する要素は1度だけ現れる．

self * OTHER

     集合の積演算．両方の配列に含まれる要素からなる新しい配列を返す．重複する要素は1度だけ現れる．

self | OTHER

     集合の和演算．両方の配列にいずれかに含まれる要素を全て含む新しい配列を返す．重複する要素は1度だけ現れる．

self << OBJ

     objを配列の末尾に追加する．selfを返すのでC++的に連鎖できる．

assoc(KEY)

     連想リスト(2要素の配列を要素とする配列)を検索し，第1要素がKEYと等しい (==で比較する)配列を返す．

clear

     配列の大きさを0にする．

delete(VAL)

     VALと一致する要素を削除する．

delete_if {...}

     要素を削除するイテレータ．ブロックを評価した値が真の時，対応する要素を配列から削除する．

each {...}

     配列の各要素を順に与えるイテレータ．

fill(VAL)
fill(VAL, START[, LENGTH])
fill(VAL, START..END)

     配列(の指定された部分)の要素の値をVALに設定する．2番めの形式で LENGTHが省略された時は配列の終りまでの長さをとる．指定された部分配列が元の配列の範囲を越える時は自動的に拡張される．

index(VAL)

     VALと等しい最初の要素のインデックスを返す．該当する要素が存在しない場合はnilを返す．

indexes(ARY)
indexes(INDEX_1,..., INDEX_N)

     1番目の形式では整数の配列を引数として受けて，その要素をインデックスとする要素を含む配列を返す．2番目の形式では各引数の値をインデックスとする要素を含む配列を返す．

join([SEP])

     配列の要素を連結した文字列を返す．各要素は文字列に変換され，間に SEPを挟んで連結される．SEPが省略された時にはシステム変数 $,の値が用いられる．

length
size

     配列の長さ(要素数)を返す．

pack(TEMPLATE)

     配列の内容をTEMPLATE文字列にしたがって，1つの文字列にパックする．パックした文字列を返す．テンプレートは型指定文字列とその長さ(省略時は 1)を並べたものである．長さとして*が指定された時は「残りのデータ全て」の長さを表す．

     型指定文字は以下のものがある．

          a     ASCII文字列(null文字を詰める)
          A     ASCII文字列(スペースを詰める)
          b     ビットストリング(下位ビットから上位ビット)
          B     ビットストリング(上位ビットから下位ビット)
          h     16進文字列(下位ニブルが先)
          H     16進文字列(上位ニブルが先)
          c     char
          C     unsigned char
          s     sort
          S     unsigned sort
          i     int
          I     unsigned int
          l     long
          L     unsigned int
          n     ネットワークバイトオーダーのshort
          N     ネットワークバイトオーダーのlong
          f     単精度浮動小数点数(機種依存)
          d     倍精度浮動小数点数(機種依存)
          x     ナルバイト
          X     1バイト後退
          @     絶対位置への移動

pop

     配列の末尾の要素を取り除いて，それを返す．

push(OBJ)

     OBJを配列の末尾に追加する．

rassoc(VALUE)

     連想リスト(2要素の配列を要素とする配列)を検索し，第2要素がVALUE と等しい(==で比較する)配列を返す．

shift

     配列の先頭の要素を取り除いて，それを返す．

sort
sort {|A, B|...}

     配列の内容をソートする．イテレータとして呼び出された場合はブロックを評価した値で要素の大小を決定する．大きい時に正，等しい時に0，小さき時に負．通常のメソッドとして呼び出された場合は各要素を<=>で比較する．

to_a

     自分自身を返す．対称性のために用意されているメソッドであまり面白くない．

unshift(OBJ)

     OBJを配列の先頭に追加する．

Single Methods:

Array[ITEM...]

     引数を要素とする配列を生成する．

See Object see Enumerable

Bignum
======

無限多倍長整数のクラス．演算の結果がこのFixnumの範囲内である場合には自動的にクラスはFixnumに変換される．一般的にrubyプログラムではFixnumとBignumの変換は暗黙のうちに行われるので，意識する必要は無い．Floatとの混合に関しては，Bignumより Floatの方がgenericityが高いのにも関わらず，Bignumの方が，大きな値を表現できるので，変換時に桁落ちが生じる可能性がある．

SuperClass: Integer

Methods:

self + OTHER
self - OTHER
self * OTHER
self / OTHER
self % OTHER
self ** OTHER

     算術演算．それぞれ和，差，積，商，剰余，冪乗を返す．

~ self
self | OTHER
self & OTHER
self ^ OTHER

     ビット演算．それぞれビット反転，論理和，論理積，排他的論理和を返す．

self << BITS
self >> BITS

     シフト演算．それぞれBITSビットだけ左右にビットシフトを行なう．

divmod(OTHER)

     商と剰余からなる配列を返す．

See Integer

Class
=====

クラスのクラス．より厳密に説明するとクラスは特異メソッドを継承するために，それぞれメタクラスと呼ばれる名前のないクラスをクラスとして持ち， Classはそのメタクラスのクラスである(分かったかな?)．が，この解説が理解できなくても，rubyを使うことに何の支障もない．クラスには特異メソッドを定義できる事と，スーパークラスで定義された特異メソッドはそのサブクラスでも有効である事を知れば十分である．

SuperClass: Module

Private Methods:

attr(NAME[, PUBLIC])

     そのクラスのインスタンスに対してNAMEで指定される属性を定義する．詳しくはModuleのattrメソッドの項を参照のこと．

Methods:

new(...)

     クラスのインスタンスを生成する．多くの場合このメソッドはサブクラスの特異メソッドによってオーバーライドされ，クラスによって引数が異なる．

See Module

Comparable
==========

比較演算を許すクラスのためのMixin．このモジュールをインクルードすることによって，<=>演算子を定義するだけで他の演算子はその定義を利用して派生できる．

Methods:

self == OTHER

     selfがOTHERと等しい時真を返す．

self > other

     selfがOTHERより大きい時真を返す．

self >= OTHER

     selfがOTHERより大きいか等しい時真を返す．

self < OTHER

     selfがOTHERより小さい時真を返す．

self <= OTHER

     selfがOTHERより小さいか等しい時真を返す．

between?(min, max)

     selfがMINとMAXの範囲内にある時真を返す．

Dir
===

ディレクトリ内の要素を順に返すディレクトリストリーム操作のためのクラス．

SuperClass: Object

Included Modules: Enumerable

Methods:

close

     ディレクトリストリームをクローズする．以後の操作は例外を発生させる．

each {|ITEM|...}

     ディレクトリ内の各要素を順に与えるイテレータ．

getwd
pwd

     カレントディレクトリを返す．

rewind

     ディレクトリストリームを先頭にリセットする．

seek(POS)

     ディレクトリストリームの位置をPOSに設定する．

tell

     ディレクトリストリームの現在の位置を返す．

     Single Methods:

self[PAT]
glob(PAT)

     文字列PATをsh形式のワイルドカードとして展開した結果を文字列の配列として返す．書式は以下の通りである．

     *
          任意の文字列(空文字列を含む)と一致

     ?
          任意の1文字と一致

     [ ]
          []内のいずれか1文字と一致

     ...
          内の(コンマで区切られた)いずれかの文字列と一致

chdir(PATH)

     カレントディレクトリをPATHに変更する．

chroot(PATH)

     プロセスのルートディレクトリを変更する，同名のシステムコールと同じ働きをする．この操作は実効uidがスーパユーザである時だけに制限されている．ルートディレクトリを元に戻す(ルートディレクトリを上方に変更する)方法は提供されていない．

mkdir(PATH[, MODE])

     MODEで指定されたモードを持つディレクトリPATHを作成する．モードはumaskによって修正される．MODEのデフォルト値は0777．

open(PATH)

     PATHに対するディレクトリストリームをオープンする．

rmdir(PATH)

     PATHで指定されたディレクトリを削除する．ディレクトリは空である必要がある．

See Object see Enumerable

Enumerable
==========

要素に対する繰り返しを行なうクラスのためのMixin．このモジュールをインクルードするためには，メソッドeachを定義する必要がある．

Methods:

collect {|ITEM|...}

     各要素に対してブロックを評価した結果を全て含む配列を返す

find {|ITEM|...}

     要素に対してブロックを評価した値が真になった最初の要素を返す．

find_all {|ITEM|...}

     各要素に対してブロックを評価した値が真であった要素を全て含む配列を返す．

grep(pattern)
grep(pattern) {|ITEM|...}

     要素 =~ PATTERNが成立する全ての要素を含む配列を返す．イテレータとして用いられた時は上記の条件の成立した要素に対してブロックを実行する．

member?(VAL)

     VALと==の関係にある要素を持つ時，真を返す．

index(VAL)

     VALと==の関係にあるオブジェクトが何番目に現れたかを返す．一番最初の要素が0になる．要素が存在しない時にはnilを返す．順序のないクラスに対してはあまり意味がない．

length

     要素の数を返す．

min

     最小の要素を返す．全ての要素がお互いに<=>メソッドで比較できることを仮定している．

max

     最大の要素を返す．各要素が<=>メソッドで比較できることを仮定している．

reverse

     全ての要素を逆順に並べた配列を返す．

sort
sort {|A, B|...}

     全ての要素をソートした配列を返す．

File
====

ファイルアクセスのためのクラス．メソッドopenで生成される．また，このクラスの特異メソッドとしてtestのファイルテスト演算子相当のメソッドが定義されている(FileTestモジュールのメソッド郡)．

SuperClass: IO

Methods:

atime

     ファイルの最終アクセス時刻を返す．

ctime

     ファイルの最終ステータス変更時刻を返す．

chmod(MODE)

     ファイルのパーミッションを変更する(cf chmod(2))．

chown(OWNER, GROUP)

     ファイルの所有者とグループを変更する(cf chown(2))．nilか -1を指定することによって所有者やグループを現在のまま変えないでおくことができる．

eof
eof?

     ファイルの終端に到達した時に真を返す．

lstat

     ファイルに関するStat構造体を返す．lstatはファイルがシンボリックリンクであればリンクそのものに関するStat構造体を返す．構造体の内容についてはstatを参照のこと．

mtime

     ファイルの最終修正時刻を返す．

rewind

     ファイルのファイルポインタの位置を先頭に移動する．

path

     ファイルのパス名を返す．

seek(OFFSET, PTRNAME)

     ファイルのファイルポインタの位置をOFFSETに移動する． PTRNAMEは0，1，2のいずれかであって，それぞれファイルの先頭，現在位置，ファイルの終端からの相対を示す．

stat

     ファイルに関するStat構造体を返す(see Struct)．

          struct stat
            dev	 	# ファイルの存在するデバイス
            ino		# ファイルのi-node番号
            mode		# モード
            nlink		# ハードリンクの数
            uid		# 所有者のユーザID
            gid		# 所有者のグループID
            rdev		# デバイスのID(スペシャルファイルのみ)
            size		# ファイルサイズ(byte数)
            blksize	# ファイルシステムにおいて適切なブロックサイズ
            blocks	# ブロック数
            atime		# 最終アクセス時間
            mtime		# 最終更新時間
            ctime		# 最終状態変更時間
          end

     詳細な説明はstat(2)を参照のこと．システム上で定義されている Stat構造体に該当するメンバがない場合は0が設定されている．

tell

     ファイルの現在のファイルポインタの位置を返す．

truncate(LENGTH)

     ファイルを切り捨てて最大LENGTHバイトにする．ファイルは writeモードでオープンされていなければならない．

     Single Methods:

atime(FILENAME)

     FILENAMEの最終アクセス時刻を返す．

basename(FILENAME[, SUFFIX])

     FILENAMEの最後の要素を返す．SUFFIXが与えられた場合は，その拡張子も取り除く．

          basename("ruby/ruby.c")
                  => "ruby.c"
          basename("ruby/ruby.c", ".c")
                  => "ruby"

ctime(FILENAME)

     FILENAMEの最終ステータス変更時刻を返す．

chmod(MODE, PATH, FILE...)

     ファイルのパーミッションを変更する(cf chmod(2))．変更したファイル数を返す．

chown(OWNER, GROUP, FILE...)

     ファイルの所有者とグループを変更する(cf chown(2))．nilか -1を指定することによって所有者やグループを現在のまま変えないでおくことができる．変更したファイル数を返す．

dirname(FNAME)

     ファイル名の最後の要素以外を返す．

expand_path(PATH)

     ファイル名を絶対パスに展開する．~はホームディレクトリに展開される．

          expand_file_name("..")
                  => "/home/matz/work"
          expand_file_name("~")
                  => "/home/matz"
          expand_file_name("~matz")
                  => "/home/matz"

link(OLD, NEW)

     OLDへのハードリンクNEWを生成する．link(2)と同じ制限がある．

mtime(FILENAME)

     FILENAMEの最終修正時刻を返す．

readlink(PATH)

     シンボリックリンクPATHの内容を文字列として返す．

rename(FROM, TO)

     ファイル名FROMをTOに変更する．rename(2)参照．既に TOという名前のファイルが存在する時にはまずそのファイルが削除される．

stat(FILENAME)

     FILENAMEのファイルのStat構造体を返す．

symlink(OLD, NEW)

     OLDへのシンボリックリンクNEWを生成する．

truncate(PATH, LENGTH)

     PATHで指定されたファイルを切り捨てて最大LENGTHバイトにする．

type(FILENAME)

     FILENAMEのファイルのタイプを表す文字列を返す．文字列は "file"，"directory"，"characterSpecial"， "blockSpecial"，"fifo"，"link"，"socket"のうちのいずれか一つである．

unlink(FILE...)

     ファイルを削除する．ディレクトリの削除にはDir.rmdirを使うこと．

utime(ATIME, MTIME, FILE...)

     ファイルのアクセス時刻をATIMEに，修正時刻をMTIMEに設定する． ATIME，MTIMEは数またはTimeクラスのインスタンスでなければならない．

これ以外にFileTestモジュールのメソッドも特異メソッドとして持つ．

See IO

FileTest
========

ファイルテスト用メソッドを集めたモジュール．インクルードして用いることもできる．このモジュールのメソッドにファイル名として"&"を指定すると，直前のファイルへのstat(2)の結果を再利用する．

Methods: Single Methods:

blockdev?(FILENAME)

     FILENAMEのファイルがブロックスペシャルファイルである時，真を返す．

chardev?(FILENAME)

     FILENAMEのファイルがキャラクタスペシャルファイルである時，真を返す．

executable?(FILENAME)

     FILENAMEのファイルが実行可能の時，真を返す．

executable_real?(FILENAME)

     FILENAMEのファイルが実uid/gidで実行可能の時，真を返す．

exists?(FILENAME)

     FILENAMEのファイルが存在する時，真を返す．

grpowned?(FILENAME)

     FILENAMEのファイルのgidが実効グループのgidと同じ時，真を返す．

directory?(FILENAME)

     FILENAMEがディレクトリの時，真を返す．

file?(FILENAME)

     FILENAMEのファイルが通常ファイルの時，真を返す．

link?(FILENAME)

     FILENAMEのファイルがシンボリックリンクである時，真を返す．

pipe?(FILENAME)

     FILENAMEのファイルが名前つきパイプ(FIFO)である時，真を返す．

socket?(FILENAME)

     FILENAMEのファイルがソケットである時，真を返す．

owned?(FILENAME)

     FILENAMEのファイルを実効ユーザが所有している時，真を返す．

readable?(FILENAME)

     FILENAMEのファイルを読みとり可能の時，真を返す．

readable_real?(FILENAME)

     FILENAMEのファイルを実uid/gidで読みとり可能の時，真を返す．

setuid?(FILENAME)

     FILENAMEのファイルのsetuidビットがセットされている時，真を返す．

setgid?(FILENAME)

     FILENAMEのファイルのsetgidビットがセットされている時，真を返す．

size(FILENAME)

     FILENAMEのファイルが存在する時，ファイルの大きさを返す．存在しない時はnilを返す．

sticky?(FILENAME)

     FILENAMEのファイルのstickyビットがセットされている時，真を返す．

symlink?(FILENAME)

     FILENAMEがシンボリックリンクである時，真を返す．

writable?(FILENAME)

     FILENAMEのファイルが実uid/gidで書き込み可能の時，真を返す．

writable_real?(FILENAME)

     FILENAMEのファイルが書き込み可能の時，真を返す．

zero?(FILENAME)

     FILENAMEのファイルが存在し，大きさが0である時，真を返す．

Fixnum
======

31bit(マシンのlongの長さ-1 bit)整数のクラス．builtin classである．このクラスはpointer内の即値であるためcall by valueで呼び出される点が特徴的である(他のクラスはcall by reference)．演算の結果が31bitを越える場合には自動的にBignum(無限多倍長整数)に拡張される．

イテレータupto，downto，stepは繰り返しのために用いられ，一般にRangeクラスを用いるより高速である．

SuperClass: Integer

Methods:

self + OTHER
self - OTHER
self * OTHER
self / OTHER
self % OTHER
self ** OTHER

     算術演算．それぞれ和，差，積，商，剰余，冪乗を返す．

~ self
self | OTHER
self & OTHER
self ^ OTHER

     ビット演算．それぞれビット反転，論理和，論理積，排他的論理和を返す．

self << BITS
self >> BITS

     シフト演算．それぞれBITSビットだけ左右にビットシフトを行なう．

downto(MIN) {...}

     イテレータ．selfからMINまで下向きに繰り返す．

id2name

     整数値をIDだとみなして，相当する文字列を返す．相当する文字列が存在しない場合はnilを返す．

step(MAX, STEP) {...}

     イテレータ．selfからMAXまでSTEPずつ変化しながら，繰り返す．

to_f

     selfをFloatに変換したものを返す．

to_i

     selfをそのまま返す．

upto(MAX) {...}

     イテレータ．selfからMAXまで繰り返す．

See Integer

Float
=====

浮動小数点数のクラス．

SuperClass: Numeric

Methods:

self + OTHER
self - OTHER
self * OTHER
self / OTHER
self % OTHER
self ** OTHER

     算術演算．それぞれ和，差，積，商，剰余，冪乗を返す．

self == OTHER
self > OTHER

     比較演算．

coerce(NUM)

     NUMをFloatに変換する．ただし現時点でFloatが理解できる他の数はFixnumとBignumだけである．

to_f

     selfをそのまま返す．

to_i

     selfを整数に変換した結果を返す．

Single Methods:

new(FLOAT)

     FLOATと同じ値を持つ新しいFloatオブジェクトを返す．

See Numeric

GC
==

Ruby組み込みのgarbage collectorの制御を行なうためのモジュール．このモジュールのメソッドをを用いることによって，一時的にGCを止めたり，GCの起きるタイミングを制御したりできる．

Methods:

garbage_collect

     GCを開始する．GC.startと同義．

Single Methods:

disable

     GCを禁止する．

enable

     GCを許可する．

start

     GCを開始する．

Hash
====

連想配列あるいはハッシュ表．任意のオブジェクトを添字とできる配列のクラスである．連想配列オブジェクトの生成は一般的には連想配列式

     {a=>b,...}

で行なわれる．

キーとして与えたオブジェクトの内容が変化し，メソッドhashの返す値が変わるとHashは正常に動作しない(値が取り出せなくなる)．内容によってhashの値が変化するクラス(たとえばArray, Hashなど)のインスタンスはキーに向かない．ただし，内容が hashの値に影響するオブジェクトのうち，文字列だけは特別に扱われる．文字列をキーとして与えると，文字列をコピーし，コピーを更新不可に設定した上で，キーとして使用する．よって，元の文字列を更新してもキーの文字列は変化しない．each, each_key, keysなどのメソッドがキーとして文字列を返す時，その文字列は更新できない(例外が発生する)．

SuperClass: Object

Included Modules: Enumerable

Methods:

self [KEY]

     KEYをキーとする値を返す．

self [KEY]= VALUE

     KEYをキーとして，VALUEを格納する．VALUEとして nilを指定するとそのKEYに対する項目の削除となる．つまり， Hashは値としてnilを持つことはできない．

clear

     連想配列を空にする．

delete(KEY)

     KEYをキーとする組を削除する．

delete_if {|ITEM|...}

     要素を削除するイテレータ．[key,value]という配列を与えて，ブロックを評価した値が真の時，該当する項目を削除する．

each {|KEY, VALUE|...}
each_pair {|KEY, VALUE|...}

     [key,value]なる2要素の配列を与えるイテレータ．

each_key {|KEY|...}

     全てのkeyに対して繰り返すイテレータ．

each_value {|VALUE|...}

     全てのvalueに対して繰り返すイテレータ．

has_key?(KEY)

     KEYをキーとする組が連想配列中に存在する時，真を返す

has_value?(VALUE)

     VALUEを値とする組が連想配列中に存在する時，真を返す

indexes(ARY)
indexes(KEY_1,..., KEY_N)

     1番目の形式では配列を引数として受けて，その要素をキーとする要素を含む配列を返す．2番目の形式では各引数の値をキーとする要素を含む配列を返す．

keys

     連想配列中に存在するキー全てを含む配列を返す．

length
size

     連想配列中の要素の数を返す．

shift

     連想配列中の要素を一つ取り出し(削除して)，[key,value]なる2要素の配列を返す．

to_a

     連想配列中のkey-value2要素の配列を要素とする配列を返す．

values

     連想配列中に存在する値全てを含む配列を返す．

Single Methods:

Hash[KEY, VALUE...]

     奇数番目の引数をKEY，偶数番目の引数をVALUEとする連想配列を生成する．

new

     新しい(空の)連想配列オブジェクトを返す．

See Object see Enumerable

Integer
=======

整数クラス．実際はその大きさによってFixnumとBignumいう二つのサブクラスで実現されている．Integerはそれらのスーパークラスとなる抽象クラスである．Rubyではほとんどの場合，Fixnumと Bignumの区別は必要なく，相互の変換は自動的に行なわれる．整数をビット列だとみなす場合には，無限の長さをもつビット列と考えて構わない．

SuperClass: Numeric

Methods:

self[IDX]

     整数のIDXビット目がセットされていれば1，セットされていなければ0 を返す．

chr

     その数をコードとする文字だけを含む1文字の文字列を返す．一般に長さ1以上の文字列について，次の関係が常に成立する．

          str[0].chr == str[0,1]

     整数が文字の範囲内(0...255)になければ例外が発生する．

integer?

     いつも真を返す．

See Numeric

IO
==

入出力のための基本クラス．

SuperClass: Object

Included Modules: Enumerable

Methods:

self << OBJECT

     OBJECTを出力する．OBJECTが文字列でない時にはメソッド to_sを用いて文字列に変換する．selfを戻り値とするので， C++のような<<の連鎖を使える．

     例

          $stdout << 1 << " is a " << Fixnum << "\n"

close

     入出力ポートをクローズする．以後のこのオブジェクトに対する入出力操作はエラーになる．

closed?

     ポートがクローズされている時，真を返す．

each {|LINE|...}

each_line {|LINE|...}

     一行ずつ読み込んでくるためのイテレータ．行の区切りはシステム変数 $/によって変更できる．読み込んだ文字列はシステム変数$_にもセットされる．

each_byte {|CH|...}

     一文字ずつ読み込んでくるためのイテレータ．文字は文字コードを表す Fixnumである．

fileno
to_i

     IOオブジェクトが使っているファイルディスクリプタ(Fixnum) を返す．

flush

     バッファをフラッシュする．

getc

     一行読み込んで，読み込みに成功した時にはその文字列を返す．ファイルの終りに到達した時にはnilを返す．カーネルメソッドgetcは $stdin.getcと同じ意味である．

gets

     一行読み込んで，読み込みに成功した時にはその文字列を返す．ファイルの終りに到達した時にはnilを返す．

isatty
tty?

     入出力ポートがttyである時，真を返す．

print(ARG...)

     引数を順に出力する．出力先が$>でなく，レシーバである以外は Kernelクラスのprintメソッドと同じ動作をする．

printf(FORMAT, ARG...)

     C言語のprintf()と同じFORMATに従い引数を文字列に変換し，レシーバに出力する．

puts(OBJ)

     OBJを出力する．self << objと同じ意味である．

read([LENGTH])

     LENGTHバイト読み込んで，その文字列を返す．LENGTHが省略された時には，EOFまでの全てのデータを読み込む．

readlines

     ファイルを全て読み込んで各行を要素としてもつ配列を返す．

sync

     現在の出力同期モードを真偽値で返す．同期モードが真の時は出力関数の呼出毎にバッファがフラッシュされる．

sync= NEWSTATE

     出力同期モードを設定する．

sysread(LENGTH)

     stdioを経由せずにread(2)を用いて入力を行なう．入力されたデータを含む文字列を返す．ファイルの終りに到達した時にはnilを返す．read(2)の性質により必ずLENGTHバイトの文字列が読み込まれるわけではない．getsやgetcなどstdioを経由するメソッドと混用することはバッファリングの不整合などで思わぬ動作をすることがある．

syswrite(STR)

     stdioを経由せずに，write(2)を用いて出力を行なう．このメソッドはバッファリングなどstdioがしてくれることは一切行なわない． syswriteは実際に書き込んだバイト数を返す．printや printfとsyswriteを混用するのは推奨できない．

write(STR)

     STRを出力する．出力したバイト数を返す．

See Object see Enumerable

Kernel
======

全てのクラスの基底クラス．Ruby組み込みの全ての関数メソッドはこのクラスで定義されている．関数メソッドについては「関数」の項目を参照のこと．

SuperClass: なし

Methods:

self == OTHER
equal?(OTHER)

     オブジェクトの一致判定．レシーバと引数の引数が一致する時，真を返す． Kernelクラスの定義では双方のオブジェクトが同一の時真を返す． ==メソッドは各オブジェクトの性質に応じて再定義する必要がある． ==メソッドを再定義した時には，hashメソッドもそれに合わせて再定義する必要がある．

     equal?メソッドは==メソッドの別名で，==を再定義した後でもオブジェクトの同一性判定を行なうために用いられる．よってequal? メソッドはサブクラスで再定義するべきではない．

self =~ OTHER

     マッチ．デフォルトの動作は==と同じである．=~は case文での比較にも用いられる．

hash

     オブジェクトのハッシュ値(Fixnum)を返す．Hashクラスでキーとなるオブジェクトを格納するのに用いられている.A == Bが成立する時は必ずA.hash == B.hashが成立する必要があるので，==を再定義した時には必ずこちらもそれに合わせて再定義すること．

id

     各オブジェクトに対して一意のFixnumを返す．が，Fixnumは自分自身を返すので，idが一致しても同じオブジェクトであることは保証されない．つまり，obj1.id == obj2.idが成立しても，どちらかが Fixnumであれば，obj1とobj2が同じであるとは限らない．ただし，両方がFixnumでないことが保証できれば，2つのオブジェクトが同一であることは確実である．

inspect

     オブジェクトを人間が読める形式の文字列に変換する．

nil?

     オブジェクトがnilであるかどうか．Kernelクラスの定義では真を返す．Nilクラスで偽を返すよう再定義されている．

type

     オブジェクトの動的な型(クラス)を返す．

          obj.is_kind_of?(obj.type)

     は常に成立する．

send(SYMBOL[, ARGS...])

     SYMBOLで指定されるメソッドをARGSとともに呼び出す．

Math
====

浮動小数点演算をサポートするクラス．Mathモジュールは同じ定義のメソッドと特異メソッドとの両方が定義されているので，特異メソッドを呼び出して使う使い方と，クラスにインクルードして使う使い方との両方ができる．

例

     pi = Math.atan2(1, 1) * 4;
     include Math
     pi2 = atan2(1, 1)

Methods: Single Methods:

atan2(X, Y)

     π〜-πの範囲でX/Yのアークタンジェントを返す．

cos(X)
sin(X)
tan(X)

     ラジアンで表されたXの三角関数の値を返す．

exp(X)

     Xの指数関数の値を返す．

log(X)

     Xの自然対数を返す．

log10(X)

     Xの常用対数を返す．

sqrt(X)

     Xの平方根を返す．Xの値が負である時には例外が発生する．

cbrt(X)

     Xの立方根を返す．

Module
======

モジュールのクラス．

SuperClass: Object

Private Methods:

attr(NAME[, PUBLIC])

     そのモジュールをインクルードしたクラスのインスタンスに対してNAME で指定される属性を付加し，属性に対するアクセスメソッドを定義する． attr("attr")はクラス定義に以下に示すコードを追加するのとほぼ同義である．

          def attr; @attr; end

     省略可能な第2引数PUBLICが与えられて，かつその値がnilでない時にはその属性には属性設定メソッドも用意され，外部から代入可能になる．

     attr("attr", TRUE)はクラス定義に以下のコードを追加するのとほぼ同義である．

          def attr; @attr; end
          def attr=(val); @attr = val; end

     属性を構成するメソッドを再定義することによって，アクセス時の動作を変更できる．例えば

          attr("test", TRUE)
          def test=(val)
            print("test was ", @test, "\n")
            print("and now is ", @test = val, "\n")
          end

     のように設定時に属性の値を表示するようなことが可能である．ATTRはアクセスメソッドがすでに定義されている場合は，デフォルトのアクセスメソッドを定義しない．

Methods:

include(MODULE...)

     引数で指定したモジュールをインクルードして，メソッド，定数を追加する．クラス，モジュールに別のモジュールをインクルードすることによって，限定された多重継承(Mixin)を実現できる．

module_function(NAME...)

     NAMEで指定されたメソッドをmodule functionに指定する． Module functionとはモジュールの特異メソッドであり，かつそのモジュールをインクルードしたクラスのprivateメソッドにもなるようなメソッドの事である．例えば，Mathモジュールの関数群はmodule functionである．

private(NAME...)

     NAMEで指定されたメソッドを関数形式でだけ呼び出し可能にする．すでにprivateメソッドである場合には何もしない．

public(NAME...)

     NAMEで指定されたメソッドを通常形式で呼び出し可能にする．すでに publicメソッドである場合には何もしない．

          def foo() 1 end
          foo
                  => 1
          self.foo
                  => 1

          def bar() 2 end
          private :bar
          bar
                  => 2
          self.bar
                  error--> method `bar' not available for "main"(Object)

          Module Baz
            def baz() 3 end
            module_function :baz
          end
          Baz.baz
                  => 3
          include Baz
          baz
                  => 3
          self.baz
                  error--> method `baz' not available for "main"(Object)

to_s

     モジュールの文字列表現であるモジュール名を返す．

See Object

Nil
===

偽を表すオブジェクトnilのクラス．偽変数(の値)nilは Nilクラスの唯一のインスタンスである．

SuperClass: Kernel

Methods:

self + OTHER

     OTHERが整数，浮動小数点数，文字列，配列である時，OTHERを返す．

nil?

     常に真を返す．

See Kernel

Numeric
=======

数一般の性質を表す抽象クラス．

SuperClass: Object

Included Modules: Comparable

Methods:

+ self

     オブジェクトselfそのものを返す

- self

     0 - selfの値を返す．サブクラスでより効率的に再定義されることが期待される．

abs

     絶対値を返す．

divmod(OTHER)

     商と剰余の2要素の配列を返す．

next

     次の数を返す．次の数とはその数を越える最小の整数である．

See Object see Comparable

Object
======

全ての通常クラスのスーパクラス．通常クラスのインスタンスの一般的な振舞いを定義している．このクラスのサブクラスでないクラスはKernelと Nilだけである．

SuperClass: Kernel

Methods:

extened(module...)

     引数で指定したモジュールをselfにインクルードする．モジュールで定義されているメソッドが特異メソッドとして追加される．

initialize(...)

     Class:newからオブジェクトの生成時に自動的に呼び出される．デフォルトの定義は何もしない．サブクラスで必要に応じて再定義されることが期待されている．Class:newに与えられた引数がそのまま渡される．

is_instance_of?(CLASS)

     オブジェクトselfがクラスCLASSのインスタンスである時，真を返す．obj.is_instance_of?(c)が成立する時，いつも obj.is_kind_of?(c)も成立する．

is_kind_of?(CLASS)

     オブジェクトselfがクラスCLASSかそのサブクラスのインスタンスである時，真を返す．

clone

dup

     オブジェクトの複製を作る．インスタンスが即値であるFixnumクラス以外のクラスの場合，obj.equal?(obj.clone)は偽であるが，多くの場合 obj == obj.cloneは真である．

     Stringクラス以外では(特に再定義しない限り)dupはcloneの別名である．

to_s

     オブジェクトの文字列表現を返す．このメソッドは内部的にprintやformatメソッドで用いられている．

to_a

     オブジェクトを配列に変換する．Kernelクラスで定義されているデフォルトは，そのオブジェクト自身を含む1要素の配列を返す．

See Kernel

Proc
====

イテレータに渡されたイテレータブロックを手続きとしてオブジェクト化したもの．実行するコードだけでなくコンテキスト(ローカル変数)なども保存する．ブロックオブジェクトは，callメソッドによって，生成されたのと同じ環境で評価することができる．ただし，大域脱出(return, break, continue, redo, retry)の環境は保存されないので，ブロックオブジェクトからの大域脱出の実行は例外を発生させることになる．

SuperClass: Object

Methods:

call(ARG[,...])

     ブロックを実行する．

Single Methods:

new

     新しいブロックを生成する．yieldを実行できる場所でこのメソッドが呼ばれると，その時点で実行されるべきコードをコンテキストとともに包み込んだオブジェクト(Proc)を生成する．

See Object

Process
=======

プロセスに関する操作を行なうためのモジュール．Mathモジュールと同様に全てのメソッドは特異メソッドとしても通常のメソッドとしても使える． Processはプロセスオブジェクトのクラスではなくて，プロセス操作のメソッドをまとめたものであることに注意すること．

Methods: Single Methods:

egid

     プロセスの現在の実効GIDを返す．

egid= GID

     プロセスの現在の実効GIDをGIDにセットする．

euid

     プロセスの現在の実効UIDを返す．

euid= UID

     プロセスの現在の実効UIDをUIDにセットする．

getpgrp([PID])

     PIDで指定されたプロセスが現在所属しているプロセスグループのidを返す．PIDを省略した時とPIDに0を与えた時は現在実行しているプロセスを対象にする．

getpriority(WHICH, WHO)

     WHICHとWHOで指定されるプロセス，プロセスグループ，ユーザの現在の優先順位を返す．詳細はgetpriority(2)を参照．Processモジュールではwhichとして指定できる定数PRIO_PROCESS，PRIO_PGRP， PRIO_USERが定義されている．

gid

     プロセスの現在の実GIDを返す．

gid= GID

     プロセスの現在の実GIDをgidにセットする.

pid

     プロセスのプロセスIDを返す．これはシステム変数$$の値と同じである．

ppid

     親プロセスのプロセスのプロセスIDを返す．UNIXでは直接の親プロセスが終了した場合，親プロセスのpidは1(initのpid)になる．

setpgrp(PID, PGRP)

     PIDで指定されたプロセスのプロセスグループをPGRPにする． PIDに0を与えると現在実行中のプロセスを対象にする．

setpriority(WHICH, WHO, PRIO)

     WHICHとWHOで指定されるプロセス，プロセスグループ，ユーザの現在の優先順位をPRIOに設定する．詳細はsetpriority(2)を参照のこと．

uid

     プロセスの現在の実UIDを返す．

uid= UID

     プロセスの現在の実UIDをUIDにセットする.

Range
=====

範囲オブジェクトのクラス．範囲オブジェクトは..演算子によって生成され，一般的には以下のような使い方をする

     for i in 1..5
       ...
     end

しかし，この場合は以下の方が速い.

     1.upto(5) {
       ...
     }

範囲オブジェクトを生成する..演算子の両辺はComparableを含むクラスのインスタンスであれば何でも構わない．範囲は始点と終点を含むことに注意すること.

SuperClass: Object

Included Modules: Enumerable

Methods:

self =~ OTHER

     selfがOTHERと同じクラスに対する範囲オブジェクトで，その範囲内にOTHERがある時(start <= OTHER <= end)，真を返す．これはcase式で範囲指定する時に便利である．例えば

          case i
          when 1, 3..5
            ...
          end case

     のようなコードを書くことができる．

each

     範囲内に存在するオブジェクトを与えるイテレータ．主にfor式のために用いられる．

end

     範囲の終点を返す

start

     範囲の始点を返す．

See Object see Enumerable

Regexp
======

正規表現のクラス．正規表現のリテラルは/.../という形式で表すが，動的に生成するためには

     Regexp.new(文字列)

とする．ただし，Stringクラスの=~を始めとして多くのメソッドは正規表現の替わりに文字列が与えられた時には内部的に正規表現を生成するので，生成コストを節約したいと思う時や，正規表現の大文字小文字の区別を明示的に指定したい時など以外は明示的に生成したいと思うことは少ないはずだ．

SuperClass: Object

Methods:

self =~ STRING

     正規表現が文字列にマッチした場合，マッチした位置を返す．マッチしない場合はnilを返す．

~ self

     $_ =~ selfと同義．

Single Methods:

compile(STRING[, CASEFOLD])
new(STRING[, CASEFOLD])

     文字列を正規表現に変換したオブジェクトを返す．省略可能な第2引数が与えられ，その値がnilでない時には，生成された正規表現オブジェクトはシステム変数$=の値に関わらず，マッチする時に大文字小文字の違いを無視する．

quote(STR)

     文字列の中の正規表現で意味を持つ文字をエスケープする．新しい文字列を返す．

See Object

String
======

文字列クラス．Rubyの文字列はヌルターミネートではないので，バイナリデータも扱える．従ってどちらかというと単なる文字列というよりバイト列である．その思想に基づいて，正規表現に関するメソッド以外は2byte系の文字を意識していない．これは作者の手抜きではなく意図的にそうしているのである(信じてくれ)．

Stringクラスのメソッドのうち!で終るものはレシーバを書き換える．同じ名前で!の無いものはレシーバのコピーを作ってから，そちらを書き換える．!のあるものの方が高速だが，予期せぬ結果を招きやすいので，無いものの方が安全である．

     f = "string"
     print f, sub("str", "ski"), f
             => string, skiing, string
     print f, sub!("str", "ski"), f
             => skiing, skiing, skiing

SuperClass: Object

Included Modules: Comparable, Enumerable

Methods:

self + OTHER

     文字列の連結．連結された文字列を返す．

self * TIMES

     文字列の繰り返し．例えばx" * 4 == "xxxx"である．

self == OTHER

self > OTHER

     文字列の比較．システム変数$=がnilでない時には大文字小文字を区別せずに比較を行なう．

self =~ OTHER

     文字列のマッチ．OTHERは正規表現か文字列．OTHERが文字列の場合には動的に正規表現に変換される．マッチした場合はマッチした位置，しなかった場合はnilが返る．

~ self

     $_ =~ selfと同義．

self[NTH]

self[BEG..END]

self[BEG, LEN]

     内容の取り出し．1番目の形式ではNTHバイト目のデータをFixnumとして返す．2番目の形式ではBEGバイト目からENDバイト目までの部分文字列を返す(両端を含む)．3番目の形式ではBEGバイト目から LENバイト分の部分文字列を返す．

self[NTH] = VAL

self[BEG..END] = VAL

self[BEG, LEN] = VAL

     内容の更新．1番目の形式ではNTHバイト目のデータをVAL(整数) に変更する．2番目の形式はBEGバイト目からENDバイト目までの部分文字列をVALとして与えられた文字列で置き換える．3番目の形式は BEGバイト目からLENバイト分の部分文字列をVALとして与えられた文字列で置き換える．

capitalize
capitalize!

     文字列中の最初の文字を(それがアルファベットであれば)，大文字に変換し，残る文字列中のアルファベットを小文字に置き換える．

chop
chop!

     文字列の最後のバイトを切り落とす．元の文字列を変更することに注意すること．chop!は元の文字列を更新する．

crypt(SALT)

     crypt(3)を用いて暗号化した文字列を返す．SALTは2バイト以上の長さの任意の文字列である．

delete(STR)
delete!(STR)

     文字列のうち，STRに含まれる文字を削除する．文字列の指定は trと同様であり，a-bでaからbまでの範囲を，先頭の^で文字列の否定(含まれてないものを指定)を意味する．

dup

     selfと同じ内容を持つ文字列を生成する．cloneは freeze状態もコピーするが，dupは内容だけが等しい文字列を生成する．

downcase
downcase!

     文字列中のアルファベットを全て小文字に置き換えた文字列を返す． tr("A-Z", "a-z")より少し速い．

each {|CHAR|...}
each_byte {|CHAR|...}

     文字列のそれぞれのバイトについて繰り返すイテレータ．

each_line {|LINE|...}

     文字列から1行ずつ読み込んでくるイテレータ．

freeze

     文字列を更新不可にする．一度更新不可に設定された文字列の内容を変更しようとすると例外が発生する．

gsub(PATTERN, REPLACE)
gsub(PATTERN) {...}
gsub!(PATTERN, REPLACE)
gsub!(PATTERN) {...}

     文字列中でPATTERNにマッチする部分を全てREPLACEに置き換える．置換文字列REPLACE中の&と\0はマッチした文字列に， \1...\9はn番目の括弧の内容に置き換えられる．引数 REPLACEが省略された時にはイテレータとして動作し，ブロックを評価した結果で置換する．

     gsubは置換された文字列を返す(置換が行なわれなかった場合は元の文字列を返す)．gsub!は置換が行なわれた時には対象となる文字列を，行なわれなかった時にはnilを返す．

hex

     文字列を16進数を表す文字列と解釈して，整数に変換する．

index(SUBSTR[, POS])

     SUBSTRが最初に出現する位置を返す．POSを与えるとその位置から検索を開始する．見つからない時にはnilを返す．

intern

     文字列に一意に対応する整数を返す．文字列はナル文字を含んではならない．

length
size

     文字列の長さ(バイト数)を返す．

ljust(WIDTH)
rjust(WIDTH)
center(WIDTH)

     文字列をそれぞれ，右詰め，左詰め，真中寄せした幅WIDTHの文字列を返す．文字列長がWIDTHより長い場合は元の文字列を返し，切り詰めない．

next

     selfの「次の」文字列を返す．次の文字列とは数字は数字として，英文字は英文字として増加し，桁上がりの処理が行なわれたものである．

          "aa".next => "ab"
          "99".next => "100"
          "a9".next => "b0"

oct

     文字列を8進数を表す文字列と解釈して，整数に変換する．8進数の定義は /[0-7]+/であり，文字列の先頭からこのパターンにマッチする部分を整数に変換する．この定義に全く当てはまらない文字列に対しては0を返す． perlとは違って文字列が0xから始まっているからといって 16進数だと見なしてくれたりはしない．それらは先頭の0が8進数と認識され，0を返す．

reverse
reverse!

     文字列の各バイトを逆順に並べた文字列を返す．文字列が2バイトで構成される文字を含んでいてもお構いなしにバイト単位で反転する．splitは2 バイト文字を理解するので，2バイト文字を含む文字列を文字単位に反転するには

          "全角文字列".split(//).reverse.join("")

     とすればよい．

rindex(SUBSTR[, POS])

     文字列SUBSTRが最後に出現する位置を返す．POSを与えるとその位置で検索を終了する．見つからない時にはnilを返す．index との相違点は

       * 文字列の末尾から検索する．

       * substrとして正規表現を受け付けない．

     の2点である．

split([SEP[, LIMIT]])

     文字列をSEPで指定されたパターンによって，フィールドに分割する． SEPが省略された時のデフォルトはシステム変数$;の値が用いられる．LIMITが指定された時には最大LIMIT個のフィールドに分割する．splitは分割された文字列を含む配列を返す．SEPで指定されたパターンが空文字列とマッチする場合は文字列が1文字ずつに分割される．

squeeze([STR])
squeeze!([STR])

     文字列のうち，STRに含まれる文字が連続していた場合，一文字に圧縮する．STRが省略された場合，すべての文字を対象とする．文字列の指定はtrと同様であり，a-bでaからbまでの範囲を，先頭の^で文字列の否定(含まれてないものを指定)を意味する．

strip
strip!

     文字列の前後の空白を取り除く．

sub(PATTERN, REPLACE)
sub(PATTERN) {...}
sub!(PATTERN, REPLACE)
sub!(PATTERN) {...}

     文字列のPATTERNにマッチする最初の部分をREPLACEに置き換える．置換文字列REPLACE中の&と\0はマッチした文字列に， \1...\9は n番目の括弧の内容に置き換えられる．引数 REPLACEのない形式の時にはイテレータとして動作し，ブロックを評価した結果で置換する．

     subは置換された文字列を返す(置換が行なわれなかった場合は元の文字列を返す)．sub!は置換が行なわれた時には対象となる文字列を，行なわれなかった時にはnilを返す．

sum([BITS])

     文字列のBITSビットのチェックサムを得る．省略値は16である．rubyでは以下のコードでSystem Vのsumプログラムと同じ値を得られる．

          while gets()
            sum += $_.sum
          end
          sum %= 65536

swapcase
swapcase!

     文字列中のアルファベットのうち大文字を小文字に，小文字を大文字に置き換える．

to_f

     文字列をFloatに変換する．

to_i

     文字列を10進数を表す文字列と解釈して，整数に変換する．

tr(SEARCH, REPLACE)
tr!(SEARCH, REPLACE)

     文字列の中にSEARCH文字列に含まれる文字が存在すれば， REPLACE文字列の対応する文字で置き換える．REPLACE文字列が省略された場合は空文字列が与えられたと見なす．REPLACE文字列が SEARCH文字列よりも短い時はREPLACE文字列の最後の文字が繰り返されていると見なす．SEARCH文字列の方が短い時には対応する文字のないREPLACE部は単に無視される(BSDのtrの動作)．

     SEARCH文字列，REPLACE文字列中にa-bという形式が現れた場合，そのaからbまでの範囲の文字をASCIIの昇順で指定したことになる．また，SEARCH文字列の最初の文字が^である場合，続く文字列に*含まれない*文字列が置換の対象になる．

     tr(1)の機能のうち，文字を削除する機能，連続する文字を圧縮する機能は別のメソッドに分割されている．それらの機能についてはdelete， squeezeを参照のこと．

     簡便のため，str.tr(src,repl).squeeze(repl)に相当するメソッド tr_s(src,repl)が提供されている．

unpack(TEMPLATE)

     文字列をTEMPLATE文字列にしたがってアンパックし，それらの要素を含む配列を返す．TEMPLATE文字列はArrayクラスのpackメソッドとほぼ同様である．

          a     ASCII文字列(後続するnull文字やスペースを残す)
          A     ASCII文字列(後続するnull文字やスペースを削除)
          b     ビットストリング(下位ビットから上位ビット)
          B     ビットストリング(上位ビットから下位ビット)
          h     16進文字列(下位ニブルが先)
          H     16進文字列(上位ニブルが先)
          c     char
          C     unsigned char
          s     sort
          S     unsigned sort
          i     int
          I     unsigned int
          l     long
          L     unsigned int
          n     ネットワークバイトオーダーのshort
          N     ネットワークバイトオーダーのlong
          f     単精度浮動小数点数(機種依存)
          d     倍精度浮動小数点数(機種依存)
          x     1バイト読み飛ばす
          X     1バイト後退
          @     絶対位置への移動

     rubyのunpackはperlと違ってチェックサムの計算機能がないことに注意すること．

upcase
upcase!

     文字列中のアルファベットを全て大文字に置き換えた文字列を返す． tr("a-z", "A-Z")より少し速い．

upto(END) {...}

     selfから始まって，ENDまで「次の」文字列を順に与えるイテレータ．次の文字列とはstr.nextで与えられる文字列である．

     このメソッドはRange:eachで用いられているので，以下のような処理が可能である．

          for i in "a" .. "ba"
            print(i, "\n");
          end

     これはa, b, c,...aa,...az, baまでを各行に出力する．

Single Methods:

new(STRING)

     STRINGと同じ内容を持つ新しい文字列を返す．

See Object see Enumerable see Comparable

Struct
======

構造体クラス．このクラスのサブクラスは複数のデータをまとめる時に用いられる(例: Time:times)．データをまとめる時には配列クラスが用いられることもあるが(例: select)，構造体を使うべき時は以下のような場合である．Struct:newはStructのサブクラスを新たに生成して，それを返す．構造体はそのサブクラスのインスタンスとなる．

 1. 要素の数が固定

     要素の数が変動するものは構造体を使うのには向かない．

 2. 要素の数が多い

     人間が一度に容易に扱える概念の数は7つまでであるという仮説がある．この仮説に従えば，要素が4つ以上あるデータの場合は配列を用いた場合，要素数の2倍(つまりオフセットとその意味の総和)が7を越える．よって，そのような場合には構造体を使った方が理解しやすいと思われる．

 3. 同時に大量に生成されない

     構造体は配列よりも若干生成コストが高いので，速度が問題になる場合 (例えば同時に大量に生成される場合など)は構造体の使用が適切でない可能性がある．

各構造体にはメンバ名と同名の引数のないメソッドが定義される．

本ドキュメント内で，構造体を表現するためには以下の形式を使う．

     struct 構造体名
       メンバ...
     end

しかし，プログラム中でこの形式で構造体を生成するわけではない．

SuperClass: Object

Included Modules: Enumerable

Methods:

self[IDX]

     IDXが数の時はIDX番目の要素を返す．

values
to_a

     構造体のメンバの値を要素に持つ配列を返す．例えば以下のコードで自分の passwdエントリを出力することができる．

          print(Etc.getpwuid().values.join(":"), "\n")

     この出力はgrep "$USER" /etc/passwdの出力と余分なフィールドがいくつか(システムによって異なる)がある以外は同じである．

Single Methods:

new(NAME, MEMBER...)

     NAMEという名前を持つ構造体のクラスを生成する．MEMBER_VALUE は構造体のメンバを表す文字列である．生成された構造体クラスにはメンバで指定された名前のメソッドが定義されていて，そのメソッドによってメンバの内容を得ることができる．

Single Methods for subclasses:

new(VALUE...)

     構造体クラスのインスタンスを生成する．VALUEは構造体のメンバの値である．メンバの数が構造体クラスで定義された数と異なる時には例外が発生する．

See Object see Enumerable

Time
====

時間を表すクラス．大小比較などができる．Time.nowで現在の時間を得ることができる．またファイルのタイムスタンプを得るメソッドの戻り値もこのクラスのインスタンスである．

SuperClass: Object

Included Modules: Comparable

Methods:

self <=> OTHER

     OTHERはTimeのインスタンスか整数．整数が与えられた場合には 1970年1月 1日 00:00:00 GMTからの秒数であるとして時刻との比較を行なう．

asctime
ctime
to_s

     時刻をdate(1)形式の文字列に変換する．

gmtime

     タイムゾーンの修正を行なわないGMTでの時刻を得る．このメソッドを受けとったTimeクラスのインスタンスは，以後の時刻変換をGMTで行なう． gmtimeは自分自身を返す．

     ロンドンの時刻を表示するにはprint(Time.now.gmtime, "\n")とすればよい．

localtime

     タイムゾーンの修正を行なった時刻を得る(デフォルト)．localtimeは自分自身を返す．

to_i
tv_sec

     1970年 1月 1日 00:00:00 GMTから時刻までの秒数を整数で返す．時刻のsecondの部分でもある．

sec
min
hour
mday
year
wday
yday
zone
isdst

     内部的に保持しているtm構造体の内容を返す．zone以外は整数を返す．zoneはタイムゾーンを表す文字列を返す．(cf localtime(3))

strftime(FORMAT)

     時刻をFORMAT文字列に従って文字列に変換した結果を返す． FORMAT文字列として指定できるものは 以下の通りである．

          %A      曜日の名称(Sunday, Monday...)
          %a      曜日の省略名(Sun, Mon...)
          %B      月の名称(January, February...)
          %b      月の省略名(Jan, Feb...)
          %c      時刻表現(cf ctime(3))
          %d      十進数での日(01-31)
          %H      24時間制の時(00-23)
          %I      12時間制の時(01-12)
          %j      年中の通算日(001-366)
          %M      分(00-59)
          %m      月を表す数字(01-12)
          %p      午前または午後(AM,PM)
          %S      秒(00-61)
          %U      週を表す数字．最初の日曜日が第1週の
                  始まり(00-53)
          %W      週を表す数字．最初の月曜日が第1週の
                  始まり(00-53)
          %w      曜日を表す数字．日曜日が0(0-6)
          %X      時刻(例: 15:01:06)
          %x      日付(例: Fri Jan 14 1994)
          %Y      西暦を表す数字
          %y      西暦の下2桁(00-99)
          %Z      タイムゾーン
          %%      %自身

usec
tv_usec

     時刻のmicro secondの部分を返す．

Single Methods:

now

     現在の時刻を表すTimeクラスのインスタンスを生成する．

at(TIME)

     TIMEと同じ時刻を表すTimeクラスのインスタンスを生成する． TIMEはTimeクラスのインスタンスかあるいは数(整数/浮動小数点数)であり，数の場合は1970年 1月 1日 00:00:00 GMTからの秒数であるとして時刻を計算する．

times

     現在のプロセスとその子プロセスが消費したユーザ/システムCPUタイムの積算を構造体として返す(see Struct)．

          struct tms
            utime		# プロセスのユーザ時間
            stime		# プロセスのシステム時間
            cutime	# 子プロセスのユーザ時間
            cstime	# 子プロセスのシステム時間
          end

     時間の単位は秒であり，浮動小数点数で与えられる．詳細はtimes(3) を参照のこと．

See Object see Comparable

C言語とのインタフェース
************

rubyはC言語とのインターフェースを提供し，C言語からのクラス，モジュールの定義，C言語で記述したメソッドの定義，rubyのメソッドの呼び出し，イテレータの呼び出し，例外処理などを行なうことが出来る．また，OSが許せば実行時にCで書かれたモジュールをロードすることも出来る．

具体的なインタフェースに関しては，別ドキュメント(添付ファイル C-IF)を参照のこと．

謝辞
**

Rubyの言語仕様は数多くの言語の影響を受けている．以下にあげるのはその主な言語である．

C, Perl, CLU, Sather, CLOS, Eiffel, Icon, tcl, AWK, bourne shell, Smalltalk, Emacs Lisp.

またrubyの言語仕様を決定するために協力して下さった方々を以下にあげる．

石塚圭樹，大庭康生，伊藤純一郎，中村＠ＮＥＣ．関根＠日本ＤＥＣ，たなか＠赤坂.富士通(敬称略)．

文法
**

以下は疑似BNFで記述したrubyの文法である．より正確な記述はparse.yを参照されたい．

     PROGRAM		: COMPEXPR

     COMPEXPR	: EXPR (TERM EXPR)* [TERM]

     EXPR		: MLHS `=' ARGS
     		| return ARGS
     		| fail ARGS
     		| yield ARGS
     		| defined? ARG
     		| identifier CALL_ARGS0
     		| PRIMARY `.' identifier CALL_ARGS0
     		| super CALL_ARGS
     		| undef FNAME
     		| alias FNAME FNAME
     		| include identifier (`,' identifier)*
     		| EXPR if EXPR
     		| EXPR while EXPR
     		| EXPR and EXPR
     		| EXPR or EXPR
     		| ASSOCS
     		| ARG

     ARG		: LHS `=' ARG
     		| LHS OP_ASGN ARG
     		| ARG `..' ARG
     		| ARG `...' ARG
     		| ARG `+' ARG
     		| ARG `-' ARG
     		| ARG `*' ARG
     		| ARG `/' ARG
     		| ARG `%' ARG
     		| ARG `**' ARG
     		| `+' ARG
     		| `-' ARG
     		| ARG `|' ARG
     		| ARG `^' ARG
     		| ARG `&' ARG
     		| ARG `<=>' ARG
     		| ARG `>' ARG
     		| ARG `>=' ARG
     		| ARG `<' ARG
     		| ARG `<=' ARG
     		| ARG `==' ARG
     		| ARG `!=' ARG
     		| ARG `=~' ARG
     		| ARG `!~' ARG
     		| `!' ARG
     		| `~' ARG
     		| ARG `<<' ARG
     		| ARG `>>' ARG
     		| ARG `&&' ARG
     		| ARG `||' ARG
     		| ARG `::' identifier
     		| PRIMARY

     PRIMARY		: `(' COMPEXPR `)'
     		| LITERAL
     		| VARIABLE
     		| super `(' [CALL_ARGS] `)'
     		| super
     		| PRIMARY `[' [ARGS] `]'
     		| `[' [ARGS [`,']] `]'
     		| `{' [ (ARGS|ASSOCS) [`,'] ] `}'
     		| redo
     		| break
     		| continue
     		| retry
     		| return
     		| fail [`(' [ARGS] `)']
     		| yield [`(' [ARGS] `)']
     		| defined? `(' ARG `)'
     		| PRIMARY `{' [`|' [ITER_VAR] `|'] COMPEXPR `}'
     		| OPERATION `(' [CALL_ARGS] `)'
     		| PRIMARY `.' OPERATION `(' [CALL_ARGS] `)'
     		| PRIMARY `.' OPERATION
     		| if EXPR THEN
     		  COMPEXPR
     		  (elsif EXPR THEN COMPEXPR)*
     		  [else COMPEXPR]
     		  end
     		| while EXPR TERM COMPEXPR end
     		| case COMPEXPR
     		  (when ARGS THEN)+
     		  [else COMPEXPR]
     		  end
     		| for ITER_VAR in EXPR TERM
     		  COMPEXPR
     		  end
     		| begin
     		  COMPEXPR
     		  [rescue COMPEXPR]
     		  [ensure COMPEXPR]
     		  end
     		| class identifier `:' identifier
     		  COMPEXPR
     		  end
     		| module identifier
     		  COMPEXPR
     		  end
     		| def FNAME ARGLIST
     		  COMPEXPR
     		  end
     		| def SINGLETON `.' FNAME ARGLIST
     		  COMPEXPR
     		  end

     THEN		: TERM
     		| then
     		| TERM then

     ITER_VAR	: LHS
     		| MLHS

     MLHS		: LHS `,' [LHS (`,' LHS)*] [`*' LHS]

     LHS		: VARIABLE
     		| PRIMARY `[' [ARGS] `]'
     		| PRIMARY `.' identifier

     CALL_ARGS	: ARGS
     		| ASSOCS
     		| ARGS [`,' ASSOCS] [`,' `*' ARG]
     		| `*' ARG

     ARGS 		: ARG (`,' ARG)*

     ARGLIST		: `('[identifier(`,'identifier)*][`*'identifier]`)'
     		| TERM

     SINGLETON	: VARIABLE
     		| `(' EXPR `)'

     ASSOCS		: ASSOC (`,' ASSOC)*

     ASSOC		: ARG `=>' ARG

     VARIABLE	: VARNAME
     		| nil
     		| self
     		| `__FILE__'
     		| `__LINE__'

     LITERAL		: numeric
     		| SYMBOL
     		| STRING
     		| REGEXP

     TERM		: `;'
     		| `\n'

ここより下は字句解析部で認識される．

     SYMBOL		: `:'FNAME
     		| `:'VARNAME

     FNAME		: identifier | `..' | `|' | `^' | `&'
     		| `<=>' | `==' | `=~' | `>' | `>=' | `<' | `<='
     		| `<<' | `>>' | `+' | `-' | `*' | `/' | `%' | `**'
     		| `~' | `+@' | `-@' | `[]' | `[]='

     OPERATION       : identifier
                     | identifier'!'
                     | identifier'?'

     VARNAME		: GLOBAL
     		| `@'identifier
     		| identifier

     GLOBAL		: `$'identifier
     		| `$'any_char

     STRING		: `"' any_char* `"'
     		| `'' any_char* `''
     		| ``' any_char* ``'

     REGEXP		: `/' any_char* `/'[i]