trepanning 0.0.6 → 0.0.8

data/io/null_output.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+
+# Nukes output. Used for example in sourcing where you don't want
+# to see output.
+# 
+
+require_relative 'base_io'
+
+class Trepan
+  class OutputNull < Trepan::OutputBase
+    def initialize(out, opts={})
+      super
+    end
+
+    def close
+    end
+
+    def flush
+    end
+
+    # Use this to set where to write to. output can be a 
+    # file object or a string. This code raises IOError on error.
+    def write(*args)
+    end
+
+    # used to write to a debugger that is connected to this
+    # `str' written will have a newline added to it
+    #
+    def writeline( msg)
+    end
+  end
+end
+
+# Demo it
+if __FILE__ == $0
+  output = Trepan::OutputNull.new(nil)
+  p output
+  output.write("Invisible")
+  output.writeline("Invisible")
+end

data/lib/trepanning.rb

@@ -20,7 +20,7 @@ ISEQS__        = {} unless
   defined?(ISEQS__) && ISEQS__.is_a?(Hash)
 
 class Trepan
-  VERSION = '0.0.6'
+  VERSION = '0.0.8'
 
   attr_accessor :core         # access to Trepan::Core instance
   attr_accessor :intf         # Array. The way the outside world
@@ -91,8 +91,6 @@ class Trepan
   # needs to be done first:
   #    require 'trepanning'
   #    mydbg = Trepan.new()
-  # or if you haven't mucked around with $0 and ARGV, you might try:
-  #    mydbg = Trepan.new(:set_restart=>true))
   # which will tell the debugger how to "restart" the program.
   #
   # If you want a synchronous stop in your program call to the
@@ -136,8 +134,7 @@ class Trepan
     th = Thread.current
     if block
       start
-      # I don't think yield or block.call is quite right.
-      ret = yield   # Not: block.call(self) ? 
+      ret = block.call
       stop
       return ret
     elsif opts[:immediate]
@@ -154,7 +151,7 @@ class Trepan
       Trace.event_masks[0] |= @core.step_events
 
       # Set to stop on the next event after this returns.
-      @core.step_count = 0
+      @core.step_count = opts[:step_count] || 0
     end
   end
 
@@ -217,7 +214,7 @@ class Trepan
   # Likewise for mydbg.debugger{ ... }
 
   def self.debug(opts={}, &block)
-    opts = {:hide_stack => true}.merge(opts)
+    opts = {:hide_stack => false}.merge(opts)
     unless defined?($trepanning) && $trepanning.is_a?(Trepan)
       $trepanning = Trepan.new(opts)
       $trepanning.trace_filter << self.method(:debug)
@@ -237,13 +234,13 @@ end
 module Kernel
   # Same as Trepan.debug. 
   # FIXME figure out a way to remove duplication.
-  def trepan(opts={}, &block)
-    opts = {:hide_stack => true}.merge(opts)
+  def debugger(opts={}, &block)
+    opts = {:hide_stack => false}.merge(opts)
     unless defined?($trepanning) && $trepanning.is_a?(Trepan)
-      $trepanning = Trepan.new
-      $trepanning.trace_filter << self.method(:trepan)
+      $trepanning = Trepan.new(opts)
+      $trepanning.trace_filter << self.method(:debugger)
     end
-    $trepanning.debugger(opts, &block)
+    $trepanning.debugger(opts)
   end
 end
 
@@ -254,7 +251,7 @@ if __FILE__ == $0
   puts 'block debugging...'
   # It is imagined that there are all sorts of command-line options here.
   # (I have a good imagination.)
-  Trepan.debug(:set_restart=>true) {
+  Trepan.debug {
     a = 2
     b = square(a)
     p "square of #{a} is #{b}"

data/processor/command/backtrace.rb

@@ -39,17 +39,18 @@ Examples:
       return false
     end
     hide_level  = 
-      if !settings[:debugstack] && @proc.hidelevels[Thread.current] 
+      if (!settings[:hidelevel] || settings[:hidelevel] < 0) && 
+          @proc.hidelevels[Thread.current] 
         @proc.hidelevels[Thread.current] 
-      else 0 
+      else settings[:hidelevel]
       end
     stack_size = @proc.top_frame.stack_size - hide_level
     opts = {
-      :basename    => @proc.settings[:basename],
+      :basename    => settings[:basename],
       :current_pos => @proc.frame_index,
-      :maxstack    => @proc.settings[:maxstack],
-      :maxwidth    => @proc.settings[:maxwidth],
-      :show_pc     => @proc.settings[:show_pc]
+      :maxstack    => settings[:maxstack],
+      :maxwidth    => settings[:maxwidth],
+      :show_pc     => settings[:show_pc]
     }
     opts[:count] = 
       if args.size > 1

data/processor/command/base/subcmd.rb

@@ -60,6 +60,10 @@ class Trepan
       return(@proc.confirm(msg, default))
     end
 
+    def prefix
+      my_const('PREFIX')
+    end
+
     # Set a Boolean-valued debugger setting. 
     def run_set_bool(args, default=true)
       onoff_arg = args.size < 3 ? 'on' : args[2]

data/processor/command/base/submgr.rb

@@ -180,7 +180,7 @@ if __FILE__ == $0
   puts cmd.help(%w(help set))
   puts '=' * 40
   # require_relative '../../../lib/trepanning)
-  # Trepan.debug(:set_restart => true)
+  # Trepan.debug
   puts cmd.help(%w(help set *))
   puts '=' * 40
   puts cmd.help(%w(help set d.*))

data/processor/command/base/subsubmgr.rb

@@ -177,6 +177,6 @@ if __FILE__ == $0
   puts '=' * 40
   # FIXME
   # require_relative '../../lib/trepanning'
-  # Trepan.debug(:set_restart => true)
+  # Trepan.debug
   # puts cmd.help(%w(help info registers p.*))
 end

data/processor/command/break.rb

@@ -7,16 +7,24 @@ class Trepan::Command::BreakCommand < Trepan::Command
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [line number|offset]
+#{NAME} [LINE-NUMBER|OFFSET]
+#{NAME} METHOD [LINE-NUMBER|OFFSET]
 
-With a line number argument, set a break there in the current
-instruction sequence.  With an offset (a number prefaced with an "O")
-set a breakpoint at that instruction offset.
+Set a breakpoint. If a line number is given, a breakpoint is set in
+that line number of the current instruction sequence. If an offset is
+given, a number prefaced with an "O", set a breakpoint at that
+instruction offset.
+
+With method name, a breakpoint it set at the beginning of the method.
+current instruction sequence. Currently you can add a module name in
+front of the method name, like FileUtils.cp, but not a class name like
+Dir.pwd. 
 
 Examples:
    #{NAME}
    #{NAME} 10    # set breakpoint on line 10
    #{NAME} o20   # set breakpoint VM Instruction Sequence offset 20
+   #{NAME} Kernel.pp # Set a breakpoint at the beginning of Kernel.pp
     HELP
 
     ALIASES      = %w(b)

data/processor/command/continue.rb

@@ -14,7 +14,7 @@ the debugger however may occur via breakpoints or explicit calls, or
 exceptions.
 
 If a parameter is given, a temporary breakpoint is set at that position
-before continuing. Offset are numbers preficed with an "O" otherwise
+before continuing. Offset are numbers prefixed with an "O" otherwise
 the parameter is taken as a line number.
 
 Examples:
@@ -23,7 +23,7 @@ Examples:
    #{NAME} o20   # continue to VM Instruction Sequence offset 20
     HELP
 
-    ALIASES      = %w(c)
+    ALIASES      = %w(c cont)
     CATEGORY     = 'running'
     MAX_ARGS     = 1  # Need at most this many
     NEED_RUNNING = true

data/processor/command/delete.rb

@@ -50,6 +50,6 @@ if __FILE__ == $0
   break_cmd = cmds['break']
   break_cmd.run(['break', cmdproc.frame.source_location[0].to_s])
   # require_relative '../../lib/trepanning'
-  # Trepan.debug(:set_restart => true)
+  # Trepan.debug
   cmd.run([cmd.name, '1'])
 end

data/processor/command/disable.rb

@@ -59,6 +59,6 @@ if __FILE__ == $0
   break_cmd = cmds['break']
   break_cmd.run(['break', cmdproc.frame.source_location[0].to_s])
   # require_relative '../../lib/trepanning'
-  # Trepan.debug(:set_restart => true)
+  # Trepan.debug
   cmd.run([cmd.name, '1'])
 end

data/processor/command/disassemble.rb

@@ -44,7 +44,7 @@ Examples:
       ary = mark_disassembly(iseq.disasm_nochildren, 
                              @proc.frame.iseq.equal?(iseq),
                              @proc.frame.pc_offset,
-                             iseq.brkpts)
+                             iseq.brkpts, settings[:maxwidth])
       msg ary
     end
   end

data/processor/command/finish.rb

@@ -18,7 +18,7 @@ reduce the number of stack frames. Also, if a thread is switched, we
 stop ignoring levels.
 
 'next>' is similar in that it stops at a return, but it doesn't
-guarentee the stack level is the same as or less than the current
+guarantee the stack level is the same as or less than the current
 one. 
 
 See the break command if you want to stop at a particular point in a
@@ -32,7 +32,7 @@ while 'break' will have less overhead.
     # Need at most this many. 
     MAX_ARGS     = 1   
     NEED_STACK   = true
-    SHORT_HELP   = 'Step program without entering called functions'
+    SHORT_HELP   = 'Step to end of current method (step out)'
   end
 
   # This method runs the command
@@ -45,7 +45,7 @@ while 'break' will have less overhead.
       count_str = args[1]
       opts = {
         :msg_on_error => 
-        "The 'next' command argument must eval to an integer. Got: %s" % 
+        "The '#{NAME}' command argument must eval to an integer. Got: %s" % 
         count_str,
         :min_value => 1
       }

data/processor/command/info_subcmd/iseq.rb

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subcmd'
+require 'pp'
 
 class Trepan::Subcommand::InfoIseq < Trepan::Subcommand
   unless defined?(HELP)
@@ -54,6 +55,14 @@ Examples:
       else
         msg("Breakpoints have not been allocated.")
       end
+      if iseq.compile_options
+        msg "\nCompile options:"
+        msg iseq.compile_options.pretty_inspect
+      end
+      if iseq.source
+        msg "Source string:"
+        msg @proc.safe_rep(iseq.source.inspect)
+      end
     else
       mess = "Can't find instruction sequence"
       mess += " for #{args.join(' ')}" unless args.empty?

data/processor/command/info_subcmd/registers_subcmd/dfp.rb

@@ -6,10 +6,10 @@ require_relative 'helper'
 class Trepan::Subcommand::InfoRegistersDfp < Trepan::SubSubcommand
   unless defined?(HELP)
     HELP         = 'Show the value of the VM dynamic frame pointer (DFP)'
-    MIN_ABBREV   = 'lf'.size
+    MIN_ABBREV   = 'df'.size
     NAME         = File.basename(__FILE__, '.rb')
     NEED_STACK   = true
-    PREFIX       = %w(info registers dfp)
+    PREFIX       = %W(info registers #{NAME})
   end
 
   include Registers
@@ -21,18 +21,9 @@ end
 if __FILE__ == $0
   # Demo it.
   require_relative '../../../mock'
-  require_relative '../../../subcmd'
-  name = File.basename(__FILE__, '.rb')
-
-  # FIXME: DRY the below code
-  dbgr, info_cmd = MockDebugger::setup('info')
-  testcmdMgr = Trepan::Subcmd.new(info_cmd)
-  cmd_name   = Trepan::SubSubcommand::InfoRegistersDfp::PREFIX.join('')
-  infox_cmd  = Trepan::SubSubcommand::InfoRegistersDfp.new(info_cmd.proc,
-                                                           info_cmd,
-                                                           cmd_name)
-  infox_cmd.run([])
-
-  # name = File.basename(__FILE__, '.rb')
-  # subcommand.summary_help(name)
+  require_relative '../registers'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::InfoRegisters,
+                                   Trepan::SubSubcommand::InfoRegistersDfp,
+                                   false)
+  cmd.run(['0'])
 end

data/processor/command/info_subcmd/registers_subcmd/lfp.rb

@@ -34,21 +34,9 @@ end
 if __FILE__ == $0
   # Demo it.
   require_relative '../../../mock'
-  require_relative '../../../subcmd'
-  name = File.basename(__FILE__, '.rb')
-
-  # FIXME: DRY the below code
-  dbgr, info_cmd = MockDebugger::setup('info')
-  testcmdMgr = Trepan::Subcmd.new(info_cmd)
-  cmd_name   = Trepan::SubSubcommand::InfoRegistersSp::PREFIX.join('')
-  infox_cmd  = Trepan::SubSubcommand::InfoRegistersSp.new(info_cmd.proc,
-                                                          info_cmd,
-                                                          cmd_name)
-  # require_relative '../../../../lib/trepanning'
-  # dbgr = Trepan.new(:set_restart => true)
-  # dbgr.debugger
-  infox_cmd.run([])
-
-  # name = File.basename(__FILE__, '.rb')
-  # subcommand.summary_help(name)
+  require_relative '../registers'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::InfoRegisters,
+                                   Trepan::SubSubcommand::InfoRegistersLfp,
+                                   false)
+  cmd.run([])
 end

data/processor/command/info_subcmd/registers_subcmd/pc.rb

@@ -13,7 +13,7 @@ See also "info disassemble" and "info registers".'
     MIN_ABBREV   = 'pc'.size
     NAME         = File.basename(__FILE__, '.rb')
     NEED_STACK   = true
-    PREFIX       = %w(info registers pc)
+    PREFIX       = %W(info registers #{NAME})
   end
 
   def run(args)
@@ -22,23 +22,10 @@ See also "info disassemble" and "info registers".'
 end
 
 if __FILE__ == $0
-  # Demo it.
   require_relative '../../../mock'
-  require_relative '../../../subcmd'
-  name = File.basename(__FILE__, '.rb')
-
-  # FIXME: DRY the below code
-  dbgr, info_cmd = MockDebugger::setup('info')
-  testcmdMgr = Trepan::Subcmd.new(info_cmd)
-  cmd_name   = Trepan::SubSubcommand::InfoRegistersPc::PREFIX.join('')
-  infox_cmd  = Trepan::SubSubcommand::InfoRegistersPc.new(info_cmd.proc, 
-                                                          info_cmd,
-                                                          cmd_name)
-  # require_relative '../../../../trepanning'
-  # dbgr = Trepan.new(:set_restart => true)
-  # dbgr.debugger
-  infox_cmd.run([])
-
-  # name = File.basename(__FILE__, '.rb')
-  # subcommand.summary_help(name)
+  require_relative '../registers'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::InfoRegisters,
+                                   Trepan::SubSubcommand::InfoRegistersPc,
+                                   false)
+  cmd.run([])
 end

data/processor/command/info_subcmd/registers_subcmd/sp.rb

@@ -5,10 +5,10 @@ require_relative 'helper'
 
 class Trepan::Subcommand::InfoRegistersSp < Trepan::SubSubcommand
   unless defined?(HELP)
-    HELP         = 'Show information about the VM stack pointer (SP).
-
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<EOH
 usage: 
-   info register sp [NUMBER NUMBER ...|size]
+   info register #{NAME} [NUMBER NUMBER ...|size]
 
 With no arguments, all SP values for the current frame of the debugged
 program are shown.  If a number is given, then the entry at that
@@ -21,12 +21,12 @@ a stack pointed to by SP. Just before the addition is perofrmed, sp(1)
 will have the value "a" contians and sp(2) will contain the value of
 "b"
 
-See also "info register LFP"'
+See also "info register LFP"
+EOH
 
     MIN_ABBREV   = 'sp'.size
-    NAME         = File.basename(__FILE__, '.rb')
     NEED_STACK   = true
-    PREFIX       = %w(info registers sp)
+    PREFIX       = %W(info registers #{NAME})
   end
 
   include Registers
@@ -48,28 +48,18 @@ end
 if __FILE__ == $0
   # Demo it.
   require_relative '../../../mock'
-  require_relative '../../../subcmd'
-  name = File.basename(__FILE__, '.rb')
-
-  # FIXME: DRY the below code
-  dbgr, info_cmd = MockDebugger::setup('info')
-  testcmdMgr = Trepan::Subcmd.new(info_cmd)
-  cmd_name   = Trepan::SubSubcommand::InfoRegistersSp::PREFIX.join('')
-  infox_cmd  = Trepan::SubSubcommand::InfoRegistersSp.new(info_cmd.proc, 
-                                                          info_cmd,
-                                                          cmd_name)
-  infox_cmd.summary_help(name)
-  puts
+  require_relative '../registers'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::InfoRegisters,
+                                   Trepan::SubSubcommand::InfoRegistersSp,
+                                   false)
   # require_relative '../../../../lib/trepanning'
-  # dbgr = Trepan.new(:set_restart => true)
+  # dbgr = Trepan.new
   # dbgr.debugger
-  infox_cmd.run([])
+  cmd.run([])
   puts
   %w(0 1 10).each do |val|
-    infox_cmd.run([val])
+    cmd.run([val])
     puts '-' * 40
   end
-  infox_cmd.run(['size'])
-
-  name = File.basename(__FILE__, '.rb')
+  cmd.run(['size'])
 end