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

module function Kernel.#caller

caller(start = 1) -> [String] | nil[permalink][rdoc]
caller(start, length) -> [String] | nil
caller(range) -> [String] | nil

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

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

引数で指定した値が範囲外の場合は nil を返します。

[PARAM] start:
long の範囲を超えない正の整数でスタックレベルを指定します。
[PARAM] length:
取得するスタックの個数を指定します。
[PARAM] range:
取得したいスタックの範囲を示す Range オブジェクトを指定します。

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

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

def bar
  foo
end

bar

#=> ["-:2:in `foo'", "-:10:in `bar'", "-:13:in `<main>'"]
#   ["-:10:in `bar'", "-:13:in `<main>'"]
#   ["-:13:in `<main>'"]
#   []
#   nil

以下の関数は、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"

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