Ruby の変数と定数の種別は変数名の最初の一文字によって、ローカル変数、インスタンス変数、クラス変数、グローバル変数、定数のいずれかに区別されます。通常の変数の二文字目以降は英数字または _ですが、組み込み変数の一部には「`$'+1文字の記号」という変数があります(組み込み変数を参照)。変数名の長さにはメモリのサイズ以外の制限はありません。
ローカル変数
例
foobar
小文字または`_'で始まる識別子はローカル変数またはメソッド呼び出しです。ローカル変数スコープ(クラス、モジュール、メソッド定義の本体)における小文字で始まる識別子への最初の代入はそのスコープに属するローカル変数の宣言になります。宣言されていない識別子の参照は引数の無いメソッド呼び出しとみなされます。
ローカル変数のスコープは、宣言した位置からその変数が宣言されたブロック、メソッド定義、またはクラス/モジュール定義の終りまでです。寿命もそのブロックの終りまで(トップレベルのローカル変数はプログラムの終了まで)ですが、例外としてブロックが手続きオブジェクト化された場合は、そのオブジェクトが消滅するまで存在します。同じスコープを参照する手続きオブジェクト間ではローカル変数は共有されます。
# (A) の部分はスコープに入らない
2.times {
p defined?(v) # (A)
v = 1 # ここ(宣言開始)から
p v # ここ(ブロックの終り)までが v のスコープ
}
# => nil
# 1
# nil <- これが nil であることに注意
# 1
宣言は、たとえ実行されなくても宣言とみなされます。
v = 1 if false # 代入は行われないが宣言は有効
p defined?(v) # => "local-variable"
p v # => nil
インスタンス変数
例
@foobar
`@'で始まる変数はインスタンス変数であり、特定のオブジェクトに所属しています。インスタンス変数はそのクラスまたはサブクラスのメソッドから参照できます。初期化されていないインスタンス変数を参照した時の値はnilです。
クラス変数
例
class Foo
@@foo = 1
def bar
puts @@foo
end
end
@@で始まる変数はクラス変数です。クラス変数はクラス定義の中で定義され、クラスの特異メソッド、インスタンスメソッドなどから参照/代入ができます。
クラス変数と定数の違いは以下の通りです。
- 再代入可能(定数は警告を出す)
- クラスの外から直接参照できない(継承されたクラスからは参照/代入可能)
クラス変数はクラス自身のインスタンス変数とは以下の点で異なります。
- サブクラスから参照/代入が可能
- インスタンスメソッドから参照/代入が可能
クラス変数は、そのクラスやサブクラス、それらのインスタンスで共有されるグローバル変数であるとみなすことができます。
class Foo
@@foo = 1
end
class Bar < Foo
p @@foo += 1 # => 2
end
class Baz < Bar
p @@foo += 1 # => 3
end
モジュールで定義されたクラス変数(モジュール変数)は、そのモジュールをインクルードしたクラス間でも共有されます。
module Foo
@@foo = 1
end
class Bar
include Foo
p @@foo += 1 # => 2
end
class Baz
include Foo
p @@foo += 1 # => 3
end
親クラスに、子クラスで既に定義されている同名のクラス変数を追加した場合、子クラスが、そのクラス変数を参照した際に例外 RuntimeError が発生します。
class Foo
end
class Bar < Foo
@@v = :bar
end
class Foo
@@v = :foo
end
class Bar
p @@v #=> RuntimeError (class variable @@v of Bar is overtaken by Foo)
end
クラス変数のスコープ
クラス変数は、その場所を囲むもっとも内側の(特異クラスでない) class 式または module 式のボディをスコープとして持ちます。
class Foo
@@a = :a
class << Foo
p @@a #=> :a
end
def Foo.a1
p @@a
end
end
Foo.a1 #=> :a
def Foo.a2
p @@a
end
Foo.a2 #=> NameError になります。
class << Foo
p @@a #=> NameError になります。
end
グローバル変数
例
$foobar
$/
`$'で始まる変数はグローバル変数で、プログラムのどこからでも参照できます(その分、利用には注意が必要です)。グローバル変数には宣言は必要ありません。初期化されていないグローバル変数を参照した時の値はnilです。
組み込み変数
グローバル変数には Ruby 処理系によって特殊な意味を与えられているものがあります。これらを組み込み変数と呼びます。
詳細は Kernel の特殊変数を参照してください。
識別子と分類
組み込み変数の一部は、通常の変数としては使用できない特殊な名前を持っています。
例えば、 $' や $& あるいは $1, $2, $3 がそうです。このように 「'$' + 特殊文字一文字」、または「'$' + 10進数字」という名前を持つ変数を特殊変数と呼びます。
また、 $-F や $-I のような変数もあります。これらは Ruby の起動オプションと -F や -I などと対応しており、オプション変数と呼ばれます。
スコープ
組み込み変数は文法解析上はグローバル変数として扱われます。しかし、実際のスコープは必ずしもグローバルとは限りません。
組み込み変数には次の種類のスコープがありえます。
- グローバルスコープ
-
通常のグローバル変数と同じ大域的なスコープを持ちます。
- ローカルスコープ
-
通常のローカル変数と同じスコープを持ちます。つまり、 class 式本体やメソッド本体で行われた代入はその外側には影響しません。プログラム内のすべての場所において代入を行わずともアクセスできることを除いて、通常のローカル変数と同じです。
- スレッドローカルスコープ
-
スレッドごとの値を持ちます。他のスレッドで異なる値が割り当てられても影響しません。
また、一部の変数は読み取り専用です。ユーザープログラムから変更することができません。代入しようとすると実行時に例外を生じます。
擬似変数
通常の変数以外に擬似変数と呼ばれる特殊な変数があります。
- self
-
現在のメソッドの実行主体。
- nil
-
NilClassクラスの唯一のインスタンス。 Object#frozen? は true を返します。
- true
-
TrueClassクラスの唯一のインスタンス。真の代表値。 Object#frozen? は true を返します。
- false
-
FalseClassクラスの唯一のインスタンス。nilとfalseは偽を表します。 Object#frozen? は true を返します。
- __FILE__
-
現在のソースファイル名
フルパスとは限らないため、フルパスが必要な場合は File.expand_path(__FILE__) とする必要があります。
- __LINE__
-
現在のソースファイル中の行番号
- __ENCODING__
-
現在のソースファイルのスクリプトエンコーディング
擬似変数の値を変更することはできません。擬似変数へ代入すると文法エラーになります。
定数
例
FOOBAR
FOOBAR
アルファベット大文字 ([A-Z]) で始まる識別子は定数です。他にも、ソースエンコーディングが Unicode の時は Unicode の大文字またはタイトルケース文字から始まる識別子も定数です。 Unicode 以外の時は小文字に変換できる文字から始まる識別子が定数です。定数の定義 (と初期化) は代入によって行われますが、メソッドの中では定義できません。一度定義された定数に再び代入を行おうとすると警告メッセージが出ます。定義されていない定数にアクセスすると例外 NameError が発生します。
定数はその定数が定義されたクラス/モジュール定義の中(メソッド本体やネストしたクラス/モジュール定義中を含みます)、クラスを継承しているクラス、モジュールをインクルードしているクラスまたはモジュールから参照することができます。クラス定義の外(トップレベル)で定義された定数は Object に所属することになります。
例
class Foo
FOO = 'FOO' # クラス Foo の定数 FOO を定義(Foo::FOO)
end
class Bar < Foo
BAR = 'BAR' # クラス Bar の定数 BAR を定義(Bar::BAR)
# 親クラスの定数は直接参照できる
p FOO # => "FOO"
class Baz
# ネストしたクラスはクラスの継承関係上は無関係であるがネス
# トの外側の定数も直接参照できる
p BAR # => "BAR"
end
end
またクラス定義式はクラスオブジェクトの生成を行うと同時に、名前がクラス名である定数にクラスオブジェクトを代入する動作をします。クラス名を参照することは文法上は定数を参照していることになります。
class C
end
p C # => C
あるクラスまたはモジュールで定義された定数を外部から参照するためには`::'演算子を用います。またObjectクラスで定義されている定数(トップレベルの定数と言う)を確実に参照するためには左辺無しの`::'演算子が使えます。
例
module M
I = 35
class C
end
end
p M::I #=> 35
p M::C #=> M::C
p ::M #=> M
M::NewConst = 777 # => 777
定数参照の優先順位
定数参照時の定数の探索順序には、以下の3つの場合があります。
- :: で始まる定数参照
- :: を含まない定数参照
- 他の値から :: で繋げられた定数参照
:: で始まる定数参照
定数参照が :: で始まる場合、Object クラスを起点としてそのスーパークラスを順番に探索し、最初に見つかった定数を参照します。
X = 1
# 以下のように書いても同じ
# class Object
# X = 1
# end
module M
X = 2
p ::X # => 1
end
class BasicObject
X = 1
end
module M
X = 2
p ::X # => 1
end
:: を含まない定数参照
定数参照が :: を含まない場合、定数参照の場所を起点としてソースコードにおけるクラス(あるいはモジュール。以下同じ)のネストを外側に向かって探索し、最初に見つかった定数を参照します。一番外側のクラスまで探索しても定数が見つからなかった場合、起点のクラスのスーパークラスを順番に探索します。
X = "Object" # Object::X として定義される
class C
X = "C"
end
module M1
X = "M1"
module M2
class C3 < C
# C3 -> M2 -> M1 -> C -> Object の順で探索される
p X # => "M1"
end
end
end
なお以下の例では X の参照箇所からソースコード上でクラスのネストを外側にたどると M2 のみに遭遇するため、 M1 は探索されないことに注意してください。
X = "Object"
class C
X = "C"
end
module M1
X = "M1"
end
module M1::M2
class C3 < C
# C3 -> M2 -> C -> Object の順で探索される
p X # => "C"
end
end
ネストしているクラスの一覧は Class.nesting(あるいはModule.nesting)で取得できます。
module M1
module M2
p Module.nesting # => [M1::M2, M1]
end
end
module M1::M2
p Module.nesting # => [M1::M2]
end
他の値から :: で繋げられた定数参照
他の値から :: で繋げられた定数参照の場合、:: の前にあるクラスを起点としてそのスーパークラスを順番に探索し、最初に見つかった定数を参照します。ただし、Object クラスとそのスーパークラスは探索対象となりません。
X = "Object"
Y = "Object"
class C
X = "C"
end
class D < C
end
p D::X # => "C"
p D::Y # => uninitialized constant D::Y (NameError)
:: を含まない定数参照と異なり、クラスのネストの外側は探索対象となりません。
module M
X = "M"
class C
end
p C::X # => uninitialized constant M::C::X (NameError)
end