trepanning 0.1.6 → 1.93.32

data/NEWS

@@ -1,3 +1,17 @@
+(1.93.32) Mar 8, 2015
+- Remove reference to threadframe
+
+(1.93.31) Mar 8, 2015
+
+- Remove threadframe dependency - it's built into patched Ruby
+- add dependencies for coderay and ansi-termcolor
+- More subcommand help converted to markdown format.
+
+(1.93.30) Mar 5, 2015
+- Make it work on a patched Ruby 1.9.3 p551
+- include columnize and linecache-tf gems
+- Help text is rendered via redcloth/markdown
+
 (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
@@ -8,7 +22,7 @@
 - Internal RubyVM::ThreadFrame -> RubyVM::Frame
 
 Oct 27,  2011  (0.1.4)
-- Add debugger commands: 
+- Add debugger commands:
   * info iv         (is in ruby-debug)
   * info variables  (is in ruby-debug)
   * info locals as alternative to "info variables locals" (is in gdb)
@@ -48,7 +62,7 @@ June 12, 2011  (0.1.3) Fleetwood Release
 - Add options from ruby-debug:
   * --cd
   * --include
-  * --require 
+  * --require
   * --debug
 - fix bugs, and improve help
 
@@ -64,7 +78,7 @@ March 15, 2011  (0.1.1)
   * VM offsets are now specified via @ rather than o or O
   * Filenames can be quoted and blanks and characters inside escaped
 - Document command syntax by adding it as a new category with sub help
-- More controlled parsing of method names 
+- More controlled parsing of method names
 - Add eval (no args) and eval? to run current source line or source line
   eval? strips:
    * leading "if", "elsif", "while", "until" "return" or "case", or "unless"
@@ -72,17 +86,17 @@ March 15, 2011  (0.1.1)
 - Save and restore some debugger state across a restart
 - Redo command completion
 - "disassemble" command: allow disassembly of specified line numbers
-- GNU Readline: 
-  * Start GNU readline tab (command) completion. 
+- GNU Readline:
+  * Start GNU readline tab (command) completion.
   * Save and restore command history
   * add --readline and --no-readline options to trepanx
 - Macros can return more than one command now
-- help 
+- help
   * "help macros" shows all macro names
   * "help aliases" shows all alias names
   * "help *" lists macros and aliases now
 - start "info line"
-- "info file" has/shows File::stat()'s mtime and ctime 
+- "info file" has/shows File::stat()'s mtime and ctime
 - be able to pass --verbose to ruby to rake
 
 Feb 1, 2011 (0.1.0)
@@ -90,7 +104,7 @@ Feb 1, 2011 (0.1.0)
 * Add Syntax highlighting on Ruby and YARV listings and locations
 * Section highlighting on some commands; italics on error if term mode
 * Use ;; to allow multiple debugger commands. Document debugger command syntax
-* include data files for debugging custom-require 
+* include data files for debugging custom-require
 * Numerous bug fixes and code cleanups
 
 Dec 25, 2010 (0.0.9)
@@ -103,10 +117,10 @@ Dec 10, 2010 (0.0.8) Phel. Mad release
 * debugger { code here }  work better
 * source -q silences all prompt and debugger messages
 * Show instruction-sequence options on demand
-* Nuke debugger set_restart => true. We now have a more reliable way to 
+* Nuke debugger set_restart => true. We now have a more reliable way to
   do this. Rubinius showing the way here.
 * Improvements to the "list" command.
-* Get/show eval string using rb-threadframe patch 
+* Get/show eval string using rb-threadframe patch
 
 Oct 27, 2010 (0.0.6)
 
@@ -122,11 +136,11 @@ First release under the name trepanning
 
 * Add gdb-like "directory" command
 * Add "set max list" to set number of lines to list by default.
-* "break line" searches parent instruction sequences in the same file. This 
+* "break line" searches parent instruction sequences in the same file. This
   should allow more line numbers to be breakpointable.
 * remap file name in custom_requre.rb
 * Some small bug fixes
-  
+
 Sept 13, 2010
 
 First public (gemcutter) release.

data/README.md

@@ -0,0 +1,62 @@
+The trepanning debugger gdb-like debugger. As such, it is both a high-level and low-level debugger. It is a also a rewrite of *ruby-debug*. But to provide all of the functionality that it has, it requires a patched version of MRI Ruby 1.9.3 or 1.9.2 found the [rb-threadframe project](https://rocky/rb-threadframe). The additional run-time support in the MRI is what gives this some debugger power that you won't find in other MRI 1.9 debuggers.
+
+See the [installation instructions](https://github.com/rocky/rb-trepanning/wiki/How-to-Install-rb-trepanning).
+
+There is a [google group mailing list](http://groups.google.com/group/ruby-debugger) for Ruby debuggers.
+
+If *trepanning* is installed, here is how to run:
+
+```console
+   $ trepan ruby-program [program]
+```
+
+If your program needs options of its own:
+
+```console
+   $ trepan -- ruby-program [program args...]
+```
+
+If you want to run from the source tree you can do that too:
+
+```console
+
+  cd place-where-trepan-is-installed
+ ./bin/trepan -- ruby-program [program args...]
+```
+
+Running from inside *irb*:
+
+```ruby
+ require 'trepanning'
+ Trepan.debug { your code }
+```
+
+The return value from Trepan is the return value of the block, i.e. the final value in the block.
+
+You can run the same thing inside your Ruby program, but probably you don't want to give a block. Instead, you may want to have debugging start on the next statement in the code:
+
+```ruby
+ require 'trepan'
+ Trepan.debug # Don't stop here...
+ work # but stop here.
+```
+
+The above is really shorthand for something like:
+
+```ruby
+  $trepan = Trepan.new
+  $trepan.debugger
+```
+
+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 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:
+
+```ruby
+
+ # ... work, work, work
+ mydbg.debugger(:immediate=>true) # enter debugger here
+ # ... work, work, work
+```
+
+There is extensive on-line help. Run `help` inside the debugger.

data/Rakefile

@@ -3,6 +3,7 @@
 require 'rubygems'
 
 ROOT_DIR = File.dirname(__FILE__)
+GEM_PROG = ENV['GEM_PROG'] || 'gem'
 Gemspec_filename='trepanning.gemspec'
 require_relative './app/options'
 
@@ -15,7 +16,7 @@ desc "Build the gem"
 task :package=>:gem
 task :gem=>:gemspec do
   Dir.chdir(ROOT_DIR) do
-    sh "gem build #{Gemspec_filename}"
+    sh "#{GEM_PROG} build #{Gemspec_filename}"
     FileUtils.mkdir_p 'pkg'
     FileUtils.mv gemspec.file_name, 'pkg'
   end
@@ -24,7 +25,7 @@ end
 desc 'Install the gem locally'
 task :install => :gem do
   Dir.chdir(ROOT_DIR) do
-    sh %{gem install --local pkg/#{gemspec.file_name}}
+    sh %{#{GEM_PROG} install --local pkg/#{gemspec.file_name}}
   end
 end
 
@@ -96,7 +97,7 @@ task :test do
       e
     end
   end.compact
-  
+
   exceptions.each {|e| puts e;puts e.backtrace }
   raise 'Test failures' unless exceptions.empty?
 end
@@ -145,6 +146,11 @@ task :'check:functional' do
   run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} test functional)))
 end
 
+desc 'Run integration tests in standalone mode.'
+task :'check:functional' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} test ingtegration)))
+end
+
 desc 'Run command parser grammar.'
 task :'check:cmd_parse' do
   sh "kpeg --test --debug #{File.join(ROOT_DIR, %w(app cmd_parse.kpeg))}"
@@ -153,12 +159,12 @@ end
 desc 'Generate command parser.'
 task :'cmd_parse' do
   require 'tmpdir'
-  temp_file = 
-    File.join(Dir.tmpdir, 
+  temp_file =
+    File.join(Dir.tmpdir,
               Dir::Tmpname.make_tmpname(['cmd_parser_', '.rb'], nil))
 
-  sh("kpeg --name CmdParse --verbose --stand-alone  " + 
-     "#{File.join(ROOT_DIR, %w(app cmd_parse.kpeg))} " + 
+  sh("kpeg --name CmdParse --verbose --stand-alone  " +
+     "#{File.join(ROOT_DIR, %w(app cmd_parse.kpeg))} " +
      "--output #{temp_file}")
 end
 
@@ -188,7 +194,7 @@ Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.title    = "Trepanning #{Trepan::VERSION} Documentation"
 
-  rdoc.rdoc_files.include(%w(lib/*.rb 
+  rdoc.rdoc_files.include(%w(lib/*.rb
                           app/*.rb intf/*.rb io/*.rb
                           bin/trepan
                          ))
@@ -216,5 +222,5 @@ task :rm_tilde_backups do
 end
 
 desc 'Remove built files'
-task :clean => [:clobber_package, :clobber_rdoc, :rm_patch_residue, 
+task :clean => [:clobber_package, :clobber_rdoc, :rm_patch_residue,
                 :rm_tilde_backups]

data/app/breakpoint.rb

@@ -1,13 +1,12 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
-require 'thread_frame'
+# Copyright (C) 2010-2011, 2013, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 
 # Breakpoint objects
 class Trepan
   class Breakpoint
     attr_accessor :condition # If non-nil, this is a String to be eval'd
                              # which must be true to enter the debugger
-    attr_accessor :hits      # Fixnum. The number of timea a breakpoint
+    attr_accessor :hits      # Fixnum. The number of times a breakpoint
                              # has been hit (with a true condition). Do
                              # we want to (also) record hits independent
                              # of the condition?
@@ -19,7 +18,7 @@ class Trepan
     attr_reader   :offset    # Fixnum. Offset into an instruction
                              # sequence for the location of the
                              # breakpoint
-    attr_reader   :negate    # Boolean. Negate sense of condition. Used in 
+    attr_reader   :negate    # Boolean. Negate sense of condition. Used in
                              # break if .. and break unless ..
                              # breakpoint
     attr_reader   :type      # String. 'line' if breakpoint requested
@@ -35,20 +34,20 @@ class Trepan
       :negate    =>  false,
       :type      => 'line',
     } unless defined?(BRKPT_DEFAULT_SETTINGS)
-    
+
     def initialize(iseq, offset, opts = {})
-      raise TypeError, 
-      "#{iseq} is not an instruction sequence" unless 
+      raise TypeError,
+      "#{iseq} is not an instruction sequence" unless
         iseq.is_a?(RubyVM::InstructionSequence)
       @iseq = iseq
 
-      raise TypeError, 
-      "offset #{offset.inspect} not found in instruction sequence" unless 
+      raise TypeError,
+      "offset #{offset.inspect} not found in instruction sequence" unless
         iseq.offset2lines(offset)
       @offset = iseq
 
-      raise TypeError, 
-      "type mismatch: #{offset.class} given, Fixnum expected" unless 
+      raise TypeError,
+      "type mismatch: #{offset.class} given, Fixnum expected" unless
         offset.is_a?(Fixnum)
       @offset = offset
 
@@ -60,7 +59,7 @@ class Trepan
       @hits = 0
 
       unless @id
-        @id = @@next_id 
+        @id = @@next_id
         @@next_id += 1
       end
       raise RuntimeError,

data/app/complete.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2011, 2013 Rocky Bernstein <rockyb@rubyforge.net>
 
 class Trepan
 
@@ -12,21 +12,21 @@ class Trepan
     def complete_token(complete_ary, prefix)
       complete_ary.select { |cmd| cmd.to_s.start_with?(prefix) }.sort
     end
-    
+
     def complete_token_with_next(complete_hash, prefix, cmd_prefix='')
       result = []
-      complete_hash.each do |cmd_name, cmd_obj| 
-        result << [cmd_name.to_s[cmd_prefix.size..-1], cmd_obj] if 
+      complete_hash.each do |cmd_name, cmd_obj|
+        result << [cmd_name.to_s[cmd_prefix.size..-1], cmd_obj] if
           cmd_name.to_s.start_with?(cmd_prefix + prefix)
       end
       result.sort{|a, b| a[0] <=> b[0]}
     end
-    
+
     # Find all starting matches in Hash +aliases+ that start with +prefix+,
     # but filter out any matches already in +expanded+.
     def complete_token_filtered(aliases, prefix, expanded)
       complete_ary = aliases.keys
-      complete_ary.select { |cmd| 
+      complete_ary.select { |cmd|
         cmd.to_s.start_with?(prefix) && ! expanded.member?(aliases[cmd])}.sort
     end
 
@@ -37,31 +37,31 @@ class Trepan
       complete_ary = aliases.keys
       expanded_ary = expanded.keys
       result = []
-      complete_ary.each do |cmd| 
-        if cmd.to_s.start_with?(prefix) && 
+      complete_ary.each do |cmd|
+        if cmd.to_s.start_with?(prefix) &&
             !expanded_ary.member?(aliases[cmd])
-          result << [cmd, commands[aliases[cmd]]] 
+          result << [cmd, commands[aliases[cmd]]]
         end
       end
-      result
+      result.sort
     end
 
     # Find the next token in str string from start_pos, we return
-    # the token and the next blank position after the token or 
+    # the token and the next blank position after the token or
     # str.size if this is the last token. Tokens are delimited by
     # white space.
     def next_token(str, start_pos)
       look_at = str[start_pos..-1]
       next_nonblank_pos = start_pos + (look_at =~ /\S/ || 0)
-      next_blank_pos = 
+      next_blank_pos =
         if next_match = str[next_nonblank_pos..-1] =~ /\s/
-          next_nonblank_pos + next_match 
+          next_nonblank_pos + next_match
         else
           str.size
         end
       return [next_blank_pos, str[next_nonblank_pos...next_blank_pos]]
     end
-    
+
   end
 end
 

data/app/core.rb

@@ -8,7 +8,7 @@ class Trepan
   # This class contains the Trepan core routines, such as an event
   # processor which is responsible of handling what to do when an event is
   # triggered.
-  # 
+  #
   # See also 'rdbgr' the top-level Trepan class and command-line routine
   # which ultimately will call this.
 
@@ -28,24 +28,24 @@ class Trepan
     attr_accessor :processor    # Trepan::CmdProc instance
     attr_reader   :settings     # Hash of things you can configure
     attr_accessor :step_count   # Fixnum. Negative means no tracing,
-                                # 0 means stop on next event, 1 means 
+                                # 0 means stop on next event, 1 means
                                 # ignore one event. Step events gives the
                                 # kind of things to count as a step.
-    attr_accessor :step_events  # bitmask of events - used only when 
+    attr_accessor :step_events  # bitmask of events - used only when
                                 # we are stepping
-    attr_accessor :unmaskable_events 
+    attr_accessor :unmaskable_events
 
     include Trace
 
     unless defined?(CORE_DEFAULT_SETTINGS)
       # Synchronous events
-      STEPPING_EVENT_MASK = 
+      STEPPING_EVENT_MASK =
         LINE_EVENT_MASK     | CLASS_EVENT_MASK    | CALL_EVENT_MASK     |
         RETURN_EVENT_MASK   | C_CALL_EVENT_MASK   | C_RETURN_EVENT_MASK |
         INSN_EVENT_MASK     | BRKPT_EVENT_MASK    | YIELD_EVENT_MASK    |
         LEAVE_EVENT_MASK    | SEND_EVENT_MASK
 
-      ASYNC_EVENT_MASK = 
+      ASYNC_EVENT_MASK =
         RAISE_EVENT_MASK    | VM_EVENT_MASK       | SWITCH_EVENT_MASK
 
       CORE_DEFAULT_SETTINGS = {
@@ -57,11 +57,11 @@ class Trepan
 
         # Not sure what the "right" set really is. The below is just
         # a guess. Use "set events" or customize in ~/.trepanrc
-        :step_events       =>  
+        :step_events       =>
 #	(DEFAULT_EVENT_MASK | INSN_EVENT_MASK) &
 	(DEFAULT_EVENT_MASK ) &
 	~(C_CALL_EVENT_MASK | C_RETURN_EVENT_MASK | SEND_EVENT_MASK)
-      } 
+      }
 
     end
 
@@ -80,6 +80,7 @@ class Trepan
       @event_proc   = self.method(hook_name).to_proc
       @processor    = CmdProcessor.new(self, @settings[:cmdproc_opts])
       @unmaskable_events = %w(brkpt raise switch vm)
+      @current_thread = nil
     end
 
     def step_events_list
@@ -94,15 +95,18 @@ class Trepan
     def event_processor(event, frame, arg=nil)
 
       return_exception = nil
-      # FIXME: check for breakpoints or other unmaskable events. 
+      # FIXME: check for breakpoints or other unmaskable events.
       # For now there are none.
 
+      return if @mutex.locked? and Thread.current == @current_thread
+
       @mutex.synchronize do
+        @current_thread = Thread.current
         @frame = frame
         while @frame.type == 'IFUNC'
           @frame = @frame.prev
         end
-        
+
         if @step_count > 0
           @step_count -= 1
           break
@@ -112,52 +116,52 @@ class Trepan
 
         @event    = event
         @hook_arg = arg
-        
+
         ### debug:
         ### puts "#{frame.file[1]}:#{frame.source_location[0]}:in `#{frame.method}' #{event}" # if %w(line).member?(event)
         @processor.process_commands(@frame)
-                
+
         # FIXME: There should be a Trace.event_mask which should return the first
         # mask that matches the given trace hook.
         if @step_count < 0
           # If we are continuing, no need to stop at stepping events.
-          Trace.event_masks[0] &= ~STEPPING_EVENT_MASK 
+          Trace.event_masks[0] &= ~STEPPING_EVENT_MASK
         else
-          # Set to trace only those events we are interested in.  
-          
+          # Set to trace only those events we are interested in.
+
           # Don't step/trace into Ruby routines called from here in the code
           # below (e.g. "trace_hooks").
           step_count_save = step_count
-          @step_count     = -1 
-          
+          @step_count     = -1
+
           unless @event_proc == dbgr.trace_filter.hook_proc
-            dbgr.trace_filter.add_trace_func(@event_proc) 
+            dbgr.trace_filter.add_trace_func(@event_proc)
             ## debug: p '+++1', @event_proc, dbgr.trace_filter.hook_proc
           end
-          
-          # FIXME: this doesn't work. Bug in rb-trace? 
+
+          # FIXME: this doesn't work. Bug in rb-trace?
           # Trace.event_masks[0] = @step_events | @async_events
-          RubyVM::TraceHook::trace_hooks[0].event_mask = 
+          RubyVM::TraceHook::trace_hooks[0].event_mask =
             @step_events | @async_events
           @step_count = step_count_save
         end
-        
+
         # Nil out variables just in case...
-        
+
         return_exception = @exception
         @frame = @event = @arg = @exception = nil
-        
+
       end
-      return return_exception 
+      return return_exception
     end
 
-    # A Ruby 1.8-style event processor. We don't use file, line, id, bind. 
+    # 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::Frame.current.prev)
     end
 
     # Call this from inside the program you want to get a synchronous
-    # call to the debugger. set prev_count to the number of levels 
+    # call to the debugger. set prev_count to the number of levels
     # *before* the caller you want to skip.
     def debugger(prev_count=0)
       while @frame && @frame.type == 'IFUNC'
@@ -167,7 +171,7 @@ class Trepan
       @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::Frame.current.prev(2)
@@ -178,8 +182,8 @@ class Trepan
       end
 
       # Stop future tracing into the debugger
-      Thread.current.tracing = true  
-      
+      Thread.current.tracing = true
+
       @step_count = 0  # Make event processor stop
       event_processor('trace-var', frame, [var_name, value])
     end