Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > Kernelモジュール

module Kernel

クラスの継承リスト: Kernel

Abstract

全てのクラスから参照できるメソッドを定義しているモジュール。 Object クラスはこのモジュールをインクルードしています。

Object クラスのメソッドは実際にはこのモジュールで定義されています。これはトップレベルでのメソッドの再定義に対応するためです。

モジュール関数

Array(arg) -> Array

引数を配列(Array)に変換した結果を返します。

arg.to_ary と arg.to_a をこの順に呼び出して、返ってきた配列を変換結果とします。

arg に to_ary, to_a のいずれのメソッドも定義されていない場合は一要素の配列 [arg] を返します。

[PARAM] arg:: 変換対象のオブジェクトです。
[EXCEPTION] TypeError:: to_ary, to_a の返り値が配列でなければ発生します

p Array({:it => 3}) #=> [[:it, 3]]
p Array(nil) #=> []
p Array("fefe") #=> ["fefe"]

[SEE_ALSO] Object#to_a, Object#to_ary, Array

Float(arg) -> Float

引数を浮動小数点数(Float)に変換した結果を返します。

引数が数値の場合は素直に変換し、文字列の場合は整数や浮動小数点数と見なせるもののみ変換します。

メソッド Float は文字列に対し String#to_f よりも厳密な変換を行います。

[PARAM] arg:: 変換対象のオブジェクトです。
[EXCEPTION] ArgumentError:: 整数や浮動小数点数と見なせない文字列を引数に指定した場合に発生します。
[EXCEPTION] TypeError:: nil またはメソッド to_f を持たないオブジェクトを引数に指定したか、 to_f が浮動小数点数を返さなかった場合に発生します。

p Float(4)            #=> 4.0
p Float(4_000)        #=> 4000.0
p Float(9.88)         #=> 9.88

p Float(Time.gm(1986)) #=> 504921600.0
p Float(Object.new)   # cannot convert Object into Float (TypeError)
p Float(nil)          # cannot convert nil into Float (TypeError)

p Float("10")         #=> 10.0
p Float("10e2")       #=> 1000.0
p Float("1e-2")       #=> 0.01
p Float(".1")         #=> 0.1

p Float("nan")        # invalid value (ArgumentError)
p Float("INF")        # invalid value (ArgumentError)
p Float("-Inf")       # invalid value (ArgumentError)
p Float(("10" * 1000)) #=> Infinity
p Float("0xa.a")      # invalid value (ArgumentError)
p Float(" \n10\s \t") #=> 10.0 # 空白類は無視される
p Float("")           # invalid value (ArgumentError)

[SEE_ALSO] String#to_f, Float

Integer(arg) -> Integer

引数を整数(Fixnum,Bignum)に変換した結果を返します。

引数が数値の場合は直接変換し（小数点以下切り落とし）、文字列の場合は、進数を表す接頭辞を含む整数表現とみなせる文字列のみ変換します。

数値と文字列以外のオブジェクトに対しては arg.to_int, arg.to_i をこの順に使用して変換します。

[PARAM] arg:: 変換対象のオブジェクトです。
[EXCEPTION] ArgumentError:: 整数と見なせない文字列を引数に指定した場合に発生します。
[EXCEPTION] TypeError:: メソッド to_int, to_i を持たないオブジェクトを引数に指定したか、to_int, to_i が整数(Integerのサブクラス)を返さなかった場合に発生します。

p Integer(4)          #=> 4
p Integer(4_000)      #=> 4000
p Integer(9.88)       #=> 9

p Integer(nil)        #=> 0
p Integer(Object.new) # cannot convert Object into Integer (TypeError)

p Integer("10")       #=> 10
p Integer("0d10")     #=> 10
p Integer("010")      #=> 8
p Integer("0o10")     #=> 8
p Integer("0x10")     #=> 16
p Integer("0b10")     #=> 2
p Integer(" \n10\t ") #=> 10 # 空白類は無視される
p Integer("hoge")     # `Integer': invalid value for Integer: "hoge" (ArgumentError)
p Integer("")         # `Integer': invalid value for Integer: "" (ArgumentError)

[SEE_ALSO] String#hex, String#oct, String#to_i, Integer

String(arg) -> String

引数を文字列(String)に変換した結果を返します。

arg.to_s を呼び出して文字列に変換します。 arg が文字列の場合、何もせず arg を返します。

[PARAM] arg:: 変換対象のオブジェクトです。
[EXCEPTION] TypeError:: to_s の返り値が文字列でなければ発生します。

class Foo
 def to_s
   "hogehoge"
 end
end

arg = Foo.new
p String(arg) #=> "hogehoge"

[SEE_ALSO] Object#to_s, String

__method__ -> Symbol

現在のメソッド名を返します。

def foo
  p __method__
end
foo #=> :foo

self ` command -> String

command を外部コマンドとして実行し、その標準出力を文字列として返します。このメソッドは `command` の形式で呼ばれます。

引数 command に対しダブルクォートで囲まれた文字列と同様の解釈と式展開を行った後、コマンドとして実行します。コマンドは評価されるたびに実行されます。コマンドの終了ステータスを得るには、$? を参照します。

コマンドの出力を得る必要がなく、単にコマンドを実行したいだけなら Kernel.#system を使います。特に端末を制御するコマンドでは `command` は失敗するかもしれません。

リテラル/コマンド出力も参照。

[PARAM] command:: コマンドとして実行する引数です。そのまま評価されるのではなく、ダブルクォート文字列と同様のバックスラッシュ記法の解釈と式展開が行われます。
[RETURN]: コマンドの出力を文字列で返します。
[EXCEPTION] Errno::EXXX:: コマンドを実行できないときや失敗した場合に発生します。

puts `ruby -v` #=> ruby 1.8.6 (2007-03-13 patchlevel 0) [i386-mswin32]
puts $?.inspect #=> #<Process::Status: pid=3580,exited(0)>

[SEE_ALSO] Kernel.#system, Kernel.#exec, Kernel.#spawn

abort(message = $!.message) -> ()

Ruby プログラムをエラーメッセージ付きで終了します。終了ステータスは 1 固定です。

このメソッドと Kernel.#exit との違いは、プログラムの終了ステータスが 1 (正確にはCレベルの定数 EXIT_FAILURE の値)固定であることと、引数を省略した呼び出し時に $! が nil でなければその例外のメッセージを標準エラー出力 $stderr に出力することです。

引数 message を指定すると SystemExit クラスの Exception#message に message を設定して標準エラー出力に出力します。

[PARAM] message:: エラーメッセージ文字列です。

puts 'start'
begin
  puts 'start1...'
  abort "error1"
rescue SystemExit => err
  puts "end1 with #{err.inspect}"
end

begin
  puts 'start2...'
  $! = RuntimeError.new
  abort
ensure
  puts 'end2...'
end
puts 'end' #実行されない

#=> start
#   start1...
#   end1 with #<SystemExit: error1>
#   start2...
#   end2...
#終了ステータス:1
#(標準エラー出力)
#=> error1
#   ..:12: RuntimeError (RuntimeError)

[SEE_ALSO] Kernel.#exit, Kernel.#exit!

at_exit { ... } -> Proc

与えられたブロックをインタプリタ終了時に実行します。

at_exitがメソッドである点を除けば、END ブロックによる終了処理の登録と同等です。登録した処理を取り消すことはできません。終了処理も参照してください。

[RETURN]: 登録した処理を Proc オブジェクトで返します。

3.times do |i|
  at_exit{puts "at_exit#{i}"}
end
END{puts "END"}
at_exit{puts "at_exit"}
puts "main_end"

#=> main_end
#   at_exit
#   END
#   at_exit2
#   at_exit1
#   at_exit0

[SEE_ALSO] 制御構造/END

autoload(const_name, feature) -> nil

定数 const_name を最初に参照した時に feature を Kernel.#require するように設定します。

const_name には、 "::" 演算子を含めることはできません（ネストした定数を指定する方法は後述）。

[PARAM] const_name:: 定数をString または Symbol で指定します。
[PARAM] feature:: require と同様な方法で autoload する対象を指定します。
[EXCEPTION] LoadError:: featureのロードに失敗すると発生します。

------- /tmp/foo.rb ---------
class Bar
end
----- end of /tmp/foo.rb ----

autoload :Bar, '/tmp/foo'
p Bar #=> Bar

ネストした定義内の定数

const_name には、 "::" 演算子を含めることはできないので、 Kernel.#autoload ではトップレベルの定数しか指定できません。

Module#autoload と組み合わせることで、任意のクラス／モジュールの定数を autoload できます。やはりconst_name に "::" 演算子を含めることはできませんが、以下のように定義する事ができます。

------- /tmp/foo.rb ---------
class Foo
  class Bar
  end
end
----- end of /tmp/foo.rb ----

class Foo
  autoload :Bar, '/tmp/foo'
end
p Foo::Bar #=> Foo::Bar

あるいは、以下のようにもできます。

class Foo
end
Foo.autoload :Bar, '/tmp/foo'
p Foo::Bar #=> Foo::Bar

以下のように、autoload したライブラリがネストした定数を定義しない場合、一見、正常に動作しているように見えるので注意が必要です(警告メッセージが出ています)。

------- /tmp/bar.rb ---------
class Bar
end
----- end of /tmp/bar.rb ----

class Foo
  autoload :Bar, '/tmp/bar.rb'
end
p Foo::Bar
p Foo.autoload?(:Bar)
#=> -:4: warning: toplevel constant Bar referenced by Foo::Bar
#   Bar
#   nil

これは以下のようにネストせずに定義したのと同じことです。

class Foo
end
class Bar
end
p Foo::Bar
#=> -:5: warning: toplevel constant Bar referenced by Foo::Bar
#   Bar

[SEE_ALSO] Kernel.#autoload?, Module#autoload, Kernel.#require

autoload?(const_name) -> String | nil

const_name が Kernel.#autoload 設定されているか調べます。

autoload 設定されていて、autoload 定数がまだ定義されてない(ロードされていない) ときにそのパス名を返します。

autoload 設定されていないか、ロード済みなら nil を返します。

[PARAM] const_name:: 定数をString または Symbol で指定します。

------- /tmp/foo.rb ---------
class Foo
  class Bar
  end
end
----- end of /tmp/foo.rb ----

class Foo
end
p Foo.autoload?(:Bar)         #=> nil
Foo.autoload :Bar, '/tmp/foo'
p Foo.autoload?(:Bar)         #=> "/tmp/foo"
p Foo::Bar                    #=> Foo::Bar
p Foo.autoload?(:Bar)         #=> nil

[SEE_ALSO] Kernel.#autoload

binding -> Binding

変数・メソッドなどの環境情報を含んだ Binding オブジェクトを生成して返します。通常、Kernel.#eval の第二引数として使います。

def foo
  a = 1
  binding
end

eval("p a", foo)  #=> 1

[SEE_ALSO] Kernel.#eval, Kernel::TOPLEVEL_BINDING

block_given? -> bool

iterator? -> bool

メソッドにブロックが与えられていれば真を返します。

このメソッドはカレントコンテキストにブロックが与えられているかを調べるので、メソッド内部以外で使っても単に false を返します。

iterator? は（ブロックが必ずイテレートするとはいえないので）推奨されていないので block_given? を使ってください。

def check
  if block_given?
    puts "Block is given."
  else
    puts "Block isn't given."
  end
end
check{} #=> Block is given.
check #=> Block isn't given.

caller(level_num = 1) -> [String] | nil

level_num 段上の呼び出し元の情報を $@ の形式のバックトレース(文字列の配列)として返します。

トップレベルでは空の配列を返します。caller の戻り値を $@ に代入することで例外の発生位置を設定できます。

指定した level_num 段上が存在しない場合は nil を返します。

[PARAM] level_num:: long の範囲を超えない正の整数でスタックレベルを指定します。

[SEE_ALSO] Kernel.#set_trace_func, Kernel.#raise

def foo
  p caller(0)
  p caller(1)
  p caller(2)
  p caller(3)
end

def bar
  foo
end

bar

#=> ["-:2:in `foo'", "-:9:in `bar'", "-:12"]
#   ["-:9:in `bar'", "-:12"]
#   ["-:12"]
#   []

以下の関数は、caller の要素から [ファイル名, 行番号, メソッド名] を取り出して返します。

def parse_caller(at)
  if /^(.+?):(\d+)(?::in `(.*)')?/ =~ at
    file = $1
    line = $2.to_i
    method = $3
    [file, line, method]
  end
end

def foo
  p parse_caller(caller.first)
end

def bar
  foo
  p parse_caller(caller.first)
end

bar
p parse_caller(caller.first)

#=> ["-", 15, "bar"]
#   ["-", 19, nil]
#   nil

以下は、$DEBUG が真の場合に役に立つ debug 関数のサンプルです。

$DEBUG = true

def debug(*args)
  p [caller.first, *args] if $DEBUG
end

debug "debug information"

#=> ["-:5", "debug information"]

catch {|tag| .... } -> object

catch(tag) {|tag| .... } -> object

Kernel.#throwとの組み合わせで大域脱出を行います。 catch はブロックを実行します。

ブロックの実行中に tag と同一のオブジェクトを引数とする Kernel.#throw が行われた場合は、その throw の第二引数を戻り値として、ブロックの実行を終了します。

主にネストしたループから一気に脱出するのに使用します。

引数を省略した場合、タグとなるオブジェクトが内部で生成せれ、ブロック引数 tag に渡されます。

[PARAM] tag:: タグとなる任意のオブジェクトです。
[RETURN]: ブロックの返り値か、対応するthrowの第二引数を返り値として返します。

result = catch do |tag|
  for i in 1..2
    for j in 1..2
      for k in 1..2
        throw tag, k
      end
    end
  end
end

p result #=> 1

[SEE_ALSO] Kernel.#throw

eval(expr) -> object

eval(expr, bind, fname = __FILE__, lineno = 1) -> object

文字列 expr を Ruby プログラムとして評価してその結果を返します。第2引数に Proc オブジェクトまたは Binding オブジェクトを与えた場合、そのオブジェクトを生成したコンテキストで文字列を評価します。

expr の中のローカル変数の扱いはブロックの場合と同じです。すなわち、eval 実行前に補足されていた変数は eval 実行後にブロック外に持ち出せます。

fname と lineno が与えられた場合には、ファイル fname の行番号 lineno から文字列 expr が書かれているかのようにコンパイルされます。スタックトレースの表示などを差し替えることができます。

bind によらずに特定のオブジェクトのコンテキストで expr を評価したい場合、 Module#module_eval, Object#instance_eval が使えます。

[PARAM] expr:: 評価する文字列です。
[PARAM] bind:: Proc オブジェクトまたは Binding オブジェクトです。
[PARAM] fname:: スタックトレースに表示するファイル名です。
[PARAM] lineno:: 文字列 expr が書かれていると想定する先頭の行番号を整数で指定します。

a = nil
eval('a = RUBY_RELEASE_DATE')
p a #=> "2007-03-13"

eval('def fuga;p 777 end')
fuga #=> 777

eval('raise RuntimeError', binding, 'XXX.rb', 4)
#=> XXX.rb:4: RuntimeError (RuntimeError)
#       from ..:9

[SEE_ALSO] Kernel.#binding, Module#module_eval, Object#instance_eval, Object#method, Object#send

exec(command) -> ()

引数で指定されたコマンドを実行します。

プロセスの実行コードはそのコマンド(あるいは shell)になるので、起動に成功した場合、このメソッドからは戻りません。

引数の解釈

この形式では command が shell のメタ文字

  * ? {} [] <> () ~ & | \ $ ; ' ` " \n

を含む場合、shell 経由で実行されます。そうでなければインタプリタから直接実行されます。

[PARAM] command:: コマンドを文字列で指定します。
[EXCEPTION] Errno::EXXX:: 起動に失敗し、ruby インタプリタに制御が戻った場合に発生します。

# a.rb
puts '実行前'
exec 'echo "実行中"'
puts '実行後'

上記のスクリプトを実行すると以下のようになります。

$ ruby a.rb
実行前
実行中
# '実行後' は表示されない

exec(program, *args) -> ()

引数で指定されたコマンドを実行します。

プロセスの実行コードはそのコマンド(あるいは shell)になるので、起動に成功した場合、このメソッドからは戻りません。

この形式では、常に shell を経由せずに実行されます。

引数の解釈

この形式で呼び出した場合、空白や shell のメタキャラクタもそのまま program の引数に渡されます。先頭の引数が2要素の配列であった場合、第1要素の文字列が実際に起動するプログラムのパスであり、第2要素が「みせかけ」のプログラム名になります。また、第1要素はフルパスで指定しなくても環境変数 PATH から探します。

[PARAM] program:: 文字列か2要素の配列を指定します。
[PARAM] args:: 渡される引数です。0 個以上の文字列を指定します。
[EXCEPTION] ArgumentError:: 第一引数が配列かつ要素数が 2 でない場合に発生します。
[EXCEPTION] Errno::EXXX:: 起動に失敗し、ruby インタプリタに制御が戻った場合に発生します。

例

# a.rb
exec ['sleep', 'mysleep'], '600'

上記スクリプトを実行すると以下のようになります。

$ ruby a.rb
## sleep してるので制御が戻ってこない。別の仮想端末に切替えて以下を実行
$ ps aux|grep sleep
xxxx    32754  0.0  0.0   2580   468 pts/3    S+   22:01   0:00 mysleep 600
xxxx    32761  0.0  0.0   2824   792 pts/6    S+   22:01   0:00 grep sleep

[SEE_ALSO] Kernel.#system, Kernel.#`, Kernel.#spawn, Kernel.#fork, IO.popen, IO.pipe, Kernel.#open, exec(3)

exit(status = true) -> ()

Rubyプログラムの実行を終了します。status として整数が与えられた場合、その値を Ruby コマンドの終了ステータスとします。デフォルトの終了ステータスは 0(正常終了)です。

status が true の場合 0、 false の場合 1 を引数に指定したとみなされます。この値はCレベルの定数 EXIT_SUCCESS、EXIT_FAILURE の値なので、正確には環境依存です。

exit は例外 SystemExit を発生させることによってプログラムの実行を終了させますので、必要に応じて begin 節で捕捉することができます。

[PARAM] status:: 終了ステータスを整数か true または false で与えます。

puts 'start'
begin
  puts 'start1...'
  exit
rescue SystemExit => err
  puts "end1 with #{err.inspect}"
end

begin
  puts 'start2...'
  exit
ensure
  puts 'end2...'
end
puts 'end' #実行されない

#=> start
#   start1...
#   end1 with #<SystemExit: exit>
#   start2...
#   end2...
#終了ステータス:0

[SEE_ALSO] Kernel.#exit!, Kernel.#abort, 制御構造/begin

exit!(status = false) -> ()

Rubyプログラムの実行を即座に終了します。 status として整数が与えられた場合、その値を Ruby コマンドの終了ステータスとします。デフォルトの終了ステータスは 1 です。

exit! は exit とは違って、例外処理などは一切行ないません。 Kernel.#fork の後、子プロセスを終了させる時などに用いられます。

[PARAM] status:: 終了ステータスを整数か true または false で与えます。

STDOUT.sync = true #表示前に終了しないようにする
puts 'start'
begin
  puts 'start1...'
  exit!
ensure
  puts 'end1...' #実行されない
end
puts 'end' #実行されない

#=> start
#   start1...
#終了ステータス:1

[SEE_ALSO] Kernel.#exit, Kernel.#abort

raise -> ()

fail -> ()

raise(message) -> ()

fail(message) -> ()

raise(error_type, message = nil, backtrace = caller(0)) -> ()

fail(error_type, message = nil, backtrace = caller(0)) -> ()

例外を発生させます。発生した例外は変数 $! に格納されます。また例外が発生した時のスタックトレースは変数 $@ に格納されます。発生した例外は rescue 節で捕捉できます。

引数無しの場合は、同スレッドの同じブロック内で最後に rescue された例外オブジェクト ($!) を再発生させます。そのような例外が存在しないが自身は捕捉されている時には例外 RuntimeError を発生させます。

begin
  open("nonexist")
rescue
  raise   #=> `open': No such file or directory - "nonexist" (Errno::ENOENT)
end

引数を渡した場合は、例外メッセージ message を持った error_type の示す例外(省略時 RuntimeError)を発生させます。

error_type として例外ではないクラスやオブジェクトを指定した場合、そのオブジェクトの exception メソッドが返す値を発生する例外にします。その際、exception メソッドに引数として変数 message を渡すことができます。

[PARAM] error_type:: 発生させる例外を例外クラスまたは例外クラスのインスタンスで指定します。
[PARAM] message:: 例外のメッセージとなる文字列です。
[PARAM] backtrace:: 例外発生時のスタックトレースで、Kernel.#caller の戻り値と同じ形式で指定しなければいけません。
[EXCEPTION] TypeError:: exception メソッドが例外オブジェクトを返さなかった場合に発生します。

例外の捕捉の例を示します。

#例1
begin
  raise NameError,"!!error!!"
rescue ArgumentError => rer
rescue NameError => rer
rescue TypeError => rer
ensure
  p rer #=> #<NameError: !!error!!>
end

#例2
def foo num
  print 'in method.'
  raise "error!!" if num <= 9
rescue RuntimeError
  num += 10
  print 'in rescue.'
  retry
else
  print 'in else.'
ensure
  print "in ensure.\n"
end

foo(4) #=> in method.in rescue.in method.in else.in ensure.

#例3
class MyException
  def exception(mesg=nil)
    SecurityError.new(mesg)
  end
end

raise MyException.new rescue p $! #=> #<SecurityError: SecurityError>

[SEE_ALSO] Kernel.#caller

fork -> Integer | nil

fork { ... } -> Integer | nil

fork(2) システムコールを使ってプロセスの複製を作ります。親プロセスでは子プロセスのプロセスIDを、子プロセスでは nil を返します。ブロックを指定して呼び出した場合には、生成した子プロセスでブロックを評価します。

fork 前に STDOUT と STDERR を IO#flush します。

[EXCEPTION] NotImplementedError:: 実行環境がこのメソッドに対応していないとき発生します。

[SEE_ALSO] IO.popen, IO.pipe, fork(2)

sprintf(format, *arg) -> String

format(format, *arg) -> String

format 文字列を C 言語の sprintf と同じように解釈し、引数をフォーマットした文字列を返します。

[PARAM] format:: フォーマット文字列です。
[PARAM] arg:: フォーマットされる引数です。

[SEE_ALSO] Kernel.#printf, Time#strftime, Date.strptime

sprintf フォーマット

Ruby の sprintf フォーマットは基本的に C 言語の sprintf(3) のものと同じです。ただし、short や long などの C 特有の型に対する修飾子がないこと、2進数の指示子(%b)が存在すること、sprintf のすべての方言をサポートしていないこと(%': 3桁区切り)などの違いがあります。

Ruby には整数の大きさに上限がないので、%b, %o, %x に負の数を与えると (左側に無限に1が続くとみなせるので) ..f のような表示をします。絶対値に符号を付けた形式で出力するためには %+x、% x のように指定します。

以下は sprintf フォーマットの書式です。[] で囲まれた部分は省略可能であることを示しています。

%[引数指定$][フラグ][幅][.精度]指示子

`%' 自身を出力するには `%%' とします。

以下それぞれの要素に関して説明します。

フラグ

フラグには #, +, ' '(スペース), -, 0 の5種類があります。

#

2進、8進、16進の指示子(b, o, x, X) ではそれぞれプレフィックスとして "0b", "0", "0x", "0X" を付加します。 C 言語とは異なり引数が 0 の場合にもプレフィックスが付加されます。

  p sprintf("%#b", 10) #=> "0b1010"
  p sprintf("%#o", 10) #=> "012"
  p sprintf("%#x", 10) #=> "0xa"
  p sprintf("%#X", 10) #=> "0XA"

浮動小数点数 (f, e, E, g, G) に対しては必ず出力に"."をつけます。

  p sprintf("%.0f", 10) #=> "10"
  p sprintf("%#.0f", 10) #=> "10."
  p sprintf("%.0e", 10) #=> "1e+01"
  p sprintf("%#.0e", 10) #=> "1.e+01"

また g, G では上記に加えて末尾の余分な0が残ります。

  p sprintf("%.05g", 10) #=> "10"
  p sprintf("%#.05g", 10) #=> "10.000"

+

出力文字列を符号付きにします。特に正の数では`+'が付加されます。数値の指示子 (d, i, b, o, x, X, u, f, e, E, g, G) に対してだけ意味を持ちます。また、特に b, o, x, X, u に対しては、負数に対して "-" を付加することを示します。

  p sprintf("%d", 1)   #=> "1"
  p sprintf("%+d", 1)  #=> "+1"

  p sprintf("%x", -1)  #=> "..f"  # ".." は無限に f が続くことを表している
  p sprintf("%+x", -1) #=> "-1"

' '(スペース)

`+' と同じですが正の符号 `+' の代わりに空白を用います。数値の指示子 (d, i, b, o, x, X, u, f, e, E, g, G) に対してだけ意味を持ちます。

  p sprintf("%d", 1)   #=> "1"
  p sprintf("%+d", 1)  #=> "+1"
  p sprintf("% d", 1)  #=> " 1"

  p sprintf("%x", -1)  #=> "..f"
  p sprintf("% x", 1)  #=> " 1"
  p sprintf("% x", -1) #=> "-1"

-

出力を左詰めにします幅の指定がなければ意味がありません。

0

出力が右詰めの場合に余った部分に空白の代わりに "0" を詰めます。

数値の指示子の一部(d, i, b, o, x, X, u, f, g, G)に対してだけ意味を持ちます(e, E には意味がない)

  p sprintf("%010d", 10)   #=> "0000000010"

`#' と一緒に指定した場合の出力は以下のようになります。

  p sprintf("%#010x", 10)  #=> "0x0000000a"
  p sprintf("%#010o", 10)  #=> "0000000012"
  p sprintf("%#010b", 10)  #=> "0b00001010"

これは、以下と同じです。

  p sprintf("%#10.8x", 10) #=> "0x0000000a"
  p sprintf("%#10.9o", 10) #=> "0000000012"
  p sprintf("%#10.8b", 10) #=> "0b00001010"

通常は、以下のようになります。

  p sprintf("%#10x", 10)   #=> "       0xa"
  p sprintf("%#10o", 10)   #=> "       012"
  p sprintf("%#10b", 10)   #=> "    0b1010"

幅

0以外の数字で始まる数字列は幅指定になります。幅は生成文字列の長さを示します。後述の精度の値によらずこの幅分だけの文字列が生成されます。

幅の指定はフラグで付与される " ", "+", "-", "0b", "0", "0x", "0X" の長さも考慮されます。

p sprintf("%+5d", 11)  #=> "  +11"
p sprintf("%+-5d", 11) #=> "+11  "
p sprintf("%+05d", 11) #=> "+0011"

幅は「最低限必要な幅」の指定になります。結果の文字列が指定した幅を超える場合は幅の指定は無効になります。

幅として `*' を指定すると幅の値を引数から得ることになります。

p sprintf("%#05x", 10)    #=> "0x00a"
p sprintf("%#0*x", 5, 10) #=> "0x00a"

精度

"." の後に続く数字列は精度を表します("." のみの場合 ".0" と同じです)。精度は整数の指示子 (d, i, b, o, x, X, u) に対しては、数値列部分の長さを意味します。

p sprintf("%10.5d", 1)  #=> "     00001"
p sprintf("%#10.5x", 1) #=> "   0x00001"
p sprintf("%+10.5x", 1) #=> "    +00001"

浮動小数点数の指示子 (f) に対しては小数部の桁数を意味します。

p sprintf("%10.5f", 1)   #=> "   1.00000"
p sprintf("%10.5f", 10)  #=> "  10.00000"

浮動小数点数の指示子 (e, E, g, G) に対しては有効桁数を意味します。

p sprintf("%10.5e", 1)   #=> "1.00000e+00"
p sprintf("%10.5e", 10)  #=> "1.00000e+01"
p sprintf("%10.5g",  10)  #=> "        10"
p sprintf("%#10.5G", 10)  #=> "    10.000"

文字列の指示子(s, p) に対しては引数の文字列のうち指定した数を超える分を切り捨てます。幅と精度を同じ値にすれば、どのような引数に対してもその長さだけの出力を行うことになります。

p sprintf("%10.2s", "foo")  #=> "        fo"

p sprintf("%5.5s", "foo")     #=> "  foo"
p sprintf("%5.5s", "foobar")  #=> "fooba"

精度として `*' を指定すると精度の値を引数から得ることになります。

p sprintf("%.5s", "foobar")    #=> "fooba"
p sprintf("%.*s", 5, "foobar") #=> "fooba"

指示子

指示子は引数の型の解釈を示します。指示子を省略することはできません。指示子には大きく分けて

文字列を表す指示子: c, s, p
整数を表す指示子: d, i, u, b, o, x, X,
浮動小数点数を表す指示子: f, g, e, E, G

があります

c

引数の数値(0～255)を文字コードとみなして対応する文字を出力します。引数が数値以外のオブジェクトの場合 to_int メソッドによる変換を試みます。引数として範囲内の一文字の文字列も受けつけます。文字そのものを出力します。

  p sprintf("%c", 97)  #=> "a"
  p sprintf("%c", 'a') #=> "a"

フラグ `-' と幅の指定だけが意味を持ちます。

s

文字列を出力します。

引数が String オブジェクトでなければ to_s メソッドにより文字列化したものを引数として扱います。

p

Object#inspect の結果を出力します。

  p sprintf("%s", /e+/)  #=> "(?-mix:e+)"
  p sprintf("%p", /e+/)  #=> "/e+/"

d

i

引数の数値を10進表現の整数として出力します。

引数が整数でなければ関数 Kernel.#Integer と同じ規則で整数に変換されます。

  p sprintf("%d", -1) #=> "-1"
  p sprintf("%d", 3.1) #=> "3"
  p sprintf("%d", '0b1010') #=> "10"

u

引数の数値を符号なし整数とみなして10進表現の整数として出力します。

  p sprintf("%u", '0b1010') #=> "10"
  p sprintf("%u", -1) #=> "-1"

b

o

x

X

整数をそれぞれ2進、8進、16進、16進(大文字)表現の文字列で出力します。

`#' フラグを指定すれば "0b", "0", "0x", "0X" を先頭に付加します。

`+', ` ' フラグがない場合、負の数には ".." が先頭(`#' フラグがあれば "0x" などの後)に付加されます。これは最上位桁の文字が無限に続くことを意味し、2の補数表現で負の数を表しています。

   p sprintf("%#b", 10)    #=> "0b1010"
   p sprintf("%#o", 10)    #=> "012"
   p sprintf("%#x", 10)    #=> "0xa"

   # 負の数に対して ".." が付加されます
   p sprintf("%#b", -1)    #=> "0b..1"
   p sprintf("%#o", -1)    #=> "0..7"
   p sprintf("%#x", -1)    #=> "0x..f"

   p sprintf("%10x", -1)   #=> "       ..f"
   p sprintf("%-10x", -1)  #=> "..f       "

   # 「精度」を指定した場合、".." は付加されません
   p sprintf("%.10x", -1)  #=> "ffffffffff"

f

e

E

g

G

f は小数点表現(xxx.xxx)で数値を出力します。

e は指数表現(x.xxxe+xx)で数値を出力します。

g は指数が -4 より小さいか精度以上の場合に e と同じ出力を、それ以外では f と同じ出力を行います。ただし、小数部の末尾の0は取り除かれます。

大文字の指示子(E, G)は出力のアルファベットを大文字にします。

  p sprintf("%f", 1.0) #=> "1.000000"
  p sprintf("%e", 1.0) #=> "1.000000e+00"
  p sprintf("%g", 1.0) #=> "1"

  p sprintf("%f", 10.1) #=> "10.100000"
  p sprintf("%e", 10.1) #=> "1.010000e+01"
  p sprintf("%g", 10.1) #=> "10.1"

  p sprintf("%g", 10 ** 6)  #=> "1e+06"
  p sprintf("%g", 10 ** -5) #=> "1e-05"

精度の省略値は 6 です。

無限大、NaN(Not a Number) に対する出力は以下のとおりです。

  p sprintf("%f",  1.0/0)  #=> "inf"
  p sprintf("%f", -1.0/0)  #=> "-inf"
  p sprintf("%f",  0.0/0)  #=> "nan"

  p sprintf("%E",  1.0/0)  #=> "INF"
  p sprintf("%E", -1.0/0)  #=> "-INF"
  p sprintf("%E",  0.0/0)  #=> "NAN"

f, e, E, g, G に関しては sprintf(3) の結果を利用しています。従って出力結果は実際にはシステムに依存することになります。

引数指定

利用頻度が低いので最後に説明します。

nth$

nth 番目の引数のフォーマットを行うことを示します。

  p sprintf("%d, %x, %o", 1, 2, 3) #=> "1, 2, 3"
  p sprintf("%3$d, %2$x, %1$o", 1, 2, 3) #=> "3, 2, 1"

  p sprintf("%1$d, %1$x, %1$o", 10) #=> "10, a, 12"

状況によってフォーマットを変えたいが引数の順序を変えたくない場合に使用します。

  case ENV['LC_TIME']
  when /^ja_JP/
    fmt = "%1$d年%2$d月%3$d日"
  else
    fmt = "%2$02d/%03$2d/%1$02d"
  end

  p sprintf(fmt, 1, 4, 22) #=> "04/22/01"

"*" の後に指定することで幅や精度を引数で指定することもできます。

  p sprintf("%5.2f", 1)              #=> " 1.00"
  p sprintf("%*.*f", 5, 2, 1)        #=> " 1.00"
  p sprintf("%1$*2$.*3$f", 1, 5, 2)  #=> " 1.00"

gets(rs = $/) -> String | nil

ARGFから一行読み込んで、それを返します。行の区切りは引数 rs で指定した文字列になります。

rs に nil を指定すると行区切りなしとみなしてファイルの内容をすべて読み込みます。ARGVに複数のファイル名が存在する場合は1度に1ファイルずつ読み込みます。空文字列 "" を指定すると連続する改行を行の区切りとみなします (パラグラフモード)。

読み込んだ文字列は組み込み変数 $_ にもセットされます。

[PARAM] rs:: 行の区切りとなる文字列です。
[RETURN]: ファイルの終り(EOF)に到達した時、 nil を返します。
[EXCEPTION] Errno::EXXX:: 読み込みに失敗した場合に発生します。

---main.rb---
ARGV << 'b.txt' << 'c.txt'
p gets #=> "hello\n"
p gets(nil) #=> "it\ncommon\n"
p gets("") #=> "ARGF\n\n"
p gets('、') #=> "スクリプトに指定した引数 (Kernel::ARGV を参照) をファイル名と\nみなして、"
p gets #=> "それらのファイルを連結した 1 つの仮想ファイルを表すオブジェクトです。 \n"
p gets #=> nil
p readline # end of file reached (EOFError)
--- b.txt ---
hello
it
common
--- c.txt ---
ARGF

スクリプトに指定した引数 (Kernel::ARGV を参照) をファイル名と
みなして、それらのファイルを連結した 1 つの仮想ファイルを表すオブジェクトです。

[SEE_ALSO] $/, ARGF, Kernel.#readlines, Kernel.#readline

global_variables -> [String]

プログラム中で定義されているグローバル変数(`$'で始まる変数)名の配列を返します。

p global_variables #=> ["$-p", "$-I", "$-v" ... ]

[SEE_ALSO] Kernel.#local_variables, Object#instance_variables, Module.constants, Module#constants, Module#class_variables

proc { ... } -> Proc

lambda { ... } -> Proc

proc -> Proc

lambda -> Proc

与えられたブロックから手続きオブジェクト (Proc のインスタンス) を生成して返します。Proc.new に近い働きをします。

ブロックが指定されなければ、呼び出し元のメソッドで指定されたブロックを手続きオブジェクトとして返します。呼び出し元のメソッドがブロックなしで呼ばれると ArgumentError 例外が発生します。

ただし、ブロックを指定しない呼び出しは推奨されていません。呼び出し元のメソッドで指定されたブロックを得たい場合は明示的に & 引数でうけるべきです。

[EXCEPTION] ArgumentError:: スタック上にブロックがないのにブロックを省略した呼び出しを行ったときに発生します。

def foo &block
  lambda(&block)
end

it = foo{p 12}
it.call #=> 12

[SEE_ALSO] Proc, Proc.new

手続きを中断して値を返す

手続きオブジェクトを中断して、呼出し元(呼び出しブロックでは yield、それ以外では Proc#call) へジャンプし値を返すには next を使います。break や return ではありません。

例:

 def foo
   f = Proc.new{
     next 1
     2
   }
 end

p foo().call       #=> 1

Proc オブジェクトをブロック付きメソッド呼び出しに使う

ブロック付きメソッドに対して Proc オブジェクトを `&' を指定して渡すと呼び出しブロックのように動作します。しかし、厳密には以下の違いがありますこれらは、Proc オブジェクトが呼び出しブロックとして振舞う際の制限です。

# 問題なし
(1..5).each { break }

# LocalJumpError が発生します。
pr = Proc.new { break }
(1..5).each(&pr)

lambda と proc と Proc.new とイテレータの違い

Kernel.#lambda と Proc.new はどちらも Proc クラスのインスタンス(手続きオブジェクト)を生成しますが、生成された手続きオブジェクトはいくつかの場面で挙動が異なります。 lambda の生成する手続きオブジェクトのほうがよりメソッドに近い働きをするように設計されています。

Kernel.#proc は Proc.new と同じになります。引数に & を付けることで手続きオブジェクト化したブロックは、Proc.new で生成されたそれと同じにように振る舞います。

引数の扱い

lambda のほうがより厳密です。引数の数が違っていると（メソッドのように）エラーになります。 Proc.new は引数を多重代入に近い扱い方をします。

例:

b1 = Proc.new{|a,b,c|
  p a,b,c
}
b1.call(2, 4)
#=> 2
    4
    nil

b2 = lambda{|a,b,c|
  p a,b,c
}
b2.call(2, 4)
#=> wrong number of arguments (2 for 3) (ArgumentError)

メソッド呼び出しも参照してください。

ジャンプ構文の挙動の違い

return と break は、lambda と Proc.new では挙動が異なります。例えば return を行った場合、lambda では手続きオブジェクト自身を抜けますが、 Proc.new では手続きオブジェクトを囲むメソッドを抜けます。

例:

def foo
  f = Proc.new { return :foo }
  f.call
  return
end

def bar
  f = lambda { return :bar }
  f.call
  return
end

def h
  yield
end

def hoge
  h{ return :hoge }
  nil
end

p foo()  #=> :foo
p bar()  #=> nil
p hoge() #=> :hoge

以下の表は、手続きオブジェクトの実行を上の例と同じように、手続きオブジェクトが定義されたのと同じメソッド内で行った場合の結果です。

               return                          next                        break
Proc.new   メソッドを抜ける            手続きオブジェクトを抜ける   例外が発生する
proc       メソッドを抜ける            手続きオブジェクトを抜ける   例外が発生する
lambda     手続きオブジェクトを抜ける  手続きオブジェクトを抜ける   手続きオブジェクトを抜ける
イテレータ メソッドを抜ける            手続きオブジェクトを抜ける   メソッドを抜ける

orphan な手続きオブジェクトの挙動

Proc を生成したメソッドから脱出した後、手続きオブジェクトからの return, break は例外 LocalJumpError を発生させます。ただし、上でも説明した通り lambda で生成した手続きオブジェクトはメソッドと同じように振る舞うことを意図されているため、例外 LocalJumpError は発生しません。

例:

def foo
  Proc.new { return }
end

foo.call
# => in `call': return from proc-closure (LocalJumpError)

以下の表は、手続きオブジェクトの実行を上の例と同じように、手続きオブジェクトが定義されたメソッドを脱出してから行った場合の結果です。

               return                          next                        break
Proc.new   例外が発生する              手続きオブジェクトを抜ける   例外が発生する
proc       例外が発生する              手続きオブジェクトを抜ける   例外が発生する
lambda     手続きオブジェクトを抜ける  手続きオブジェクトを抜ける   手続きオブジェクトを抜ける

load(file, priv = false) -> true

Ruby プログラム file をロードして実行します。再ロード可能です。

file が絶対パスのときは file からロードします。 file が相対パスのときは組み込み変数 $: に示されるパスを順番に探し、最初に見付かったファイルをロードします。このとき、$: の要素文字列の先頭文字が `~' (チルダ) だと、環境変数 HOME の値に展開されます。

ロードに成功した場合は true を返します。

[PARAM] file:: ファイル名の文字列です。
[PARAM] priv:: 真のとき、ロード・実行は内部的に生成される無名モジュールをトップレベルとして行われ、グローバルな名前空間を汚染しません。
[EXCEPTION] LoadError:: ロードに失敗した場合に発生します。

[SEE_ALSO] Kernel.#require

require と load の違い

Kernel.#require は同じファイルは一度だけしかロードしませんが、 Kernel.#load は無条件にロードします。また、require は拡張子.rb や .so を自動的に補完しますが、 load は行いません。 require はライブラリのロード、load は設定ファイルの読み込みなどに使うのが典型的な用途です。

# 使用例
load "#{ENV['HOME']}/.myapprc"
load "/etc/myapprc"

なお、特定のディレクトリからファイルをロードしたい場合、 load 'filename' とするのは不適切です。必ず絶対パスを使ってください。

local_variables -> [String]

現在のスコープで定義されているローカル変数名の配列を返します。

yuyu = 0
p local_variables #=> ["yuyu"]

[SEE_ALSO] Kernel.#global_variables, Object#instance_variables, Module.constants, Module#constants, Module#class_variables

loop { ... } -> object

(中断されない限り)永遠にブロックの評価を繰り返します。

[RETURN]: breakの引数など、ループ脱出時の値を返します。

def try int
  n = 0
  loop do
    n += 1
    break(n) if rand(n) > int
  end
end

puts "end on #{try(400)}" #=> end on ???

open(name, mode = 'r', perm = nil, options = {}) -> StringIO | File [redefined by open-uri]

open(name, mode = 'r', perm = nil, options = {}) {|ouri| ...} -> nil [redefined by open-uri]

name が http:// や ftp:// で始まっている文字列なら URI のリソースを取得した上で StringIO オブジェクトとして返します。 StringIO オブジェクトは OpenURI::Meta モジュールで extend されています。

name に open メソッドが定義されている場合は、*rest を引数として渡し name.open(*rest, &block) のように name の open メソッドが呼ばれます。

これ以外の場合は、name はファイル名として扱われ、従来の Kernel.#open(name, *rest) が呼ばれます。

ブロックを与えた場合は上の場合と同様、name が http:// や ftp:// で始まっている文字列なら URI のリソースを取得した上で StringIO オブジェクトを引数としてブロックを評価します。後は同様です。 StringIO オブジェクトは OpenURI::Meta モジュールで extend されています。

[PARAM] name:: オープンしたいリソースを文字列で与えます。
[PARAM] mode:: モードを文字列で与えます。Kernel.#open と同じです。
[PARAM] perm:: open(2) の第 3 引数のように、ファイルを生成する場合のファイルのパーミッションを整数で指定します。Kernel.#open と同じです
[PARAM] options:: ハッシュを与えます。詳しくは OpenURI.open_uri を参照してください。
[EXCEPTION] OpenURI::HTTPError:: 対象となる URI のスキームが http であり、かつリソースの取得に失敗した時に発生します。
[EXCEPTION] Net::FTPError:: 対象となる URI のスキームが ftp であり、かつリソースの取得に失敗した時に Net::FTPError のサブクラスが発生します。詳しくは net/ftp を参照して下さい。

例:

require 'open-uri'
sio = open('http://www.example.com')
p sio.is_a?(OpenURI::Meta) # => true
p sio.content_type
puts sio.read

[SEE_ALSO] OpenURI.open_uri

open(file, mode = "r", perm = 0666) -> IO

open(file, mode = "r", perm = 0666) {|io| ... } -> object

file をオープンして、IO（Fileを含む）クラスのインスタンスを返します。

ブロックが与えられた場合、指定されたファイルをオープンし、生成した IO オブジェクトを引数としてブロックを実行します。ブロックの終了時や例外によりブロックを脱出するとき、ファイルをクローズします。ブロックを評価した結果を返します。

ファイル名 file が `|' で始まる時には続く文字列をコマンドとして起動し、コマンドの標準入出力に対してパイプラインを生成します

ファイル名が "|-" である時、open は Ruby の子プロセスを生成し、その子プロセスとの間のパイプ(IOオブジェクト)を返します。(このときの動作は、IO.popen と同じです。 File.open にはパイプラインを生成する機能はありません)。

Perlと異なりコマンドは常に `|' で始まります。

[PARAM] file:: ファイルを文字列で指定します。整数を指定した場合はファイルディスクリプタとして扱います。
[PARAM] mode:: モードを文字列か定数の論理和で指定します。後述。
[PARAM] perm:: open(2) の第 3 引数のように、ファイルを生成する場合のファイルのパーミッションを整数で指定します。
[EXCEPTION] Errno::EXXX:: ファイルのオープンに失敗した場合に発生します。

[SEE_ALSO] File.open, IO.popen, IO.open

第二引数のオープンモード

以下の文字列か整数(File::Constants モジュールの定数の論理和)を組み合わせて指定します。

"r", RDONLY: ファイルを読み込みモードでオープンします。（デフォルトのモード）
"w", WRONLY|CREAT|TRUNC: ファイルを書き込みモードでオープンします。オープン時にファイルがすでに存在していればその内容を空にします。
"a", WRONLY|CREAT|APPEND: ファイルを書き込みモードでオープンします。出力は常にファイルの末尾に追加されます。例えば、ファイルオープン中にファイルのサイズが小さくなってもその末尾に出力されます。

"+" があれば、ファイルは読み書き両用モード (RDWR) でオープンされます。

"r+": ファイルの読み書き位置は先頭にセットされます。
"w+": "r+" と同じですが、オープン時にファイルがすでに存在していればその内容を空にします。
"a+": "r+" と同じですが、オープン時にファイルがすでに存在していれば読み書き位置がファイルの末尾にセットされます。

これらのいずれに対しても "b" フラグを ("r+b"のように) つけることができます (整数なら File::BINARY )。この場合、バイナリモードでオープンします (ただし、DOS/Windowsのようにシステムがテキスト／バイナリでファイルを区別する場合に限ります)

p(*arg) -> object | Array

引数を人間に読みやすい形に整形して改行と順番に標準出力 $stdout に出力します。主にデバッグに使用します。

引数の inspect メソッドの返り値と改行を順番に出力します。つまり以下のコードと同じです。

print arg[0].inspect, "\n", arg[1].inspect, "\n", ...

整形に用いられるObject#inspectは普通に文字列に変換すると区別がつかなくなるようなクラス間の差異も表現できるように工夫されています。

p に引数を与えずに呼び出した場合は特に何もしません。

[PARAM] arg:: 出力するオブジェクトを任意個指定します。
[EXCEPTION] IOError:: 標準出力が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。
[RETURN]: 指定された引数 arg を返します。複数の引数が指定された場合はそれらを要素とする配列を返します。

puts "" #=> （空行）
p "" #=> ""

puts 50,"50"
#=> 50
#=> 50
p 50,"50"
#=> 50
#=> "50"

[SEE_ALSO] Object#inspect, Kernel.#puts, Kernel.#print

print(*arg) -> nil

引数を順に標準出力 $stdout に出力します。引数が与えられない時には変数 $_ の値を出力します。

文字列以外のオブジェクトが引数として与えられた場合には、 to_s メソッドにより文字列に変換してから出力します。

変数 $, (出力フィールドセパレータ)に nil でない値がセットされている時には、各引数の間にその文字列を出力します。変数 $\ (出力レコードセパレータ)に nil でない値がセットされている時には、最後にそれを出力します。

[PARAM] arg:: 出力するオブジェクトを任意個指定します。
[EXCEPTION] IOError:: 標準出力が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

print "Hello, world!"
print "Regexp is",/ant/
print nil
print "\n"
#=> Hello, world!Regexp is(?-mix:ant)

$_ = "input"
$, = "<and>"
$\ = "<end>\n"
print
print "AA","BB"
#=> input<and><end>
#=> AA<and>BB<and><end>

[SEE_ALSO] Kernel.#puts, Kernel.#p

printf(format, *arg) -> nil

printf(port, format, *arg) -> nil

C 言語の printf と同じように、format に従い引数を文字列に変換して port に出力します。

port を省略した場合は標準出力 $stdout に出力します。

引数を 1 つも指定しなければ何もしません。

Ruby における format 文字列の拡張については Kernel.#sprintfの項を参照してください。

[PARAM] port:: 出力先になるIO のサブクラスのインスタンスです。
[PARAM] format:: フォーマット文字列です。
[PARAM] arg:: フォーマットされる引数です。
[EXCEPTION] ArgumentError:: port を指定したのに format を省略した場合に発生します。
[EXCEPTION] IOError:: port が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

printf("calculate%3s%-6s%.15f", 'PI', '...', Math::PI)
#=> calculate PI...   3.141592653589793

printf("%d %04x", 123, 123)               #=> "123 007b"
printf("%08b '%4s'", 123, 123)            #=> "01111011 ' 123'"
printf("%1$*2$s %2$d %1$s", "hello", 8)   #=> "   hello 8 hello"
printf("%1$*2$s %2$d", "hello", -8)       #=> "hello    -8"
printf("%+g:% g:%-g", 1.23, 1.23, 1.23)   #=> "+1.23: 1.23:1.23"
printf("%u", -123)                        #=> "..4294967173"

[SEE_ALSO] Kernel.#sprintf, IO#printf

putc(ch) -> object

文字 ch を標準出力 $stdout に出力します。

ch が数値なら 0 ～ 255 の範囲の対応する文字を出力します。 ch が文字列なら、その先頭 1byte を出力します。どちらでもない場合は、ch.to_int で整数に変換を試みます。

[PARAM] ch:: 出力する文字です。数または文字列で指定します。
[RETURN]: ch を返します
[EXCEPTION] RangeError:: Bignum を引数にした場合に発生します。
[EXCEPTION] IOError:: 標準出力が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。
[EXCEPTION] TypeError:: Integer に変換できないオブジェクトを引数に指定した場合に発生します。

putc("ch")
putc(?c)
putc(99)
putc(355)
#=> cccc

putc(99.00) #=> c
putc(33333333333333333333333333333333333) # bignum too big to convert into `long' (RangeError)

[SEE_ALSO] IO#putc

puts(*arg) -> nil

引数と改行を順番に標準出力 $stdout に出力します。引数がなければ改行のみを出力します。

引数が配列の場合、その要素と改行を順に出力します。配列や文字列以外のオブジェクトが引数として与えられた場合には、当該オブジェクトを最初に to_ary により配列へ、次に to_s メソッドにより文字列へ変換を試みます。末尾が改行で終っている引数や配列の要素に対しては puts 自身は改行を出力しません。

[PARAM] arg:: 出力するオブジェクトを任意個指定します。
[EXCEPTION] IOError:: 標準出力が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

puts "foo", "bar\n", "baz"
puts ""    # 改行のみ出力
puts       # 改行のみ出力
puts nil   # 改行のみ出力
puts ["oui", "non"]
#=> foo
#   bar
#   baz
#
#
#
#   oui
#   non

[SEE_ALSO] Kernel.#print, Kernel.#p, IO#puts

rand(max = 0) -> Integer|Float

擬似乱数を得るメソッドです。

max.to_i.abs（引数の整数表現の絶対値）が 0以外の場合、 0 以上 max.to_i.abs 未満の範囲の整数をランダムに返します。また 0 の場合、0.0 以上 1.0 未満の範囲の浮動小数点数をランダムに返します。

まだ Kernel.#srand が呼ばれていなければ自動的に呼び出します。

[PARAM] max:: 数値オブジェクトです。

p rand(63) #=> 20
p rand(63) #=> 56
p rand(0) #=> 0.341033520223401
p rand(0) #=> 0.31341550089985

p rand(-5) #=> 2
p rand(0.9) #=> 0.195303845149051
p rand(1.5) #=> 0

[SEE_ALSO] Kernel.#srand, Object#to_int, Numeric#abs

readline(rs = $/) -> String

ARGFから一行読み込んで、それを返します。行の区切りは引数 rs で指定した文字列になります。

読み込んだ文字列は組み込み変数 $_ にもセットされます。

[PARAM] rs:: 行の区切りとなる文字列です。
[EXCEPTION] Errno::EXXX:: 読み込みに失敗した場合に発生します。
[EXCEPTION] EOFError:: readline でファイル末端(EOF)を検出すると発生します。

---main.rb---
ARGV << 'b.txt' << 'c.txt'
p readline #=> "hello\n"
p readline(nil) #=> "it\ncommon\n"
p readline("") #=> "ARGF\n\n"
p readline('、') #=> "スクリプトに指定した引数 (Kernel::ARGV を参照) をファイル名と\nみなして、"
p readline #=> "それらのファイルを連結した 1 つの仮想ファイルを表すオブジェクトです。 \n"
p readline # end of file reached (EOFError)
--- b.txt ---
hello
it
common
--- c.txt ---
ARGF

スクリプトに指定した引数 (Kernel::ARGV を参照) をファイル名と
みなして、それらのファイルを連結した 1 つの仮想ファイルを表すオブジェクトです。

[SEE_ALSO] $/, ARGF, Kernel.#readlines, Kernel.#gets

readlines(rs = $/) -> [String] | nil

ARGFを Kernel.#gets(rs) でEOFまで読み込んで、その各行を要素としてもつ配列を返します。行の区切りは引数 rs で指定した文字列になります。

rs に nil を指定すると行区切りなしとみなします。空文字列 "" を指定すると連続する改行を行の区切りとみなします (パラグラフモード)。

[PARAM] rs:: 行の区切りとなる文字列です。
[EXCEPTION] Errno::EXXX:: 読み込みに失敗した場合に発生します。

---main.rb---
ARGV << 'b.txt' << 'b.txt'
p readlines #=> ["hello\n", "it\n", "\n", "common\n", "hello\n", "it\n", "\n", "common\n"]

ARGV << 'b.txt' << 'b.txt'
p readlines(nil) #=> ["hello\nit\n\ncommon\n", "hello\nit\n\ncommon\n"]

ARGV << 'b.txt' << 'b.txt'
p readlines("") #=> ["hello\nit\n\n", "common\n", "hello\nit\n\n", "common\n"]

ARGV << 'b.txt' << 'b.txt'
p readlines('it') #=> ["hello\nit", "\n\ncommon\n", "hello\nit", "\n\ncommon\n"]
p readlines #=> nil
--- b.txt ---
hello
it

common

[SEE_ALSO] $/, ARGF, Kernel.#gets

require(feature) -> bool

Ruby ライブラリ feature をロードします。拡張子補完を行い、同じファイルの複数回ロードはしません。

feature が絶対パスのときは feature からロードします。 feature が相対パスのときは組み込み変数 $: に示されるパスを順番に探し、最初に見付かったファイルをロードします。このとき、$: の要素文字列の先頭文字が `~' (チルダ) だと、環境変数 HOME の値に展開されます。

Ruby ライブラリとは Ruby スクリプト (*.rb) か拡張ライブラリ (*.so,*.o,*.dll など) であり、feature の拡張子が省略された場合はその両方から探します( *.rb が優先されます)。省略されなかった場合は指定された種別のみを探します。また、feature の拡張子にはアーキテクチャで実際に使われる拡張子に関らず拡張ライブラリの拡張子として常に .so を用いることができます（内部で適切に変換されます）。

ライブラリのロードに成功した時には true を返し、ロードした feature の名前を(拡張子も含めて) 変数 $" に追加します。ただし、feature の名前が既に $" に含まれていた場合はロードせずに false を返します。

[PARAM] feature:: ファイル名の文字列です。
[EXCEPTION] LoadError:: ロードに失敗した場合に発生します。

[SEE_ALSO] Kernel.#load, Kernel.#autoload, Kernel.#require_relative

require_relative(relative_feature) -> bool

現在のファイルからの相対パスで require します。

require File.expand_path(File.join(File.dirname(__FILE__), relative_feature))

とほぼ同じです。

[PARAM] feature:: ファイル名の文字列です。
[EXCEPTION] LoadError:: ロードに失敗した場合に発生します。

[SEE_ALSO] Kernel.#require

require と load のスコープ

ローカル変数はファイル間では共有されません。ですので、ロードしたライブラリのローカル変数をロード元のスクリプトから直接取得することはできません。このスコープの扱い方はKernel.#loadでも同様です。

---------- some.rb -----------
$a = 1
@a = 1
A = 1
a = 1
---------- end some.rb -------

require 'some'
p $a #=> 1
p @a #=> 1
p A #=> 1
p a # undefined local variable or method `a' for #<Object:0x294f9ec @a=1> (NameError)

select(reads, writes = [], excepts = [], timeout = nil) -> [[IO]] | nil

IO.select と同じです。

[PARAM] reads:: IO.select 参照
[PARAM] writes:: IO.select 参照
[PARAM] excepts:: IO.select 参照
[PARAM] timeout:: IO.select 参照

[SEE_ALSO] IO.select

set_trace_func(proc) -> object

set_trace_func {|event, file, line, id, binding, klass| ... } -> Proc

Ruby インタプリタのイベントをトレースする Proc オブジェクトとして指定された proc を登録します。 proc に nil を指定した場合でトレースをオフにします。ブロックを指定された場合はそのブロックをトレースする Proc オブジェクトとして登録します。

引数 proc かブロックを Proc オブジェクトに変換したものを返します。

Ruby インタプリタがプログラムを実行する過程で、メソッドの呼び出しや式の評価などのイベントが発生する度に、以下で説明する6個の引数とともに登録された Proc オブジェクトを実行します。

標準添付の debug、tracer、 profile はこの組み込み関数を利用して実現されています。

ブロック引数の意味

event

実行のタイプを表す、以下のいずれかの文字列。

  "line":      式の評価。
  "call":      メソッドの呼び出し。
  "return":    メソッド呼び出しからのリターン。
  "c-call":    Cで記述されたメソッドの呼び出し。
  "c-return":  Cで記述されたメソッド呼び出しからのリターン。
  "class":     クラス定義、特異クラス定義、モジュール定義への突入。
  "end":       クラス定義、特異クラス定義、モジュール定義の終了。
  "raise":     例外の発生。

file

実行中のプログラムのソースファイル名 (文字列)。

line

実行中のプログラムのソースファイル上の行番号 (整数)。

id

event に応じ、以下のものが渡されます。第六ブロック引数の klass と対応しています。

    line
        最後に呼び出されたメソッドを表す Symbol オブジェクト。
        トップレベルでは nil。
    call/return/c-call/c-return
        呼び出された/リターンするメソッドを表す Symbol オブジェクト。
    class/end
        nil。
    raise
        最後に呼び出されたメソッドを表す Symbol オブジェクト。
        トップレベルでは nil。

binding

実行中のプログラムのコンテキストを表す Binding オブジェクト。

klass

event に応じ、以下のものが渡されます。第四ブロック引数の id と対応しています。

    line
        最後に呼び出されたメソッドが属するクラスを表す
        Class オブジェクト。トップレベルでは false。
    call/return/c-call/c-return
        呼び出された/リターンするメソッドが属するクラス
        を表す Class オブジェクト。
    class/end
        false。
    raise
        最後に呼び出されたメソッドが属するクラスを表す
        Class オブジェクト。トップレベルでは false。

[PARAM] proc:: トレース用 Proc オブジェクトを指定します。nil を指定した場合、トレースをオフにします。
[RETURN]: 引数 proc が指定された場合は proc を、ブロックの場合は Proc オブジェクトに変換したものを返します。

例:

set_trace_func lambda {|*arg|
  p arg
}
class Foo
end
43.to_s

#----結果----
#["line", "..", 4, nil, #<Binding:0x2b69584>, false]
#  ["c-call", "..", 4, :inherited, #<Binding:0x2b693b8>, Class]
#    ["c-return", "..", 4, :inherited, #<Binding:0x2b6937c>, Class]
#      ["class", "..", 4, nil, #<Binding:0x2b69098>, false]
#        ["end", "..", 4, nil, nil, false]
#        ["line", "..", 6, nil, #<Binding:0x2b68d78>, false]
#          ["c-call", "..", 6, :to_s, #<Binding:0x2b68c88>, Fixnum]
#            ["c-return", "..", 6, :to_s, #<Binding:0x2b68aa8>, Fixnum]

[SEE_ALSO] Kernel.#caller

sleep(sec = 0) -> Integer

sec 秒だけプログラムの実行を停止します。

sec が省略されたり 0 を指定した場合、他スレッドからの Thread#run などで明示的に起こさない限り永久にスリープします。Thread#runを呼ぶとその時点で sleepの実行が中断されます。

[PARAM] sec:: 停止する秒数を非負の数値で指定します。浮動小数点数も指定できます。 0 を指定した場合、永久にスリープします。
[RETURN]: 実際に停止していた秒数 (整数に丸められた値) です。

it = Thread.new do
  sleep 999
  puts 'it_end'
end

re = sleep 2.11
puts re
it.run
re2 = sleep 0.76
puts re2
#=> 2
#   it_end
#   1

spawn(command) -> Integer

spawn(env, command) -> Integer

引数を外部コマンドとして実行しますが、生成した子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

引数の解釈

この形式では command が shell のメタ文字

  * ? {} [] <> () ~ & | \ $ ; ' ` " \n

を含む場合、shell 経由で実行されます。そうでなければインタプリタから直接実行されます。

[PARAM] command:: コマンドを文字列で指定します。
[PARAM] env:: If a hash is given as env, the environment is updated by env before exec(2) in the child process. If a pair in env has nil as the value, the variable is deleted. name => val : set the environment variable name => nil : unset the environment variable
[EXCEPTION] Errno::EXXX:: 起動に失敗し、ruby インタプリタに制御が戻った場合に発生します。
[EXCEPTION] Errno::EXXX:: コマンドが実行できなかった場合に発生します。

If a hash is given as env, the environment is updated by env before exec(2) in the child process. If a pair in env has nil as the value, the variable is deleted.

# set FOO as BAR and unset BAZ.
pid = spawn({"FOO"=>"BAR", "BAZ"=>nil}, command)

[SEE_ALSO] Kernel.#system, Kernel.#exec

spawn(program, *arg) -> Integer

spawn(env, program, *arg) -> Integer

spawn(env, program, *arg, option) -> Integer

引数を外部コマンドとして実行しますが、生成した子プロセスの終了を待ち合わせません。生成した子プロセスのプロセスIDを返します。

引数の解釈

[PARAM] program:: 文字列か2要素の配列を指定します。
[PARAM] args:: 渡される引数です。0 個以上の文字列を指定します。
[PARAM] env:: If a hash is given as env, the environment is updated by env before exec(2) in the child process. If a pair in env has nil as the value, the variable is deleted. name => val : set the environment variable name => nil : unset the environment variable
[PARAM] option:: If a hash is given as options, it specifies process group, resource limit, current directory, umask and redirects for the child process. Also, it can be specified to clear environment variables.
[EXCEPTION] ArgumentError:: 第一引数が配列かつ要素数が 2 でない場合に発生します。
[EXCEPTION] Errno::EXXX:: コマンドが実行できなかった場合に発生します。

options: hash
  clearing environment variables:
    :unsetenv_others => true   : clear environment variables except specified by env
    :unsetenv_others => false  : don't clear (default)
  process group:
    :pgroup => true or 0 : make a new process group
    :pgroup => pgid      : join to specified process group
  resource limit: resourcename is core, cpu, data, etc.  See Process.setrlimit.
    :rlimit_resourcename => limit
    :rlimit_resourcename => [cur_limit, max_limit]
  current directory:
    :chdir => str
  umask:
    :umask => int
  redirection:
    key:
      FD              : single file descriptor in child process
      [FD, FD, ...]   : multiple file descriptor in child process
    value:
      FD                        : redirect to the file descriptor in parent process
      string                    : redirect to file with open(string, "r" or "w")
      [string]                  : redirect to file with open(string, File::RDONLY)
      [string, open_mode]       : redirect to file with open(string, open_mode, 0644)
      [string, open_mode, perm] : redirect to file with open(string, open_mode, perm)
      [:child, FD]              : redirect to the redirected file descriptor
      :close                    : close the file descriptor in child process
    FD is one of follows
      :in     : the file descriptor 0
      :out    : the file descriptor 1
      :err    : the file descriptor 2
      integer : the file descriptor of specified the integer
      io      : the file descriptor specified as io.fileno
  file descriptor inheritance: close non-redirected non-standard fds (3, 4, 5, ...) or not
    :close_others => false : inherit fds (default for system and exec)
    :close_others => true  : don't inherit (default for spawn and IO.popen)

If a hash is given as env, the environment is updated by env before exec(2) in the child process. If a pair in env has nil as the value, the variable is deleted.

# set FOO as BAR and unset BAZ.
pid = spawn({"FOO"=>"BAR", "BAZ"=>nil}, command)

option で有効なキーと値

If a hash is given as options, it specifies process group, resource limit, current directory, umask and redirects for the child process. Also, it can be specified to clear environment variables.

:unsetenv_others

The :unsetenv_others key in options specifies to clear environment variables, other than specified by env.

  pid = spawn(command, :unsetenv_others=>true) # no environment variable
  pid = spawn({"FOO"=>"BAR"}, command, :unsetenv_others=>true) # FOO only

:pgroup

The :pgroup key in options specifies a process group. The corresponding value should be true, zero or positive integer. true and zero means the process should be a process leader of a new process group. Other values specifies a process group to be belongs.

  pid = spawn(command, :pgroup=>true) # process leader
  pid = spawn(command, :pgroup=>10) # belongs to the process group 10

:rlimit_XXX

The :rlimit_foo key specifies a resource limit. foo should be one of resource types such as core. The corresponding value should be an integer or an array which have one or two integers: same as cur_limit and max_limit arguments for Process.setrlimit.

  pid = spawn(command, :rlimit_core=>0) # never dump core.
  cur, max = Process.getrlimit(:CORE)
  pid = spawn(command, :rlimit_core=>[0,max]) # disable core temporary.
  pid = spawn(command, :rlimit_core=>max) # enable core dump

:chdir

The :chdir key in options specifies the current directory.

  pid = spawn(command, :chdir=>"/var/tmp")

:umask

The :umask key in options specifies the umask.

  pid = spawn(command, :umask=>077)

:in, :out, :err

The :in, :out, :err, a fixnum, an IO and an array key specifies a redirection. The redirection maps a file descriptor in the child process.

For example, stderr can be merged into stdout as follows:

  pid = spawn(command, :err=>:out)
  pid = spawn(command, 2=>1)
  pid = spawn(command, STDERR=>:out)
  pid = spawn(command, STDERR=>STDOUT)

The hash keys specifies a file descriptor in the child process started by spawn. :err, 2 and STDERR specifies the standard error stream (stderr).

The hash values specifies a file descriptor in the parent process which invokes spawn. :out, 1 and STDOUT specifies the standard output stream (stdout).

In the above example, the standard output in the child process is not specified. So it is inherited from the parent process.

The standard input stream (stdin) can be specified by :in, 0 and STDIN.

A filename can be specified as a hash value.

  pid = spawn(command, :in=>"/dev/null") # read mode
  pid = spawn(command, :out=>"/dev/null") # write mode
  pid = spawn(command, :err=>"log") # write mode
  pid = spawn(command, 3=>"/dev/null") # read mode

For stdout and stderr, it is opened in write mode. Otherwise read mode is used.

For specifying flags and permission of file creation explicitly, an array is used instead.

  pid = spawn(command, :in=>["file"]) # read mode is assumed
  pid = spawn(command, :in=>["file", "r"])
  pid = spawn(command, :out=>["log", "w"]) # 0644 assumed
  pid = spawn(command, :out=>["log", "w", 0600])
  pid = spawn(command, :out=>["log", File::WRONLY|File::EXCL|File::CREAT, 0600])

The array specifies a filename, flags and permission. The flags can be a string or an integer. If the flags is omitted or nil, File::RDONLY is assumed. The permission should be an integer. If the permission is omitted or nil, 0644 is assumed.

If an array of IOs and integers are specified as a hash key, all the elements are redirected.

  # stdout and stderr is redirected to log file.
  # The file "log" is opened just once.
  pid = spawn(command, [:out, :err]=>["log", "w"])

Another way to merge multiple file descriptors is [:child, fd]. [:child, fd] means the file descriptor in the child process. This is different from fd. For example, :err=>:out means redirecting child stderr to parent stdout. But :err=>[:child, :out] means redirecting child stderr to child stdout. They differs if stdout is redirected in the child process as follows.

  # stdout and stderr is redirected to log file.
  # The file "log" is opened just once.
  pid = spawn(command, :out=>["log", "w"], :err=>[:child, :out])

[:child, :out] can be used to merge stderr into stdout in IO.popen. In this case, IO.popen redirects stdout to a pipe in the child process and [:child, :out] refers the redirected stdout.

  io = IO.popen(["sh", "-c", "echo out; echo err >&2", :err=>[:child, :out]])
  p io.read #=> "out\nerr\n"

spawn closes all non-standard unspecified descriptors by default. The "standard" descriptors are 0, 1 and 2. This behavior is specified by :close_others option. :close_others doesn‘t affect the standard descriptors which are closed only if :close is specified explicitly.

  pid = spawn(command, :close_others=>true)  # close 3,4,5,... (default)
  pid = spawn(command, :close_others=>false) # don't close 3,4,5,...

The option :close_others is true by default for spawn and IO.popen.

So IO.pipe and spawn can be used as IO.popen.

  # similar to r = IO.popen(command)
  r, w = IO.pipe
  pid = spawn(command, :out=>w)   # r, w is closed in the child process.
  w.close

The symbol :close is specified as a hash value to close a fd individually.

  f = open(foo)
  system(command, f=>:close)        # don't inherit f.

If a file descriptor need to be inherited, io=>io can be used.

  # valgrind has --log-fd option for log destination.
  # log_w=>log_w indicates log_w.fileno inherits to child process.
  log_r, log_w = IO.pipe
  pid = spawn("valgrind", "--log-fd=#{log_w.fileno}", "echo", "a", log_w=>log_w)
  log_w.close
  p log_r.read

It is also possible to exchange file descriptors.

  pid = spawn(command, :out=>:err, :err=>:out)

The hash keys specify file descriptors in the child process. The hash values specifies file descriptors in the parent process. So the above specifies exchanging stdout and stderr. Internally, spawn uses an extra file descriptor to resolve such cyclic file descriptor mapping.

[SEE_ALSO] Kernel.#system, Kernel.#exec

srand -> Integer

srand(seed) -> Integer

Kernel.#rand の乱数の種を設定し、古い種を返します。

seed.to_i（引数の整数表現）を乱数の種に設定します。 seed に既知の値を与えると、以前の Kernel.#rand の値を再現できます。

初期値 seed が省略された時には現在の時刻やプロセス ID、srand を呼び出した回数、また可能なら /dev/urandom から読み出したデータなどを元に種を作ります。

[PARAM] seed:: 乱数の種となる数値を指定します。to_int メソッドにより整数に変換されます。 Bignum も指定可能です。

num = 455675
seeds = []

srand(num)

p rand(6) #=> 3
p rand(6) #=> 0
p rand(0) #=> 0.445804380918972
p rand(0) #=> 0.422248634121701

seeds << srand

p rand(6) #=> 3
p rand(6) #=> 3
p rand(0) #=> 0.938911141393347
p rand(0) #=> 0.915824970865251

seeds << srand(num)

p rand(6) #=> 3
p rand(6) #=> 0
p rand(0) #=> 0.445804380918972
p rand(0) #=> 0.422248634121701

seeds << srand

p seeds #=> [455675, 2995620310703489221660585195204777696, 455675]

[SEE_ALSO] Kernel.#rand, Object#to_int

syscall(num, *arg) -> Integer

numで指定された番号のシステムコールを実行します。第2引数以降をシステムコールの引数として渡します。

どの数値がどのシステムコールに対応するかは、 syscall(2) や /usr/include/sys/syscall.h を参照してください。

システムコールの慣習に従い、syscall(2) が -1 を返す場合には例外 Errno::EXXX が発生します。それ以外では、返した値をそのまま数値で返します。

ライブラリ dl を使えばより高レベルな操作ができます。

[PARAM] num:: システムコール番号です。
[PARAM] arg:: 文字列か、整数です。最大 9 個まで渡すことができます。
[EXCEPTION] Errno::EXXX:: syscall(2) が -1 を返した場合に発生します。
[EXCEPTION] NotImplementedError:: 実行環境がこのメソッドに対応していないとき発生します。

[SEE_ALSO] dl

system(command) -> bool

引数を外部コマンドとして実行して、成功した時に真を返します。

子プロセスが終了ステータス 0 で終了すると成功とみなし true を返します。それ以外の終了ステータスの場合は false を返します。コマンドを実行できなかった場合は nil を返します。

終了ステータスは変数 $? で参照できます。

コマンドを実行することができなかった場合、多くのシェルはステータス 127 を返します。(したがって $? の数値は、0x7f00)、シェルを介さない場合は Ruby の子プロセスがステータス 127 で終了します。コマンドが実行できなかったのか、コマンドが失敗したのかは、普通 $? を参照することで判別可能です。

引数の解釈

この形式では command が shell のメタ文字

  * ? {} [] <> () ~ & | \ $ ; ' ` " \n

を含む場合、shell 経由で実行されます。そうでなければインタプリタから直接実行されます。

[PARAM] command:: command コマンドを文字列で指定します。

[SEE_ALSO] Kernel.#`, Kernel.#spawn, Kernel.#exec, system(3)

system(program, *args) -> bool

引数を外部コマンドとして実行して、成功した時に真を返します。

子プロセスが終了ステータス 0 で終了すると成功とみなし true を返します。それ以外の終了ステータスの場合 (コマンドを実行できなかった場合も含む)は false を返します。

終了ステータスは変数 $? で参照できます。

引数の解釈

[PARAM] program:: 文字列か2要素の配列です。
[PARAM] args:: program に渡す引数を 0 個以上指定する
[EXCEPTION] ArgumentError:: 第一引数が配列かつ要素数が 2 でない場合に発生します。

[SEE_ALSO] Kernel.#`, Kernel.#spawn, Kernel.#exec, system(3)

test(cmd, file) -> bool | Time | Integer | nil

単体のファイルでファイルテストを行います。

[PARAM] cmd:: 以下に示す数値リテラルか文字列です(文字列の場合はその先頭の文字だけをコマンドとみなします)。
[PARAM] file:: テストするファイルオブジェクトです。
[RETURN]: 下表に特に明記していないものは、真偽値を返します。

以下は cmd として指定できる数値リテラルとその意味です。

?r: ファイルを実効 uid で読むことができる
?w: ファイルに実効 uid で書くことができる
?x: ファイルを実効 uid で実行することができる
?o: ファイルの所有者が実効 uid である
?G: ファイルのグループ所有者が実効 gid である
?R: ファイルを実 uid で読むことができる
?W: ファイルに実 uid で書くことができる
?X: ファイルを実 uid で実行することができる
?O: ファイルの所有者が実 uid である
?e: ファイルが存在する
?z: ファイルサイズが 0 である
?s: ファイルサイズが 0 でない (ファイルサイズを返す、0 ならば nil) -> Integer|nil
?f: ファイルはプレーンファイルである
?d: ファイルはディレクトリである
?l: ファイルはシンボリックリンクである
?p: ファイルは名前つきパイプ(FIFO)である
?S: ファイルはソケットである
?b: ファイルはブロック特殊ファイルである
?c: ファイルはキャラクター特殊ファイルである
?u: ファイルに setuid ビットがセットされている
?g: ファイルに setgid ビットがセットされている
?k: ファイルに sticky ビットがセットされている
?M: ファイルの最終更新時刻を返す -> Time
?A: ファイルの最終アクセス時刻を返す -> Time
?C: ファイルの inode 変更時刻を返す -> Time

test(cmd, file1, file2) -> bool

２ファイル間のファイルテストを行います。

[PARAM] cmd:: 以下に示す数値リテラルか文字列です(文字列の場合はその先頭の文字だけをコマンドとみなします)。
[PARAM] file1:: テストするファイルオブジェクトです。
[PARAM] file2:: テストするファイルオブジェクトです。
[RETURN]: 真偽値を返します。

以下は cmd として指定できる数値リテラルとその意味です。

?=: ファイル1とファイル2の最終更新時刻が等しい
?>: ファイル1の方がファイル2より最終更新時刻が新しい
?<: ファイル1の方がファイル2より最終更新時刻が古い
?-: ファイル1とファイル2が同一のファイルである

throw(tag, value = nil) -> ()

Kernel.#catchとの組み合わせで大域脱出を行います。 throw は同じ tag を指定した catch のブロックの終わりまでジャンプします。

throw は探索時に呼び出しスタックをさかのぼるので、ジャンプ先は同じメソッド内にあるとは限りません。もし ensure節が存在するならジャンプ前に実行します。

もし同じ tag で待っている catch が存在しない場合は NameError でスレッドが終了します。

同じタグであるとは Object#object_id が同じであるという意味です。

[PARAM] tag:: catch の引数に対応する任意のオブジェクトです。
[PARAM] value:: catch の戻り値になります。
[EXCEPTION] NameError:: 同じ tag で待っている catch が存在しない場合に発生します。

def foo
  throw :exit, 25
end

ret = catch(:exit) do
  begin
    foo
    some_process()    # 絶対に実行されない
    10
  ensure
    puts "ensure"
  end
end
puts ret
#=> ensure
#   25

[SEE_ALSO] Kernel.#catch

trace_var(varname, hook) -> nil

trace_var(varname) {|new_val| .... } -> nil

trace_var(varname, hook) -> [String|Proc]

グローバル変数 varname への代入のフックを登録します。

ここでの「グローバル変数」は、 [[unknown:特殊変数|組み込み変数]]も含めた `$' で始まる変数のことです。

この呼び出し以降、varname で指定したグローバル変数に値が代入されるたびに hook かブロックが評価されます。hook が Proc オブジェクトの場合代入された値がブロック引数に渡されます。文字列の場合はRubyコードとして評価されます。

trace_var がフックするのは明示的な代入だけです。フックは複数登録できます。

フックを解除するには、hook に nil を指定するか、Kernel.#untrace_var を用います。

hook が nil ならば、設定されていた hook をすべて解除してその配列を返します(ブロックで登録されていれば Proc オブジェクトで返されます) それ以外は、nil を返します。

[PARAM] varname:: グローバル変数名を文字列か Symbol で指定します。
[PARAM] hook:: フックになる文字列または Proc オブジェクトです。
[RETURN]: フックを登録した場合は nil を返します。解除した場合は解除したフックを並べた配列を返します。

trace_var(:$v){|val| puts "hook: $v=#{val.inspect}" }
$v = 1       #=> hook: $v=1
$v = "foo"   #=> hook: $v="foo"
$v.upcase!
p $v         #=> "FOO"

[SEE_ALSO] Kernel.#untrace_var

trap(signal, command) -> object

trap(signal) { ... } -> object

signal で指定された割り込みにたいするハンドラとして command を登録します。Signal.#trapと同じです。

Signal.#trapの使用を推奨します。

[PARAM] signal:: Signal.#trap 参照
[PARAM] command:: Signal.#trap 参照

[SEE_ALSO] Signal.#trap, Signal

untrace_var(varname, hook = nil) -> [String|Proc]

グローバル変数 varname に関連付けられたフックを解除します。

hook が指定された場合にはそのフックだけを解除します。省略するか nil を与えた場合は varname のフックを全て解除します。

[PARAM] varname:: グローバル変数名を文字列か Symbol で指定します。
[PARAM] hook:: 文字列または Proc オブジェクトです。
[RETURN]: 解除されたフックの配列を返します。

trace_var(:$v){|val| print "hookA.#{val.inspect},\n" }
block = proc{|val| print "hookB.#{val.inspect}," }
trace_var(:$v,&block)
$v = 'str'        #=> hookB."str",hookA."str",

untrace_var(:$v,block)
$v = 'str'        #=> hookA."str",

trace_var(:$v){|val| print "hookC.#{val.inspect}," }
p untrace_var(:$v) #=> [#<Proc:0x02b68f58@..:9>, #<Proc:0x02b6978c@..:3>]
$v = 'str'        # なにも出力されない

[SEE_ALSO] Kernel.#trace_var

warn(message) -> nil

message を標準エラー出力 $stderr に出力します。 $VERBOSE フラグが nil のときは何も出力しません。

文字列以外のオブジェクトが引数として与えられた場合には、 to_s メソッドにより文字列に変換してから出力します。

このメソッドは以下と同じです。

$stderr.print message, "\n" unless $VERBOSE.nil?

[PARAM] message:: 出力するオブジェクトです。
[EXCEPTION] IOError:: 標準エラー出力が書き込み用にオープンされていなければ発生します。
[EXCEPTION] Errno::EXXX:: 出力に失敗した場合に発生します。

warn "caution!" #=> caution!
$VERBOSE = nil
warn "caution!" # 何もしない

[SEE_ALSO] $stderr, $VERBOSE

定数

ARGF

引数 (なければ標準入力) で構成される仮想ファイル (詳細は ARGF を参照)。

つまり Kernel.#gets は ARGF.gets と同じ意味です。 ARGF.file で現在読み込み中のファイルオブジェクトが、 ARGF.filename で現在読み込み中のファイル名が得られます。

ARGV [redefined by optparse]

optparse を require することにより、ARGV は OptionParser::Arguable を extend します。

ARGV

Ruby スクリプトに与えられた引数を表す配列です。

組み込み変数 $* の別名です。 Ruby 自身に対する引数は取り除かれています。

例:

スクリプト argv.rb の内容が

p ARGV

であったとします。このときシェルから次を実行すると、

$ ruby argv.rb foo bar baz

結果は以下のように出力されます。

["foo", "bar", "baz"]

DATA

スクリプトの __END__ プログラムの終り以降をアクセスする File オブジェクト。

プログラム・文・式/プログラムの終りも参照。

ソースファイルの __END__ 以降は解析・実行の対象にならないのでその部分にプログラムが利用するためのデータを書き込んでおくことができます。 DATA 定数はそのデータ部分にアクセスするための File オブジェクトを保持しています。

__END__ を含まないプログラムにおいては DATA は定義されません。

注意

DATA.rewind で移動する読みとり位置は __END__ 直後ではなく、スクリプトファイルの先頭です。
スクリプトが標準入力から読みこまれた場合は標準入力になります。
スクリプトがファイルや標準入力から読みこまれなかった場合や、 __END__ で終っていない場合には定義されません。
Kernel.#require や Kernel.#load で読み込まれたファイルの中であってもそのファイル (Kernel#__FILE__) ではなく実行されたファイル ($0) を指します。

例1

print DATA.gets # => 故人西辞黄鶴楼
print DATA.gets # => 烟花三月下揚州
print DATA.gets # => 孤帆遠影碧空尽
print DATA.gets # => 唯見長江天際流
DATA.gets       # => nil

__END__
故人西辞黄鶴楼
烟花三月下揚州
孤帆遠影碧空尽
唯見長江天際流

例2

sum = 0
DATA.each_line do |line|
  sum += line.to_i
end

DATA.rewind
p DATA.gets    # => "sum = 0￥n"

__END__
17
19
23
29
31

例3

DATA.gets    # => uninitialized constant DATA (NameError)

例4

ファイル library.rb と app.rb の内容が以下であったとします。

library.rb:

print DATA.gets

__END__
data from library

app.rb:

require 'library.rb'

__END__
data from app

このときシェルから次を実行すると

$ ruby app.rb

結果は以下のように出力されます。

data from app

ENV

環境変数を表す (疑似) 連想配列 (詳細は ENV を参照)。

この連想配列の値を変更すると子プロセスの環境として引き継がれます。

FALSE

非推奨です。代表的な偽の値。false と同じ。

この定数は過去との互換性のために提供されています。擬似変数 false を使ってください。 Ruby では false と nil が偽として扱われます。偽でない値(false でも nil でもない値) は全て真とみなされます。

NIL

非推奨です。 nil と同じ。

この定数は過去との互換性のために提供されています。擬似変数 nil を使ってください。

Ruby では false と nil が偽として扱われます。偽でない値(false でも nil でもない値) は全て真とみなされます。

RUBY_COPYRIGHT

Ruby のコピーライトを表す文字列。

RUBY_DESCRIPTION

Ruby の詳細を表す文字列。

ruby -v で表示される内容が格納されています。

RUBY_PATCHLEVEL

Ruby のパッチレベルを表す Fixnum オブジェクトです。

パッチレベルはRubyの各バージョンに対するバグ修正パッチの適用をカウントしています。 teeny リリースのそれぞれについてパッチレベルは 0 から始まり、その teeny リリースに対してバグ修正パッチが適用される度に増えていきます。

パッチレベルという概念および RUBY_PATCHLEVEL 定数は、 Ruby 1.8.5-p1 以降、 1.8.6 以降で導入されました。 1.8.5やそれ以前のバージョンでは定義されていません。

RUBY_PLATFORM

プラットフォームを表す文字列。

RUBY_RELEASE_DATE

Ruby のリリース日を表す文字列。

RUBY_VERSION

Ruby のバージョンを表す文字列。

Ruby のバージョンは、major.minor.teeny という形式です。それぞれの番号は (今のところ) 2 桁以上にならないと約束されていますので、

if RUBY_VERSION >= '1.6.7'
  # バージョン 1.6.7 以降で有効な処理
else
  # それ以前のバージョンで有効な処理
end

とバージョンの違いによる処理の分岐を書くことができます。

Ruby 1.8 までは、minor が奇数のバージョンは開発版、 minor が偶数のバージョンは安定版です。 RUby 1.9.0 以降は、teeny が 0 のバージョンが開発版となる予定です。

SCRIPT_LINES__

ソースファイル別にまとめられたソースコードの各行。

この定数は、デフォルトでは定義されていません。この定数がハッシュとして定義された後にソースが((*コンパイル*))されると、そのソースファイル名をキーに、ソースを行毎に分割した配列を値にしたハッシュ要素が設定されます。

この定数はデバッガ (debug) などで利用されています。

なお、 $SAFE レベルが 0 でなければ有効にはなりません。また、 Kernel.#eval によるコンパイルは対象にはなりません。

例:

require 'pp'
SCRIPT_LINES__ = {}
require 'English'
pp SCRIPT_LINES__

# => {"/usr/local/lib/ruby/1.6/English.rb"=>
#     ["alias $ERROR_INFO              $!\n",
#      "alias $ERROR_POSITION          $@\n",
#      "alias $LOADED_FEATURES         $\"\n",
#               :
#               :
#      "alias $POSTMATCH               $'\n",
#      "alias $LAST_PAREN_MATCH        $+\n"]}

STDERR

標準エラー出力。$stderr のデフォルト値。 $stderr も参照してください。

STDERR は、 ruby プロセスが起動された時点での標準エラー出力を表します。起動時点では $stderr も同じ値に初期化されています。

$stderr に他の出力オブジェクトを代入することで簡易なリダイレクトを実現できます。そして、 $stderr に STDERR を代入すればこのリダイレクトを復元できるわけです。

注意

STDERR は ruby 自体が起動された時点での標準エラー出力です。「システムにおける標準のエラー出力ストリーム」とは異なります。

多くのシステムでは標準のエラー出力ストリームは端末です。 ruby 自体が他のストリームに向けてエラー出力をリダイレクトされた状態で起動された場合、 STDERR が保持するのは端末ではなく、リダイレクト先のストリームです。

STDIN

標準入力。$stdin のデフォルト値。 $stdin も参照してください。

STDIN は、 ruby プロセスが起動された時点での標準入力を表します。起動時点では $stdin も同じ値に初期化されています。

$stdin に他の入力オブジェクトを代入することで簡易なリダイレクトを実現できます。そして、 $stdin に STDIN を代入すればこのリダイレクトを復元できるわけです。

注意

STDIN は ruby 自体が起動された時点での標準入力です。「システムにおける標準の入力ストリーム」とは異なります。

多くのシステムでは標準の入力ストリームは端末です。 ruby 自体が他のストリームに向けて入力をリダイレクトされた状態で起動された場合、 STDIN が保持するのは端末ではなく、リダイレクト先のストリームです。

STDOUT

標準出力。$stdout のデフォルト値。 $stdout も参照してください。

STDOUT は、 ruby プロセスが起動された時点での標準出力を表します。起動時点では $stdout も同じ値に初期化されています。

$stdout に他の出力オブジェクトを代入することで簡易なリダイレクトを実現できます。そして、 $stdout に STDOUT を代入すればこのリダイレクトを復元できるわけです。

注意

STDOUT は ruby 自体が起動された時点での標準出力です。「システムにおける標準の出力ストリーム」とは異なります。

多くのシステムでは標準の出力ストリームは端末です。 ruby 自体が他のストリームに向けて出力をリダイレクトされた状態で起動された場合、 STDOUT が保持するのは端末ではなく、リダイレクト先のストリームです。

TOPLEVEL_BINDING

トップレベルでの Binding オブジェクト。

詳細は Binding を参照してください。

TRUE

非推奨です。代表的な真の値。true と同じ。

この定数は過去との互換性のために提供されています。擬似変数 true を使ってください。

Ruby では false と nil が偽として扱われます。偽でない値(false でも nil でもない値) は全て真とみなされます。

特殊変数

$!

最後に例外が発生したときの Exception オブジェクトです。

Kernel.#raise によって設定されます。

この変数はスレッドローカルです。該当する例外がないときは nil です。

$"

$LOADED_FEATURES

Kernel.#require でロードされたファイル名を含む配列です。

Kernel.#require で同じファイルを複数回ロードしないようにするためのロックとして使われます。

この変数はグローバルスコープです。

$$

現在実行中の Ruby プロセスのプロセス ID です。 Process.#pid と同じです。

この変数はグローバルスコープです。

$&

現在のスコープで最後に成功した正規表現のパターンマッチでマッチした文字列です。

最後のマッチが失敗していた場合には nil。 Regexp.last_match[0] と同じです。

この変数はローカルスコープかつスレッドローカルです。

$'

現在のスコープで最後に成功した正規表現のパターンマッチでマッチした部分より後ろの文字列です。

最後のマッチが失敗していた場合には nil。

Regexp.last_match.post_match と同じです。

この変数はローカルスコープかつスレッドローカルです。

$*

Rubyスクリプトに与えられた引数を表す配列です。組み込み定数 Kernel::ARGV の別名です。

Ruby 自身に対する引数は取り除かれています。

この変数はグローバルスコープです。

$+

現在のスコープで最後に成功した正規表現のパターンマッチでマッチした中で最後の括弧に対応する部分文字列です。

最後のマッチが失敗していた場合には nil。いくつかある選択型のパターンのどれがマッチしたのか分からない時に便利です。

この変数はローカルスコープかつスレッドローカルです。

$,

デフォルトの区切り文字列です。 Array#join で引数を省略した場合と、 Kernel.#print の各引数の間で出力されます。

デフォルト値は nil で、空文字列と同じ結果になります。

この変数はグローバルスコープです。

$/

$-0

入力レコードセパレータを表す文字列です。 awk の RS 変数のように働きます。

Kernel.#gets のような行単位の読み込みメソッドに影響します。デフォルト値は "\n" です。

この変数に nil を設定すると読み込みメソッドはファイル全体を一度に読み込みます。空文字列 "" を設定するとパラグラフモードとみなされ、 2 つ以上連続した改行がレコードの区切りになります。

$/ には正規表現は使えません。

この変数はグローバルスコープです。

$;

$-F

String#split で引数を省略した場合の区切り文字です。

デフォルト値は nil で、この場合特殊な分割を行います。詳細は String#split を参照してください。

コマンドラインオプション [[unknown:Rubyの起動/-F]] を指定した場合は、その値が設定されます。

Ruby 1.6 では $; には文字列しか代入できませんが、 Ruby 1.8 以降は任意のオブジェクトを代入できます。ただし、String#split の仕様変更を考慮すると常に正規表現を指定すべきです。

Ruby のバージョンによらず動作するプログラムを書くときは $; に頼らないコードを書くべきです。

この変数はグローバルスコープです。

$:

$LOAD_PATH

$-I

Rubyライブラリをロードするときの検索パスです。

Kernel.#load や Kernel.#require がファイルをロードする時に検索するディレクトリのリストを含む配列です。

起動時には、 [[unknown:Rubyの起動/-I directory]] オプションで指定したディレクトリ、環境変数 [[unknown:環境変数/RUBYLIB]] の値、コンパイル時に指定したデフォルト値、 "." (カレントディレクトリ) をこの順番で含みます。

以下に典型的な UNIX システム上でのロードパスを示します。

-I で指定したパス
環境変数 RUBYLIB の値
/usr/local/lib/ruby/site_ruby/VERSION        サイト固有、バージョン依存のライブラリ
/usr/local/lib/ruby/site_ruby/VERSION/ARCH   サイト固有、システム依存、拡張ライブラリ
/usr/local/lib/ruby/site_ruby                サイト固有ライブラリ
/usr/local/lib/ruby/VERSION                  標準ライブラリ
/usr/local/lib/ruby/VERSION/ARCH             標準、システム依存、拡張ライブラリ
.                                            カレントディレクトリ

上記表中の VERSION は Ruby のバージョンを表す文字列で、「1.6」や「1.8」です。 ARCH はハードウェアと OS を表す文字列で、「i686-linux」や「alpha-osf5.1」などです。 ARCH の値は Config::CONFIG['arch'] で得られます。

コンパイル時のデフォルトパスは多くの UNIX システムでは "/usr/local/lib/ruby" です。 [[unknown:mswin32]]、[[unknown:mingw32]]、[[unknown:Cygwin]]、 [[unknown:bccwin32]]、[[unknown:mswince]] 環境では ruby.dll の位置からの相対で決まります。 [[unknown:DJGPP]] と [[unknown:emx]] (OS/2) では ruby.exe の位置からの相対で決まります。

-T オプションで起動時に $SAFE を 1 以上に設定したときは "." (カレントディレクトリ) はロードパスに入りません。

require 'foo' を実行すると、以下のように foo.rb と foo.so が交互に探索されます。

/usr/local/lib/ruby/site_ruby/VERSION/foo.rb
/usr/local/lib/ruby/site_ruby/VERSION/foo.so
/usr/local/lib/ruby/site_ruby/VERSION/ARCH/foo.rb
/usr/local/lib/ruby/site_ruby/VERSION/ARCH/foo.so
  :
  :

なお、共有ライブラリの拡張子が .so でないシステムでは「.so」が適切な拡張子に変更されます。例えば HP-UX では require 'foo.so' とすると foo.sl を検索します。したがって Ruby で記述されたコードでは常に .so を使うべきです。

なお、ロードパスをコマンドラインから調べるには

$ ruby -e 'puts $:'

とします。

この変数はグローバルスコープです。

$KCODE

$-K

この特殊変数は何の影響も持たなくなりました。

値を代入しても無視され、参照すると常に nil です。

>> $KCODE = true
(irb):1: warning: variable $KCODE is no longer effective; ignored
=> true
>> $KCODE
(irb):2: warning: variable $KCODE is no longer effective
=> nil

$-W

コマンドラインオプション -W を指定したとき、そのコマンドライン引数の値が設定されます。

つまり、$VERBOSE の値によって以下の値を返します。 : nil

0。警告を出力しない。

false: 1。重要な警告のみ出力する。(デフォルト)
true: 2。すべての警告を出力する。

この変数には代入できません。

この変数はグローバルスコープです。

$-a

自動 split モードを表すフラグです。 [[unknown:Rubyの起動/-a]] を参照してください。

コマンドラインオプション -a を使ったとき true に設定されます。この変数には代入できません。

この変数はグローバルスコープです。

$DEBUG

$-d

この値が真のときはインタプリタがデバッグモードになります。

[[unknown:Rubyの起動/-d]] オプションでセットされます。スクリプトから代入することもできます。

デバッグモードでは、通常モードに比べて以下の違いがあります。

通常時はいずれかのスレッドが例外によって終了しても他のスレッドは実行を続けますが、デバッグモードではいずれかのスレッドが例外によって終了した時にインタプリタ全体が中断されるようになります。 Thread.abort_on_exception を true にセットするのと同じ効果です。
Thread.abort_on_exception= の効果がなくなります。
例外を捕捉しているかどうかに関係なく、例外が発生した時点で $stderr にそれが出力されます。スクリプトの処理は続行されます。

この変数はグローバルスコープです。

$-i

in-place 置換モードで用いられます。

コマンドラインオプション [[unknown:Rubyの起動/-i]] を指定したとき、空文字列になります。 -i オプションに拡張子を渡した場合にはその拡張子が文字列として格納されます。

-i オプションが指定されていない時の値は nil です。

スクリプト内で $-i に代入することもでき、その場合は Kernel::ARGV の次のファイルを読み込み始めるタイミングで in-place 置換を開始します。

この変数はグローバルスコープです。

$-l

コマンドラインオプション [[unknown:Rubyの起動/-l]] を指定したとき true に設定されます。この変数には代入できません。

この変数はグローバルスコープです。

$-p

コマンドラインオプション [[unknown:Rubyの起動/-p]] を指定したとき true に設定されます。この変数には代入できません。

この変数はグローバルスコープです。

$VERBOSE

$-v

$-w

冗長メッセージフラグです。Rubyインタプリタへの [[unknown:Rubyの起動/-v]] オプションでセットされます。

警告レベルは三段階あり、それぞれ以下の通りです。

nil: 警告を出力しない
false: 重要な警告のみ出力 (デフォルト)
true: すべての警告を出力する

$VERBOSE に nil, false 以外を代入すると値は true になります。

$VERBOSE の値はコマンドラインオプション [[unknown:Rubyの起動/-W[level]]] でも設定できます。 -W0 オプションで nil、 -W1 オプションで false、 -W2, -W オプションで true が設定されます。 [[unknown:Rubyの起動/-v]] オプションや [[unknown:Rubyの起動/-w]] オプションを指定した場合は true が設定されます。

$VERBOSE はグローバルスコープです。

$.

最後に読んだ入力ファイルの行番号を表す整数です。 ARGF.lineno と同じです。

各引数ファイルごとの行番号が必要な場合は代わりに ARGF.file.lineno を使ってください。

この変数はグローバルスコープです。

$0

$PROGRAM_NAME

現在実行中の Ruby スクリプトの名前を表す文字列です。

OS によってはこの変数に代入すると ps(1) の出力が変化します。この機能はプログラムの現在の状態を表示するのに便利です。

この変数はグローバルスコープです。

$1

$2

$3

$4

$5

$6

$7

$8

$9

最後に成功したパターンマッチでn番目の括弧にマッチした値が格納されます。該当する括弧がなければnilが入っています。(覚え方: \数字のようなもの)

Regexp.last_match[1], Regexp.last_match[2], ... と同じ。

この変数はローカルスコープかつスレッドローカルです。

$<

すべての引数または標準入力で構成される仮想ファイルです。定数 Kernel::ARGF の別名です。

この変数はグローバルスコープです。

$=

非推奨です。この変数は将来のバージョンで削除される予定です。

パターンマッチや文字列の比較でアルファベットの大文字小文字を区別するかどうかのフラグ。デフォルトは nil です。

この変数はグローバルスコープです。

$>

$stdout

標準出力です。

組み込み関数 Kernel.#print、Kernel.#puts や Kernel.#p などのデフォルトの出力先となります。初期値は Kernel::STDOUT です。 [[unknown:Rubyの起動/-i[extension]]] オプションを指定した場合には読み込み元と同じ名前のファイルを表します。

$stdout に代入するオブジェクトには write という名前のメソッドが定義されていなければいけません。

自プロセスの標準出力をリダイレクトしたいときには、以下のように $stdout に代入すれば十分です。

# 標準出力の出力先を /tmp/foo に変更
$stdout = File.open("/tmp/foo", "w")
puts "foo"         # 出力する
$stdout = STDOUT   # 元に戻す

自プロセスだけでなく、子プロセスの標準出力もリダイレクトしたいときは以下のように IO#reopen を使います。

STDOUT.reopen("/tmp/foo", "w")

また、リダイレクトしたあと出力先をまた元に戻したい場合は以下のようにします。

stdout_old = $stdout.dup        # 元の $stdout を保存する
$stdout.reopen("/tmp/foo")      # $stdout を /tmp/foo にリダイレクトする
puts "foo"                      # /tmp/foo に出力
$stdout.flush                   # 念のためフラッシュする
$stdout.reopen stdout_old       # 元に戻す

$stdout はグローバルスコープです。

$?

このスレッドで最後に終了した子プロセスのステータスです。

Process::Status オブジェクトが入っています。子プロセスの終了時ステータスは Process::Status#exitstatus で得られます。

Process.#wait なども参照してください。

この変数はスレッドローカルです。

$@

最後に例外が発生した時のバックトレースを表す配列です。

配列の各要素はメソッドの呼び出し位置を示す文字列で形式は

"filename:line"

または

"filename:line:in `methodname'"

です。これは Kernel.#caller が返す値と同じ形式です。

$@ へ値を代入するときは、$! が nil であってはいけません。 $@ の値は、$!.backtrace の値と同じです。また、$@ への代入は $!.set_backtrace 呼び出しと同じです。

この変数はスレッドローカルです。

$FILENAME

仮想ファイル Kernel::ARGF で現在読み込み中のファイル名です。 ARGF.filename と同じです。

この変数はグローバルスコープです。

$SAFE

カレントスレッドのセーフレベルを表す整数です。セーフレベルについてはセキュリティモデルを参照してください。

Thread.current.safe_level と同じです。

この変数はスレッドローカルです。

$\

出力レコードセパレータを表す文字列です。 Kernel.#print が最後にこの文字列を出力します。

デフォルトは nil で、何も出力しません。

この変数はグローバルスコープです。

$_

最後に gets または readline で読み込んだ文字列です。

EOF に達した場合には、nil。この変数はローカルスコープです。 (覚え方: Perlと同じ)

この変数はローカルスコープかつスレッドローカルです。

$`

現在のスコープで最後に成功した正規表現のパターンマッチでマッチした部分より前の文字列です。

最後のマッチが失敗していた場合には nil を返します。 Regexp.last_match.pre_match と同じです。

この変数はローカルスコープかつスレッドローカルです。

$stderr

標準エラー出力です。

Ruby インタプリタが出力するエラーメッセージや警告メッセージ、Kernel.#warn の出力先となります。初期値は Kernel::STDERR です。

$stderr に代入するオブジェクトには write という名前のメソッドが定義されていなければいけません。

自プロセスの標準エラー出力をリダイレクトしたいときには、 $stderr に代入すれば十分です。

# 標準エラー出力の出力先を /tmp/foo に変更
$stderr = File.open("/tmp/foo", "w")
puts "foo"         # 出力する
$stderr = STDERR   # 元に戻す

自プロセスだけでなく、子プロセスの標準エラー出力もリダイレクトしたいときは以下のように IO#reopen を使います。

$stderr.reopen("/tmp/foo", "w")

また、リダイレクトしたあと出力先をまた元に戻したい場合は以下のようにします。

stderr_old = $stderr.dup        # 元の $stderr を保存する
$stderr.reopen("/tmp/foo")      # $stderr を /tmp/foo にリダイレクトする
puts "foo"                      # /tmp/foo に出力
$stderr.flush                   # 念のためフラッシュする
$stderr.reopen stderr_old       # 元に戻す

$stderr はグローバルスコープです。

$stdin

標準入力です。

自プロセスの標準入力をリダイレクトしたいときは $stdin に代入すれば十分です。

# 標準入力の入力元 /tmp/foo に変更
$stdin = File.open("/tmp/foo", "w")
gets               # 入力する
$stdin = STDIN     # 元に戻す

ただし、Kernel.#gets など、特定の組み込みメソッドは $stdin オブジェクトにメソッドを転送して実装されています。従って、Kernel.#gets などが正しく動作するには、 $stdin オブジェクトに代入したオブジェクトが以下のメソッドを正しく実装していなければいけません。

gets, readline, readlines, getc, readchar, tell, seek,
pos=, rewind, fileno, to_io, eof, each_line, each_byte,
binmode, closed?

例:

$stdin = Object.new
def $stdin.gets
  "foo"
end
p gets()  # => "foo"

自プロセスだけでなく、子プロセスの標準入力もリダイレクトしたいときは以下のように IO#reopen を使います。

$stdin.reopen("/tmp/foo")

また、リダイレクトしたあと出力先をまた元に戻したい場合は以下のようにします。

stdin_old = $stdin.dup       # 元の $stdin を保存する
$stdout.reopen("/tmp/foo")   # $stdin を /tmp/foo にリダイレクトする
gets                         # /tmp/foo から入力
$stdin.reopen stdin_old      # 元に戻す

$stdin はグローバルスコープです。

$~

現在のスコープで最後に成功したマッチに関する MatchDataオブジェクトです。

Regexp.last_match と同じです。この値に代入すると $& や $1, $2, ... などの値が変化します。

このデータから n 番目のマッチ ($n) を取り出すためには $~[n] を使います。

この変数はローカルスコープかつスレッドローカルです。

追加されるメソッド

$ARGV [added by English]

$* の別名

require "English"
p $ARGV
# end of sample.rb

ruby sample.rb 31 /home/hoge/fuga.txt
#=> ["31", "/home/hoge/fuga.txt"]

BigDecimal(s [, n]) [added by bigdecimal]

詳細は BigDecimal.new を参照

$CFLAGS [added by mkmf]

拡張ライブラリをコンパイルするときの C コンパイラのオプションや、ヘッダファイルのディレクトリを指定する文字列です。

Kernel#dir_config の検査が成功すると、この変数の値に " -Idir" が追加されます。

CFLAGS [added by mkmf]

C コンパイラに渡されるコマンドラインオプションです。この値は Makefile にも反映されます。

$CHILD_STATUS [added by English]

$? の別名

require "English"

out = `wget http://www2.ruby-lang.org/ja/LICENSE.txt -O - 2>/dev/null`

if $CHILD_STATUS.to_i == 0
  print "wget success\n"
  out.split(/\n/).each { |line|
    printf "%s\n", line
  }
else
  print "wget failed\n"
end

CONFIG [added by mkmf]

Config::MAKEFILE_CONFIG と同じです。

CPP [added by mkmf]

プリプロセッサを起動するときのコマンドラインのフォーマットです。 Kernel#try_cpp などが使用します。

Complex(a, b) [added by complex]

実部が a 虚部が b である Complex オブジェクトを生成して返します。

[PARAM] a:: 実部を数値で指定します。
[PARAM] b:: 虚部を数値で指定します。

[SEE_ALSO] Complex

例:

p Complex(2,1) #=> (2+1i)

$DEFAULT_INPUT [added by English]

$< の別名

require "English"
while line = $DEFAULT_INPUT.gets
  p line
end
# end of sample.rb

ruby sample.rb < /etc/passwd
# => "hoge:x:500:501::/home/hoge:/bin/bash\n"
     ...

$DEFAULT_OUTPUT [added by English]

$> の別名

require "English"

dout = $DEFAULT_OUTPUT.dup
$DEFAULT_OUTPUT.reopen("out.txt", "w")
print "foo"
$DEFAULT_OUTPUT.close
$DEFAULT_OUTPUT = dout
p "bar" # => bar
p File.read("out.txt") #=> foo

DelegateClass(superclass) -> object [added by delegate]

クラス superclass のインスタンスへメソッドを委譲するクラスを定義し、そのクラスを返します。

[PARAM] superclass:: 委譲先となるクラス

例:

require 'delegate'

class ExtArray < DelegateClass(Array)
  def initialize
    super([])
  end
end
a = ExtArray.new
p a.class   # => ExtArray
a.push 25
p a         # => [25]

Digest(name) -> object [added by digest]

"MD5"や"SHA1"などのダイジェストを示す文字列 name を指定し、対応するダイジェストのクラスを取得します。

[PARAM] name:: "MD5"や"SHA1"などのダイジェストを示す文字列を指定します。
[RETURN]: Digest::MD5やDigest::SHA1などの対応するダイジェストのクラスを返します。インスタンスではなく、クラスを返します。注意してください。

例: Digest::MD、Digest::SHA1、Digest::SHA512のクラス名を順番に出力する。

for a in ["MD5", "SHA1", "SHA512"]
  p Digest(a) # => Digest::MD5, Digest::SHA1, Digest::SHA512
end

$ERROR_INFO [added by English]

$! の別名

require "English"
class SomethingError < StandardError; end

begin
  raise SomethingError
rescue
  p $ERROR_INFO.backtrace #=> ["sample.rb:5"]
  p $ERROR_INFO.to_s #=> "SomethingError"
end

$ERROR_POSITION [added by English]

$@ の別名

require "English"
class SomethingError < StandardError; end

begin
  raise SomethingError
rescue
  p $ERROR_POSITION #=> ["sample.rb:5"]
end

$FS [added by English]

$FIELD_SEPARATOR [added by English]

$; の別名

require "English"

str = "hoge,fuga,ugo,bar,foo"
p str.split #=> ["hoge,fuga,ugo,bar,foo"]
$FIELD_SEPARATOR = ","
p str.split #=> ["hoge", "fuga", "ugo", "bar", "foo"]

$IGNORECASE [added by English]

$= の別名

require "English"

$IGNORECASE=true

str_l = "FOOBAR"
str_s = "foobar"

if str_l == str_s
  p "#{str_l} equal to #{str_s}" #=> "FOOBAR equal to foobar"
end

$INPUT_LINE_NUMBER [added by English]

$NR [added by English]

$. の別名

1 e
2 f
3 g
4 h
5 i
# end of a.txt

require "English"

File.foreach(ARGV.at(0)){|line|
  # read line
}
p $INPUT_LINE_NUMBER
# end of sample.rb

ruby sample.rb a.txt
#=> 5

$RS [added by English]

$INPUT_RECORD_SEPARATOR [added by English]

$/ の別名

require "English"

$INPUT_RECORD_SEPARATOR = '|'
array = []
while line = DATA.gets
  array << line
end
p array #=> ["ugo|", "ego|", "fogo\n"]

__END__
ugo|ego|fogo

$LAST_MATCH_INFO [added by English]

$~ の別名

require "English"

str = "<a href=http://www2.ruby-lang.org/ja/LICENSE.txt>license</a>"

if /<a href=(.+?)>/ =~ str
  p $LAST_MATCH_INFO[0] #=> "<a href=http://www2.ruby-lang.org/ja/LICENSE.txt>"
  p $LAST_MATCH_INFO[1] #=> "http://www2.ruby-lang.org/ja/LICENSE.txt"
  p $LAST_MATCH_INFO[2] #=> nil
end

$LAST_PAREN_MATCH [added by English]

$+ の別名

require "English"

r1 = Regexp.compile("<img src=(http:.+?)>")
r2 = Regexp.compile("<a href=(http|ftp).+?>(.+?)</a>")

while line = DATA.gets
  [ r1, r2 ].each {|rep|
    rep =~ line
    p $+
  }
end
__END__
<tr> <td><img src=http://localhost/a.jpg></td> <td>ikkou</td> <td><a href=http://localhost/link.html>link</a></td> </tr>
#enf of sample.rb

$ ruby sample.rb
"http://localhost/a.jpg"
"link"

$LAST_READ_LINE [added by English]

$_ の別名

1 e
2 f
3 g
4 h
5 i
# end of a.txt

ruby -rEnglish -ne'p $LAST_READ_LINE' a.txt
#=>
"1 e\n"
"2 f\n"
"3 g\n"
"4 h\n"
"5 i\n"

$LDFLAGS [added by mkmf]

拡張ライブラリをリンクするときのリンカのオプション、ライブラリファイルのディレクトリを指定する文字列です。

Kernel#find_library または Kernel#dir_config の検査が成功すると、$LDFLAGS の値に "-Ldir" を追加します。

LINK [added by mkmf]

リンカを起動するときのコマンドラインのフォーマットです。 Kernel#try_link などが使用します。

$LOADED_FEATURES [added by English]

$" の別名

require "English"
require "find"

p $LOADED_FEATURES #=> ["English.rb", "find.rb"]

$MATCH [added by English]

$& の別名

require "English"

str = 'hoge,foo,bar,hee,hoo'

/(foo|bar)/ =~ str
p $MATCH     #=> "foo"

Mainloop [added by tkclass]

$OFS [added by English]

$OUTPUT_FIELD_SEPARATOR [added by English]

$, の別名

require "English"

array = %w|hoge fuga ugo bar foo|
p array.join #=> "hogefugaugobarfoo"
$OUTPUT_FIELD_SEPARATOR = ","
p array.join #=> "hoge,fuga,ugo,bar,foo"

$ORS [added by English]

$OUTPUT_RECORD_SEPARATOR [added by English]

$\ の別名

require "English"

print "hoge\nhuga\n"
$OUTPUT_RECORD_SEPARATOR = "\n"
print "fuge"
print "ugo"
# end of sample.rb

ruby sample.rb
hoge
huga
fuge
ugo

$PID [added by English]

$PROCESS_ID [added by English]

$$ の別名

require "English"

      p sprintf("something%s", $PID) #=> "something5543" など

$POSTMATCH [added by English]

$' の別名

require "English"

str = 'hoge,foo,bar,hee,hoo'

/foo/ =~ str
p $POSTMATCH #=> ",bar,hee,hoo"

$PREMATCH [added by English]

$` の別名

require "English"

str = 'hoge,foo,bar,hee,hoo'

/foo/ =~ str
p $PREMATCH  #=> "hoge,"

$PROGRAM_NAME [added by English]

$0 の別名

require "English"

p $PROGRAM_NAME
#end of sample.rb

ruby sample.rb  #=> "sample.rb"
ruby ./sample.rb #=> "./sample.rb"
ruby /home/hoge/bin/sample.rb #=> "/home/hoge/bin/sample.rb"

Pathname(path) -> Pathname [added by pathname]

文字列 path を元に Pathname オブジェクトを生成します。

Pathname.new(string) と同じです。

Rational(a, b) [added by rational]

Rational オブジェクトを生成する。

Creates a Rational number (i.e. a fraction). +a+ and +b+ should be Integers:

Rational(1,3)           # -> 1/3

Note: trying to construct a Rational with floating point or real values produces errors:

Rational(1.1, 2.3)      # -> NoMethodError

TkGrid(*args) [added by tk/autoload]

TkGrid.#configure と同じ

TkPack(*args) [added by tk/autoload]

TkPack.#configure と同じ

TkPlace(*args) [added by tk/autoload]

TkPlace.#configure と同じ

URI(uri_str) -> object [added by uri]

与えられた URI から該当する URI::Generic のサブクラスのインスタンスを生成して返します。scheme が指定されていない場合は、URI::Generic オブジェクトを返します。

[PARAM] url:: パースしたい URI を文字列として与えます。
[EXCEPTION] URI::InvalidURIError:: パースに失敗した場合に発生します。

[SEE_ALSO] URI.parse

append_library(libs, lib) [added by mkmf]

ライブラリのリスト libs の先頭にライブラリ lib を追加し、その結果を返します。

引数 libs とこのメソッドの戻り値はリンカに渡す引数形式の文字列です。すなわち、UNIX 系 OS では

"-lfoo -lbar"

であり、MS Windows などでは

"foo.lib bar.lib"

です。第 2 引数 lib は、この例での "foo" や "bar" にあたります。

$archdir [added by mkmf]

マシン固有のライブラリを置くディレクトリです。通常は "/usr/local/lib/ruby/バージョン/arch" です。

arg_config(config[, default]) [added by mkmf]

configure オプション --config の値を返します。オプションが指定されていないときは第 2 引数 default を返します。

例えば extconf.rb で arg_config メソッドを使う場合、

$ ruby extconf.rb --foo --bar=baz

と実行したとき、arg_config("--foo") の値は true、 arg_config("--bar") の値は "baz" です。

check_sizeof(type, headers = nil, &b) [added by mkmf]

Returns the size of the given +type+. You may optionally specify additional +headers+ to search in for the +type+.

If found, a macro is passed as a preprocessor constant to the compiler using the type name, in uppercase, prepended with 'SIZEOF_', followed by the type name, followed by '=X' where 'X' is the actual size.

For example, if check_sizeof('mystruct') returned 12, then the SIZEOF_MYSTRUCT=12 preprocessor macro would be passed to the compiler.

checking_for [added by mkmf]

chmod -> () [added by un]

ファイルのアクセス権を変更します。

Change the mode of each FILE to OCTAL-MODE.

ruby -run -e chmod -- [OPTION] OCTAL-MODE FILE

-v          verbose

[SEE_ALSO] chmod(1)

cp -> () [added by un]

ファイルやディレクトリをコピーします。

Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY

ruby -run -e cp -- [OPTION] SOURCE DEST

-p          preserve file attributes if possible
-r          copy recursively
-v          verbose

[SEE_ALSO] cp(1)

create_header [added by mkmf]

create_makefile(target[, srcdir]) [added by mkmf]

Kernel#have_library などの各種検査の結果を元に、拡張ライブラリ TARGET.so をビルドするための Makefile を生成します。

第 2 引数 srcdir は make 変数 srcdir の値を指定します。この変数には、ソースコードがあるディレクトリ名を指定します。この引数を省略した場合は、extconf.rb があるディレクトリが使われます。

extconf.rb は普通このメソッドの呼び出しで終ります。

$defs [added by mkmf]

拡張ライブラリをコンパイルするときのマクロ定義を指定する配列です。

この変数の値は、例えば

["-DHAVE_FUNC", "-DHAVE_HEADER_H"]

のような形式の配列です。

Kernel#have_func または Kernel#have_header を呼び出すと、その検査結果が $defs に追加されます。

Kernel#create_header はこの変数の値を参照してヘッダファイルを生成します。

desc(description) [added by rake]

直後の Rake タスクの説明を登録します。

[PARAM] description:: 直後のタスクの説明を指定します。

例:

desc "Run the Unit Tests"
task :test => [:build]
  runtests
end

dir_config(target[, default]) [added by mkmf]

dir_config(target[, idefault, ldefault]) [added by mkmf]

configure オプション --with-TARGET-dir, --with-TARGET-include, --with-TARGET-lib をユーザが extconf.rb に指定できるようにします。

--with-TARGET-dir オプションはシステム標準ではない、ヘッダファイルやライブラリがあるディレクトリをまとめて指定するために使います。ユーザが extconf.rb に --with-TARGET-dir=PATH を指定したときは $CFLAGS に "-IPATH/include" を、 $LDFLAGS に "-LPATH/lib" を、それぞれ追加します。

--with-TARGET-include オプションはシステム標準ではないヘッダファイルのディレクトリを指定するために使います。ユーザが extconf.rb に --with-TARGET-include=PATH を指定したときは $CFLAGS に PATH を追加します。

--with-TARGET-lib オプションはシステム標準ではないライブラリのディレクトリを指定するために使います。ユーザが extconf.rb に --with-TARGET-lib=PATH を指定したときは $CFLAGS に PATH を追加します。

以上 3 つの configure オプションがいずれも指定されていないときは、デフォルト値として引数 default、idefault、ldefault の値が使われます。第 2 引数のみ与えた場合は "-Idefault/include" と "-Ldefault/lib" をそれぞれ追加し、第 3 引数も与えた場合は "-Iidefault" と "-Lldefault" をそれぞれ追加します。

directory(dir) [added by rake]

与えられたディレクトリを作成するタスクを定義します。

[PARAM] dir:: 作成するディレクトリを指定します。

例:

directory 'testdata/doc'

egrep_cpp(pat, src[, opt]) [added by mkmf]

C プログラムのソースコード src をプリプロセスし、その結果が正規表現 pat にマッチするかどうかを判定します。

CPP $CFLAGS opt | egrep pat

を実行し、その結果が正常かどうかを true または false で返します。

第 1 引数 pat には「egrep の」正規表現を文字列で指定します。 Ruby の正規表現ではありません。

第 2 引数 src には C 言語のソースコードを文字列で記述します。

このメソッドはヘッダファイルに関数などの宣言があるかどうか検査するために使用します。

enable_config(config[, default]) [added by mkmf]

Kernel#arg_config と同じですが、 --enable-config オプション、または--disable-config オプションの値だけを参照します。

file(*args) { ... } -> Rake::FileTask [added by rake]

ファイルタスクを定義します。

[PARAM] args:: ファイル名と依存ファイル名を指定します。

例:

file "config.cfg" => ["config.template"] do
  open("config.cfg", "w") do |outfile|
    open("config.template") do |infile|
      while line = infile.gets
        outfile.puts line
      end
    end
  end
end

[SEE_ALSO] Rake::Task.define_task

file_create(*args) { ... } -> Rake::FileCreationTask [added by rake]

ファイルを作成するタスクを定義します。

主に Kernel.#directory を定義するために使用します。

find_header(header, *paths) [added by mkmf]

Instructs mkmf to search for the given +header+ in any of the +paths+ provided, and returns whether or not it was found in those paths.

If the header is found then the path it was found on is added to the list of included directories that are sent to the compiler (via the -I switch).

find_library(lib, func, *pathes) [added by mkmf]

関数 func が定義されたライブラリ lib を探します。最初はパスを指定せずに探し、それに失敗したら pathes[0] を指定して探し、それにも失敗したら pathes[1] を指定して探し…… というように、リンク可能なライブラリを探索します。

上記の探索でライブラリ lib を発見できた場合は lib を $libs に追加し、見つかったパスを $LDFLAGS に追加して true を返します。指定されたすべてのパスを検査してもライブラリ lib が見つからないときは、変数を変更せず false を返します。

pathes を指定しないときは Kernel#have_library と同じ動作です。

gem(gem_name, *version_requirements) -> bool [added by rubygems]

$LOAD_PATH に Ruby Gem を追加します。

指定された Gem をロードする前にその Gem が必要とする Gem をロードします。バージョン情報を省略した場合は、最も高いバージョンの Gem をロードします。指定された Gem やその Gem が必要とする Gem が見つからなかった場合は Gem::LoadError が発生します。

バージョンの指定方法に関しては Gem::Version を参照してください。

rubygems ライブラリがライブラリバージョンの衝突を検出しない限り、 gem メソッドは全ての require メソッドよりも前に実行されます。

環境変数 GEM_SKIP

特定の Gem をロードしないようにするために環境変数 GEM_SKIP を定義することができます。特定の Gem がまだインストールされていないという状況を試すために使用できます。

例:

GEM_SKIP=libA:libB ruby-I../libA -I../libB ./mycode.rb

[PARAM] gem:: Gem の名前の文字列か、Gem の依存関係を Gem::Dependency のインスタンスで指定します。
[PARAM] version_requirements:: 必要とする gem のバージョンを指定します。
[RETURN]: Gem がロードできた場合は true を返します。ロードできなかった場合は false を返します。
[EXCEPTION] Gem::LoadError:: 指定された Gem やその Gem が必要とする Gem が見つからなかった場合に発生します。ただし、環境変数 GEM_SKIP に指定されている Gem に関してはこの例外は発生しません。

[SEE_ALSO] Gem::Version

have_func(func[, header]) [added by mkmf]

関数 func がシステムに存在するかどうかを検査します。

関数 func が存在すれば $defs に "-DHAVE_func" (func は大文字に変換されます) を追加して true を返します。関数 func が見つからないときはグローバル変数を変更せず false を返します。

第 2 引数 header には、関数 func を使用するのに必要なヘッダファイル名を指定します。これは関数の型をチェックするためではなく、関数が実際にはマクロで定義されている場合などのために使用します。

have_header(header) [added by mkmf]

ヘッダファイル header がシステムに存在するかどうか調べます。

ヘッダファイル header が存在すればグローバル変数 $defs に "-DHAVE_header" を追加して true を返します。ヘッダファイル header が存在しないときは $defs は変更せず false を返します。なお、-DAHVE_header の header には、実際には header.upcase.tr('-.', '_') が使われます。

have_library(lib[, func]) [added by mkmf]

ライブラリ lib がシステムに存在し、関数 func が定義されているかどうかをチェックします。チェックが成功すれば $libs に lib を追加し true を返します。チェックが失敗したら false を返します。

第 2 引数 func を省略した場合、関数の存在までは検査せず、ライブラリが存在するかどうかだけをチェックします。

第 2 引数 func が nil または空文字列 ("") のときは、何も検査をせず、無条件で lib を追加します。

have_macro(macro, headers = nil, opt = "", &b) [added by mkmf]

Returns whether or not +macro+ is defined either in the common header files or within any +headers+ you provide.

Any options you pass to +opt+ are passed along to the compiler.

have_struct_member(type, member, headers = nil, &b) [added by mkmf]

Returns whether or not the struct of type +type+ contains +member+. If it does not, or the struct type can't be found, then false is returned. You may optionally specify additional +headers+ in which to look for the struct (in addition to the common header files).

If found, a macro is passed as a preprocessor constant to the compiler using the member name, in uppercase, prepended with 'HAVE_ST_'.

For example, if have_struct_member('foo', 'bar') returned true, then the HAVE_ST_BAR preprocessor macro would be passed to the compiler.

have_type(type, headers = nil, opt = "", &b) [added by mkmf]

Returns whether or not the static type +type+ is defined. You may optionally pass additional +headers+ to check against in addition to the common header files.

You may also pass additional flags to +opt+ which are then passed along to the compiler.

If found, a macro is passed as a preprocessor constant to the compiler using the type name, in uppercase, prepended with 'HAVE_TYPE_'.

For example, if have_type('foo') returned true, then the HAVE_TYPE_FOO preprocessor macro would be passed to the compiler.

have_var(var, headers = nil, &b) [added by mkmf]

Returns whether or not the variable +var+ can be found in the common header files, or within any +headers+ that you provide. If found, a macro is passed as a preprocessor constant to the compiler using the variable name, in uppercase, prepended with 'HAVE_'.

For example, if have_var('foo') returned true, then the HAVE_FOO preprocessor macro would be passed to the compiler.

$hdrdir [added by mkmf]

Ruby のヘッダファイル ruby.h が存在するディレクトリです。通常は $archdir と同じで、"/usr/local/lib/ruby/バージョン/arch" です。

help -> () [added by un]

ヘルプメッセージを表示します。

Display help message.

ruby -run -e help [COMMAND]

import(*filenames) [added by rake]

分割された Rakefile をインポートします。

インポートされたファイルは、現在のファイルが完全にロードされた後でロードされます。このメソッドはインポートするファイルのどこで呼び出されてもかまいません。また、インポートされるファイル内に現れるオブジェクトはインポートするファイル内で定義されているオブジェクトに依存していてもかまいません。

このメソッドは依存関係を定義したファイルを読み込むのによく使われます。

[PARAM] filenames:: インポートする Rakefile を指定します。

例:

import ".depend", "my_rules"

install -> () [added by un]

ファイルをコピーし、その属性を設定します。

Copy SOURCE to DEST.

ruby -run -e install -- [OPTION] SOURCE DEST

-p          apply access/modification times of SOURCE files to
            corresponding destination files
-m          set permission mode (as in chmod), instead of 0755
-v          verbose

[SEE_ALSO] install(1)

install_rb(mfile, dest, srcdir = '.') [added by mkmf]

ディレクトリ srcdir/lib 配下の Ruby スクリプト (*.rb ファイル) を dest にインストールするための Makefile 規則を mfile に出力します。 mfile は IO クラスのインスタンスです。

srcdir/lib のディレクトリ構造はそのまま dest 配下に反映されます。

$libdir [added by mkmf]

Ruby のライブラリを置くディレクトリです。通常は "/usr/local/lib/ruby/バージョン" です。

$libs [added by mkmf]

拡張ライブラリをリンクするときに一緒にリンクされるライブラリを指定する文字列です。

この変数の値は、例えば

"-lfoo -lbar"

のような形式の文字列です。

Kernel#have_library または Kernel#find_library を呼び出すと、その検査結果が間に空白をはさみつつ $libs に連結されます。

ln -> () [added by un]

ファイルへのリンクを作成します。

ruby -run -e ln -- [OPTION] TARGET LINK_NAME

-s          make symbolic links instead of hard links
-f          remove existing destination files
-v          verbose

[SEE_ALSO] ln(1)

mkdir -> () [added by un]

ディレクトリを作成します。

Create the DIR, if they do not already exist.

ruby -run -e mkdir -- [OPTION] DIR

-p          no error if existing, make parent directories as needed
-v          verbose

[SEE_ALSO] mkdir(1)

multitask(args) { ... } -> Rake::MultiTask [added by rake]

事前タスクを並列実行するタスクを定義します。

与えられた事前タスクを実行する順序は不定です。

例:

multitask :deploy => [:deploy_gem, :deploy_rdoc]

mv -> () [added by un]

ファイルを移動します (ファイル名を変更します)。

Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.

ruby -run -e mv -- [OPTION] SOURCE DEST

-v          verbose

[SEE_ALSO] mv(1)

namespace(name = nil) { ... } -> Rake::NameSpace [added by rake]

新しい名前空間を作成します。

与えられたブロックを評価する間は、その名前空間を使用します。

例:

ns = namespace "nested" do
  task :run
end
task_run = ns[:run] # find :run in the given namespace.

[SEE_ALSO] Rake::TaskManager#in_namespace

pkg_config(pkg) [added by mkmf]

pp(*obj) -> nil [added by pp]

指定されたオブジェクト obj を標準出力に見やすい形式(プリティプリント)で出力します。 obj それぞれを引数として PP.pp を呼びことと同等です。

[PARAM] obj:: 表示したいオブジェクトを指定します。

例:

require 'pp'

b = [1, 2, 3] * 4
a = [b, b]
a << a
pp a

#=> [[1, 2, 3, 1, 2, 3, 1, 2, 3, 1, 2, 3],
     [1, 2, 3, 1, 2, 3, 1, 2, 3, 1, 2, 3],
     [...]]

[SEE_ALSO] PP.pp

require(path) -> bool [added by rubygems/custom_require]

RubyGems を require すると、Kernel#require が Gem を要求されたときにロードするように置き換えます。

再定義された Kernel#require を呼び出すと以下の事を行います。 Ruby のロードパスに存在するライブラリを指定した場合はそのままロードします。そうではなく、インストールされた Gem ファイルの中から見つかった場合は、その Gem をロードパスに登録します。

[PARAM] path:: ロードしたいライブラリの名前を指定します。
[RETURN]: 既にロードされているライブラリを再度ロードしようとした場合は false を返します。そうでない場合は true を返します。

rm -> () [added by un]

ファイルやディレクトリを削除します。

Remove the FILE

ruby -run -e rm -- [OPTION] FILE

-f          ignore nonexistent files
-r          remove the contents of directories recursively
-v          verbose

[SEE_ALSO] rm(1)

rmdir -> () [added by un]

空のディレクトリを削除します。

Remove the DIR.

ruby -run -e rmdir -- [OPTION] DIR

-v          verbose

[SEE_ALSO] rmdir(1)

rule(*args) {|t| ... } [added by rake]

自動的に作成するタスクのためのルールを定義します。

[PARAM] args:: ルールに与えるパラメータを指定します。

例:

rule '.o' => '.c' do |t|
  sh %{cc -o #{t.name} #{t.source}}
end

scanf(format) -> Array [added by scanf]

scanf(format) {|*ary| ...} -> Array [added by scanf]

STDIN.scanf と同じです。 IO#scanf、Stdin#scanfも参照してください。

[PARAM] format:: スキャンするフォーマットを文字列で指定します。詳細は、[[unknown:scanfフォーマット文字列]] を参照してください。

[SEE_ALSO] IO#scanf, Stdin#scanf

$sitearchdir [added by mkmf]

サイト固有でかつマシン固有のライブラリを置くディレクトリです。通常は "/usr/local/lib/ruby/site_ruby/バージョン/arch" です。

$sitelibdir [added by mkmf]

サイト固有のライブラリを置くディレクトリです。通常は "/usr/local/lib/ruby/site_ruby/バージョン" です。

$srcdir [added by mkmf]

Ruby インタプリタを make したときのソースディレクトリです。

task(*args) { ... } -> Rake::Task [added by rake]

Rake タスクを定義します。

[PARAM] args:: タスク名と依存タスクを指定します。

例:

task :clobber => [:clean] do
  rm_rf "html"
end

[SEE_ALSO] Rake::Task.define_task

time(msg, width = 25) { ... } -> object [added by rubygems/timer]

与えられたブロックの実行時間を計測して表示します。

[PARAM] msg:: 表示するメッセージを指定します。
[PARAM] width:: 表示する幅を指定します。
[RETURN]: ブロックの実行結果を返します。

timeout(sec) {|i| .... } [added by timeout]

timeout(sec, exception_class = nil) {|i| .... } [added by timeout]

ブロックを sec 秒の期限付きで実行します。ブロックの実行時間が制限を過ぎたときは例外 Timeout::Error が発生します。 exception_class を指定した場合には Timeout::Error の代わりにその例外が発生します。ブロックパラメータ i は sec がはいります。

また sec が nil のときは制限時間なしでブロックを実行します。

[PARAM] sec:: タイムアウトする時間を秒数で指定します.
[PARAM] exception_class:: タイムアウトした時、発生させる例外を指定します.

[注意]

timeout による割り込みは Thread によって実現されています。C 言語レベルで実装され、Ruby のスレッドが割り込めない処理に対して timeout は無力です。そのようなものは実用レベルでは少ないのですが、例をあげると Socket などは DNSの名前解決に時間がかかった場合割り込めません (resolv-replace を使用する必要があります)。その処理を Ruby で実装しなおすか C 側で Ruby のスレッドを意識してあげる必要があります。 [[unknown:timeoutの落し穴|trap::timeout]]も参照

$topdir [added by mkmf]

拡張ライブラリを make するためのヘッダファイル、ライブラリ等が存在するディレクトリです。通常は $archdir と同じで、"/usr/local/lib/ruby/バージョン/arch" です。

touch -> () [added by un]

ファイルのアクセス時刻と修正時刻を変更する。

Update the access and modification times of each FILE to the current time.

ruby -run -e touch -- [OPTION] FILE

-v          verbose

[SEE_ALSO] touch(1)

try_compile [added by mkmf]

try_cpp(src[, opt]) [added by mkmf]

C プログラムのソースコード src をプリプロセスします。問題なくプリプロセスできたら true を返します。プリプロセスに失敗したら false を返します。

第 1 引数 src は文字列で渡します。

第 2 引数 opt と $CFLAGS の値をプリプロセッサにコマンドライン引数として渡します。

このメソッドはヘッダファイルの存在チェックなどに使用します。

例：

if try_cpp("#include <stdio.h>")
  $stderr.puts "stdio.h exists"
end

try_link(src[, opt]) [added by mkmf]

C プログラムのソースコード src をコンパイル、リンクします。問題なくリンクできたら true を返します。コンパイルとリンクに失敗したら false を返します。

第 2 引数 opt が指定されたときは、リンカにコマンド引数として渡します。また、このメソッドは $CFLAGS と $LDFLAGS の値もコンパイラまたはリンカに渡します。

例：

if try_link("int main() { sin(0.0); }", '-lm')
  $stderr.puts "sin() exists"
end

try_run [added by mkmf]

try_static_assert [added by mkmf]

what_type? [added by mkmf]

with_config(config[, default]) [added by mkmf]

Kernel#arg_config と同じですが、 --with-config オプションの値だけを参照します。

xmp [added by irb/xmp]

y(obj) [added by yaml]

オブジェクトをYAMLフォーマットで表示します。

[PARAM] YAML:

フォーマットで表示したいオブジェクト

require 'yaml'

class MyDog
  attr_accessor :name, :age
end

mydog = MyDog.new
mydog.age = 17

p mydog
#=> #<MyDog:0x2b080b8 @age=17>
y mydog
#=> --- !ruby/object:MyDog
#=> age: 17

module Kernel

Abstract

モジュール関数

ネストした定義内の定数

引数の解釈

引数の解釈

sprintf フォーマット

フラグ

幅

精度

指示子

引数指定

手続きを中断して値を返す

Proc オブジェクトをブロック付きメソッド呼び出しに使う

lambda と proc と Proc.new とイテレータの違い

引数の扱い

ジャンプ構文の挙動の違い

orphan な手続きオブジェクトの挙動

require と load の違い

第二引数のオープンモード

require と load のスコープ

ブロック引数の意味

引数の解釈

引数の解釈

option で有効なキーと値

引数の解釈

引数の解釈

定数

注意

例1

例2

例3

例4

注意

注意

注意

特殊変数

追加されるメソッド

環境変数 GEM_SKIP

Methods

Classes