Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > irb/contextライブラリ > IRB::Contextクラス

class IRB::Context

クラスの継承リスト: IRB::Context < Object < Kernel < BasicObject

要約

irb の設定を扱うためのクラスです。

irb 中で conf コマンドの戻り値や .irbrc で IRB.conf を操作する事で設定を変更します。irb の起動後は IRB.conf の内容を更新しても変更の内容は反映されない事に注意してください。

なお、.irbrc 中に記述できる以下の設定値については、IRB::Context オブジェクトのメソッドとして操作できません。

IRB.conf[:AT_EXIT]

irb の終了時(サブ irb を含みません)に本項目に設定された Proc オブジェクトを実行します。ブロック引数には何も渡されません。

デフォルト値は [] です。

IRB.conf[:CONTEXT_MODE]

新しいワークスペースを作成した時(サブ irb の起動や pushws した時)に、ワークスペースに関連する Binding オブジェクトの作成方法を Integer で設定します。

0 を指定した場合、Object::TOPLEVEL_BINDINGProc 内の Binding を使用します。1 を指定した場合、Tempfile 中の Binding を使用します。2 を指定した場合、Thread 内で読み込んだファイル中の Binding を使用します。3 を指定した場合、 Object::TOPLEVEL_BINDING の関数中の Binding を使用します。

ただし、IRB.conf[:SINGLE_IRB] に true を設定していた場合は、現在のワークスペースをそのまま使用します。

デフォルト値は 3 です。

IRB.conf[:IRB_LIB_PATH]

ライブラリ内部で使用します。

IRB.conf[:IRB_RC]

irb の起動時(サブ irb を含みます)に本項目に設定された Proc オブジェクトを実行します。ブロック引数には IRB::Context が渡されます。そのため、サブ irb の設定をまとめて実行するのに使用します。

デフォルト値は nil です。

irb/サブ irb の設定 も併せて参照してください。

IRB.conf[:LC_MESSAGES]

ライブラリ内部で使用します。

IRB.conf[:MAIN_CONTEXT]

ライブラリ内部で使用します。

IRB.conf[:SCRIPT]

ファイル名を指定して irb を実行した場合のパスを文字列で返します。

デフォルト値は nil です。

IRB.conf[:SINGLE_IRB]

irb 中で self を実行して得られるオブジェクトをサブ irb と共有するかどうかを設定します。true を設定した場合に共有されます。

デフォルト値は false です。

IRB.conf[:VERSION]

IRB.version を実行した時に返すバージョンを String で指定します。

デフォルト値は nil です。

IRB.conf[:__MAIN__]

ライブラリ内部で使用します。

特異メソッド

定義 説明
new(irb, workspace = nil, input_method = nil, output_method = nil) -> IRB::Context

自身を初期化します。

インスタンスメソッド

定義 説明
__inspect__ -> String

自身を文字列表現にしたオブジェクトを返します。

__to_s__ -> String

自身を文字列表現にしたオブジェクトを返します。

ap_name -> String

自身のアプリケーション名を返します。

ap_name=(val)

自身のアプリケーション名を val に設定します。

auto_indent_mode -> bool

入力が次の行に継続した時に自動で字下げを行うかどうかを返します。

auto_indent_mode=(val)

入力が次の行に継続した時に自動で字下げを行うかどうかを val に設定します。

back_trace_limit -> Integer

エラー発生時のバックトレース表示の先頭、末尾の上限の行数を返します。

back_trace_limit=(val)

エラー発生時のバックトレース表示の先頭、末尾の上限の行数をそれぞれ val 行に設定します。

debug? -> bool

irb がデバッグモード(IRB::Context#debug_level が 1 以上)で動作しているかどうかを返します。

debug_level -> Integer

irb のデバッグレベルを返します。

debug_level=(val)

irb のデバッグレベルを val に設定します。

echo -> bool
echo? -> bool

irb のプロンプトでの評価結果を表示するかどうかを返します。

echo=(val)

irb のプロンプトでの評価結果を表示するかどうかを設定します。

evaluate(line, line_no) -> object

ライブラリ内部で使用します。

exit(ret = 0) -> object

irb を終了します。ret で指定したオブジェクトを返します。

file_input? -> bool

ライブラリ内部で使用します。

ignore_eof -> bool
ignore_eof? -> bool

Ctrl-D(EOF) が入力された時に irb を終了するかどうかを返します。

ignore_eof=(val)

Ctrl-D(EOF) が入力された時に irb を終了するかどうかを val に設定します。

ignore_sigint -> bool
ignore_sigint? -> bool

Ctrl-C が入力された時に irb を終了するかどうかを返します。

ignore_sigint=(val)

Ctrl-C が入力された時に irb を終了するかどうかを val に設定します。

inspect -> String
to_s -> String

自身を人間に読みやすい文字列にして返します。

inspect? -> bool

IRB::Context#inspect_mode が有効かどうかを返します。

inspect_mode -> object | nil

実行結果の出力方式を返します。

inspect_mode=(opt)

実行結果の出力方式を opt に設定します。

io -> IRB::InputMethod

ライブラリ内部で使用します。

io=(val)

ライブラリ内部で使用します。

irb -> IRB::Irb

ライブラリ内部で使用します。

irb=(val)

ライブラリ内部で使用します。

irb_name -> String

起動しているコマンド名を文字列で返します。

irb_name=(val)

起動しているコマンド名を val に設定します。

irb_path -> String

ライブラリ内部で使用します。

irb_path=(val)

ライブラリ内部で使用します。

last_value -> object

irb 中での最後の実行結果を返します。

load_modules -> [String]

irb の起動時に -r オプション指定で読み込まれたライブラリ、~/.irbrc などの設定ファイル内で IRB.conf[:LOAD_MODULES] 指定で読み込まれたライブラリの名前の配列を返します。

main -> object

self に設定されたオブジェクトを返します。

prompt_c -> String

式が継続している時のプロンプトを表現するフォーマット文字列を返します。

prompt_c=(val)

式が継続している時のプロンプトを表現するフォーマット文字列を val に設定します。

prompt_i -> String

通常のプロンプトを表現するフォーマット文字列を返します。

prompt_i=(val)

通常のプロンプトを表現するフォーマット文字列を val に設定します。

prompt_mode -> Symbol

現在のプロンプトモードを Symbol で返します。

prompt_mode=(mode)

プロンプトモードを mode に設定します。

prompt_n -> String

継続行のプロンプトを表現するフォーマット文字列を返します。

prompt_n=(val)

継続行のプロンプトを表現するフォーマット文字列を val に設定します。

prompt_s -> String

文字列中のプロンプトを表現するフォーマット文字列を返します。

prompt_s=(val)

文字列中のプロンプトを表現するフォーマット文字列を val に設定します。

prompting? -> bool

ライブラリ内部で使用します。

rc -> bool
rc? -> bool

~/.irbrc などの設定ファイルがあれば読み込みを行うかどうかを返します。

return_format -> String

irb のプロンプトでの評価結果を表示する際のフォーマットを文字列で返します。

return_format=(val)

irb のプロンプトでの評価結果を表示する際のフォーマットに val を設定します。

set_last_value(value) -> object

ライブラリ内部で使用します。

thread -> Thread

現在のスレッドを返します。

use_readline -> bool | nil
use_readline? -> bool | nil

readline を使うかどうかを返します。

verbose -> bool | nil

標準出力に詳細なメッセージを出力するように設定されているかどうかを返します。

verbose=(val)

標準出力に詳細なメッセージを出力するかどうかを val に設定します。

verbose? -> bool | nil

標準出力に詳細なメッセージを出力するかどうかを返します。

workspace -> IRB::WorkSpace

ライブラリ内部で使用します。

workspace=(val)

ライブラリ内部で使用します。

定数

定義 説明
IDNAME_IVARS -> [String]

ライブラリ内部で使用します。

NOPRINTING_IVARS -> [String]

ライブラリ内部で使用します。

NO_INSPECTING_IVARS -> [String]

ライブラリ内部で使用します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods must_be must_be_close_to must_be_empty must_be_instance_of must_be_kind_of must_be_nil must_be_same_as must_be_within_epsilon must_equal must_include must_match must_raise must_respond_to must_send must_throw nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE

追加されるメソッド

定義 説明 ライブラリ
eval_history -> Integer | nil

実行結果の履歴の最大保存件数を Integer か nil で返します。

irb/ext/history
eval_history=(val)

実行結果の履歴の最大保存件数を val に設定します。

irb/ext/history
history_file -> String | nil

履歴ファイルのパスを返します。

irb/ext/save-history
history_file=(hist)

履歴ファイルのパスを val に設定します。

irb/ext/save-history
init_save_history -> ()

自身の持つ IRB::InputMethod オブジェクトが irb のヒストリを扱えるようにします。

irb/ext/save-history
inspect? -> bool

IRB::Context#inspect_mode が有効かどうかを返します。

irb/ext/math-mode
math_mode -> bool
math? -> bool

math_mode が有効かどうかを返します。

irb/ext/math-mode
math_mode=(opt)

math_mode を有効にするかどうかを指定します。

irb/ext/math-mode
save_history -> Integer | nil

履歴の最大保存件数を Integer か nil で返します。

irb/ext/save-history
save_history=(val)

履歴の最大保存件数を val に設定します。

irb/ext/save-history
use_loader -> bool
use_loader? -> bool

load または require 時に irb のファイル読み込み機能(irb_load、 irb_require)を使うかどうかを返します。

irb/ext/use-loader
use_loader=(opt)

load または require 時に irb のファイル読み込み機能(irb_load、 irb_require)を使うかどうかを設定します。

irb/ext/use-loader
use_tracer -> bool
use_tracer? -> bool

irb への入力を評価する時に tracer が有効かどうかを返します。

irb/ext/tracer
use_tracer=(val)

irb への入力を評価する時に tracer が有効にするかどうかを val で指定します。

irb/ext/tracer