trepanning 0.0.4

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (C) 2010  Rocky Bernstein <rockyb@rubyforge.org>
+All rights reserved.
+ *
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+ *
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/NEWS

@@ -0,0 +1,12 @@
+Oct 8, 2010
+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 
+  should allow more line numbers to be breakpointable.
+* Some small bug fixes
+  
+Sept 13, 2010
+
+First public (gemcutter) release.

data/README.textile

@@ -0,0 +1,56 @@
+A modular, testable debugger for Ruby 1.9.2. 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.":http://wiki.github.com/rocky/rb-trepanning/how-to-install-rbdbgr__
+
+Right now this debugger is beta code.
+
+There is a "google group mailing list":http://groups.google.com/group/ruby-debugger for Ruby debuggers.
+
+If rb-trepanning is installed, here is how to run:
+
+bc.  trepan ruby-program [program]
+
+If your program needs options of its own:
+
+bc.  trepan -- ruby-program [program args...]
+
+If you want to run from the source tree you can do that too:
+
+bc.  cd place-where-trepan-is-installed:
+ ./bin/trepan -- ruby-program [program args...]
+
+Running from inside _irb_:
+
+bc.  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:
+
+bc.  require 'trepan' 
+ Trepan.debug # Don't stop here...
+ work # but stop here.
+
+or if you haven't mucked around with $0 and ARGV, you might try:
+
+bc.  Trepan.debug(:set_restart=>true)
+
+which informs the debugger on how to restart the program (via the restart command) using the values of ARGV and $0 at the time Trepan.debug was called.
+
+The above is really shorthand for something like:
+
+bc.  $trepan = Trepan.new(:set_restart=>true) 
+ $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 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:
+
+bc.  # ... 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

@@ -0,0 +1,171 @@
+#!/usr/bin/env rake
+# -*- Ruby -*-
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+ROOT_DIR = File.dirname(__FILE__)
+require File.join %W(#{ROOT_DIR} app options)
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :package=>:gem
+task :gem=>:gemspec do
+  Dir.chdir(ROOT_DIR) do
+    sh "gem build .gemspec"
+    FileUtils.mkdir_p 'pkg'
+    FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  end
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  Dir.chdir(ROOT_DIR) do
+    sh %{gem install --local pkg/#{gemspec.name}-#{gemspec.version}}
+  end
+end
+
+desc "Test everything."
+Rake::TestTask.new(:test) do |t|
+  t.libs << './lib'
+  t.pattern = 'test/test-*.rb'
+  t.verbose = true
+end
+task :test => :lib
+
+desc "same as test"
+task :check => :test
+
+require 'rbconfig'
+RUBY_PATH = File.join(RbConfig::CONFIG['bindir'],  
+                      RbConfig::CONFIG['RUBY_INSTALL_NAME'])
+
+def run_standalone_ruby_file(directory)
+  puts ('*' * 10) + ' ' + directory + ' ' + ('*' * 10)
+  Dir.chdir(directory) do
+    Dir.glob('*.rb').each do |ruby_file|
+      puts ('-' * 20) + ' ' + ruby_file + ' ' + ('-' * 20)
+      system(RUBY_PATH, ruby_file)
+    end
+  end
+end
+
+desc 'Create a GNU-style ChangeLog via git2cl'
+task :ChangeLog do
+  system('git log --pretty --numstat --summary | git2cl > ChangeLog')
+end
+
+desc 'Test units - the smaller tests'
+task :'test:unit' do |t|
+  Rake::TestTask.new(:'test:unit') do |t|
+    t.test_files = FileList['test/unit/**/test-*.rb']
+    # t.pattern = 'test/**/*test-*.rb' # instead of above
+    t.verbose = true
+  end
+end
+
+desc 'Test functional - the medium-sized tests'
+task :'test:functional' do |t|
+  Rake::TestTask.new(:'test:functional') do |t|
+    t.test_files = FileList['test/functional/**/test-*.rb']
+    t.verbose = true
+  end
+end
+
+desc 'Test integration - end-to-end blackbox tests'
+task :'test:integration' do |t|
+  Rake::TestTask.new(:'test:integration') do |t|
+    t.test_files = FileList['test/integration/**/test-*.rb']
+    t.verbose = true
+  end
+end
+
+desc 'Test everything - unit tests for now.'
+task :test do
+  exceptions = %w(test:unit test:functional test:integration).collect do |task|
+    begin
+      Rake::Task[task].invoke
+      nil
+    rescue => e
+      e
+    end
+  end.compact
+  
+  exceptions.each {|e| puts e;puts e.backtrace }
+  raise "Test failures" unless exceptions.empty?
+end
+
+desc "Run each library Ruby file in standalone mode."
+task :'check:app' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} app)))
+end
+
+desc "Run each command in standalone mode."
+task :'check:commands' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} processor command)))
+end
+
+desc "Run each processor Ruby file in standalone mode."
+task :'check:lib' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} lib)))
+end
+
+desc "Run each processor Ruby file in standalone mode."
+task :'check:processor' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} processor)))
+end
+
+desc "Run each processor Ruby file in standalone mode."
+task :'check:unit' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} test unit)))
+end
+
+task :'check:functional' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} test functional)))
+end
+
+task :'check:integration' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} test integration)))
+end
+
+task :check => %w(check:lib check:processor check:commands).map{|c| c.to_sym}
+
+desc "Test everything - same as test."
+task :default => :test
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+# ---------  RDoc Documentation ------
+desc "Generate rdoc documentation"
+Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Trepanning #{Trepanning::VERSION} Documentation"
+
+  rdoc.rdoc_files.include('lib/*.rb', 'app/*.rb', 'bin/trepan')
+end
+desc "Same as rdoc"
+task :doc => :rdoc
+
+desc "Remove built files"
+task :clean => [:clobber_package, :clobber_rdoc]
+
+task :clobber_package do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'pkg')
+end
+
+task :clobber_rdoc do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'doc')
+end
+

data/app/Makefile

@@ -0,0 +1,7 @@
+# Whatever it is you want to do, it should be forwarded to the 
+# to top-level irectories
+.PHONY: check all
+all: check
+
+%: 
+	$(MAKE) -C .. $@

data/app/breakpoint.rb

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'thread_frame'
+
+# Breakpoint objects
+module Trepanning
+  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
+                             # has been hit (with a true condition). Do
+                             # we want to (also) record hits independent
+                             # of the condition?
+    attr_reader   :id        # Fixnum. Name of breakpoint
+    attr_reader   :ignore    # Fixnum. Number of times encountered to ignore
+    attr_reader   :iseq      # Instruction sequence associated with this
+                             # breakpoint. From this we can derive
+                             # information such as source location.
+    attr_reader   :offset    # Fixnum. Offset into an instruction
+                             # sequence for the location of the
+                             # breakpoint
+    attr_reader   :type      # String. 'line' if breakpoint requested
+                             # at "line" boundary or 'offset'
+                             # requested at a specific offset
+    @@next_id = 1
+
+    BRKPT_DEFAULT_SETTINGS = {
+      :condition => 'true',
+      :enabled   => 'true',
+      :ignore    =>  0,
+      :temp      =>  false,
+      :type      => 'line',
+    } unless defined?(BRKPT_DEFAULT_SETTINGS)
+    
+    def initialize(iseq, offset, opts = {})
+      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 
+        iseq.offset2lines(offset)
+      @offset = iseq
+
+      raise TypeError, 
+      "type mismatch: #{offset.class} given, Fixnum expected" unless 
+        offset.is_a?(Fixnum)
+      @offset = offset
+
+      opts = BRKPT_DEFAULT_SETTINGS.merge(opts)
+      opts.keys.each do |key|
+        self.instance_variable_set('@'+key.to_s, opts[key])
+      end
+
+      @hits = 0
+
+      unless @id
+        @id = @@next_id 
+        @@next_id += 1
+      end
+      set
+    end
+
+    def condition?(bind)
+      if eval(@condition, bind)
+        if @ignore > 0
+          @ignore -= 1
+          return false
+        else
+          @hits += 1
+          return true
+        end
+      else
+        return false
+      end
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def enabled
+      @enabled = true
+    end
+
+    def enabled=(bool)
+      @enabled = bool
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    # Return a one-character "icon" giving the state of the breakpoint
+    # 't': temporary breakpoint
+    # 'B': enabled breakpoint
+    # 'b': disabled breakpoint
+    def icon_char
+      temp? ? 't' : (enabled? ? 'B' : 'b')
+    end
+
+    def set
+      @iseq.brkpt_set(@offset)
+    end
+
+    def source_container
+      @iseq.source_container
+    end
+
+    def source_location
+      @iseq.offset2lines(@offset)
+    end
+
+    def temp?
+      @temp
+    end
+
+    def remove!
+      @iseq.brkpt_unset(@offset)
+    end
+
+    # Really shouldn't need this after next_id is removed.
+    def self.reset
+      @@next_id = 1
+    end
+
+  end
+end
+
+if __FILE__ == $0
+  tf = RubyVM::ThreadFrame.current
+  iseq = tf.iseq
+  b1 = Trepanning::Breakpoint.new(iseq, 0)
+  p b1
+  p b1.source_location
+  p b1.source_container
+  b2 = Trepanning::Breakpoint.new(iseq, 0, :temp => true)
+  p b2
+  puts "b2 id: #{b2.id}"
+  puts "b2 hits: #{b2.hits}"
+  puts "b2.condition? #{b2.condition?(tf.binding)}"
+  puts "b2 hits: #{b2.hits}"
+  begin
+    b3 = Breakpoint.new(iseq, iseq.iseq_size)
+  rescue TypeError => e
+    puts "TypeError (expected): #{e}"
+  end
+  begin
+    b3 = Trepanning::Breakpoint.new(5, iseq.iseq_size)
+  rescue TypeError => e
+    puts "TypeError (expected): #{e}"
+  end
+  puts Trepanning::Breakpoint.class_variable_get('@@next_id')
+  Trepanning::Breakpoint.reset
+  puts Trepanning::Breakpoint.class_variable_get('@@next_id')
+end

data/app/brkptmgr.rb

@@ -0,0 +1,149 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'set'
+require_relative 'breakpoint'
+class BreakpointMgr
+
+  attr_reader :list
+  attr_reader :set
+
+  def initialize
+    @list = []
+    @next_id = 1
+    @set = Set.new
+  end
+
+  def <<(brkpt)
+    @list << brkpt
+    @set.add(set_key(brkpt))
+  end
+
+  def [](index)
+    raise TypeError, 
+    "index #{index} should be a Fixnum, is #{index.class}" unless
+      index.is_a?(Fixnum)
+    @list.detect {|bp| bp.id == index }
+  end
+
+  alias detect []
+
+  def delete(index)
+    bp = detect(index)
+    if bp
+      delete_by_brkpt(bp)
+      return bp
+    else
+      return nil
+    end
+  end
+
+  def delete_by_brkpt(delete_bp)
+    @list = @list.reject{|candidate| candidate == delete_bp}
+    @set  = Set.new(@list.map{|bp| set_key(bp)})
+    delete_bp.remove! unless @set.member?(set_key(delete_bp))
+    return delete_bp
+  end
+
+  def add(*args)
+    if args[2] 
+      unless args[2].member?(:id)
+        args[2][:id] = @next_id
+        @next_id += 1
+      end
+    else
+      args[2] = {:id => @next_id}
+      @next_id += 1
+    end
+
+    brkpt = Trepanning::Breakpoint.new(*args)
+    @list << brkpt
+    @set.add(set_key(brkpt))
+    return brkpt
+  end
+
+  def empty?
+    @list.empty?
+  end
+
+  def line_breaks(container)
+    result = {}
+    @list.each do |bp|
+      if bp.source_container == container
+        bp.source_location.each do |line|
+          result[line] = bp 
+        end
+      end
+    end
+    result
+  end
+
+  def find(iseq, offset, bind)
+    @list.detect do |bp| 
+      if bp.enabled? && bp.iseq.equal?(iseq) && bp.offset == offset
+        begin
+          return bp if bp.condition?(bind)
+        rescue
+        end 
+      end
+    end
+  end
+
+  def max
+    @list.map{|bp| bp.id}.max
+  end
+
+  # Key used in @set to list unique instruction-sequence offsets.
+  def set_key(bp)
+    [bp.iseq, bp.offset]
+  end
+
+  def size
+    @list.size
+  end
+
+  def reset
+    @list.each{|bp| bp.remove!}
+    @list = []
+    @set  = Set.new
+  end
+
+end
+if __FILE__ == $0
+  def bp_status(brkpts, i)
+    puts "list size: #{brkpts.list.size}"
+    puts "set size: #{brkpts.set.size}"
+    puts "max: #{brkpts.max}"
+    p brkpts
+    puts "--- #{i} ---"
+  end
+
+  frame = RubyVM::ThreadFrame.current 
+  iseq = frame.iseq
+  brkpts = BreakpointMgr.new
+  brkpts.add(iseq, 0)
+  p brkpts[2]
+  bp_status(brkpts, 1)
+  offset = frame.pc_offset
+  b2 = Trepanning::Breakpoint.new(iseq, offset)
+  brkpts << b2
+  p brkpts.find(b2.iseq, b2.offset, nil)
+  p brkpts[2]
+  puts '--- 2 ---'
+  p brkpts.line_breaks(iseq.source_container)
+  p brkpts.delete(2)
+  p brkpts[2]
+  bp_status(brkpts, 3)
+
+  # Two of the same breakpoints but delete 1 and see that the
+  # other still stays
+  offset = frame.pc_offset
+  b2 = Trepanning::Breakpoint.new(iseq, offset)
+  brkpts << b2
+  bp_status(brkpts, 4)
+  b3 = Trepanning::Breakpoint.new(iseq, offset)
+  brkpts << b3
+  bp_status(brkpts, 5)
+  brkpts.delete_by_brkpt(b2)
+  bp_status(brkpts, 6)
+  brkpts.delete_by_brkpt(b3)
+  bp_status(brkpts, 7)
+end

data/app/condition.rb

@@ -0,0 +1,22 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+class Trepan
+  module Condition
+    def valid_condition?(str)
+      begin
+        RubyVM::InstructionSequence.compile(str)
+      rescue SyntaxError
+        return nil
+      rescue
+        nil
+      end
+    end
+    module_function :valid_condition?
+  end
+end
+if __FILE__ == $0
+  include Trepan::Condition
+  p valid_condition?('a+2')
+  puts '-' * 20
+  p valid_condition?('1+')
+  puts '-' * 20
+end