rbx-trepanning 0.2.0-universal-rubinius-2.0

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2010, Rocky Bernstein
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* 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.
+* Neither the name of the Evan Phoenix nor the names of its contributors 
+  may be used to endorse or promote products derived from this software 
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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/Makefile

@@ -0,0 +1,13 @@
+# I'll admit it -- I'm an absent-minded old-timer who has trouble
+# learning new tricks.
+.PHONY: all test
+
+all: test
+
+check: 
+	rake test
+test: 
+	rake test
+
+%: 
+	rake $@

data/NEWS

@@ -0,0 +1,105 @@
+Oct 27,  2011  (0.1.0)
+- Add debugger commands: 
+  * info variables  (is in ruby-debug)
+  * info locals as alternative to "info variables locals" (is in gdb)
+
+- POSIX shell -x (long form: --trace) fixed
+
+- Add disabling and enabling on display expressions
+
+- Confirm before deleting all displays.
+
+- Give breakpoints for files via linecache if they are syntactically
+  correct Ruby files
+
+- Change whence-file to match gdb's resolution: don't apply PATH to
+  relative files.
+
+- Command Completion and help text improvements
+
+- Syntax highlighting updated to support coderay 1.0 and greater
+
+- Bugs fixed, code reorganized.
+
+
+June 12, 2011  (0.0.9) Fleetwood release
+- Add debugger commands:
+  * tbreak          (is in gdb)
+  * info globals    (is in ruby-debug)
+  * info locals     (is in gdb)
+  * info source     (is in gdb)
+  * info stack      (is in gdb, same as backtrace)
+  * info macro      (in in gdb; remove show macro)
+  * show timer      (set timer was already there)
+  * parsetree
+  * pp              (is in ruby-debug)
+  * set/show reload (is in ruby-debug)
+
+- Add options from ruby-debug:
+  * --cd
+  * --include
+  * --require 
+  * --debug
+- fix bugs, and improve help
+
+March 15, 2011  (0.0.8)
+
+- Revise breakpoint location parsing
+  * Add: break <location> if/unless <condition>
+  * Add: step until <condition>
+  * 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 
+- improvements to "info files"
+  show if we have a compiled method object for the file
+- eval? now strips more: 
+   * leading "return" or "case", or "unless"
+   * trailing "then"
+- Save and restore some debugger state across a restart
+
+Feb 22, 2011  (0.0.7)
+- Add gdb "condition" command
+- More complete command completion
+- Add kill! alias to force without prompting
+- Add eval (no args) and eval? to run current source line or source line
+  expression
+- Add "set/show trace buffer on/off" to keep a history of recent places
+  we've stopped in the debugger
+- Add "show macro *" to list all macro names.
+- A number of bug fixes
+
+Feb 15, 2011  (0.0.6)
+- Repackage using rubinus platform 1.2 rather than 1.2.1
+
+Feb 15, 2011  (0.0.5)
+- "disassemble" command: allow disassembly of specified line numbers
+- 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 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 
+- be able to pass --verbose to ruby to rake
+
+
+Feb 1, 2011  (0.0.4)
+- Add Remote debugging interface. Add options --server --port
+- Add Syntax highlighting on Ruby and Rubinus LLVM listings and locations
+- Section highlighting on some commands; italics on error if term mode
+- Use ;; to allow multiple debugger commands. Document debugger command syntax
+- Numerous bug fixes and code cleanups
+
+Jan 1, 2011  (0.0.3)
+- Add finish+
+- Add "step into" "step over" and "step out" as alternates
+  for "step", "next", and "finish"
+- Remove extraneous debug command.
+
+Dec 25, 26, 2010  (0.0.1, & 0.0.2)
+First general release. Port of trepanning debugger for Ruby 1.9.2.

data/README.textile

@@ -0,0 +1,34 @@
+A debugger for Rubinius 1.2.x
+
+bc.  [sudo] gem install rbx-trepanning
+
+should get you going.
+
+There is a "google group mailing list":http://groups.google.com/group/ruby-debugger for Ruby debuggers.
+
+To run initially: 
+
+bc.   $ trepanx my-ruby-program.rb
+
+Or to call from inside your code: 
+
+bc.   require 'trepanning' 
+  debugger # Don't stop here...
+  work # but stop here.
+
+If you want an immediate stop:
+
+bc.  debugger(:immediate=>true)
+
+Finally, if you put in your .trepanx
+
+bc.   Rubinius::Loader.debugger = proc { 
+    require 'trepanning'; 
+    Trepan.start(:skip_loader => :Xdebug) 
+  }
+
+Then you can use the -Xdebug option the Ruby, e.g.
+
+bc. rbx -Xdebug my-ruby-program.rb
+
+There is extensive on-line help. Run "help" inside the debugger.

data/Rakefile

@@ -0,0 +1,244 @@
+#!/usr/bin/env rake
+# -*- Ruby -*-
+# Are we Rubinius? The right versions of it? 
+raise RuntimeError, 
+'This package is for Rubinius 1.2.[34] or 2.0.x only!' unless
+  Object.constants.include?('Rubinius') && 
+  Rubinius.constants.include?('VM') && 
+  Rubinius::VERSION =~ /1\.2\.[34]/ || Rubinius::VERSION =~ /2\.0/
+
+require 'rubygems'
+
+ROOT_DIR = File.dirname(__FILE__)
+Gemspec_filename = 'rbx-trepanning.gemspec'
+require File.join %W(#{ROOT_DIR} app options)
+
+def gemspec
+  @gemspec ||= eval(File.read(Gemspec_filename), binding, Gemspec_filename)
+end
+
+require 'rubygems/package_task'
+desc "Build the gem"
+task :package=>:gem
+task :gem=>:gemspec do
+  Dir.chdir(ROOT_DIR) do
+    sh "gem build #{Gemspec_filename}"
+    FileUtils.mkdir_p 'pkg'
+    FileUtils.mv gemspec.file_name, 'pkg'
+
+    # Now make a 2.0 package by changing 1.2 to 2.0 in the gemspec
+    # and creating another gemspec and moving that accordingly
+    lines = File.open(Gemspec_filename).readlines.map{|line|
+      line.gsub(/'universal', 'rubinius', '1\.2'/,
+                "'universal', 'rubinius', '2.0'");
+    }
+
+    two_filename = gemspec.dup.file_name.gsub(/1\.2/, '2.0')
+    FileUtils.cp("rbx-trepanning.gemspec", "rbx-trepanning-2.0.gemspec")
+    gemspec_filename2 = "rbx-trepanning-2.0.gemspec"
+    f = File.open(gemspec_filename2, "w")
+    f.write(lines); f.close
+    sh "gem build #{gemspec_filename2}"
+    FileUtils.mv("#{two_filename}", "pkg/")
+  end
+end
+
+desc 'Install the gem locally'
+task :install => :gem do
+  Dir.chdir(ROOT_DIR) do
+    sh %{gem install --local pkg/#{gemspec.file_name}}
+  end
+end
+
+require 'rake/testtask'
+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'
+def RbConfig.ruby
+  File.join(RbConfig::CONFIG['bindir'],  
+            RbConfig::CONFIG['RUBY_INSTALL_NAME'] + 
+            RbConfig::CONFIG['EXEEXT'])
+end unless defined? RbConfig.ruby
+
+def run_standalone_ruby_files(list, opts={})
+  puts '*' * 40
+  list.each do |ruby_file|
+    system(RbConfig.ruby, ruby_file)
+    p $?.exitstatus
+    break if $?.exitstatus != 0 && !opts[:continue]
+  end
+end
+
+def run_standalone_ruby_file(directory, opts={})
+  puts(('*' * 10) + ' ' + directory + ' ' + ('*' * 10))
+  Dir.chdir(directory) do
+    Dir.glob('*.rb').each do |ruby_file|
+      puts(('-' * 20) + ' ' + ruby_file + ' ' + ('-' * 20))
+      system(RbConfig.ruby, ruby_file)
+      break if $?.exitstatus != 0 && !opts[:continue]
+    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'
+Rake::TestTask.new(:'test:unit') do |t|
+  t.test_files = FileList['test/unit/**/test-*.rb']
+  # t.pattern = 'test/**/*test-*.rb' # instead of above
+  t.options = '--verbose' if $VERBOSE
+end
+
+desc 'Test functional - the medium-sized tests'
+Rake::TestTask.new(:'test:functional') do |t|
+  t.test_files = FileList['test/functional/**/test-*.rb']
+  t.options = '--verbose' if $VERBOSE
+end
+
+desc 'Test integration - end-to-end blackbox tests'
+Rake::TestTask.new(:'test:integration') do |t|
+  t.test_files = FileList['test/integration/**/test-*.rb']
+  t.options = '--verbose' if $VERBOSE
+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 Ruby app 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 of the sub-sub commands in standalone mode.'
+task :'check:sub:commands' do
+  p "#{ROOT_DIR}/processor/command/*_subcmd/*_subcmd/*.rb"
+  Dir.glob("#{ROOT_DIR}/processor/command/*_subcmd").each do |sub_dir|
+    run_standalone_ruby_file(sub_dir)
+  end
+end
+
+desc 'Run each of the sub-sub commands in standalone mode.'
+task :'check:subsub:commands' do
+  subsub_files = FileList["#{ROOT_DIR}/processor/command/*_subcmd/*_subcmd/*.rb"]
+  run_standalone_ruby_files(subsub_files)
+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_files(FileList['test/unit/**/test-*.rb'])
+end
+
+desc 'Run functional tests in standalone mode.'
+task :'check:functional' do
+  run_standalone_ruby_file(File.join(%W(#{ROOT_DIR} test functional)))
+end
+
+desc 'Run command parser grammar.'
+task :'check:cmd_parse' do
+  sh "kpeg --test --debug #{File.join(ROOT_DIR, %w(app cmd_parse.kpeg))}"
+end
+
+desc 'Generate command parser.'
+task :'cmd_parse' do
+  require 'tmpdir'
+  temp_file = File.join(Dir.tmpdir, "cmd_parser_#{$$}.rb")
+  sh("kpeg --name CmdParse --verbose --stand-alone  " + 
+     "#{File.join(ROOT_DIR, %w(app cmd_parse.kpeg))} " + 
+     "--output #{temp_file}")
+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 "Default action is 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 ------
+require 'rdoc/task'
+desc "Generate rdoc documentation"
+Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Trepanning #{Trepan::VERSION} Documentation"
+
+  rdoc.rdoc_files.include(%w(lib/trepanning.rb processor/*.rb
+                             processor/command/*.rb
+                             app/*.rb intf/*.rb io/*.rb 
+                            ))
+end
+
+desc 'Same as rdoc'
+task :doc => :rdoc
+
+task :clobber_package do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'pkg'), :verbose => true
+end
+
+task :clobber_rdoc do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'doc'), :verbose => true
+end
+
+desc 'Remove residue from running patch'
+task :rm_patch_residue do
+  FileUtils.rm_rf Dir.glob('**/*.{rej,orig}'), :verbose => true
+end
+
+desc 'Remove ~ backup files'
+task :rm_tilde_backups do
+  FileUtils.rm_rf Dir.glob('**/*~'), :verbose => true
+end
+
+desc 'Remove built files'
+task :clean => [:clobber_package, :clobber_rdoc, :rm_patch_residue, 
+                :rm_tilde_backups]

data/THANKS

@@ -0,0 +1,14 @@
+This code builds off of code from the Rubinius reference debugger. At
+the time it was created, Brian Ford and Evan Phoenix were the primary
+forces behind that. See the AUTHORS file in the Rubinius distribution
+for a complete list of Rubinius authors.
+
+I am very grateful to Evan Phoenix for so graciously and willingly making
+the numerous little changes that I think not only improve the debugging
+experience, but increase location reporting and live introspection.
+
+Ideas and in some cases command structure or exact text from help,
+command name, command structure, and errors messages have come from
+gdb and ruby-debug. The creative force and author of ruby-debug is
+Kent Sibilev.  Other ideas from other debuggers are used here; in
+particular, the debugger that comes distributed with Python, pdb.

data/app/.gitignore

@@ -0,0 +1,2 @@
+/*.rbc
+/*~

data/app/breakpoint.rb

@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 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_reader   :event     # Symbol. Optional type of event associated with
+                             # 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?
+    attr_reader   :id        # Fixnum. Name of breakpoint
+    attr_reader   :ignore    # Fixnum. How many more times do we have
+                             # to encounter the breakpoint before we stop?
+    attr_reader   :line   
+    attr_reader   :method
+    attr_reader   :negate    # Boolean. Negate sense of condition. Used in 
+                             # break if .. and break unless ..
+                             # breakpoint
+    @@next_id = 1
+
+    BRKPT_DEFAULT_SETTINGS = {
+      :condition => 'true',
+      :enabled   => 'true',
+      :ignore    =>  0,
+      :negate    =>  false,
+      :temp      =>  false,
+      :event     =>  :Unknown,
+    } unless defined?(BRKPT_DEFAULT_SETTINGS)
+
+    def initialize(name, method, ip, line, id=nil, opts = {})
+      @descriptor = name
+      @id = id
+      @method = method
+      @ip = ip
+      @line = line
+
+      # If not nil, is a Rubinius::VariableScope. This is what we 
+      # check to have call-frame-specific breakpoints.
+      @scope = nil
+
+      @related_bp = []
+
+      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
+
+      @activated = false
+    end
+
+    attr_reader :method, :ip, :line, :descriptor
+    attr_accessor :related_bp
+
+    def scoped!(scope, temp = true)
+      @temp = temp
+      @scope = scope
+    end
+
+    def set_temp!
+      @temp = true
+    end
+
+    def scoped?
+      !!@scope
+    end
+
+    def related_with(bp)
+      @related_bp += [bp] + bp.related_bp
+      @related_bp.uniq!
+      # List of related breakpoints should be shared.
+      bp.related_bp = @related_bp
+    end
+
+    def activate
+      @activated = true
+      @method.set_breakpoint @ip, self
+    end
+
+    def active?
+      @activated
+    end
+
+    # FIXME: give this a better name.
+    # Return true if the breakpoint is a temporary breakpoint and is
+    # relevant. By releveant we mean that, the breakpoint is either
+    # not a scoped breakpoint or it is scoped and test_scope matches
+    # the desired scope. We also remove the breakpoint and any related
+    # breakpoints if it was hit and temporary.  
+    # 
+    # If the breakpoint is not a temporary breakpoint, return nil.
+    # 
+    # See also "condition' below which is run to determine whether or 
+    # not to stop. 
+    def hit!(test_scope)
+      return nil unless @temp
+      return false if @scope && test_scope != @scope
+
+      @related_bp.each { |bp| bp.remove! }
+      remove!
+      return true
+    end
+
+    def condition?(bind)
+      if @negate != eval(@condition, bind)
+        if @ignore > 0
+          @ignore -= 1
+          return false
+        else
+          @hits += 1
+          return true
+        end
+      else
+        return false
+      end
+    end
+
+    def delete!
+      remove!
+    end
+
+    def describe
+      "#{@descriptor} - #{location}"
+    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 location
+      "#{@method.active_path}:#{@line} (@#{ip})"
+    end
+
+    def remove!
+      return unless @activated
+      @activated = false
+      @method.clear_breakpoint(@ip)
+    end
+
+    def temp?
+      @temp
+    end
+
+    def self.for_ip(exec, ip, opts={})
+      name = opts[:name] || :anon
+      line = exec.line_from_ip(ip)
+
+      Breakpoint.new(name, exec, ip, line, nil, opts)
+    end
+
+  end
+
+  class DeferredBreakpoint
+    def initialize(debugger, frame, klass, which, name, line=nil, list=nil)
+      @debugger = debugger
+      @frame = frame
+      @klass_name = klass
+      @which = which
+      @name = name
+      @line = line
+      @list = list
+    end
+
+    def descriptor
+      "#{@klass_name}#{@which}#{@name}"
+    end
+
+    def resolve!
+      begin
+        klass = @frame.run(@klass_name)
+      rescue NameError
+        return false
+      end
+
+      begin
+        if @which == "#"
+          meth = klass.instance_method(@name)
+        else
+          meth = klass.method(@name)
+        end
+      rescue NameError
+        return false
+      end
+
+      @debugger.processor.msg "Resolved breakpoint for #{@klass_name}#{@which}#{@name}"
+
+      @debugger.processor.set_breakpoint_method descriptor, meth, @line
+
+      return true
+    end
+
+    def describe
+      "#{descriptor} - unknown location (deferred)"
+    end
+
+    def delete!
+      if @list
+        @list.delete self
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  method = Rubinius::CompiledMethod.of_sender
+  bp = Trepan::Breakpoint.new '<start>', method, 0, 2, 0
+  %w(describe location icon_char hits temp? enabled? condition).each do |field|
+    puts "#{field}: #{bp.send(field.to_sym)}"
+  end
+  bp.activate
+  bp.remove!
+end