trepanning 0.0.9 → 0.1.0

data/processor/default.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../app/default'
 class Trepan
   class CmdProcessor
@@ -23,6 +23,7 @@ class Trepan
                                    # nil or -1 means compute value. 0
                                    # means hide none. Less than 0 means show
                                    # all stack entries.
+      :hightlight    => false,     # Use terminal highlight? 
       :maxlist       => 10,        # Number of source lines to list 
       :maxstack      => 10,        # backtrace limit
       :maxstring     => 150,       # Strings which are larger than this
@@ -36,7 +37,7 @@ class Trepan
       :timer         => false,     # show elapsed time between events
       :traceprint    => false,     # event tracing printing
       :tracebuffer   => false,     # save events to a trace buffer.
-      :user_cmd_dir  => File.join(Trepanning::HOME_DIR, 'trepan', 'command'),
+      :user_cmd_dir  => File.join(Trepan::HOME_DIR, 'tepanx', 'command'),
                                    # User command directory
     } 
   end

data/processor/load_cmds.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # Trepan::CmdProcess that loads up debugger commands from builtin and
 # user directories.
 # Sets @commands, @aliases, @macros
@@ -29,28 +29,48 @@ class Trepan
     # 'command' directory. Then a new instance of each class of the 
     # form Trepan::xxCommand is added to @commands and that array
     # is returned.
+    def load_debugger_commands(file_or_dir)
+      if File.directory?(file_or_dir)
+        Dir.glob(File.join(file_or_dir, '*.rb')).each do |rb| 
+          # We use require so that multiple calls have no effect.
+          require rb
+        end
+      elsif File.readable?(file_or_dir)
+        # We use load in case we are reloading. 
+        # 'require' would not be effective here
+        load file_or_dir
+      else
+        return false
+      end
+      Trepan::Command.constants.grep(/.Command$/).each do |command|
+        setup_command(command)
+      end
+      return true
+    end
 
-    def load_debugger_commands(cmd_dir)
-      Dir.glob(File.join(cmd_dir, '*.rb')).each do |rb| 
-        require rb
-      end if File.directory?(cmd_dir)
-      # Instantiate each Command class found by the above require(s).
-      ### p Trepan::Command.constants ## REMOVE ME
+    def load_debugger_command(command_file)
+      return unless File.readable?(command_file)
+      load command_file
       Trepan::Command.constants.grep(/.Command$/).each do |command|
-        # Note: there is probably a non-eval way to instantiate the
-        # command, but I don't know it. And eval works.
-        new_cmd = "Trepan::Command::#{command}.new(self)"
-        cmd = self.instance_eval(new_cmd)
+        setup_command(command)
+      end
+    end
 
-        # Add to list of commands and aliases.
-        cc = cmd.class
-        cmd_name = cc.const_get(:NAME)
-        if cc.constants.member?(:ALIASES)
-          aliases= cc.const_get(:ALIASES)  
-          aliases.each {|a| @aliases[a] = cmd_name}
-        end
-        @commands[cmd_name] = cmd
+    # Instantiate a Trepan::Command and extract info: the NAME, ALIASES
+    # and store the command in @commands.
+    def setup_command(command)
+      # Note: there is probably a non-eval way to instantiate the
+      # command, but I don't know it. And eval works.
+      klass = self.instance_eval("Trepan::Command::#{command}")
+      cmd = klass.send(:new, self)
+      
+      # Add to list of commands and aliases.
+      cmd_name = klass.const_get(:NAME)
+      if klass.constants.member?(:ALIASES)
+        aliases= klass.const_get(:ALIASES)  
+        aliases.each {|a| @aliases[a] = cmd_name}
       end
+      @commands[cmd_name] = cmd
     end
 
     # Looks up cmd_array[0] in @commands and runs that. We do lots of 

data/processor/location.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'linecache'
 require_relative 'msg'
 require_relative '../app/frame'
@@ -42,15 +42,18 @@ class Trepan
     # Get line +line_number+ from file named +filename+. Return ''
     # if there was a problem. Leading blanks are stripped off.
     def line_at(filename, line_number) # :nodoc:
-      line = LineCache::getline(filename, line_number, @reload_on_change)
+      opts = {
+        :reload_on_change => @reload_on_change,
+        :output => @settings[:highlight]
+      }
+      line = LineCache::getline(filename, line_number, opts)
 
       unless line
         # Try using search directories (set with command "directory")
         if filename[0..0] != File::SEPARATOR
           try_filename = resolve_file_with_dir(filename) 
           if try_filename && 
-              line = LineCache::getline(try_filename, line_number, 
-                                        @reload_on_change)
+              line = LineCache::getline(try_filename, line_number, opts)
             LineCache::remap_file(filename, try_filename)
           end
         end
@@ -61,7 +64,7 @@ class Trepan
     def loc_and_text(loc, frame, line_no, source_container)
       found_line = true
       ## FIXME: condition is too long.
-      if source_container[0] == 'string' && frame.iseq && frame.iseq.source
+      if source_container[0] == 'string' && frame.iseq && frame.iseq.eval_source
         file = LineCache::map_iseq(frame.iseq)
         text = LineCache::getline(frame.iseq, line_no)
         loc += " remapped #{canonic_file(file)}:#{line_no}"
@@ -138,8 +141,9 @@ class Trepan
       filename  = source_container[1]
       ## FIXME: condition is too long.
       canonic_filename = 
-        if 'string' == source_container[0] && frame.iseq && frame.iseq.source
-          eval_str = frame.iseq.source
+        if 'string' == source_container[0] && frame.iseq && 
+            frame.iseq.eval_source
+          eval_str = frame.iseq.eval_source
           'eval "' + safe_repr(eval_str.gsub(/\n/,';'), 15) + '"'
         else
           canonic_file(filename)

data/processor/main.rb

@@ -1,8 +1,7 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # The main "driver" class for a command processor. Other parts of the 
 # command class and debugger command objects are pulled in from here.
 
-require 'linecache'
 require 'set'
 require 'pathname'  # For cleanpath
 
@@ -22,6 +21,7 @@ class Trepan
                                    # This is current_command with the command
                                    # name removed from the beginning.
     attr_reader   :cmd_name        # command name before alias or macro resolution
+    attr_reader   :cmd_queue       # queue of commands to run
     attr_reader   :core            # Trepan core object
     attr_reader   :current_command # Current command getting run, a String.
     attr_reader   :dbgr            # Trepan instance (via
@@ -59,6 +59,7 @@ class Trepan
       # Event icons used in printing locations.
       EVENT2ICON = {
         'brkpt'          => 'xx',
+        'tbrkpt'         => 'x1',
         'c-call'         => 'C>',
         'c-return'       => '<C',
         'call'           => '->',
@@ -81,6 +82,7 @@ class Trepan
     end
 
     def initialize(core, settings={})
+      @cmd_queue       = []
       @core            = core
       @debug_nest      = 1
       @dbgr            = core.dbgr
@@ -93,7 +95,7 @@ class Trepan
       start_cmds       = settings.delete(:start_cmds)
       start_file       = settings.delete(:start_file)
 
-      @settings        = settings.merge(DEFAULT_SETTINGS)
+      @settings        = DEFAULT_SETTINGS.merge(settings)
       @different_pos   = @settings[:different]
 
       # FIXME: Rework using a general "set substitute file" command and
@@ -167,13 +169,19 @@ class Trepan
 
     # Run one debugger command. True is returned if we want to quit.
     def process_command_and_quit?()
-      intf = @dbgr.intf
-      return true if intf[-1].input.eof? && intf.size == 1
-      while !intf[-1].input.eof? || intf.size > 1
+      intf_size = @dbgr.intf.size
+      intf  = @dbgr.intf[-1]
+      return true if intf.input_eof? && intf_size == 1
+      while intf_size > 1 || !intf.input_eof?
         begin
-          @current_command = read_command().strip
+          @current_command = 
+            if @cmd_queue.empty?
+              read_command.strip
+            else
+              @cmd_queue.shift
+            end
           if @current_command.empty? 
-            if @last_command && intf[-1].interactive?
+            if @last_command && intf.interactive?
               @current_command = @last_command 
             else
               next
@@ -181,13 +189,15 @@ class Trepan
           end
           next if @current_command[0..0] == '#' # Skip comment lines
           break
-        rescue IOError, Errno::EPIPE
-          if @dbgr.intf.size > 1
-            @dbgr.intf.pop 
+        rescue IOError, Errno::EPIPE => e
+          if intf_size > 1
+            @dbgr.intf.pop
+            intf_size = @dbgr.intf.size
+            intf = @dbgr.intf[-1]
             @last_command = nil
             print_location
           else
-            msg "EOF - Leaving"
+            msg "That's all folks..."
             ## FIXME: think of something better.
             quit('quit!')
             return true
@@ -230,7 +240,7 @@ class Trepan
           @dbgr.stop
           raise
         rescue Exception => exc
-          msg("Internal debugger error: #{exc.inspect}")
+          errmsg("Internal debugger error: #{exc.inspect}")
           exception_dump(exc, @settings[:debugexcept], $!.backtrace)
         end
       end
@@ -248,16 +258,22 @@ class Trepan
         end
 
       unless eval_command
-        # Expand macros. FIXME: put in a procedure
+        commands = current_command.split(';;')
+        if commands.size > 1
+          current_command = commands.shift
+          @cmd_queue.unshift *commands
+        end
         args = current_command.split
+        # Expand macros. FIXME: put in a procedure
         while true do
           macro_cmd_name = args[0]
           return false if args.size == 0
           break unless @macros.member?(macro_cmd_name)
           current_command = @macros[macro_cmd_name].call(*args[1..-1])
           msg current_command if settings[:debugmacro]
+          # FIXME: should handle nested Array as a new command.
           if current_command.is_a?(Array) && 
-              current_command.any {|val| !val.is_a?(String)}
+              current_command.all? {|val| val.is_a?(String)}
             args = current_command
           elsif current_command.is_a?(String)
             args = current_command.split

data/processor/mock.rb

@@ -1,8 +1,10 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # Mock setup for commands.
 require_relative 'main'
+
 require_relative '../app/core'
 require_relative '../app/default'
+require_relative '../app/frame'
 require_relative '../interface/user'  # user interface (includes I/O)
 
 SCRIPT_ISEQS__ = {} unless 
@@ -14,6 +16,7 @@ module MockDebugger
   class MockDebugger
     attr_accessor :trace_filter # Procs/Methods we ignore.
 
+    attr_accessor :frame        # Actually a "Rubinius::Location object
     attr_accessor :core         # access to Debugger::Core instance
     attr_accessor :intf         # The way the outside world interfaces with us.
     attr_reader   :initial_dir  # String. Current directory when program
@@ -21,10 +24,16 @@ module MockDebugger
     attr_accessor :restart_argv # How to restart us, empty or nil. 
                                 # Note restart[0] is typically $0.
     attr_reader   :settings     # Hash[:symbol] of things you can configure
+    attr_accessor :processor
+
+    # FIXME: move more stuff of here and into Trepan::CmdProcessor
+    # These below should go into Trepan::CmdProcessor.
+    attr_reader :cmd_argstr, :cmd_name, :vm_locations, :current_frame, 
+                :debugee_thread
 
     def initialize(settings={})
       @before_cmdloop_hooks = []
-      @settings             = Trepanning::DEFAULT_SETTINGS.merge(settings)
+      @settings             = Trepan::DEFAULT_SETTINGS.merge(settings)
       @intf                 = [Trepan::UserInterface.new]
       @core                 = Trepan::Core.new(self)
       @trace_filter         = []
@@ -34,6 +43,9 @@ module MockDebugger
 
     end
 
+    def frame(num)
+      @frames[num] ||= Trepan::Frame.new(self, num, @vm_locations[num])
+    end
   end
 
   # Common Mock debugger setup 
@@ -55,17 +67,20 @@ module MockDebugger
     cmd.proc.frame_setup(RubyVM::ThreadFrame::current.prev)
     show_special_class_constants(cmd) if show_constants
 
+    def cmd.confirm(prompt, default)
+      true
+    end
+    def cmd.errmsg(message)
+      puts "Error: #{message}"
+    end
     def cmd.msg(message)
       puts message
     end
     def cmd.msg_nocr(message)
       print message
     end
-    def cmd.errmsg(message)
-      puts "Error: #{message}"
-    end
-    def cmd.confirm(prompt, default)
-      true
+    def cmd.section(message, opts={})
+      puts "Section: #{message}"
     end
 
     return dbgr, cmd

data/processor/msg.rb

@@ -1,18 +1,25 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # I/O related command processor methods
 require_relative '../app/util'
 class Trepan
   class CmdProcessor
-    def errmsg(message)
-      @dbgr.intf[-1].errmsg(safe_rep(message))
+    def errmsg(message, opts={})
+      message = safe_rep(message) unless opts[:unlimited]
+      if @settings[:highlight] && defined?(Term::ANSIColor)
+        message = 
+          Term::ANSIColor.italic + message + Term::ANSIColor.reset 
+      end
+      @dbgr.intf[-1].errmsg(message)
     end
 
-    def msg(message)
-      @dbgr.intf[-1].msg(safe_rep(message))
+    def msg(message, opts={})
+      message = safe_rep(message) unless opts[:unlimited]
+      @dbgr.intf[-1].msg(message)
     end
 
-    def msg_nocr(message)
-      @dbgr.intf[-1].msg_nocr(safe_rep(message))
+    def msg_nocr(message, opts={})
+      message = safe_rep(message) unless opts[:unlimited]
+      @dbgr.intf[-1].msg_nocr(message)
     end
 
     def read_command()
@@ -20,7 +27,16 @@ class Trepan
     end
 
     def safe_rep(str)
-      Trepan::Util::safe_repr(str, @settings[:maxstring])
+      Util::safe_repr(str, @settings[:maxstring])
+    end
+
+    def section(message, opts={})
+      message = safe_rep(message) unless opts[:unlimited]
+      if @settings[:highlight] && defined?(Term::ANSIColor)
+        message = 
+          Term::ANSIColor.bold + message + Term::ANSIColor.reset 
+      end
+      @dbgr.intf[-1].msg(message)
     end
   end
 end

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

@@ -1 +1,4 @@
+-> (fname with blank.rb:1 @0)
+puts "Ha!"
+basename is off.
 Ha!

data/test/data/quit.right

@@ -0,0 +1,2 @@
+-> (null.rb:1 @0)
+x = 1

data/test/functional/test-break-long.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+require 'trace'
+require_relative 'fn_helper'
+require_relative '../../app/breakpoint'
+
+class TestBreak < Test::Unit::TestCase
+
+  include FnTestHelper
+
+  def setup
+    Trepan::Breakpoint::reset
+  end
+
+  def test_break_same_level
+
+    # See that we can stop at a breakpoint
+    cmds = ['set basename on',
+            'break ' + (__LINE__ + 7).to_s, 
+            'continue']
+    d = strarray_setup(cmds)
+    d.start
+    ########### b1 ###############
+    x = 5
+    y = 6
+    z = 7
+    ##############################
+    d.stop
+    out = ['-- ',
+           'x = 5',
+           'basename is on.',
+ "Breakpoint 1 set at line 55 in file foo.rb,
+\tVM offset 55 of instruction sequence \"test_break_same_level\".",
+           'xx ',
+           'z = 7']
+    compare_output(out, d, cmds)
+
+    # Try a disabling the breakpoint
+    cmds = ['set basename on',
+            'break ' + (__LINE__ + 8).to_s, 
+            'break ' + (__LINE__ + 8).to_s, 
+            'disable 1',
+            'continue']
+    d = strarray_setup(cmds)
+    d.start
+    ########### b2 ###############
+    x = 7
+    y = 8
+    z = 8+1
+    ##############################
+    d.stop
+    out = ['-- ',
+           'x = 7',
+           "basename is on.",
+           "Breakpoint 1 set at line 55 in file foo.rb,
+\tVM offset 55 of instruction sequence \"test_break_same_level\".",
+           "Breakpoint 2 set at line 55 in file foo.rb,
+\tVM offset 55 of instruction sequence \"test_break_same_level\".",
+           "Breakpoint 1 disabled.",
+           'xx ',
+           'z = 8+1']
+    compare_output(out, d, cmds)
+
+    # Stepping after a breakpoint should not stay at same location.
+    cmds = ['set basename on',
+            'continue ' + (__LINE__ + 8).to_s, 
+            'continue']
+    dbg = strarray_setup(cmds)
+    dbg.start
+    ########### b3 ###############
+    a = 1
+    b = 2
+    c = 3
+    d = 4
+    e = 5
+    ##############################
+    dbg.stop
+    out = ['-- ',
+           'a = 1',
+           'basename is on.',
+           'xx ',
+           'd = 4' ]
+    compare_output(out, dbg, cmds)
+  end
+    
+end
+