rb8-trepanning 0.1.3

data/processor/command-ruby-debug/trace.rb

@@ -0,0 +1,57 @@
+module Trepan
+  class TraceCommand < OldCommand # :nodoc:
+    def regexp
+      /^\s* tr(?:ace)? (?: \s+ (\S+))         # on |off | var(iable)
+                       (?: \s+ (\S+))?        # (all | variable-name)?
+                       (?: \s+ (\S+))? \s*    # (stop | nostop)? 
+       $/ix
+    end
+
+    def execute
+      if @match[1] =~ /on|off/
+        onoff = 'on' == @match[1] 
+        if @match[2]
+          Debugger.current_context.tracing = onoff
+          print "Tracing %s all threads.\n" % (onoff ? 'on' : 'off')
+        else
+          Debugger.tracing = onoff
+          print "Tracing %s on current thread.\n"  % (onoff ? 'on' : 'off')
+        end
+      elsif @match[1] =~ /var(?:iable)?/
+        varname=@match[2]
+        if debug_eval("defined?(#{varname})")
+          if @match[3] && @match[3] !~ /(:?no)?stop/
+            errmsg("expecting 'stop' or 'nostop'; got %s\n" % @match[3])
+          else
+            dbg_cmd = if @match[3] && (@match[3] !~ /nostop/) 
+                        'debugger' else '' end
+          end
+          eval("
+           trace_var(:#{varname}) do |val|
+              print \"traced variable #{varname} has value \#{val}\n\"
+              #{dbg_cmd}
+           end")
+        else
+          errmsg "#{varname} is not a global variable.\n"
+        end
+      else 
+        errmsg("expecting 'on', 'off', 'var' or 'variable'; got: %s\n" %
+               @match[1])
+      end
+    end
+
+    class << self
+      def help_command
+        'trace'
+      end
+
+      def help(cmd)
+        %{
+          tr[ace] (on|off)\tset trace mode of current thread
+          tr[ace] (on|off) all\tset trace mode of all threads
+          tr[ace] var(iable) VARNAME [stop|nostop]\tset trace variable on VARNAME
+        }
+      end
+    end
+  end
+end

data/processor/command-ruby-debug/variables.rb

@@ -0,0 +1,199 @@
+module Trepan
+  module VarFunctions # :nodoc:
+    def var_list(ary, b = get_binding)
+      ary.sort!
+      for v in ary
+        begin
+          s = debug_eval(v, b).inspect
+        rescue
+          begin
+            s = debug_eval(v, b).to_s
+          rescue
+            s = "*Error in evaluation*"
+          end
+        end
+        if s.size > self.class.settings[:width]
+          s[self.class.settings[:width]-3 .. -1] = "..."
+        end
+        print "%s = %s\n", v, s
+      end
+    end
+    def var_class_self
+      obj = debug_eval('self')
+      var_list(obj.class.class_variables, get_binding)
+    end
+  end
+
+  # Implements the debugger 'var class' command.
+  class VarClassVarCommand < OldCommand
+    def regexp
+      /^\s*v(?:ar)?\s+cl(?:ass)?/
+    end
+
+    def execute
+      unless @state.context
+        errmsg "can't get class variables here.\n"
+        return 
+      end
+      var_class_self
+    end
+
+    class << self
+      def help_command
+        'var'
+      end
+
+      def help(cmd)
+        %{
+          v[ar] cl[ass] \t\t\tshow class variables of self
+        }
+      end
+    end
+  end
+
+  class VarConstantCommand < OldCommand # :nodoc:
+    def regexp
+      /^\s*v(?:ar)?\s+co(?:nst(?:ant)?)?\s+/
+    end
+
+    def execute
+      obj = debug_eval(@match.post_match)
+      if obj.kind_of? Module
+        constants = debug_eval("#{@match.post_match}.constants")
+        constants.sort!
+        for c in constants
+          next if c =~ /SCRIPT/
+          value = obj.const_get(c) rescue "ERROR: #{$!}"
+          print " %s => %p\n", c, value
+        end
+      else
+        print "Should be Class/Module: %s\n", @match.post_match
+      end
+    end
+
+    class << self
+      def help_command
+        'var'
+      end
+
+      def help(cmd)
+        %{
+          v[ar] c[onst] <object>\t\tshow constants of object
+        }
+      end
+    end
+  end
+
+  class VarGlobalCommand < OldCommand # :nodoc:
+    def regexp
+      /^\s*v(?:ar)?\s+g(?:lobal)?\s*$/
+    end
+
+    def execute
+      var_list(global_variables)
+    end
+
+    class << self
+      def help_command
+        'var'
+      end
+
+      def help(cmd)
+        %{
+          v[ar] g[lobal]\t\t\tshow global variables
+        }
+      end
+    end
+  end
+
+  class VarInstanceCommand < OldCommand # :nodoc:
+    def regexp
+      /^\s*v(?:ar)?\s+ins(?:tance)?\s*/
+    end
+
+    def execute
+      obj = debug_eval(@match.post_match.empty? ? 'self' : @match.post_match)
+      var_list(obj.instance_variables, obj.instance_eval{binding()})
+    end
+
+    class << self
+      def help_command
+        'var'
+      end
+
+      def help(cmd)
+        %{
+          v[ar] i[nstance] <object>\tshow instance variables of object
+        }
+      end
+    end
+  end
+
+  # Implements the debugger 'var local' command.
+  class VarLocalCommand < OldCommand
+    def regexp
+      /^\s*v(?:ar)?\s+l(?:ocal)?\s*$/
+    end
+
+    def execute
+      locals = @state.context.frame_locals(@state.frame_pos)
+      _self = @state.context.frame_self(@state.frame_pos) 
+      locals.keys.sort.each do |name|
+        print "  %s => %p\n", name, locals[name]
+      end
+    end
+
+    class << self
+      def help_command
+        'var'
+      end
+
+      def help(cmd)
+        %{
+          v[ar] l[ocal]\t\t\tshow local variables
+        }
+      end
+    end
+  end
+  
+    # Implements the debugger 'var inherit' command.
+  begin
+    require 'classtree'
+    have_classtree = true
+  rescue LoadError
+    have_classtree = false
+  end
+
+  class VarInheritCommand < OldCommand
+    def regexp
+      /^\s*v(?:ar)?\s+ct\s*/
+    end
+
+    def execute
+      unless @state.context
+        errmsg "can't get object inheritance.\n"
+        return 
+      end
+      puts @match.post_match
+      obj = debug_eval("#{@match.post_match}.classtree")
+      if obj
+        print obj
+      else
+        errmsg "Trouble getting object #{@match.post_match}\n"
+      end
+    end
+
+    class << self
+      def help_command
+        'var'
+      end
+
+      def help(cmd)
+        %{
+          v[ar] ct\t\t\tshow class heirarchy of object
+        }
+      end
+    end
+  end if have_classtree
+
+end

data/processor/command.rb

@@ -0,0 +1,270 @@
+require 'rubygems'
+require 'columnize'
+require 'require_relative'
+require_relative './helper'
+
+module Trepan
+  RUBY_DEBUG_DIR = File.expand_path(File.dirname(__FILE__)) unless
+    defined?(RUBY_DEBUG_DIR)
+
+  # A Trepan::Command object is is the base class for commands that
+  # implement a single debugger command. Individual debugger commands
+  # will be a subclass of this. The singleton class object is the
+  # command manager for all commands.
+  # 
+  # Each debugger command is expected to implement the following methods:
+  # _regexp_::   A regular expression which input strings are matched
+  #              against. If we have a match, run this command. 
+  #              It is the ruby-debug programmer's responsibility
+  #              to make sure that these regular expressions match disjoint
+  #              sets of strings. Otherwise one is arbitrarily used.
+  # _execute_::  Ruby code that implements the command.
+  # _help_::     Should return a String containing descriptive help for
+  #              the commmand. Used by the 'help' command Trepan::HelpCommand
+  # _help_command_:: The name of the command listed via help.
+  # 
+  # _help_ and _help_command_ methods are singleton methods, not 
+  # instance methods like _regexp_ and _execute_.
+  class OldCommand
+    SubcmdStruct=Struct.new(:name, :min, :short_help, :long_help) unless
+      defined?(SubcmdStruct)
+
+    include Columnize
+
+    # Find _param_ in _subcmds_. The _param_ id downcased and can be
+    # abbreviated to the minimum length listed in the subcommands
+    def find(subcmds, param)
+      param.downcase!
+      for try_subcmd in subcmds do
+        if (param.size >= try_subcmd.min) and
+            (try_subcmd.name[0..param.size-1] == param)
+          return try_subcmd
+        end
+      end
+      return nil
+    end
+
+    class << self
+      # An Array containing Trepan::Command classes that implment each
+      # of the debugger commands.
+      def commands
+        @commands ||= []
+      end
+      
+      DEF_OPTIONS = {
+        :allow_in_control     => false, 
+        :allow_in_post_mortem => true,
+        :event => true, 
+        :always_run => 0,
+        :unknown => false,
+        :need_context => false,
+      } unless defined?(DEF_OPTIONS)
+      
+      def inherited(klass)
+        DEF_OPTIONS.each do |o, v|
+          klass.options[o] = v if klass.options[o].nil?
+        end
+        commands << klass
+      end 
+
+      # Read in and "include" all the subclasses of the
+      # Trepan::Command class. For example
+      # Trepan::QuitCommand is one of them. The list of Ruby
+      # files to read are all the files that end .rb in directory
+      # Trepan::RUBY_DEBUG_DIR
+      def load_commands
+        Dir[File.join(%W(#{Trepan.const_get(:RUBY_DEBUG_DIR)}
+                      command-ruby-debug *))].each do 
+          |file|
+          require file if file =~ /\.rb$/
+        end
+        Trepan.constants.grep(/Functions$/).map { |name| Trepan.const_get(name) }.each do |mod|
+          include mod
+        end
+      end
+      
+      def method_missing(meth, *args, &block)
+        if meth.to_s =~ /^(.+?)=$/
+          @options[$1.intern] = args.first
+        else
+          if @options.has_key?(meth)
+            @options[meth]
+          else
+            super
+          end
+        end
+      end
+      
+      def options
+        @options ||= {}
+      end
+
+      def settings_map
+        @@settings_map ||= {}
+      end
+      private :settings_map
+
+      # Returns a Hash of Debugger settings, @settings. If doesn't exist
+      # we create a @settings hash with [] setter and getter and return that.
+      def settings
+        unless true and defined? @settings and @settings
+          @settings = Object.new
+          map = settings_map
+          c = class << @settings; self end
+          if c.respond_to?(:funcall)
+            c.funcall(:define_method, :[]) do |name|
+              raise "No such setting #{name}" unless map.has_key?(name)
+              map[name][:getter].call
+            end
+          else
+            c.send(:define_method, :[]) do |name|
+              raise "No such setting #{name}" unless map.has_key?(name)
+              map[name][:getter].call
+            end
+          end
+          c = class << @settings; self end
+          if c.respond_to?(:funcall)
+            c.funcall(:define_method, :[]=) do |name, value|
+              raise "No such setting #{name}" unless map.has_key?(name)
+              map[name][:setter].call(value)
+            end
+          else
+            c.send(:define_method, :[]=) do |name, value|
+              raise "No such setting #{name}" unless map.has_key?(name)
+              map[name][:setter].call(value)
+            end
+          end
+        end
+        @settings
+      end
+
+      def register_setting_var(name, default)
+        var_name = "@@#{name}"
+        class_variable_set(var_name, default)
+        register_setting_get(name) { class_variable_get(var_name) }
+        register_setting_set(name) { |value| class_variable_set(var_name, value) }
+      end
+
+      def register_setting_get(name, &block)
+        settings_map[name] ||= {}
+        settings_map[name][:getter] = block
+      end
+
+      def register_setting_set(name, &block)
+        settings_map[name] ||= {}
+        settings_map[name][:setter] = block
+      end
+    end
+
+    register_setting_var(:basename, false)  # use basename in showing files? 
+    register_setting_var(:callstyle, :last)
+    register_setting_var(:debuggertesting, false)
+    register_setting_var(:force_stepping, false)
+    register_setting_var(:full_path, true)
+    register_setting_var(:listsize, 10)    # number of lines in list command
+    register_setting_var(:stack_trace_on_error, false)
+    register_setting_var(:tracing_plus, false) # different linetrace lines?
+    
+    # width of line output. Use COLUMNS value if it exists and is 
+    # not too rediculously large.
+    width = ENV['COLUMNS'].to_i 
+    width = 80 unless width > 10
+    register_setting_var(:width, width)  
+
+    if not defined? Trepan::ARGV
+      Trepan::ARGV = ARGV.clone
+    end
+    register_setting_var(:argv, Trepan::ARGV)
+    
+    def initialize(state)
+      @state = state
+    end
+
+    def match(input)
+      @match = regexp.match(input)
+    end
+
+    protected
+
+    # FIXME: use delegate? 
+    def errmsg(*args)
+      @state.errmsg(*args)
+    end
+
+    def print(*args)
+      @state.print(*args)
+    end
+
+    # Called when we are about to do a dangerous operation. _msg_
+    # contains a prompt message. Return _true_ if confirmed or _false_
+    # if not confirmed.
+    def confirm(msg)
+      @state.confirm(msg) == 'y'
+    end
+
+    # debug_eval like Kernel.eval or Object.instance_eval but using
+    # the bindings for the debugged program. If there is a
+    # syntax-error like exception in running eval, print an
+    # appropriate message and throw :debug_error
+    def debug_eval(str, b = get_binding)
+      begin
+        val = eval(str, b)
+      rescue StandardError, ScriptError => e
+        if OldCommand.settings[:stack_trace_on_error]
+          at = eval("caller(1)", b)
+          print "%s:%s\n", at.shift, e.to_s.sub(/\(eval\):1:(in `.*?':)?/, '')
+          for i in at
+            print "\tfrom %s\n", i
+          end
+        else
+          print "#{e.class} Exception: #{e.message}\n"
+        end
+        throw :debug_error
+      end
+    end
+
+    # debug_eval like Kernel.eval or Object.instance_eval but using
+    # the bindings for the debugged program. If there is a syntax
+    # error kind of exception in running eval, no warning is given and
+    # nil is returned.
+    def debug_silent_eval(str)
+      begin
+        eval(str, get_binding)
+      rescue StandardError, ScriptError
+        nil
+      end
+    end
+
+    # Return a binding object for the debugged program.
+    def get_binding
+      @state.context.frame_binding(@state.frame_pos)
+    end
+
+    def line_at(file, line)
+      Debugger.line_at(file, line)
+    end
+
+    def get_context(thnum)
+      Debugger.contexts.find{|c| c.thnum == thnum}
+    end  
+  end
+  
+  OldCommand.load_commands
+
+  # Returns setting object.
+  # Use Debugger.settings[] and Debugger.settings[]= methods to query and set
+  # debugger settings. These settings are available:
+  # 
+  # - :autolist - automatically calls 'list' command on breakpoint
+  # - :autoeval - evaluates input in the current binding if it's not recognized as a debugger command
+  # - :autoirb - automatically calls 'irb' command on breakpoint
+  # - :stack_trace_on_error - shows full stack trace if eval command results with an exception
+  # - :frame_full_path - displays full paths when showing frame stack
+  # - :frame_class_names - displays method's class name when showing frame stack
+  # - :reload_source_on_change - makes 'list' command to always display up-to-date source code
+  # - :force_stepping - stepping command asways move to the new line
+  # 
+  def self.settings
+    OldCommand.settings
+  end
+end