# frozen_string_literal: false
# irb/context.rb - irb context
# $Release Version: 0.9.6$
# by Keiju ISHITSUKA(keiju@ruby-lang.org)
require_relative "workspace"
require_relative "inspector"
require_relative "input-method"
require_relative "output-method"
# A class that wraps the current state of the irb session, including the
# configuration of IRB.conf.
# Creates a new IRB context.
# The optional +input_method+ argument:
# +nil+:: uses stdin or Reidline or Readline
# +other+:: uses this as InputMethod
def initialize(irb, workspace = nil, input_method = nil)
@workspace = WorkSpace.new
@thread = Thread.current if defined? Thread
# copy of default configuration
@ap_name = IRB.conf[:AP_NAME]
@load_modules = IRB.conf[:LOAD_MODULES]
if IRB.conf.has_key?(:USE_SINGLELINE)
@use_singleline = IRB.conf[:USE_SINGLELINE]
elsif IRB.conf.has_key?(:USE_READLINE) # backward compatibility
@use_singleline = IRB.conf[:USE_READLINE]
if IRB.conf.has_key?(:USE_MULTILINE)
@use_multiline = IRB.conf[:USE_MULTILINE]
elsif IRB.conf.has_key?(:USE_REIDLINE) # backward compatibility
@use_multiline = IRB.conf[:USE_REIDLINE]
@use_colorize = IRB.conf[:USE_COLORIZE]
@verbose = IRB.conf[:VERBOSE]
self.inspect_mode = IRB.conf[:INSPECT_MODE]
self.use_tracer = IRB.conf[:USE_TRACER] if IRB.conf[:USE_TRACER]
self.use_loader = IRB.conf[:USE_LOADER] if IRB.conf[:USE_LOADER]
self.eval_history = IRB.conf[:EVAL_HISTORY] if IRB.conf[:EVAL_HISTORY]
@ignore_sigint = IRB.conf[:IGNORE_SIGINT]
@ignore_eof = IRB.conf[:IGNORE_EOF]
@back_trace_limit = IRB.conf[:BACK_TRACE_LIMIT]
self.prompt_mode = IRB.conf[:PROMPT_MODE]
if IRB.conf[:SINGLE_IRB] or !defined?(IRB::JobManager)
@irb_name = IRB.conf[:IRB_NAME]
@irb_name = IRB.conf[:IRB_NAME]+"#"+IRB.JobManager.n_jobs.to_s
@irb_path = "(" + @irb_name + ")"
if STDIN.tty? && IRB.conf[:PROMPT_MODE] != :INF_RUBY && !use_singleline?
# Both of multiline mode and singleline mode aren't specified.
@io = ReidlineInputMethod.new
@io = ReidlineInputMethod.new
if (defined?(ReadlineInputMethod) && STDIN.tty? &&
IRB.conf[:PROMPT_MODE] != :INF_RUBY)
@io = ReadlineInputMethod.new
if defined?(ReadlineInputMethod)
@io = ReadlineInputMethod.new
@io = StdioInputMethod.new unless @io
@io = FileInputMethod.new(input_method)
@irb_name = File.basename(input_method)
self.save_history = IRB.conf[:SAVE_HISTORY] if IRB.conf[:SAVE_HISTORY]
@echo_on_assignment = IRB.conf[:ECHO_ON_ASSIGNMENT]
if @echo_on_assignment.nil?
@echo_on_assignment = true
@omit_on_assignment = IRB.conf[:OMIT_ON_ASSIGNMENT]
if @omit_on_assignment.nil?
@omit_on_assignment = true
@newline_before_multiline_output = IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT]
if @newline_before_multiline_output.nil?
@newline_before_multiline_output = true
# The top-level workspace, see WorkSpace#main
# The toplevel workspace, see #home_workspace
attr_reader :workspace_home
# WorkSpace in the current context
# The current thread in this context
# The current input method
# Can be either StdioInputMethod, ReadlineInputMethod,
# ReidlineInputMethod, FileInputMethod or other specified when the
# context is created. See ::new for more # information on +input_method+.
# A copy of the default <code>IRB.conf[:AP_NAME]</code>
# A copy of the default <code>IRB.conf[:RC]</code>
# A copy of the default <code>IRB.conf[:LOAD_MODULES]</code>
attr_accessor :load_modules
# Can be either name from <code>IRB.conf[:IRB_NAME]</code>, or the number of
# the current job set by JobManager, such as <code>irb#2</code>
# Can be either the #irb_name surrounded by parenthesis, or the
# +input_method+ passed to Context.new
# Whether multiline editor mode is enabled or not.
# A copy of the default <code>IRB.conf[:USE_MULTILINE]</code>
attr_reader :use_multiline
# Whether singleline editor mode is enabled or not.
# A copy of the default <code>IRB.conf[:USE_SINGLELINE]</code>
attr_reader :use_singleline
# Whether colorization is enabled or not.
# A copy of the default <code>IRB.conf[:USE_COLORIZE]</code>
attr_reader :use_colorize
# A copy of the default <code>IRB.conf[:INSPECT_MODE]</code>
attr_reader :inspect_mode
# A copy of the default <code>IRB.conf[:PROMPT_MODE]</code>
# See IRB@Customizing+the+IRB+Prompt for more information.
# IRB prompt for continuated strings
# See IRB@Customizing+the+IRB+Prompt for more information.
# IRB prompt for continuated statement (e.g. immediately after an +if+)
# See IRB@Customizing+the+IRB+Prompt for more information.
# See IRB@Customizing+the+IRB+Prompt for more information.
# Can be either the default <code>IRB.conf[:AUTO_INDENT]</code>, or the
# mode set by #prompt_mode=
# To disable auto-indentation in irb:
# IRB.conf[:AUTO_INDENT] = false
# irb_context.auto_indent_mode = false
# IRB.CurrentContext.auto_indent_mode = false
# See IRB@Configuration for more information.
attr_accessor :auto_indent_mode
# The format of the return statement, set by #prompt_mode= using the
# +:RETURN+ of the +mode+ passed to set the current #prompt_mode.
attr_accessor :return_format
# Whether <code>^C</code> (+control-c+) will be ignored or not.
# If set to +false+, <code>^C</code> will quit irb.
# * during input: cancel input then return to top level.
# * during execute: abandon current execution.
attr_accessor :ignore_sigint
# Whether <code>^D</code> (+control-d+) will be ignored or not.
# If set to +false+, <code>^D</code> will quit irb.
attr_accessor :ignore_eof
# Whether to echo the return value to output or not.
# Uses <code>IRB.conf[:ECHO]</code> if available, or defaults to +true+.
# IRB.CurrentContext.echo = false
# Whether to echo for assignment expressions
# Uses <code>IRB.conf[:ECHO_ON_ASSIGNMENT]</code> if available, or defaults to +true+.
# IRB.CurrentContext.echo_on_assignment = false
attr_accessor :echo_on_assignment
# Whether to omit echo for assignment expressions
# Uses <code>IRB.conf[:OMIT_ON_ASSIGNMENT]</code> if available, or defaults to +true+.
# #=> [1, 1, 1, 1, 1, 1, 1, 1, ...
# #=> [1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
# IRB.CurrentContext.omit_on_assignment = false
# #=> [1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
# #=> [1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
attr_accessor :omit_on_assignment
# Whether a newline is put before multiline output.
# Uses <code>IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT]</code> if available,
# IRB.CurrentContext.newline_before_multiline_output = false
attr_accessor :newline_before_multiline_output
# Whether verbose messages are displayed or not.
# A copy of the default <code>IRB.conf[:VERBOSE]</code>
# The limit of backtrace lines displayed as top +n+ and tail +n+.
# The default value is 16.
# Can also be set using the +--back-trace-limit+ command line option.
# See IRB@Command+line+options for more command line options.
attr_accessor :back_trace_limit
# Alias for #use_multiline
alias use_multiline? use_multiline
# Alias for #use_singleline
alias use_singleline? use_singleline
alias use_reidline use_multiline
alias use_reidline? use_multiline
alias use_readline use_singleline
alias use_readline? use_singleline
# Alias for #use_colorize
alias use_colorize? use_colorize
alias ignore_sigint? ignore_sigint
alias ignore_eof? ignore_eof
alias echo_on_assignment? echo_on_assignment
alias omit_on_assignment? omit_on_assignment
alias newline_before_multiline_output? newline_before_multiline_output
# Returns whether messages are displayed or not.
if @io.kind_of?(ReidlineInputMethod)
elsif defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)
elsif !STDIN.tty? or @io.kind_of?(FileInputMethod)
# Whether #verbose? is +true+, and +input_method+ is either
# StdioInputMethod or ReidlineInputMethod or ReadlineInputMethod, see #io
verbose? || (STDIN.tty? && @io.kind_of?(StdioInputMethod) ||
@io.kind_of?(ReidlineInputMethod) ||
(defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)))
# The return value of the last statement evaluated.
# Sets the return value from the last statement evaluated in this context
def set_last_value(value)
@workspace.local_variable_set :_, value
# Sets the +mode+ of the prompt in this context.
# See IRB@Customizing+the+IRB+Prompt for more information.
pconf = IRB.conf[:PROMPT][mode]
@prompt_i = pconf[:PROMPT_I]
@prompt_s = pconf[:PROMPT_S]
@prompt_c = pconf[:PROMPT_C]
@prompt_n = pconf[:PROMPT_N]
@return_format = pconf[:RETURN]
if ai = pconf.include?(:AUTO_INDENT)
@auto_indent_mode = IRB.conf[:AUTO_INDENT]
# Whether #inspect_mode is set or not, see #inspect_mode= for more detail.
@inspect_mode.nil? or @inspect_mode
# Whether #io uses a File for the +input_method+ passed when creating the
# current context, see ::new
@io.class == FileInputMethod
# Specifies the inspect mode with +opt+:
# +true+:: display +inspect+
# +false+:: display +to_s+
# +nil+:: inspect mode in non-math mode,
# non-inspect mode in math mode
# See IRB::Inspector for more information.
# Can also be set using the +--inspect+ and +--noinspect+ command line
# See IRB@Command+line+options for more command line options.
if i = Inspector::INSPECTORS[opt]
if Inspector.keys_with_inspector(Inspector::INSPECTORS[true]).include?(@inspect_mode)
self.inspect_mode = false
elsif Inspector.keys_with_inspector(Inspector::INSPECTORS[false]).include?(@inspect_mode)
puts "Can't switch inspect mode."
inspector = eval "proc#{opt}"
puts "Can't switch inspect mode(#{opt})."
self.inspect_mode = inspector
self.inspect_mode = IRB::Inspector(opt)
while Inspector::INSPECTORS[format(prefix, i)]; i += 1; end
@inspect_mode = format(prefix, i)
Inspector.def_inspector(format(prefix, i), @inspect_method)
puts "Can't switch inspect mode(#{opt})."
print "Switch to#{unless @inspect_mode; ' non';end} inspect mode.\n" if verbose?
def evaluate(line, line_no, exception: nil) # :nodoc:
line = "begin ::Kernel.raise _; rescue _.class\n#{line}\n""end"
@workspace.local_variable_set(:_, exception)
set_last_value(@workspace.evaluate(self, line, irb_path, line_no))
def inspect_last_value # :nodoc:
@inspect_method.inspect_value(@last_value)
# Exits the current session, see IRB.irb_exit
NOPRINTING_IVARS = ["@last_value"] # :nodoc:
NO_INSPECTING_IVARS = ["@irb", "@io"] # :nodoc:
IDNAME_IVARS = ["@prompt_mode"] # :nodoc:
alias __inspect__ inspect
for ivar in instance_variables.sort{|e1, e2| e1 <=> e2}
name = ivar.sub(/^@(.*)$/, '\1')
val = instance_eval(ivar)
array.push format("conf.%s=%s", name, "...")
when *NO_INSPECTING_IVARS
array.push format("conf.%s=%s", name, val.to_s)
array.push format("conf.%s=:%s", name, val.id2name)
array.push format("conf.%s=%s", name, val.inspect)