rb8-trepanning 0.1.3

data/app/frame.rb

@@ -0,0 +1,166 @@
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+module Trepan
+
+  # Call-Stack frame methods
+  class Frame
+    attr_accessor :stack_size, :index
+    def initialize(context, index=0)
+      @context = context
+      @index = index
+      @stack_size = @context.stack_size
+      reset
+    end
+
+    def reset
+      @binding = @klass = @file = @line = 
+        @local_variables = @method_name = @thread = nil
+    end
+
+    def index=(new_value)
+      if new_value > 0 && new_value < @stack_size
+        reset
+        @index  = new_value
+      else
+        nil
+      end
+    end
+
+    def run(code, filename=nil)
+      filename='(eval :%s)' % code unless filename
+      eval(code, self.binding, filename)
+    end
+
+    def binding
+      @binding ||= @context.frame_binding(@index)
+    end
+
+    def call_string(opts={:maxwidth=>80, :callstyle => :last})
+      call_str = ""
+      if method_name
+        locals = local_variables
+        if opts[:callstyle] != :short && klass
+          if opts[:callstyle] == :tracked
+            arg_info = @context.frame_args_info(@index)
+          end
+          call_str << "#{klass}." 
+        end
+        call_str << method_name
+        if args.any?
+          call_str << "("
+          args.each_with_index do |name, i|
+            case opts[:callstyle] 
+            when :short
+              call_str += "%s, " % [name]
+            when :last
+              klass = locals[name].class
+              if klass.inspect.size > 20+3
+                klass = klass.inspect[0..20]+"..." 
+              end
+              call_str += "%s#%s, " % [name, klass]
+            when :tracked
+              if arg_info && arg_info.size > i
+                call_str += "#{name}: #{arg_info[i].inspect}, "
+              else
+                call_str += "%s, " % name
+              end
+            end
+            if call_str.size > opts[:maxwidth]
+              # Strip off trailing ', ' if any but add stuff for later trunc
+              call_str[-2..-1] = ",...XX"
+              break
+            end
+          end
+          call_str[-2..-1] = ")" # Strip off trailing ', ' if any 
+        end
+      end
+      return call_str
+    end
+
+    def describe(opts = {:maxwidth => 80})
+      str       = ''
+      # FIXME There seem to be bugs in showing call if
+      # index != 0
+      call_str  = index == 0 ? call_string(opts) : ''
+      file = opts[:basename] ? File.basename(self.file) : self.file
+      file_line = "at line %s:%d\n" % [file, line]
+      unless call_str.empty?
+        str += call_str + ' '
+        if str.size + call_str.size + 1 + file_line.size > opts[:maxwidth]
+          str += "\n       "
+        else
+          str += '  '
+        end
+      end
+      str += file_line
+      str
+    end
+
+    def args
+      @args ||= @context.frame_args(@index)
+    end
+
+    def file
+      @file ||= @context.frame_file(@index)
+    end
+
+    def klass
+      @klass ||= @context.frame_class(@index)
+    end
+
+    def line
+      @line ||= @context.frame_line(@index)
+    end
+
+    def local_variables
+      @local_variables ||= @context.frame_locals(@index)
+    end
+
+    def method_name
+      if @method_name
+        @method_name
+      else
+        m = @context.frame_method(@index)
+        @method_name = m ? m.id2name : ''
+      end
+    end
+
+    def thread
+      @thread ||= @context.thread
+    end
+
+    # def eval?
+    #   static = @vm_location.static_scope
+    #   static && static.script && static.script.eval_source
+    # end
+
+    # def eval_string
+    #   return nil unless eval?
+    #   static = @vm_location.static_scope
+    #   static.script.eval_source
+    # end
+
+  end
+end
+
+if __FILE__ == $0
+  # Show it:
+  require 'rubygems'
+  require 'ruby-debug-base'; Debugger.start
+  def foo(str, num)
+    x = 1
+    context = Debugger.current_context
+    Debugger.skip do 
+      0.upto(Debugger.current_context.stack_size-1) do |i|
+        frame = Trepan::Frame.new(context)
+        frame.index = i
+        puts "Frame #{i}: #{frame.file}, line #{frame.line}, " + 
+          "class #{frame.klass}, thread: #{frame.thread}, " + 
+          "method: #{frame.method_name}"
+        p frame.local_variables
+        puts frame.describe(:maxwidth => 80, :callstyle=>:tracked)
+        puts '-' * 30
+      end
+    end
+  end
+  foo('arg', 5)
+end

data/app/irb.rb

@@ -0,0 +1,114 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# This code comes more or less from ruby-debug.
+require 'irb'
+module IRB # :nodoc:
+  module ExtendCommand # :nodoc:
+    # FIXME: should we read these out of a directory to 
+    #        make this more user-customizable? 
+
+    # A base command class that resume execution
+    class DebuggerResumeCommand
+      def self.execute(conf, *opts)
+        name = 
+          if self.name =~ /IRB::ExtendCommand::(\S+)/
+            $1.downcase
+          else
+            'unknown'
+          end
+        $trepan_args = opts
+        $trepan_command = 
+          if $trepan_irb_statements 
+            $trepan_irb_statements
+          else
+            ([name] + opts).join(' ')
+          end
+
+        throw :IRB_EXIT, name.to_sym
+      end
+    end
+
+    # FIXME: figure out why superclass type mismatch problem on 1.9
+    if RUBY_VERSION !~ /^1.9/
+      class Continue < DebuggerResumeCommand ; end
+      class Finish   < DebuggerResumeCommand ; end
+      class Next     < DebuggerResumeCommand ; end
+      class Quit     < DebuggerResumeCommand ; end
+      class Step     < DebuggerResumeCommand ; end
+    end
+
+    # Issues a comamnd to the debugger without continuing
+    # execution. 
+    class Dbgr
+      def self.execute(conf, *opts)
+        $trepan_command = 
+          if opts.size == 1 && opts[0].is_a?(String)
+            $trepan_args = opts[0]
+          else
+            opts.join(' ')
+          end
+        dbg_cmdproc = conf.workspace.instance_variable_get('@dbg_cmdproc')
+        dbg_cmdproc.run_command($trepan_command)
+      end
+    end
+
+  end
+  if defined?(ExtendCommandBundle)
+    # New irb Commands which are the same name as their debugger
+    # counterpart
+    %w(Dbgr Finish Step).each do |name|
+      command = name.downcase
+      sym     = name.to_sym
+      ExtendCommandBundle.def_extend_command command, sym
+    end
+    # New irb Commands which are the slightly different from their
+    # debugger counterpart
+    [['cont',   :Continue],
+     ['ne',     :Next],
+     ['q',      :Quit]].each do |command, sym|
+      ExtendCommandBundle.def_extend_command command, sym
+    end
+  end
+  
+  def self.start_session(binding, dbg_cmdproc, conf={})
+    unless @__initialized
+
+      # Set to run the standard trepan IRB profile
+      irbrc = File.expand_path(File.join(File.dirname(__FILE__), 
+                                         %w(.. data irbrc)))
+      ENV['IRBRC'] = irbrc
+
+      args = ARGV.dup
+      ARGV.replace([])
+      IRB.setup(nil)
+      ARGV.replace(args)
+      
+      # If the user has a IRB profile, run that now.
+      if ENV['TREPANX_IRB']
+        ENV['IRBRC'] = ENV['TREPANX_IRB']
+        @CONF[:RC_NAME_GENERATOR]=nil
+        IRB.run_config
+      end
+
+      @__initialized = true
+    end
+    
+    workspace = WorkSpace.new(binding)
+
+    irb = Irb.new(workspace)
+
+    @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
+    @CONF[:MAIN_CONTEXT] = irb.context
+    conf.each {|k, v| @CONF[k] = v}
+    # A copy of this back_trace_limit is already active. How? 
+    IRB.CurrentContext.back_trace_limit = @CONF[:BACK_TRACE_LIMIT]
+
+    catch(:IRB_EXIT) do
+      irb.eval_input
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  IRB.start_session(binding, nil) if ARGV.size > 0
+end

data/app/options.rb

@@ -0,0 +1,200 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+#=== Summary
+# Parses command-line options. 
+
+require 'optparse'
+module Trepan
+  require 'rubygems'; require 'require_relative'
+  require_relative 'default'
+
+  VERSION = '0.1.3' unless defined? Trepan::VERSION
+  PROGRAM = 'trepan8' unless defined? Trepan::PROGRAM
+
+  module_function
+
+  def show_version
+    "#{PROGRAM}, version #{VERSION}"
+  end
+
+  def copy_default_options
+    options = {}
+    DEFAULT_CMDLINE_SETTINGS.each do |key, value|
+      begin 
+        options[key] = value.clone
+      rescue TypeError
+        options[key] = value
+      end
+    end
+    options
+  end
+
+  def setup_options(options, stdout=$stdout, stderr=$stderr)
+    OptionParser.new do |opts|
+      opts.banner = <<EOB
+#{show_version}
+Usage: #{PROGRAM} [options] [[--] <script.rb> <script.rb parameters>]
+EOB
+      opts.separator ''
+      opts.separator 'Options:'
+      opts.on('--client',
+              'Connect to out-of-process program') do
+        if options[:server]
+          stderr.puts '--server option previously given. --client option ignored.'
+        else
+          options[:client] = true
+        end
+      end
+      opts.on('-c', '--command FILE', String, 
+              'Execute debugger commands from FILE') do |cmdfile| 
+        if File.readable?(cmdfile)
+          options[:cmdfiles] << cmdfile
+        elsif File.exists?(cmdfile)
+            stderr.puts "Command file '#{cmdfile}' is not readable. Option ignored."
+        else
+          stderr.puts "Command file '#{cmdfile}' does not exist."
+        end
+      end
+      opts.on('--cd DIR', String, 'Change current directory to DIR') do |dir| 
+        if File.directory?(dir)
+          if File.executable?(dir)
+            options[:chdir] = dir
+          else
+            stderr.puts "Can't cd to #{dir}. Option --cd ignored."
+          end
+        else
+          stderr.puts "\"#{dir}\" is not a directory. Option --cd ignored."
+        end
+      end
+      opts.on('--basename', 
+              'Show only file basename in file locations') do 
+        options[:basename] = true
+      end
+      opts.on('-d', '--debug', 'Set $DEBUG=true') do 
+        $DEBUG = true
+      end
+      opts.on('--cport PORT', Integer, 'Port used for control commands') do 
+        |cport|
+        options[:cport] = cport
+      end
+      opts.on('--[no-]highlight',
+              'Use [no] syntax highlight output') do |v|
+        options[:highlight] = ((v) ? :term : nil)
+        if options[:highlight]
+          begin
+            require 'linecache'
+          rescue LoadError
+            require 'linecache19'
+          end
+          unless LineCache.respond_to?(:clear_file_format_cache)
+            stderr.puts "Your version of LineCache doesn't support terminal highlight"
+            options[:higlight] = false 
+          end
+        end
+      end
+      opts.on('-h', '--host NAME', String, 
+              'Host or IP used in TCP connections for --server or --client. ' + 
+              "Default is #{DEFAULT_SETTINGS[:host].inspect}.") do 
+        |name_or_ip| 
+        options[:host] = name_or_ip
+      end
+      opts.on('-I', '--include PATH', String, 'Add PATH to $LOAD_PATH') do |path|
+        $LOAD_PATH.unshift(path)
+      end
+      opts.on('--keep-frame-binding', 'Keep frame bindings') do 
+        options[:frame_bind] = true
+      end
+      opts.on('-m', '--post-mortem', 'Activate post-mortem mode') do 
+        options[:post_mortem] = true
+      end
+      opts.on('--nx',
+              "Do not run debugger initialization file #{CMD_INITFILE}") do
+        options[:nx] = true
+      end
+      opts.on('--[no-]control', 'Start [not] control thread') do |v|
+        options[:control] = v
+      end
+      opts.on('-p', '--port NUMBER', Integer, 
+              'Port number used in TCP connections for --server or --client. ' + 
+              "Default is #{DEFAULT_SETTINGS[:port]}.") do 
+        |num| 
+        options[:port] = num
+      end
+      opts.on('--[no-]quit', 'Do [not] quit when script finishes') do |v|
+        options[:quit] = v
+      end
+      opts.on('--[no-]readline',
+              'Try [not] GNU Readline') do |v|
+        options[:readline] = v
+      end
+      opts.on('-r', '--require SCRIPT', String,
+              'Require the library, before executing your script') do |name|
+        if name == 'debug'
+          stderr.puts "trepan8 is not compatible with Ruby's 'debug' library. This option is ignored."
+        else
+          require name
+        end
+      end
+      opts.on('--[no-]rewrite-program',
+              'Do not set $0 to the program being debugged') do |v|
+        options[:rewrite_program] = v
+      end
+      opts.on('--[no-]stop', 'Do not stop when script is loaded') do |v|
+        options[:stop] = v
+      end
+      opts.on('--script FILE', String, 'Name of the script file to run') do 
+        |script|
+        options[:script] = script
+        unless File.exists?(options[:script])
+          stderr.puts "Script file '#{options[:script]}' is not found"
+          exit 10
+        end
+      end
+      opts.on('-s', '--server',
+              'Set up for out-of-process debugging') do
+        if options[:client]
+          stderr.puts '--client option previously given. --server option ignored.'
+        else
+          options[:server] = true
+        end
+      end
+      opts.on('-w', '--wait', 'Wait for a client connection; implies -s option') do
+        options[:wait] = true
+      end
+      opts.on('-x', '--trace', 'Turn on line tracing') do 
+        options[:tracing] = true
+      end
+      opts.separator ''
+      opts.on_tail('-?', '--help', 'Show this message') do
+        options[:help] = true
+        stdout.puts opts
+        exit 
+      end
+      opts.on_tail('-v', '--version', 
+                   'print the version') do
+        options[:version] = true
+        stdout.puts show_version
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  include Trepan
+  opts = {}
+  options ={}
+  [%w(--help), %w(--version)].each do |o|
+    options = Trepan::copy_default_options
+    opts    = Trepan::setup_options(options)
+    rest    = opts.parse o
+    p options
+    puts '=' * 10
+  end
+  rest = opts.parse! ARGV
+  puts opts
+  puts '=' * 10
+  p options
+  puts '=' * 10
+  p Trepan::DEFAULT_CMDLINE_SETTINGS
+end