trepanning 0.0.8 → 0.0.9

data/NEWS

@@ -1,3 +1,6 @@
+Dec 25, 2010 (0.0.9)
+* Minor fixes. Remove some Ruby warnings
+
 Dec 10, 2010 (0.0.8) Phel. Mad release
 * Show IP in source location
 * Can handle: break *method" *pos* now

data/app/options.rb

@@ -65,7 +65,7 @@ EOB
         end
       end
       opts.on('--nx',
-              "Do not run debugger initialization files (e.g. #{CMD_INITFILE}") do
+              "Do not run debugger initialization file #{CMD_INITFILE}") do
         options[:nx] = true
       end
       # opts.on('--output FILE', String, "Name of file to record output") do |outfile| 

data/app/run.rb

@@ -3,7 +3,7 @@
 require 'rbconfig'
 module Trepanning
 
-  :module_function # All functions below are easily publically accessible
+  module_function # All functions below are easily publically accessible
 
   # Given a Ruby interpreter and program we are to debug, debug it.
   # The caller must ensure that ARGV is set up to remove any debugger
@@ -50,7 +50,6 @@ module Trepanning
   def ruby_path
     File.join(%w(bindir RUBY_INSTALL_NAME).map{|k| RbConfig::CONFIG[k]})
   end
-  module_function :ruby_path
 
   # Do a shell-like path lookup for prog_script and return the results.
   # If we can't find anything return prog_script.

data/interface/script.rb

@@ -24,8 +24,8 @@ class Trepan::ScriptInterface < Trepan::Interface
     at_exit { finalize }
     @script_name     = script_name
     @input_lineno    = 0
-    @input           = Trepan::UserInput.open(script_name,
-                                                :line_edit => false)
+    @input           = opts[:input] || 
+      Trepan::UserInput.open(script_name, :line_edit => false)
     @buffer_output   = []
     unless opts[:verbose] or out
       out = Trepan::StringArrayOutput.open(@buffer_output)

data/lib/trepanning.rb

@@ -20,7 +20,7 @@ ISEQS__        = {} unless
   defined?(ISEQS__) && ISEQS__.is_a?(Hash)
 
 class Trepan
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 
   attr_accessor :core         # access to Trepan::Core instance
   attr_accessor :intf         # Array. The way the outside world

data/processor/breakpoint.rb

@@ -1,5 +1,4 @@
 # Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
-require_relative '../app/core'
 class Trepan
 
   class CmdProcessor
@@ -14,8 +13,8 @@ class Trepan
                                    # If no breakpoint stop this is nil.
 
     def breakpoint_initialize
-      @brkpts          = BreakpointMgr.new
-      @brkpt           = nil
+      @brkpts = BreakpointMgr.new
+      @brkpt  = nil
     end
 
     def breakpoint?
@@ -44,13 +43,13 @@ class Trepan
     end
 
     # Does whatever needs to be done to set a breakpoint
-    def breakpoint_line(line_number, iseq, temp=false)
+    def breakpoint_line(line_number, initial_iseq, temp=false)
       # FIXME: handle breakpoint conditions.
-      found_iseq = iseq.child_iseqs.detect do |iseq|
+      found_iseq = initial_iseq.child_iseqs.detect do |iseq|
         iseq.lineoffsets.keys.member?(line_number) 
       end
       unless found_iseq
-        found_iseq = iseq.parent
+        found_iseq = initial_iseq.parent
         while found_iseq do
           break if found_iseq.lineoffsets.keys.member?(line_number)
           found_iseq = found_iseq.parent

data/processor/command/base/subcmd.rb

@@ -27,6 +27,7 @@ class Trepan
       # which append current settings to list output.
       MIN_ABBREV = 1
       NEED_STACK = false
+      NAME       = 'your_command_name'
     end
 
 
@@ -180,11 +181,12 @@ class Trepan
 
   class ShowIntSubcommand < Subcommand
     def run(args)
-      if self.respond_to?(:short_help)
-        doc = short_help
-      else
-        doc = my_const(:HELP)[5..-2].capitalize
-      end
+      doc = 
+        if self.respond_to?(:short_help)
+          short_help
+        else
+          my_const(:HELP)[5..-2].capitalize
+        end
       run_show_int(doc)
     end
   end

data/processor/command/base/submgr.rb

@@ -28,7 +28,7 @@ class Trepan::SubcommandMgr < Trepan::Command
     @name    = obj_const(self, :NAME)
     @subcmds = Trepan::Subcmd.new(self)
     @proc    = proc
-    load_debugger_subcommands(@name, self)
+    load_debugger_subcommands(self)
   end
 
   # Create an instance of each of the debugger subcommands. Commands
@@ -38,7 +38,7 @@ class Trepan::SubcommandMgr < Trepan::Command
   # inside those files and for each class name, we will create an
   # instance of that class. The set of TrepanCommand class instances
   # form set of possible debugger commands.
-  def load_debugger_subcommands(name, parent)
+  def load_debugger_subcommands(parent)
 
     # Initialization
     cmd_names     = []

data/processor/command/disassemble.rb

@@ -10,7 +10,9 @@ class Trepan::Command::DisassembleCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
-    HELP = <<-HELP
+    ALIASES       = %w(disas disassem) # Note we have disable
+    CATEGORY      = 'data'
+    HELP          = <<-HELP
 #{NAME} [thing] [full]
 
 With no argument, disassemble the current frame.  With a method,
@@ -23,24 +25,21 @@ instruction sequence might have. If 'full' is given, all instruction
 sequences are include.
 
 Examples:
-
-  disassemble 
-  disas .       # Same as above
-  disas . full  # At least the instruction sequence above but maybe more
-  disas require_relative # disassemble method 'require_relative'
+  #{NAME} 
+  #{NAME} .       # Same as above
+  #{NAME} . full  # At least the instruction sequence above but maybe more
+  #{NAME} require_relative # disassemble method 'require_relative'
     HELP
 
-    ALIASES       = %w(disas disassem) # Note we have disable
-    CATEGORY      = 'data'
     NEED_STACK    = true
     SHORT_HELP    = 'Disassemble Ruby VM instructions'
   end
 
   # FIXME: put in processor/data.rb? 
 
-  def marked_disassemble(iseq, include_children)
-    iseqs = include_children ? iseq.child_iseqs : [iseq]
-      iseqs.each do |iseq|
+  def marked_disassemble(iseq_param, include_children)
+    iseqs = include_children ? iseq_param.child_iseqs : [iseq_param]
+    iseqs.each do |iseq|
       ary = mark_disassembly(iseq.disasm_nochildren, 
                              @proc.frame.iseq.equal?(iseq),
                              @proc.frame.pc_offset,

data/processor/command/info_subcmd/file.rb

@@ -65,7 +65,7 @@ If no sub-options are given #{DEFAULT_FILE_ARGS.join(' ')} are assumed.
     elsif !(matches = find_scripts(filename)).empty?
       if (matches.size > 1)
         msg("Multiple files found:")
-        matches.each { |filename| msg("\t%s" % filename) }
+        matches.each { |match_file| msg "\t%s" % match_file }
         return
       else
         msg('File "%s" just now cached.' % filename)
@@ -135,7 +135,7 @@ If no sub-options are given #{DEFAULT_FILE_ARGS.join(' ')} are assumed.
 end
 
 if __FILE__ == $0
-  if  not (ARGV.size == 1 && ARGV[0] == 'noload')
+  if !(ARGV.size == 1 && ARGV[0] == 'noload')
     ISEQS__        = {}
     SCRIPT_ISEQS__ = {}
     ARGV[0..-1]    = ['noload']

data/processor/command/irb.rb

@@ -93,7 +93,7 @@ Here then is a loop to query VM stack values:
     $trepan_in_irb = false
     # restore old trap if any
     trap('SIGINT', save_trap) if save_trap
-   end
+  end
 end
 
 if __FILE__ == $0

data/processor/command/kill.rb

@@ -31,13 +31,13 @@ Examples:
   end
     
   # This method runs the command
-  def run(args)
+  def run(args) # :nodoc
     if args.size > 1
       sig = Integer(args[1]) rescue args[1]
       unless sig.is_a?(Integer) || Signal.list.member?(sig.upcase)
         errmsg("Signal name '#{sig}' is not a signal I know about.\n")
         return false
-        end
+      end
 #       FIXME: reinstate
 #       if 'KILL' == sig || Signal['KILL'] == sig
 #           @proc.intf.finalize

data/processor/command/list.rb

@@ -257,13 +257,13 @@ disabled.
         @proc.line_no = lineno
       end
     rescue => e
-      errmsg e if settings[:debugexcept]
+      errmsg e.to_s if settings[:debugexcept]
     end
   end
 end
 
 if __FILE__ == $0
-  if  not (ARGV.size == 1 && ARGV[0] == 'noload')
+  if !(ARGV.size == 1 && ARGV[0] == 'noload')
     ISEQS__        = {}
     SCRIPT_ISEQS__ = {}
     ARGV[0..-1]    = ['noload']
@@ -275,8 +275,8 @@ if __FILE__ == $0
     dbgr, cmd = MockDebugger::setup
     cmd.proc.send('frame_initialize')
     LineCache::cache(__FILE__)
-    cmd.run(['list'])
-    cmd.run(['list', __FILE__ + ':10'])
+    cmd.run([cmd.name])
+    cmd.run([cmd.name, __FILE__ + ':10'])
 
     def run_cmd(cmd, args)
       seps = '--' * 10

data/processor/command/nocache.rb

@@ -19,7 +19,7 @@ class Trepan::Command::NoCacheCommand < Trepan::Command
     if @proc.frame.iseq
       puts @proc.frame.iseq.disassemble
       count = @proc.frame.iseq.killcache
-      msg ("%d locations removed" % count)
+      msg "%d locations removed" % count
       # puts @proc.frame.iseq.disassemble
     end
   end

data/processor/command/set_subcmd/substitute_subcmd/eval.rb

@@ -47,7 +47,7 @@ We have this here for completeness and just in case.
         @proc.get_frame(count, absolute)[0]
       else
         @proc.frame
-    end
+      end
     return unless frame
     if 'EVAL' != frame.type
       errmsg "Current frame has to be of type EVAL, not #{frame.type}"

data/processor/main.rb

@@ -113,7 +113,7 @@ class Trepan
 
       # Run initialization routines for each of the "submodule"s.
       # load_cmds has to come first.
-      %w(load_cmds breakpoint display eventbuf frame running validate
+      %w(load_cmds breakpoint display eventbuf frame location running validate
          ).each do |submod|
         self.send("#{submod}_initialize")
       end

data/processor/running.rb

@@ -1,5 +1,4 @@
 # Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
-require_relative '../app/core'
 class Trepan
   class CmdProcessor
 

data/test/data/enable.cmd

@@ -0,0 +1,12 @@
+# ********************************************************
+# This tests the enable command.
+# ********************************************************
+set basename off
+break gcd
+# Should have a breakpoint 1
+enable 1
+# An invalid enable command
+enable foo
+quit
+
+

data/test/data/enable.right

@@ -0,0 +1,36 @@
+gcd.rb:4
+def gcd(a, b)
+# # ********************************************************
+# # This tests the enable command.
+# # ********************************************************
+# set debuggertesting on
+Currently testing the debugger is on.
+# set callstyle last
+Frame call-display style is last.
+# set autoeval off
+autoeval is off.
+# break Object.gcd
+Breakpoint 1 at Object::gcd
+# # Should have a breakpoint 1
+# enable br 1
+# # Get help on enable
+# help enable
+Enable some things.
+This is used to cancel the effect of the "disable" command.
+-- 
+List of enable subcommands:
+--  
+enable breakpoints -- Enable specified breakpoints
+enable display -- Enable some expressions to be displayed when program stops
+# # Get help on just enable break
+# help enable break
+Enable specified breakpoints.
+Give breakpoint numbers (separated by spaces) as arguments.
+This is used to cancel the effect of the "disable" command.
+# # Plain enable should work
+# enable
+*** "enable" must be followed "display", "breakpoints" or breakpoint numbers.
+# # An invalid enable command
+# enable foo
+Enable breakpoints argument 'foo' needs to be a number.
+# quit

data/test/data/fname-with-blank.cmd

@@ -0,0 +1,6 @@
+# *******************************************************************
+# Just to see that we can load a filename with an blank in it
+# *******************************************************************
+set basename off
+continue
+

data/test/data/fname-with-blank.right

@@ -0,0 +1 @@
+Ha!

data/test/data/quit.cmd

@@ -0,0 +1,5 @@
+# ***************************************************
+# This tests the quit.
+# ***************************************************
+# FIXME need to test --no-quit.
+quit!

data/test/example/null.rb

@@ -1 +1,2 @@
 # Nothing here. Move along.
+x = 1

data/test/integration/helper.rb

@@ -1,8 +1,18 @@
 require 'diff/lcs'
 require 'fileutils'
+require_relative '../../app/run' # for ruby_path
 
-def run_debugger(testname, ruby_file, dbgr_opts='', args='', outfile=nil)
+DEFAULT_DEBUGGER_OPTS = {
+  :args        => '', 
+  :dbgr        => '', 
+  :outfile     => nil,
+  :short_cmd   => nil,
+  :short_right => nil, 
+  :do_diff     => true,
+}
 
+def run_debugger(testname, ruby_file, opts={})
+  opts       = DEFAULT_DEBUGGER_OPTS.merge(opts)
   srcdir     = File.dirname(__FILE__)
   datadir    = File.join(srcdir, %w(.. data))
   progdir    = File.join(srcdir, %w(.. example)) 
@@ -11,40 +21,49 @@ def run_debugger(testname, ruby_file, dbgr_opts='', args='', outfile=nil)
   dbgr_short = File.join(%w(bin trepan))
   dbgr_path  = File.join(dbgr_dir, dbgr_short)
 
-  rightfile  = File.join(datadir, "#{testname}.right")
+  short_right = "#{opts[:short_right] || testname}.right"
+  rightfile  = File.join(datadir, short_right)
 
-  cmdfile     = File.join(datadir, "#{testname}.cmd" % testname)
-  outfile     = File.join(srcdir,  "#{testname}.out" % testname)
+  short_cmd   = "#{opts[:short_cmd] || testname}.cmd"
+  cmdfile     = File.join(datadir, short_cmd)
+  outfile     = opts[:outfile] ||
+    File.join(srcdir,  "#{testname}.out")
   programfile = ruby_file ? File.join(progdir, ruby_file) : ''
 
   FileUtils.rm(outfile) if File.exist?(outfile)
 
-  cmd = "%s --nx --command %s %s '%s' %s >%s" %
-    [dbgr_path, cmdfile, dbgr_opts, programfile, args, outfile]
+  cmd = "%s %s --nx --command %s %s '%s' %s >%s" %
+    [Trepanning::ruby_path, dbgr_path, cmdfile, opts[:dbgr], 
+     programfile, opts[:args], outfile]
   
   system(cmd)
-  from_file  = rightfile
-  # fromdate  = time.ctime(os.stat(fromfile).st_mtime)
-  from_lines = File.open(from_file).readlines()
-  to_file    = outfile
-  # todate    = time.ctime(os.stat(tofile).st_mtime)
-  to_lines   = File.open(to_file).readlines()
-
-  # Seems to be a bug in LCS in that it will return a diff even if two
-  # files are the same.
-  return true if from_lines == to_lines
-
-  sdiffs = Diff::LCS.sdiff(from_lines, to_lines)
-
-  if sdiffs.empty?
-    FileUtils.rm(outfile)
-  else 
-    puts cmd
-    sdiffs.each do |diff|
-      p diff
+  return false unless 0 == $?.exitstatus 
+  if opts[:do_diff]
+    from_file  = rightfile
+    # fromdate  = time.ctime(os.stat(fromfile).st_mtime)
+    from_lines = File.open(from_file).readlines()
+    to_file    = outfile
+    # todate    = time.ctime(os.stat(tofile).st_mtime)
+    to_lines   = File.open(to_file).readlines()
+    
+    # Seems to be a bug in LCS in that it will return a diff even if two
+    # files are the same.
+    return true if from_lines == to_lines
+    
+    sdiffs = Diff::LCS.sdiff(from_lines, to_lines)
+    
+    if sdiffs.empty?
+      FileUtils.rm(outfile)
+    else 
+      puts cmd
+      sdiffs.each do |diff|
+        p diff
+      end
     end
+    return sdiffs.empty?
+  else
+    return true  # We already tested for false above
   end
-  return sdiffs.empty?
 end
     
 if __FILE__ == $0