123456789_123456789_123456789_123456789_123456789_

Class: IRB::Irb

Relationships & Source Files
Inherits: Object
Defined in: lib/irb.rb,
lib/irb/ext/multi-irb.rb

Constant Summary

  • ASSIGNMENT_NODE_TYPES =
    # File 'lib/irb.rb', line 425
    [
      # Local, instance, global, class, constant, instance, and index assignment:
      #   "foo = bar",
      #   "@foo = bar",
      #   "$foo = bar",
      #   "@@foo = bar",
      #   "::Foo = bar",
      #   "a::Foo = bar",
      #   "Foo = bar"
      #   "foo.bar = 1"
      #   "foo[1] = bar"
      :assign,
    
      # Operation assignment:
      #   "foo += bar"
      #   "foo -= bar"
      #   "foo ||= bar"
      #   "foo &&= bar"
      :opassign,
    
      # Multiple assignment:
      #   "foo, bar = 1, 2
      :massign,
    ]
  • ATTR_PLAIN =
    # File 'lib/irb.rb', line 816
    ""
  • ATTR_TTY =
    # File 'lib/irb.rb', line 814
    "\e[%sm"

Class Method Summary

Instance Attribute Summary

  • #context readonly

    Returns the current context of this irb session.

  • #scanner rw

    The lexer used by this irb session.

Instance Method Summary

Constructor Details

.new(workspace = nil, input_method = nil) ⇒ Irb

Creates a new irb session

[ GitHub ]

  
# File 'lib/irb.rb', line 455

def initialize(workspace = nil, input_method = nil)
  @context = Context.new(self, workspace, input_method)
  @context.main.extend ExtendCommandBundle
  @signal_status = :IN_IRB
  @scanner = RubyLex.new
end

Instance Attribute Details

#context (readonly)

Returns the current context of this irb session

[ GitHub ]

  
# File 'lib/irb.rb', line 480

attr_reader :context

#scanner (rw)

The lexer used by this irb session

[ GitHub ]

  
# File 'lib/irb.rb', line 482

attr_accessor :scanner

Instance Method Details

#assignment_expression?(line) ⇒ Boolean

[ GitHub ]

  
# File 'lib/irb.rb', line 799

def assignment_expression?(line)
  # Try to parse the line and check if the last of possibly multiple
  # expressions is an assignment type.

  # If the expression is invalid, Ripper.sexp should return nil which will
  # result in false being returned. Any valid expression should return an
  # s-expression where the second selement of the top level array is an
  # array of parsed expressions. The first element of each expression is the
  # expression's type.
  verbose, $VERBOSE = $VERBOSE, nil
  result = ASSIGNMENT_NODE_TYPES.include?(Ripper.sexp(line)&.dig(1,-1,0))
  $VERBOSE = verbose
  result
end

#eval_input

Evaluates input for this session.

[ GitHub ]

  
# File 'lib/irb.rb', line 485

def eval_input
  exc = nil

  @scanner.set_prompt do
    |ltype, indent, continue, line_no|
    if ltype
      f = @context.prompt_s
    elsif continue
      f = @context.prompt_c
    elsif indent > 0
      f = @context.prompt_n
    else
      f = @context.prompt_i
    end
    f = "" unless f
    if @context.prompting?
      @context.io.prompt = p = prompt(f, ltype, indent, line_no)
    else
      @context.io.prompt = p = ""
    end
    if @context.auto_indent_mode and !@context.io.respond_to?(:auto_indent)
      unless ltype
        prompt_i = @context.prompt_i.nil? ? "" : @context.prompt_i
        ind = prompt(prompt_i, ltype, indent, line_no)[/.*\z/].size +
          indent * 2 - p.size
        ind += 2 if continue
        @context.io.prompt = p + " " * ind if ind > 0
      end
    end
    @context.io.prompt
  end

  @scanner.set_input(@context.io) do
    signal_status(:IN_INPUT) do
      if l = @context.io.gets
        print l if @context.verbose?
      else
        if @context.ignore_eof? and @context.io.readable_after_eof?
          l = "\n"
          if @context.verbose?
            printf "Use \"exit\" to leave %s\n", @context.ap_name
          end
        else
          print "\n"
        end
      end
      l
    end
  end

  @scanner.set_auto_indent(@context) if @context.auto_indent_mode

  @scanner.each_top_level_statement do |line, line_no|
    signal_status(:IN_EVAL) do
      begin
        line.untaint if RUBY_VERSION < '2.7'
        @context.evaluate(line, line_no, exception: exc)
        if @context.echo?
          if assignment_expression?(line)
            if @context.echo_on_assignment?
              output_value(@context.omit_on_assignment?)
            end
          else
            output_value
          end
        end
      rescue Interrupt => exc
      rescue SystemExit, SignalException
        raise
      rescue Exception => exc
      else
        exc = nil
        next
      end
      handle_exception(exc)
    end
  end
end

#handle_exception(exc)

[ GitHub ]

  
# File 'lib/irb.rb', line 564

def handle_exception(exc)
  if exc.backtrace && exc.backtrace[0] =~ /\/irb(2)?(\/.*|-.*|\.rb)?:/ && exc.class.to_s !~ /^IRB/ &&
     !(SyntaxError === exc) && !(EncodingError === exc)
    # The backtrace of invalid encoding hash (ex. {"\xAE": 1}) raises EncodingError without lineno.
    irb_bug = true
  else
    irb_bug = false
  end

  if STDOUT.tty?
    attr = ATTR_TTY
    print "#{attr[1]}Traceback#{attr[]} (most recent call last):\n"
  else
    attr = ATTR_PLAIN
  end
  messages = []
  lasts = []
  levels = 0
  if exc.backtrace
    count = 0
    exc.backtrace.each do |m|
      m = @context.workspace.filter_backtrace(m) or next unless irb_bug
      count += 1
      if attr == ATTR_TTY
        m = sprintf("%9d: from %s", count, m)
      else
        m = "\tfrom #{m}"
      end
      if messages.size < @context.back_trace_limit
        messages.push(m)
      elsif lasts.size < @context.back_trace_limit
        lasts.push(m).shift
        levels += 1
      end
    end
  end
  if attr == ATTR_TTY
    unless lasts.empty?
      puts lasts.reverse
      printf "... %d levels...\n", levels if levels > 0
    end
    puts messages.reverse
  end
  m = exc.to_s.split(/\n/)
  print "#{attr[1]}#{exc.class} (#{attr[4]}#{m.shift}#{attr[0, 1]})#{attr[]}\n"
  puts m.map {|s| "#{attr[1]}#{s}#{attr[]}\n"}
  if attr == ATTR_PLAIN
    puts messages
    unless lasts.empty?
      puts lasts
      printf "... %d levels...\n", levels if levels > 0
    end
  end
  print "Maybe IRB bug!\n" if irb_bug
end

#inspect

Outputs the local variables to this current session, including #signal_status and #context, using Locale.

[ GitHub ]

  
# File 'lib/irb.rb', line 784

def inspect
  ary = []
  for iv in instance_variables
    case (iv = iv.to_s)
    when "@signal_status"
      ary.push format("%s=:%s", iv, @signal_status.id2name)
    when "@context"
      ary.push format("%s=%s", iv, eval(iv).__to_s__)
    else
      ary.push format("%s=%s", iv, eval(iv))
    end
  end
  format("#<%s: %s>", self.class, ary.join(", "))
end

#output_value(omit = false)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/irb.rb', line 749

def output_value(omit = false) # :nodoc:
  str = @context.inspect_last_value
  multiline_p = str.include?("\n")
  if omit
    winwidth = @context.io.winsize.last
    if multiline_p
      first_line = str.split("\n").first
      result = @context.newline_before_multiline_output? ? (@context.return_format % first_line) : first_line
      output_width = Reline::Unicode.calculate_width(result, true)
      diff_size = output_width - Reline::Unicode.calculate_width(first_line, true)
      if diff_size.positive? and output_width > winwidth
        lines, _ = Reline::Unicode.split_by_width(first_line, winwidth - diff_size - 3)
        str = "%s...\e[0m" % lines.first
        multiline_p = false
      else
        str.gsub!(/(\A.*?\n).*/m, "\\1...")
      end
    else
      output_width = Reline::Unicode.calculate_width(@context.return_format % str, true)
      diff_size = output_width - Reline::Unicode.calculate_width(str, true)
      if diff_size.positive? and output_width > winwidth
        lines, _ = Reline::Unicode.split_by_width(str, winwidth - diff_size - 3)
        str = "%s...\e[0m" % lines.first
      end
    end
  end
  if multiline_p && @context.newline_before_multiline_output?
    printf @context.return_format, "\n#{str}"
  else
    printf @context.return_format, str
  end
end

#prompt(prompt, ltype, indent, line_no)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/irb.rb', line 710

def prompt(prompt, ltype, indent, line_no) # :nodoc:
  p = prompt.dup
  p.gsub!(/%([0-9]+)?([a-zA-Z])/) do
    case $2
    when "N"
      @context.irb_name
    when "m"
      @context.main.to_s
    when "M"
      @context.main.inspect
    when "l"
      ltype
    when "i"
      if indent < 0
        if $1
          "-".rjust($1.to_i)
        else
          "-"
        end
      else
        if $1
          format("%" + $1 + "d", indent)
        else
          indent.to_s
        end
      end
    when "n"
      if $1
        format("%" + $1 + "d", line_no)
      else
        line_no.to_s
      end
    when "%"
      "%"
    end
  end
  p
end

#run(conf = IRB.conf)

[ GitHub ]

  
# File 'lib/irb.rb', line 462

def run(conf = IRB.conf)
  conf[:IRB_RC].call(context) if conf[:IRB_RC]
  conf[:MAIN_CONTEXT] = context

  trap("SIGINT") do
    signal_handle
  end

  begin
    catch(:IRB_EXIT) do
      eval_input
    end
  ensure
    conf[:AT_EXIT].each{|hook| hook.call}
  end
end

#signal_handle

Handler for the signal SIGINT, see Kernel.trap for more information.

See additional method definition at file lib/irb.rb line 676.

[ GitHub ]

  
# File 'lib/irb/ext/multi-irb.rb', line 238

def signal_handle
  unless @context.ignore_sigint?
    print "\nabort!\n" if @context.verbose?
    exit
  end

  case @signal_status
  when :IN_INPUT
    print "^C\n"
    raise RubyLex::TerminateLineInput
  when :IN_EVAL
    IRB.irb_abort(self)
  when :IN_LOAD
    IRB.irb_abort(self, LoadAbort)
  when :IN_IRB
    # ignore
  else
    # ignore other cases as well
  end
end

#signal_status(status)

Evaluates the given block using the given status.

[ GitHub ]

  
# File 'lib/irb.rb', line 698

def signal_status(status)
  return yield if @signal_status == :IN_LOAD

  signal_status_back = @signal_status
  @signal_status = status
  begin
    yield
  ensure
    @signal_status = signal_status_back
  end
end

#suspend_context(context)

Evaluates the given block using the given #context as the Context.

[ GitHub ]

  
# File 'lib/irb.rb', line 666

def suspend_context(context)
  @context, back_context = context, @context
  begin
    yield back_context
  ensure
    @context = back_context
  end
end

#suspend_input_method(input_method)

Evaluates the given block using the given input_method as the Context#io.

Used by the irb commands source and irb_load, see IRB@IRB+Sessions for more information.

[ GitHub ]

  
# File 'lib/irb.rb', line 655

def suspend_input_method(input_method)
  back_io = @context.io
  @context.instance_eval{@io = input_method}
  begin
    yield back_io
  ensure
    @context.instance_eval{@io = back_io}
  end
end

#suspend_name(path = nil, name = nil)

Evaluates the given block using the given path as the Context#irb_path and name as the Context#irb_name.

Used by the irb command source, see IRB@IRB+Sessions for more information.

[ GitHub ]

  
# File 'lib/irb.rb', line 625

def suspend_name(path = nil, name = nil)
  @context.irb_path, back_path = path, @context.irb_path if path
  @context.irb_name, back_name = name, @context.irb_name if name
  begin
    yield back_path, back_name
  ensure
    @context.irb_path = back_path if path
    @context.irb_name = back_name if name
  end
end

#suspend_workspace(workspace)

Evaluates the given block using the given workspace as the Context#workspace.

Used by the irb command irb_load, see IRB@IRB+Sessions for more information.

[ GitHub ]

  
# File 'lib/irb.rb', line 641

def suspend_workspace(workspace)
  @context.workspace, back_workspace = workspace, @context.workspace
  begin
    yield back_workspace
  ensure
    @context.workspace = back_workspace
  end
end