class IRB::WorkSpace - RDoc Documentation

# class IRB::WorkSpace

### Attributes

binding[R]

The `Binding` of this workspace

main[R]

The top-level workspace of this context, also available as `IRB.conf[:__MAIN__]`

### Public Class Methods

new(*main) click to toggle source

Creates a new workspace.

set self to main if specified, otherwise inherit main from TOPLEVEL_BINDING.

    # File lib/irb/workspace.rb, line 22
        def initialize(*main)
          if main[0].kind_of?(Binding)
            @binding = main.shift
          elsif IRB.conf[:SINGLE_IRB]
            @binding = TOPLEVEL_BINDING
          else
            case IRB.conf[:CONTEXT_MODE]
            when 0  # binding in proc on TOPLEVEL_BINDING
              @binding = eval("proc{binding}.call",
                              TOPLEVEL_BINDING,
                              __FILE__,
                              __LINE__)
            when 1  # binding in loaded file
              require "tempfile"
              f = Tempfile.open("irb-binding")
              f.print <<EOF
          $binding = binding
    EOF
              f.close
              load f.path
              @binding = $binding

            when 2  # binding in loaded file(thread use)
              unless defined? BINDING_QUEUE
                IRB.const_set(:BINDING_QUEUE, Thread::SizedQueue.new(1))
                Thread.abort_on_exception = true
                Thread.start do
                  eval "require \"irb/ws-for-case-2\"", TOPLEVEL_BINDING, __FILE__, __LINE__
                end
                Thread.pass
              end
              @binding = BINDING_QUEUE.pop

            when 3  # binding in function on TOPLEVEL_BINDING
              @binding = eval("self.class.remove_method(:irb_binding) if defined?(irb_binding); private; def irb_binding; binding; end; irb_binding",
                              TOPLEVEL_BINDING,
                              __FILE__,
                              __LINE__ - 3)
            when 4  # binding is a copy of TOPLEVEL_BINDING (default)
              # Note that this will typically be IRB::TOPLEVEL_BINDING
              # This is to avoid RubyGems' local variables (see issue #17623)
              @binding = TOPLEVEL_BINDING.dup
            end
          end

          if main.empty?
            @main = eval("self", @binding)
          else
            @main = main[0]
          end
          IRB.conf[:__MAIN__] = @main

          unless main.empty?
            case @main
            when Module
              @binding = eval("IRB.conf[:__MAIN__].module_eval('binding', __FILE__, __LINE__)", @binding, __FILE__, __LINE__)
            else
              begin
                @binding = eval("IRB.conf[:__MAIN__].instance_eval('binding', __FILE__, __LINE__)", @binding, __FILE__, __LINE__)
              rescue TypeError
                fail CantChangeBinding, @main.inspect
              end
            end
          end

          case @main
          when Object
            use_delegator = @main.frozen?
          else
            use_delegator = true
          end

          if use_delegator
            @main = SimpleDelegator.new(@main)
            IRB.conf[:__MAIN__] = @main
            @main.singleton_class.class_eval do
              private
              define_method(:exit) do |*a, &b|
                # Do nothing, will be overridden
              end
              define_method(:binding, Kernel.instance_method(:binding))
              define_method(:local_variables, Kernel.instance_method(:local_variables))
            end
            @binding = eval("IRB.conf[:__MAIN__].instance_eval('binding', __FILE__, __LINE__)", @binding, *@binding.source_location)
          end

          @binding.local_variable_set(:_, nil)
        end

### Public Instance Methods

__evaluate__(context, statements, file = nil, line = nil)
Alias for: evaluate
code_around_binding() click to toggle source

    # File lib/irb/workspace.rb, line 144
    def code_around_binding
      if @binding.respond_to?(:source_location)
        file, pos = @binding.source_location
      else
        file, pos = @binding.eval('[__FILE__, __LINE__]')
      end

      if defined?(::SCRIPT_LINES__[file]) && lines = ::SCRIPT_LINES__[file]
        code = ::SCRIPT_LINES__[file].join('')
      else
        begin
          code = File.read(file)
        rescue SystemCallError
          return
        end
      end

      # NOT using #use_colorize? of IRB.conf[:MAIN_CONTEXT] because this method may be called before IRB::Irb#run
      use_colorize = IRB.conf.fetch(:USE_COLORIZE, true)
      if use_colorize
        lines = Color.colorize_code(code).lines
      else
        lines = code.lines
      end
      pos -= 1

      start_pos = [pos - 5, 0].max
      end_pos   = [pos + 5, lines.size - 1].min

      if use_colorize
        fmt = " %2s #{Color.colorize("%#{end_pos.to_s.length}d", [:BLUE, :BOLD])}: %s"
      else
        fmt = " %2s %#{end_pos.to_s.length}d: %s"
      end
      body = (start_pos..end_pos).map do |current_pos|
        sprintf(fmt, pos == current_pos ? '=>' : '', current_pos + 1, lines[current_pos])
      end.join("")
      "\nFrom: #{file} @ line #{pos + 1} :\n\n#{body}#{Color.clear if use_colorize}\n"
    end

evaluate(context, statements, file = nil, line = nil) click to toggle source

Evaluate the context of this workspace and use the Tracer library to output the exact lines of code are being executed in chronological order.

See `lib/tracer.rb` for more information.

    # File lib/irb/ext/tracer.rb, line 69
    def evaluate(context, statements, file = nil, line = nil)
      if context.use_tracer? && file != nil && line != nil
        Tracer.on
        begin
          __evaluate__(context, statements, file, line)
        ensure
          Tracer.off
        end
      else
        __evaluate__(context, statements, file || __FILE__, line || __LINE__)
      end
    end

Also aliased as: __evaluate__
filter_backtrace(bt) click to toggle source

error message manipulator

    # File lib/irb/workspace.rb, line 131
    def filter_backtrace(bt)
      return nil if bt =~ /\/irb\/.*\.rb/
      return nil if bt =~ /\/irb\.rb/
      return nil if bt =~ /tool\/lib\/.*\.rb|runner\.rb/ # for tests in Ruby repository
      case IRB.conf[:CONTEXT_MODE]
      when 1
        return nil if bt =~ %r!/tmp/irb-binding!
      when 3
        bt = bt.sub(/:\s*in `irb_binding'/, '')
      end
      bt
    end

local_variable_get(name) click to toggle source

    # File lib/irb/workspace.rb, line 126
    def local_variable_get(name)
      @binding.local_variable_get(name)
    end

local_variable_set(name, value) click to toggle source

    # File lib/irb/workspace.rb, line 122
    def local_variable_set(name, value)
      @binding.local_variable_set(name, value)
    end