trepanning 0.1.2 → 0.1.3

data/processor/main.rb

@@ -12,7 +12,7 @@ end
 require_relative '../app/brkptmgr'
 
 class Trepan
-  class CmdProcessor
+  class CmdProcessor < VirtualCmdProcessor
 
     # SEE ALSO attr's in require_relative's of loop above.
 
@@ -48,6 +48,8 @@ class Trepan
     attr_accessor :prompt          # String print before requesting input
     attr_reader   :settings        # Hash[:symbol] of command
                                    # processor settings
+    
+    attr_accessor :traced_vars     # list of traced global variables
 
     # The following are used in to force stopping at a different line
     # number. FIXME: could generalize to a position object.
@@ -91,6 +93,7 @@ class Trepan
       @debug_nest      = 1
       @dbgr            = core.dbgr
       @hidelevels      = {}
+      @interfaces      = @dbgr.intf
       @last_command    = nil
       @last_pos        = [nil, nil, nil, nil, nil, nil]
       @next_level      = 32000
@@ -100,6 +103,7 @@ class Trepan
       start_file       = settings.delete(:start_file)
 
       @settings        = DEFAULT_SETTINGS.merge(settings)
+      @traced_vars     = {}
       @different_pos   = @settings[:different]
 
       # FIXME: Rework using a general "set substitute file" command and
@@ -119,7 +123,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 location running validate
+      %w(load_cmds breakpoint display eventbuf frame running validate
          ).each do |submod|
         self.send("#{submod}_initialize")
       end
@@ -206,7 +210,6 @@ class Trepan
             @last_command = nil
             print_location
           else
-            msg "That's all folks..."
             ## FIXME: think of something better.
             quit('quit!')
             return true
@@ -226,6 +229,24 @@ class Trepan
       @event = @core.event
 
       @unconditional_prehooks.run
+      
+      if 'trace-var' == @event 
+        variable_name, value = @core.hook_arg
+        action = @traced_vars[variable_name]
+        msg "trace: #{variable_name} = #{value}"
+        case action
+        when nil
+          errmsg "No action recorded for variable. Using 'stop'."
+        when 'stop'
+          msg "Note: we are stopped *after* the above location."
+        when 'nostop'
+          print_location
+          return
+        else
+          errmsg "Internal error: unknown trace_var action #{action}"
+        end
+      end
+
       if breakpoint?
         @last_pos = [@frame.source_container, frame_line,
                      @stack_size, @current_thread, @event, 
@@ -237,13 +258,10 @@ class Trepan
       @prompt = compute_prompt
 
       @leave_cmd_loop = false
-      print_location unless @settings[:traceprint]
-      if 'trace-var' == @event 
-        msg "Note: we are stopped *after* the above location."
-      end
 
+      print_location unless @settings[:traceprint]
       @eventbuf.add_mark if @settings[:tracebuffer]
-
+ 
       @cmdloop_prehooks.run
       while not @leave_cmd_loop do
         begin
@@ -255,7 +273,7 @@ class Trepan
           # If we are inside the script interface errmsg may fail.
           begin
             errmsg("Internal debugger error: #{exc.inspect}")
-          rescue
+          rescue IOError
             $stderr.puts "Internal debugger error: #{exc.inspect}"
           end
           exception_dump(exc, @settings[:debugexcept], $!.backtrace)
@@ -278,7 +296,7 @@ class Trepan
         commands = current_command.split(';;')
         if commands.size > 1
           current_command = commands.shift
-          @cmd_queue.unshift *commands
+          @cmd_queue.unshift(*commands)
         end
         args = current_command.split
         # Expand macros. FIXME: put in a procedure
@@ -309,7 +327,10 @@ class Trepan
           else
             @cmd_name
           end
-            
+        
+        run_cmd_name = uniq_abbrev(@commands.keys, run_cmd_name) if
+          !@commands.member?(run_cmd_name) && @settings[:abbrev]
+          
         if @commands.member?(run_cmd_name)
           cmd = @commands[run_cmd_name]
           if ok_for_running(cmd, run_cmd_name, args.size-1)
@@ -324,17 +345,24 @@ class Trepan
       # Eval anything that's not a command or has been
       # requested to be eval'd
       if settings[:autoeval] || eval_command
-        ## eval_code(current_command, @settings[:maxstring])
-        msg 'D=> ' + debug_eval(current_command).inspect
-      else
-        undefined_command(cmd_name)
+        # eval_code(current_command, @settings[:maxstring])
+        begin
+          msg 'D=> ' + debug_eval_with_exception(current_command).inspect
+          return false
+        rescue NameError
+        end
       end
+      undefined_command(cmd_name)
       return false
     end
 
     # Error message when a command doesn't exist
     def undefined_command(cmd_name)
-      errmsg('Undefined command: "%s". Try "help".' % cmd_name)
+      begin 
+        errmsg('Undefined command: "%s". Try "help".' % cmd_name)
+      rescue
+        $stderr.puts 'Undefined command: "%s". Try "help".' % cmd_name
+      end
     end
 
     # FIXME: Allow access to both Trepan::CmdProcessor and Trepan

data/processor/mock.rb

@@ -129,17 +129,6 @@ module MockDebugger
 
 end
 
-# To get Trepan::CmdProcessor defined and with the 
-# with the correct initialize parameters.
-class Trepan
-  class << CmdProcessor
-    def initialize(core, settings={})
-      @core            = core
-      @settings        = settings
-    end
-  end
-end
-
 if __FILE__ == $0
   dbgr = MockDebugger::MockDebugger.new
   p dbgr.settings

data/processor/msg.rb

@@ -1,8 +1,10 @@
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # I/O related command processor methods
 require_relative '../app/util'
+require_relative 'virtual'
 class Trepan
-  class CmdProcessor
+  class CmdProcessor < VirtualCmdProcessor
+
     attr_accessor :ruby_highlighter
 
     def errmsg(message, opts={})

data/processor/running.rb

@@ -1,6 +1,7 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'virtual'
 class Trepan
-  class CmdProcessor
+  class CmdProcessor < VirtualCmdProcessor
 
     attr_accessor :stop_condition  # String or nil. When not nil
                                    # this has to eval non-nil

data/processor/validate.rb

@@ -3,19 +3,25 @@
 # Trepan command input validation routines.  A String type is
 # usually passed in as the argument to validation routines.
 
+require 'rubygems'
+require 'linecache'
+
+require_relative '../app/cmd_parse'
 require_relative '../app/condition'
 require_relative '../app/file'
-require_relative '../app/cmd_parse'
 require_relative '../app/thread'
 
 require_relative 'location' # for resolve_file_with_dir
 require_relative 'msg'      # for errmsg, msg
+require_relative 'virtual'
 
 class Trepan
-  class CmdProcessor
+  class CmdProcessor < VirtualCmdProcessor
 
     attr_reader :dbgr_script_iseqs
     attr_reader :dbgr_iseqs
+    attr_reader :file_exists_proc  # Like File.exists? but checks using
+                                   # cached files
 
     include Trepanning
     include Trepan::ThreadHelper
@@ -166,6 +172,7 @@ class Trepan
           return [nil, nil]
         end
       when :offset
+        position = position.position unless position.kind_of?(Fixnum)
         if ary=iseq.offset2lines(position)
           line_no   = ary.first
           vm_offset = position
@@ -269,7 +276,7 @@ class Trepan
         begin
           meth_for_parse_struct(meth, start_binding)
         rescue NameError
-          errmsg("Can't evalute #{meth.name} to get a method")
+          errmsg("Can't evaluate #{meth.name} to get a method")
           return nil
         end
       end
@@ -290,7 +297,7 @@ class Trepan
       info = parse_location(info) if info.kind_of?(String)
       case info.container_type
       when :fn
-        if meth = method?(info.container)
+        if (meth = method?(info.container)) && meth.iseq
           return [meth, meth.iseq.source_container[1], info.position, 
                   info.position_type]
         else
@@ -327,6 +334,20 @@ class Trepan
     def validate_initialize
       ## top_srcdir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
       ## @dbgr_script_iseqs, @dbgr_iseqs = filter_scripts(top_srcdir)
+      @file_exists_proc = Proc.new {|filename|
+        if LineCache.cached?(filename) || LineCache.cached_script?(filename) ||
+            (File.readable?(filename) && !File.directory?(filename))
+          true
+        else
+          matches = find_scripts(filename)
+          if matches.size == 1 
+            LineCache.remap_file(filename, matches[0])
+            true
+          else
+            false
+          end
+        end
+      }
     end
   end
 end

data/processor/virtual.rb

@@ -0,0 +1,32 @@
+# The class serves as the parent for Trepan::CmdProcessor which is
+# quite large and spans over several files. By declaring "initialize"
+# below, we have a consistent initialization routine and many of the
+# others don't need to define "initialize".
+
+# Also, simple versions of the I/O routines make it possible
+# to do testing without having to bring in the whole "Interface"
+# and I/O routines that trepanning (and "main.rb") use.
+
+# Note that via this file we can change 'class Trepan' to 'module
+# Trepan' or vice versa. So this takes effect on all of the places
+# which subclass this. They use class Trepan::CmdProcessor <
+# Trepan::VirtualCmdProcessor rather than breaking this down into to
+# parts as below.
+class Trepan
+  class VirtualCmdProcessor
+    attr_reader :settings
+    def initialize(core, settings={})
+      @core            = core
+      @settings        = settings
+    end
+    def errmsg(message)
+      puts "Error: #{message}"
+    end
+    def msg(message)
+      puts message
+    end
+    def section(message, opts={})
+      puts "Section: #{message}"
+    end
+  end
+end

data/test/data/debugger-stop.right

@@ -3,3 +3,4 @@ Foo::five
 (trepan): Program stop event: line; PC offset 100 <top debugger-stop.rb>
 -- debugger-stop.rb:10 @1954)
 5
+trepan: That's all, folks...

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

@@ -1 +1,2 @@
 -> (fname with blank.rb:1 @0)
+trepan: That's all, folks...

data/test/example/gcd.rb

@@ -3,6 +3,7 @@
 # GCD. We assume positive numbers
 def gcd(a, b)
   # Make: a <= b
+  debugger
   if a > b
     a, b = [b, a]
   end

data/test/functional/{test-trace-var.rb → test-watchg.rb}

@@ -4,14 +4,19 @@ require 'trace'
 require_relative 'fn_helper'
 
 # See that we hande "set trace var" properly
-class TestTraceVar < Test::Unit::TestCase
+class TestWatchG < Test::Unit::TestCase
 
   include FnTestHelper
   include Trace
 
   def test_basic
 
-    cmds = ['set trace var $my_var', 'continue', 'continue', 'continue']
+    cmds = ['watchg $my_var', 
+            'watchg $my_var',
+            'continue', 'continue', 
+            'watchg $my_var off',
+            'watchg $my_var off',
+            'continue']
     d = strarray_setup(cmds)
     d.core.step_events = TEST_STEP_EVENT_MASK
 
@@ -26,13 +31,19 @@ class TestTraceVar < Test::Unit::TestCase
     d.stop
     out = ['-- ',
            'x = 1',
-           'Tracing variable $my_var.',
+           'Tracing for variable $my_var set to: stop.',
+           '** global variable $my_var is already traced with stop.',
+           'trace: $my_var = 5',
+           'Note: we are stopped *after* the above location.',
            '$V ',
            '$my_var = 5',
+           'trace: $my_var = 6',
            'Note: we are stopped *after* the above location.',
            '$V ',
            '$my_var = 6',
-           'Note: we are stopped *after* the above location.',
+           'Removed trace for variable $my_var.',
+           'Warning: variable $my_var is not currently marked as traced.',
+           'Removed trace for variable $my_var.'
           ]
     compare_output(out, d, cmds)
     end

data/test/unit/cmd-helper.rb

@@ -2,11 +2,8 @@ require 'test/unit'
 require 'thread_frame'
 require_relative '../../app/core'
 require_relative '../../app/mock'
-require_relative '../../processor/main' # Have to include before frame!
-                                        # FIXME
 require_relative '../../processor/frame'
 
-
 module UnitHelper
 
   def common_setup

data/test/unit/test-app-cmd_parser.rb

@@ -4,7 +4,7 @@ require_relative '../../app/cmd_parser'
 
 class TestAppCmdParser < Test::Unit::TestCase
   def setup
-    @cp = CmdParse.new('', true)
+    @cp = CmdParse.new('', :debug=>true)
   end
 
   def test_parse_filename
@@ -14,7 +14,7 @@ class TestAppCmdParser < Test::Unit::TestCase
      ['this\ is\ another\ filename', 'this is another filename'],
      ['C\:filename', 'C:filename']
     ].each do |name, expect|
-      @cp.setup_parser(name, true)
+      @cp.setup_parser(name, :debug => true)
       res = @cp._filename
       assert_equal(expect, @cp.result)
     end

data/test/unit/test-app-file.rb

@@ -12,6 +12,7 @@ if defined?(ISEQS__) && ISEQS__.is_a?(Hash)
 else  
   ISEQS__ = {}
 end
+SCRIPT_LINES__={} unless defined?(SCRIPT_LINES__)
 
 # To have something to work with.
 load 'tmpdir.rb'

data/test/unit/test-app-frame.rb

@@ -40,7 +40,7 @@ class TestAppFrame < Test::Unit::TestCase
 
   def test_return
     assert_equal(1, offset_for_return('return'))
-    assert_equal(2, offset_for_return('c-return'))
+    assert_equal(4, offset_for_return('c-return'))
     assert_raises RuntimeError do
       offset_for_return('c-call')
     end

data/test/unit/test-app-util.rb

@@ -12,4 +12,25 @@ class TestAppUtil < Test::Unit::TestCase
     string = "'The time has come to talk of many things.'"
     assert_equal("'The tim... things.'", safe_repr(string, 17))
   end
+
+  def test_abbrev
+    list = %w(disassemble disable distance up)
+    [['dis', 'dis'],
+     ['disas', 'disassemble'],
+     ['u', 'up'],
+     ['upper', 'upper'],
+     ['foo', 'foo']].each do |name, expect|
+      assert_equal expect, uniq_abbrev(list, name)
+    end
+  end
+
+  def test_extract_expression
+    [['if condition("if")',        'condition("if")'],
+     ['until until_termination',   'until_termination'],
+     ['return return_value',       'return_value'],
+     ['nothing_to_be.done',         'nothing_to_be.done'],
+    ].each do |stmt, expect|
+      assert_equal expect, extract_expression(stmt)
+    end
+  end
 end

data/test/unit/test-base-cmd.rb

@@ -2,12 +2,10 @@
 require 'test/unit'
 require_relative '../../processor/command/base/cmd'
 
-class Trepan
-  class Command::Test < Trepan::Command
-    NAME = 'test'
-    CATEGORY = 'testcategory'
-    completion %w(a aa ab ba aac)
-  end
+class Trepan::Command::Test < Trepan::Command
+  NAME = 'test'
+  CATEGORY = 'testcategory'
+  completion %w(a aa ab ba aac)
 end
 
 class TestBaseCommand < Test::Unit::TestCase