trepanning 0.1.4 → 0.1.6

data/ChangeLog

@@ -1,3 +1,191 @@
+2012-11-25  rocky <rockyb@rubyforge.org>
+
+	* NEWS, app/options.rb: Get ready for release. 0.1.6
+
+2012-11-25  rocky <rockyb@rubyforge.org>
+
+	* Rakefile: Gem packaging de jour. Gem packaging stuff keeps moving
+	around.
+
+2012-11-25  rocky <rockyb@rubyforge.org>
+
+	* processor/command/debug.rb, processor/eval.rb: Hacks to make
+	recursive debugging on 1.9.3 work. This is really horrible.
+
+2012-11-24  rocky <rockyb@rubyforge.org>
+
+	* README.textile: Note that this now works on 1.9.3.
+
+2012-11-24  rocky <rockyb@rubyforge.org>
+
+	* README.textile: Note that this now works on 1.9.3.
+
+2012-11-24  rocky <rockyb@rubyforge.org>
+
+	Merge branch 'master' of github.com:rocky/rb-trepanning
+
+2012-11-24  rocky <rockyb@rubyforge.org>
+
+	* lib/trepanning.rb, processor/command/debug.rb,
+	processor/command/finish.rb, test/functional/test-recursive-bt.rb,
+	trepanning.gemspec: Make this work on 1.9.3! (Really the heavy
+	lifting was done in rb-threadframe). Adjust dependent versions
+	acceptance.
+
+2012-08-25  rocky <rockyb@rubyforge.org>
+
+	* NEWS, processor/command/delete.rb, processor/command/down.rb,
+	processor/command/up.rb: Remove aliases 'd' and 'u'.
+
+2012-08-25  rocky <rockyb@rubyforge.org>
+
+	* processor/command/finish.rb: Correct "finish" doc string.
+
+2012-08-05  rocky <rockyb@rubyforge.org>
+
+	Merge branch 'master' of github.com:rocky/rb-trepanning
+
+2012-08-05  rocky <rockyb@rubyforge.org>
+
+	* test/functional/test-remap.rb: Skipp remap test until I figure
+	what's up.
+
+2012-08-05  rocky <rockyb@rubyforge.org>
+
+	* processor/command/show_subcmd/abbrev.rb: Doc string typo.
+
+2012-07-02  rocky <rockyb@rubyforge.org>
+
+	* trepanning.gemspec: Need 0.40 now with ThreadFrame -> Frame
+	change.
+
+2012-07-02  rocky <rockyb@rubyforge.org>
+
+	* ChangeLog, NEWS, app/breakpoint.rb, app/brkptmgr.rb, app/core.rb,
+	app/display.rb, app/frame.rb, app/run.rb, lib/trepanning.rb,
+	processor/command/backtrace.rb, processor/command/break.rb,
+	processor/command/condition.rb, processor/command/debug.rb,
+	processor/command/disassemble.rb, processor/command/display.rb,
+	processor/command/down.rb, processor/command/frame.rb,
+	processor/command/help.rb,
+	processor/command/info_subcmd/breakpoints.rb,
+	processor/command/info_subcmd/registers.rb,
+	processor/command/info_subcmd/thread.rb, processor/command/list.rb,
+	processor/command/set_subcmd/substitute_subcmd/eval.rb,
+	processor/command/undisplay.rb, processor/command/up.rb,
+	processor/eval.rb, processor/frame.rb, processor/list.rb,
+	processor/location.rb, processor/mock.rb, processor/validate.rb,
+	test/example/gcd1.rb, test/functional/fn_helper.rb,
+	test/unit/test-app-brkpt.rb, test/unit/test-app-brkptmgr.rb,
+	test/unit/test-app-display.rb, test/unit/test-app-frame.rb,
+	test/unit/test-cmd-break.rb, test/unit/test-cmd-endisable.rb,
+	test/unit/test-cmd-parse_list_cmd.rb, test/unit/test-proc-eval.rb,
+	test/unit/test-proc-frame.rb, test/unit/test-proc-list.rb,
+	test/unit/test-proc-location.rb, test/unit/test-proc-validate.rb,
+	trepanning.gemspec: RubyVM::ThreadFrame -> RubyVM::Frame
+
+2012-06-29  rocky <rockyb@rubyforge.org>
+
+	* app/core.rb, app/default.rb, app/options.rb, app/run.rb,
+	bin/trepan, processor.rb, processor/location.rb,
+	processor/running.rb: Lame attempt at post-mortem
+
+2012-06-29  rocky <rockyb@rubyforge.org>
+
+	* app/client.rb, interface/comcodes.rb, interface/server.rb: Add a
+	sync op. Not sure if it will be useful though
+
+2012-06-27  rocky <rockyb@rubyforge.org>
+
+	* app/client.rb, io/input.rb: Remove debug output, small indention
+	correction; sync with rbx-trepanning
+
+2012-06-25  rocky <rockyb@rubyforge.org>
+
+	* io/input.rb: Remove stray debugger call. Doesn't anyone check
+	these commits?
+
+2012-06-25  rocky <rockyb@rubyforge.org>
+
+	* app/client.rb: This commented-out code *is* useful. Should turn
+	into a debug option. Until then...
+
+2012-06-25  rocky <rockyb@rubyforge.org>
+
+	* Rakefile, app/client.rb, interface/client.rb, interface/user.rb,
+	io/input.rb, io/tcpserver.rb, lib/trepanning.rb,
+	test/integration/test-remote.rb, test/unit/test-app-options.rb,
+	test/unit/test-cmd-quit.rb: Fix missing prompt/confirm output in
+	client mode. Noticed during Bandung 2012 tak.
+
+2012-06-20  rocky <rockyb@rubyforge.org>
+
+	* Makefile, check-filter.rb, processor/command/base/subcmd.rb,
+	processor/command/set_subcmd/auto_subcmd/eval.rb,
+	processor/command/set_subcmd/auto_subcmd/irb.rb,
+	processor/command/set_subcmd/auto_subcmd/list.rb,
+	test/unit/test-cmd-set-auto-eval.rb.try: Makefile, check-filter.rb:
+	reduce verbosity of testing output. Makefile: comment targets
+	subcmd: document how save_command is supposed to work.
+
+2012-06-19  rocky <rockyb@rubyforge.org>
+
+	* processor/command/set_subcmd/auto_subcmd/eval.rb,
+	processor/command/set_subcmd/auto_subcmd/irb.rb,
+	processor/command/set_subcmd/auto_subcmd/list.rb: "set auto *"
+	routines were not setting their prefix properly causing "restart" to
+	fail.
+
+2012-05-10  rocky <rockyb@rubyforge.org>
+
+	* io/tcpclient.rb, processor.rb, test/functional/test-remap.rb: * processor.rb: Since location of processor has moved, relative path
+	to data has changed too. * test/functional/test-remap.rb: test above
+	change * io/tcpclient.rb: remove unused DEFAULT_OPTIONS
+
+2012-03-09  R. Bernstein <rocky.bernstein@gmail.com>
+
+	Merge pull request #2 from Erkan-Yilmaz/master  two small
+	language changes
+
+2012-03-09  Erkan Yilmaz <erkan77@gmail.com>
+
+	* README.textile: small language changes
+
+2011-10-29  rocky <rockyb@rubyforge.org>
+
+	* app/frame.rb, test/functional/test-recursive-bt.rb: Add "more
+	frames follow" on truncated backtraces. Matches what we do in
+	rbx-trepanning.
+
+2011-10-28  rocky <rockyb@rubyforge.org>
+
+	* app/frame.rb, app/options.rb, app/run.rb,
+	processor/command/info_subcmd/source.rb, test/example/factorial.rb,
+	test/functional/test-recursive-bt.rb: app/frame.rb: Add direct
+	recursion in stack frame and give a count of repeated frames. Was
+	floor rounding halfway frame point when should have been ceiling
+	rounding. source.rb: called ruby_syntax incorrectly. app/options.rb:
+	bump version number
+
+2011-10-27  rocky <rockyb@rubyforge.org>
+
+	* app/options.rb: Get ready 0.1.4 release
+
+2011-10-23  rocky <rockyb@rubyforge.org>
+
+	Merge branch 'master' of github.com:rocky/rb-trepanning
+
+2011-10-23  rocky <rockyb@rubyforge.org>
+
+	* processor/command/set_subcmd/substitute_subcmd/eval.rb: Doc
+	spelling typo
+
+2011-10-16  rocky <rockyb@rubyforge.org>
+
+	* ChangeLog, NEWS, processor/command/shell.rb: Update NEWS and
+	ChangeLog in preparation for release. shell.rb: adjust help to refer
+	to "irb", since #{NAME} is no longer "irb" but "shell".
+
 2011-10-15  rocky <rockyb@rubyforge.org>
 
 	* processor/command/enable.rb: Another small doc change to enable

data/Makefile

@@ -4,8 +4,15 @@
 
 all: test
 
+#: Run all tests without bloated output
+check-short: 
+	$(MAKE) check 2>&1  | ruby check-filter.rb
+
+#: Run all tests (same as "test")
 check: 
 	rake test
+
+#: Run all tests (same as "check")
 test: 
 	rake test
 

data/NEWS

@@ -1,3 +1,12 @@
+(0.1.6) Nov 25, 2012
+- Make it work on Ruby 1.9.3 p327
+- Incompatible change: Remove aliases 'd' and 'u' for down and up
+  respectively. gdb uses 'u' and 'd' to mean something different.
+
+(0.1.5)
+- Fix bug in remote debugging not showing prompt.
+- Internal RubyVM::ThreadFrame -> RubyVM::Frame
+
 Oct 27,  2011  (0.1.4)
 - Add debugger commands: 
   * info iv         (is in ruby-debug)

data/README.textile

@@ -1,6 +1,6 @@
-A modular, testable debugger for Ruby 1.9.2. A total rewrite of _ruby-debug_.
+A modular, testable debugger for MRI Ruby 1.9.2 or 1.9.3. A total rewrite of _ruby-debug_.
 
-__In order to use this debugger, you'll need a patched Ruby 1.9.2 and some additional packages. See the "installation instructions.":https://github.com/rocky/rb-trepanning/wiki/How-to-Install-rb-trepanning__
+__In order to use this debugger, you'll need a patched MRI Ruby 1.9.2 or 1.9.3 and some additional packages. See the "installation instructions.":https://github.com/rocky/rb-trepanning/wiki/How-to-Install-rb-trepanning__
 
 Right now this debugger is beta code.
 
@@ -39,7 +39,7 @@ bc.  $trepan = Trepan.new
 
 The global variable $trepan set holds debugger settings, such as "autolist" or "autoeval" settings and breakpoint information.
 
-Due to the line-event orientation in ruby-debug, it occasionally it was convenient to add a synchronous stop in your program. I don't think that will as necessary here, but if you do call to the debugger at the point of the call rather than the subsequent stopping point, set opts[:immediate] to true. Example:
+Due to the line-event orientation in ruby-debug, it occasionally was convenient to add a synchronous stop in your program. I don't think that will be necessary here, but if you do call to the debugger at the point of the call rather than the subsequent stopping point, set opts[:immediate] to true. Example:
 
 bc.  # ... work, work, work 
  mydbg.debugger(:immediate=>true) # enter debugger here 

data/Rakefile

@@ -10,7 +10,7 @@ def gemspec
   @gemspec ||= eval(File.read(Gemspec_filename), binding, Gemspec_filename)
 end
 
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 desc "Build the gem"
 task :package=>:gem
 task :gem=>:gemspec do
@@ -86,7 +86,7 @@ Rake::TestTask.new(:'test:integration') do |t|
   t.options = '--verbose' if $VERBOSE
 end
 
-desc 'Test everything - unit tests for now.'
+desc 'Test everything - unit, functional, and integration tests.'
 task :test do
   exceptions = %w(test:unit test:functional test:integration).collect do |task|
     begin
@@ -182,7 +182,7 @@ task :gemspec do
 end
 
 # ---------  RDoc Documentation ------
-require 'rake/rdoctask'
+require 'rdoc/task'
 desc "Generate rdoc documentation"
 Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'

data/app/breakpoint.rb

@@ -134,7 +134,7 @@ class Trepan
 end
 
 if __FILE__ == $0
-  tf = RubyVM::ThreadFrame.current
+  tf = RubyVM::Frame.current
   iseq = tf.iseq
   b1 = Trepan::Breakpoint.new(iseq, 0)
   p b1

data/app/brkptmgr.rb

@@ -129,7 +129,7 @@ if __FILE__ == $0
     puts "--- #{i} ---"
   end
 
-  frame = RubyVM::ThreadFrame.current 
+  frame = RubyVM::Frame.current 
   iseq = frame.iseq
   brkpts = Trepan::BreakpointMgr.new
   brkpts.add(iseq, 0)

data/app/client.rb

@@ -1,20 +1,27 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2011, 2012 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'default'                # default debugger settings
+require_relative '../lib/trepanning'      # main Trepan object & initialization
 require_relative '../interface/comcodes'  # communication codes
 
 module Trepanning
   include Trepanning::RemoteCommunication
   def start_client(options)
     puts "Client option given"
+    user_opts = {}
+    %w(readline).each do |opt|
+      user_opts[opt.to_sym] = options[opt.to_sym]
+    end
     dbgr = Trepan.new(:client      => true,
                       :cmdfiles    => [],
                       :initial_dir => options[:chdir],
                       :nx          => true,
                       :host        => options[:host],
-                      :port        => options[:port]
+                      :port        => options[:port],
+                      :user_opts   => user_opts
                       )
     intf = dbgr.intf[-1]
+    intf.write_remote(SYNC, 'FIXME: add useful info')
     while true
       begin
         control_code, line = intf.read_remote
@@ -25,6 +32,11 @@ module Trepanning
       # p [control_code, line]
       case control_code
       when PRINT
+
+        # FIXME: don't know why server sometimes adds a gratuituous space.
+        # the space is added somewhere inside TCPSocket.print
+        line = line[0..-2] if line.end_with?("\n ")
+
         print line
       when CONFIRM_TRUE
         response = intf.confirm(line, true)
@@ -33,8 +45,7 @@ module Trepanning
         response = intf.confirm(line, true)
         intf.write_remote(CONFIRM_REPLY, response ? 'Y' : 'N')
       when PROMPT
-        # require 'trepanning'
-        # debugger
+        # Printing of prompt has been handled already by PRINT.
         begin
           command = intf.read_command(line)
         rescue EOFError

data/app/core.rb

@@ -146,14 +146,14 @@ class Trepan
         
         return_exception = @exception
         @frame = @event = @arg = @exception = nil
-
+        
       end
       return return_exception 
     end
 
     # A Ruby 1.8-style event processor. We don't use file, line, id, bind. 
     def old_event_processor(event, file, line, id, bind, klass)
-      event_processor(event, RubyVM::ThreadFrame.current.prev)
+      event_processor(event, RubyVM::Frame.current.prev)
     end
 
     # Call this from inside the program you want to get a synchronous
@@ -163,14 +163,14 @@ class Trepan
       while @frame && @frame.type == 'IFUNC'
         @frame = @frame.prev
       end
-      frame = RubyVM::ThreadFrame.current.prev(prev_count+1)
+      frame = RubyVM::Frame.current.prev(prev_count+1)
       @step_count = 0  # Make event processor stop
       event_processor('debugger-call', frame)
     end
     
     # A trace-hook processor for 'trace var'
     def trace_var_processor(var_name, value)
-      frame = RubyVM::ThreadFrame.current.prev(2)
+      frame = RubyVM::Frame.current.prev(2)
       if 'CFUNC' == frame.type
         # Don't need the C call that got us here.
         prev = frame.prev

data/app/default.rb

@@ -16,6 +16,7 @@ class Trepan
     # Default values used only when 'server' or 'client'
     # (out-of-process debugging)
     :port            => 1955,
+    :post_mortem     => false,
     :host            => 'localhost', 
 
     :restart_argv    => RubyVM::OS_ARGV,

data/app/display.rb

@@ -166,7 +166,7 @@ if __FILE__ == $0
   end
     
   require 'thread_frame'
-  frame = RubyVM::ThreadFrame::current
+  frame = RubyVM::Frame::current
 
   x = 1
   mgr.add(frame, 'x > 1')

data/app/frame.rb

@@ -156,13 +156,20 @@ class Trepan
       return s
     end
 
+    # Return true if frame1 and frame2 are at the same place.
+    # We use this for example in detecting tail recursion.
+    def location_equal(frame1, frame2)
+      frame1 && frame2 && frame1.source_location == frame2.source_location &&
+        frame1.pc_offset == frame2.pc_offset && 
+        frame1.source_container == frame2.source_container
+    end
+
     def offset_for_return(event)
       raise RuntimeError unless %w(return c-return).member?(event)
       # FIXME: C calls have a RubyVM::Env added to the stack.
       # Where? Why?
       'return' == event ? 1 : 4
     end
-    module_function :offset_for_return
 
     def param_names(iseq, start, stop, prefix='')
       start.upto(stop).map do |i| 
@@ -180,10 +187,22 @@ class Trepan
     end
 
     def print_stack_trace_from_to(from, to, frame, opts)
+      last_frame = nil
+      # TODO: handle indirect recursion.
+      direct_recursion_count = 0
       from.upto(to) do |i|
-        prefix = (i == opts[:current_pos]) ? '-->' : '   '
-        prefix += ' #%d ' % [i]
-        print_stack_entry(frame, i, prefix, opts)
+        if location_equal(last_frame, frame)
+          direct_recursion_count += 1
+        else
+          if direct_recursion_count > 0
+            msg("... above line repeated #{direct_recursion_count} times")
+            direct_recursion_count = 0
+          end
+          prefix = (i == opts[:current_pos]) ? '-->' : '   '
+          prefix += ' #%d ' % [i]
+          print_stack_entry(frame, i, prefix, opts)
+        end
+        last_frame = frame
         frame = frame.prev
       end
     end
@@ -191,7 +210,7 @@ class Trepan
     # Print `count' frame entries
     def print_stack_trace(frame, opts={})
       opts    = DEFAULT_STACK_TRACE_SETTINGS.merge(opts)
-      halfstack = opts[:maxstack] / 2
+      halfstack = (opts[:maxstack]+1) / 2
       n       = frame.stack_size
       n       = [n, opts[:count]].min if opts[:count]
       if n > (halfstack * 2)
@@ -201,6 +220,7 @@ class Trepan
       else
         print_stack_trace_from_to(0, n-1, frame, opts)
       end
+      msg "(More stack frames follow...)" if n < frame.stack_size
     end
 
     def set_return_value(frame, event, value)
@@ -212,7 +232,6 @@ class Trepan
     def value_returned(frame, event)
       frame.sp(offset_for_return(event))
     end
-    module_function :value_returned
   end
 end
 
@@ -223,61 +242,61 @@ if __FILE__ == $0
   def msg(msg)
     puts msg
   end
-  print_stack_trace(RubyVM::ThreadFrame.current, :basename => true)
+  print_stack_trace(RubyVM::Frame.current, :basename => true)
   def foo
     puts '=' * 10
-    print_stack_trace(RubyVM::ThreadFrame.current, :show_pc => true)
+    print_stack_trace(RubyVM::Frame.current, :show_pc => true)
   end
   foo
 
   def bar(a, b, c)
     puts '=' * 10
-    print_stack_trace(RubyVM::ThreadFrame.current,
+    print_stack_trace(RubyVM::Frame.current,
                       )
   end
   bar(1, 2, 3)
 
   def baz(a, b, c=5)
     puts '=' * 10
-    print_stack_trace(RubyVM::ThreadFrame.current)
+    print_stack_trace(RubyVM::Frame.current)
   end
   baz(1, 2)
 
   def bat(a, b, &block)
     puts '=' * 10
-    print_stack_trace(RubyVM::ThreadFrame.current)
+    print_stack_trace(RubyVM::Frame.current)
   end
   bat(1, 2)
 
   def babe(a, b, *rest)
     puts '=' * 10
-    print_stack_trace(RubyVM::ThreadFrame.current)
+    print_stack_trace(RubyVM::Frame.current)
   end
   babe(1, 2)
 
   puts '=' * 10
-  x  = lambda { |a,b|  print_stack_trace(RubyVM::ThreadFrame::current) }
+  x  = lambda { |a,b|  print_stack_trace(RubyVM::Frame::current) }
   x.call(1,2)
   puts '=' * 10
   x  = Proc.new do |a| 
-    print_stack_trace(RubyVM::ThreadFrame::current)
+    print_stack_trace(RubyVM::Frame::current)
   end
   x.call(1,2)
   class C # :nodoc
     def initialize(a)
-      print_stack_trace(RubyVM::ThreadFrame::current)
+      print_stack_trace(RubyVM::Frame::current)
     end
   end
   puts '=' * 30
   C.new('Hi')
   puts '=' * 30
-  eval("print_stack_trace(RubyVM::ThreadFrame.current)")
+  eval("print_stack_trace(RubyVM::Frame.current)")
   puts '=' * 30
-  eval("eval('print_stack_trace(RubyVM::ThreadFrame.current)')")
+  eval("eval('print_stack_trace(RubyVM::Frame.current)')")
   puts '=' * 30
-  eval("eval('print_stack_trace(RubyVM::ThreadFrame.current, :maxstack => 2)')")
+  eval("eval('print_stack_trace(RubyVM::Frame.current, :maxstack => 2)')")
   puts '=' * 30
   1.times do |a; b|
-    print_stack_trace(RubyVM::ThreadFrame::current)
+    print_stack_trace(RubyVM::Frame::current)
   end
 end