ruby-debug-base 0.10.4 → 0.10.5.rc1

data/AUTHORS

@@ -1,7 +1,12 @@
 Author and maintainer:
 Kent Sibilev
 
+JRuby Extension Authors:
+Martin Krauskopf
+Peter Brant
+
 Contributers:
 Markus Barchfeld
 R. Bernstein
 Anders Lindgren
+Chris Nelson

data/CHANGES

@@ -1,3 +1,20 @@
+0.10.5
+12/25/10 
+ - Remove extraneous .RB files messing up Microsoft Windows
+ - Deprecate "set force". Use "set di[fferent]. 
+ - Moved to github.
+ - Merged JRuby extension.
+ - Moved ruby-debug-extra to a separate repository.
+ - JRuby: fixed race condition that was causing the debugger to hang:
+     http://youtrack.jetbrains.net/issue/RUBY-8123
+     https://github.com/ruby-debug/ruby-debug/issues/7
+     http://jira.codehaus.org/browse/JRUBY-6083
+ - JRuby: fixed stopping in wrong file with the same basename
+ - Use rake-compiler for building extensions
+ - Fix use of stale variables after restarting the debugger (#4)
+ - Use Travis for CI
+ - JRuby: Remove GPL'd linecache code (#3)
+
 0.10.4
 10/27/10
 

data/README

@@ -112,3 +112,42 @@ your program can be minimized.
 == License
 
 See LICENSE for license information.
+
+
+
+= ruby-debug-base for JRuby
+
+== Overview
+
+(j)ruby-debug-base provides the fast debugger extension for JRuby interpreter.
+It is the same as ruby-debug-base native C extension from ruby-debug project
+(http://rubyforge.org/projects/ruby-debug/), but for JRuby.
+
+== Install
+
+(j)ruby-debug-base is available as a RubyGem:
+
+   jruby -S gem install ruby-debug-base
+
+== Usage
+
+The usage is then the same as with native ruby-debugger, but you might need to
+force JRuby which has to run in interpreted mode. Simplest usage is:
+
+  $ jruby --debug -S rdebug <your-script>
+
+Or easier, you might create 'jruby-dm' ('dm' for 'debugger-mode'):
+
+  $ cat ~/bin/jruby-dm
+  #!/bin/bash
+  jruby --debug "$@"
+
+Then you may run just as you used to:
+
+  $ jruby-dm -S rdebug <your-script>
+
+For more information see: http://bashdb.sourceforge.net/ruby-debug.html
+
+== License
+
+See MIT-LICENSE for license information.

data/Rakefile

@@ -1,34 +1,17 @@
 #!/usr/bin/env rake
 # -*- Ruby -*-
 require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 require 'rake/testtask'
+require 'rake/extensiontask'
+require 'rake/javaextensiontask'
+
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-debug-base/version"
 
 SO_NAME = "ruby_debug.so"
 ROOT_DIR = File.dirname(__FILE__)
-VERSION_FILE = ROOT_DIR + '/VERSION'
-
-def make_version_file
-  ruby_debug_version = open("ext/ruby_debug.c").
-    grep(/^#define DEBUG_VERSION/).first[/"(.+)"/,1]
-  File.open(VERSION_FILE, 'w') do |f|
-      f.write(
-"# This file was created automatically from data in ext/ruby_debug.c via:
-# 	rake :make_version_file. 
-#{ruby_debug_version}
-")
-    end
-end
-
-make_version_file unless File.exist?(VERSION_FILE)
-ruby_debug_version = nil
-open(VERSION_FILE).each do |line| 
-  next if line =~ /^#/
-  ruby_debug_version = line.chomp
-  break
-end
-
 
 # ------- Default Package ----------
 COMMON_FILES = FileList[
@@ -36,7 +19,6 @@ COMMON_FILES = FileList[
   'CHANGES',
   'LICENSE',
   'README',
-  'VERSION',
   'Rakefile',
 ]                        
 
@@ -52,19 +34,14 @@ CLI_FILES = COMMON_FILES + FileList[
   'test/rdebug-save.1',
   'test/**/data/*.cmd',
   'test/**/data/*.right',
+  'test/**/example/*.rb',
   'test/config.yaml',
   'test/**/*.rb',
   'rdbg.rb',
-  'runner.sh',
    CLI_TEST_FILE_LIST
 ]
 
-BASE_TEST_FILE_LIST = %w(
-  test/base/base.rb 
-  test/base/binding.rb 
-  test/base/catchpoint.rb
-  test/base/reload_bug.rb 
-)
+BASE_TEST_FILE_LIST = FileList['test/base/*.rb']
 
 BASE_FILES = COMMON_FILES + FileList[
   'ext/breakpoint.c',
@@ -72,54 +49,46 @@ BASE_FILES = COMMON_FILES + FileList[
   'ext/ruby_debug.c',
   'ext/ruby_debug.h',
   'ext/win32/*',
-  'lib/**/*',
+  'lib/ruby-debug-base.rb',
+  'lib/ruby-debug-base/version.rb',
   BASE_TEST_FILE_LIST,
 ]
 
-desc "Test everything."
 ext = File.join(ROOT_DIR, 'ext')
-test_and_args = File.exist?(ext) ? {:test => :test_base} : [:test]
-task test_and_args do 
-  Rake::TestTask.new(:test) do |t|
-    t.libs += %W(#{ROOT_DIR}/lib #{ROOT_DIR}/cli)
-    t.libs << ext if File.exist?(ext)
-    t.test_files = CLI_TEST_FILE_LIST
-    t.verbose = true
-  end
-end
 
-desc "Test ruby-debug-base."
-task :test_base => :lib do 
-  Rake::TestTask.new(:test_base) do |t|
-    t.libs += ['./ext', './lib']
-    t.test_files = FileList[BASE_TEST_FILE_LIST]
-    t.verbose = true
-  end
+desc "Test everything."
+Rake::TestTask.new(:test) do |t|
+  t.libs += %W(#{ROOT_DIR}/lib #{ROOT_DIR}/cli)
+  t.libs << ext if File.exist?(ext)
+  t.test_files = CLI_TEST_FILE_LIST
+  t.options = '--verbose' if $VERBOSE
+  t.ruby_opts << "--debug" if defined?(JRUBY_VERSION)
 end
 
-desc "Test everything - same as test."
-task :check => :test
+task :test => :test_base if File.exist?(ext)
 
-desc "Create the core ruby-debug shared library extension"
-task :lib do
-  Dir.chdir("ext") do
-    system("#{Gem.ruby} extconf.rb && make")
-  end
+desc "Test ruby-debug-base."
+Rake::TestTask.new(:test_base) do |t|
+  t.libs += ['./ext', './lib']
+  t.test_files = FileList[BASE_TEST_FILE_LIST]
+  t.options = '--verbose' if $VERBOSE
+  t.ruby_opts << "--debug" if defined?(JRUBY_VERSION)
 end
 
-desc "Compile Emacs code"
-task :emacs => "emacs/rdebug.elc"
-file "emacs/rdebug.elc" => ["emacs/elisp-comp", "emacs/rdebug.el"] do
-  Dir.chdir("emacs") do
-    system("./elisp-comp ./rdebug.el")
-  end
+if defined?(JRUBY_VERSION)
+  task :test_base => 'jruby:compile:java'
+else
+  task :test_base => :compile
 end
 
+desc "Test everything - same as test."
+task :check => :test
+
 desc "Create a GNU-style ChangeLog via svn2cl"
 task :ChangeLog do
-  system('svn2cl --authors=svn2cl_usermap http://ruby-debug.rubyforge.org/svn/trunk')
-  system("svn2cl --authors=svn2cl_usermap http://ruby-debug.rubyforge.org/svn/trunk/ext -o ext/ChangeLog")
-  system("svn2cl --authors=svn2cl_usermap http://ruby-debug.rubyforge.org/svn/trunk/lib -o lib/ChangeLog")
+  system('git log --pretty --numstat --summary     | git2cl >     ChangeLog')
+  system('git log --pretty --numstat --summary ext | git2cl > ext/ChangeLog')
+  system('git log --pretty --numstat --summary lib | git2cl > lib/ChangeLog')
 end
 
 # Base GEM Specification
@@ -135,7 +104,7 @@ provides support that front-ends can build on. It provides breakpoint
 handling, bindings for stack frames among other things.
 EOF
 
-  spec.version = ruby_debug_version
+  spec.version = Debugger::VERSION
 
   spec.author = "Kent Sibilev"
   spec.email = "ksibilev@yahoo.com"
@@ -148,7 +117,8 @@ EOF
   spec.date = Time.now
   spec.rubyforge_project = 'ruby-debug'
   spec.add_dependency('linecache', '>= 0.3')
-  
+  spec.add_development_dependency('rake-compiler')
+
   spec.test_files = FileList[BASE_TEST_FILE_LIST]
   
   # rdoc
@@ -165,7 +135,7 @@ cli_spec = Gem::Specification.new do |spec|
 A generic command line interface for ruby-debug.
 EOF
 
-  spec.version = ruby_debug_version
+  spec.version = Debugger::VERSION
 
   spec.author = "Kent Sibilev"
   spec.email = "ksibilev@yahoo.com"
@@ -179,7 +149,7 @@ EOF
   spec.date = Time.now
   spec.rubyforge_project = 'ruby-debug'
   spec.add_dependency('columnize', '>= 0.1')
-  spec.add_dependency('ruby-debug-base', "~> #{ruby_debug_version}.0")
+  spec.add_dependency('ruby-debug-base', "~> #{Debugger::VERSION}.0")
   
   # FIXME: work out operational logistics for this
   # spec.test_files = FileList[CLI_TEST_FILE_LIST]
@@ -190,14 +160,18 @@ EOF
 end
 
 # Rake task to build the default package
-Rake::GemPackageTask.new(base_spec) do |pkg|
+Gem::PackageTask.new(base_spec) do |pkg|
   pkg.need_tar = true
 end
-Rake::GemPackageTask.new(cli_spec) do |pkg|
+Gem::PackageTask.new(cli_spec) do |pkg|
   pkg.need_tar = true
 end
 
-task :default => [:package]
+Rake::ExtensionTask.new('ruby_debug', base_spec) do |t|
+  t.ext_dir = "ext"
+end
+
+task :default => :test
 
 # Windows specification
 win_spec = base_spec.clone
@@ -244,11 +218,12 @@ task :clean do
     derived_files = Dir.glob(".o") + Dir.glob("*.so")
     rm derived_files unless derived_files.empty?
   end
+  rm 'lib/ruby_debug.jar' if File.exists?("lib/ruby_debug.jar")
 end
 
 # ---------  RDoc Documentation ------
 desc "Generate rdoc documentation"
-Rake::RDocTask.new("rdoc") do |rdoc|
+RDoc::Task.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'doc/rdoc'
   rdoc.title    = "ruby-debug"
   # Show source inline with line numbers
@@ -284,9 +259,9 @@ task :rubyforge_upload do
   end
 end
 
-def install(spec, *opts)
+def install_gem(spec, *opts)
   args = ['gem', 'install', "pkg/#{spec.name}-#{spec.version}.gem"] + opts
-  args.unshift 'sudo' unless 0 == Process.uid
+  args.unshift 'sudo' unless 0 == Process.uid || ENV['rvm_path']
   system(*args)
 end
 
@@ -294,18 +269,28 @@ desc 'Install locally'
 task :install => :package do
   Dir.chdir(File::dirname(__FILE__)) do
     # ri and rdoc take lots of time
-    install(base_spec, '--no-ri', '--no-rdoc')
-    install(cli_spec, '--no-ri', '--no-rdoc')
+    install_gem(base_spec, '--no-ri', '--no-rdoc')
+    install_gem(cli_spec, '--no-ri', '--no-rdoc')
   end
 end    
 
 task :install_full => :package do
   Dir.chdir(File::dirname(__FILE__)) do
-    install(base_spec)
-    install(cli_spec)
+    install_gem(base_spec)
+    install_gem(cli_spec)
   end
 end    
 
-task :make_version_file do 
-  make_version_file 
+namespace :jruby do
+  jruby_spec = base_spec.clone
+  jruby_spec.platform   = "java"
+  jruby_spec.files      = jruby_spec.files.reject {|f| f =~ /^ext/ }
+  jruby_spec.files     += ['lib/ruby_debug.jar']
+  jruby_spec.extensions = []
+
+  Gem::PackageTask.new(jruby_spec) {}
+
+  Rake::JavaExtensionTask.new('ruby_debug') do |t|
+    t.ext_dir = "src"
+  end
 end

data/ext/extconf.rb

@@ -1,20 +1,23 @@
 require "mkmf"
 
 if RUBY_VERSION >= "1.9"
-  if RUBY_RELEASE_DATE < "2005-03-17"
-    STDERR.print("Ruby version is too old\n")
-    exit(1)
-  end
+  STDERR.print("Ruby version #{RUBY_VERSION} is too new\n")
+  exit(1)
 elsif RUBY_VERSION >= "1.8"
   if RUBY_RELEASE_DATE < "2005-03-22"
-    STDERR.print("Ruby version is too old\n")
+    STDERR.print("Ruby release date #{RUBY_RELEASE_DATE} is too old\n")
     exit(1)
   end
 else
-  STDERR.print("Ruby version is too old\n")
+  STDERR.print("Ruby version is not compatible for this version.\n")
   exit(1)
 end
 
-# Temporary: to turn off optimization
-# $CFLAGS='-fno-strict-aliasing -g -fPIC'
+# Allow use customization of compile options. For example, the
+# following lines could be put in config_options to to turn off
+# optimization:
+#   $CFLAGS='-fPIC -fno-strict-aliasing -g3 -ggdb -O2 -fPIC'
+config_file = File.join(File.dirname(__FILE__), 'config_options.rb')
+load config_file if File.exist?(config_file)
+
 create_makefile("ruby_debug")

data/ext/ruby_debug.c

@@ -6,8 +6,6 @@
 #include <st.h>
 #include <intern.h>
 
-#define DEBUG_VERSION "0.10.4"
-
 #ifdef _WIN32
 struct FRAME {
     VALUE self;
@@ -1061,6 +1059,9 @@ debug_stop(VALUE self)
     locker             = Qnil;
     rdebug_breakpoints = Qnil;
     rdebug_threads_tbl = Qnil;
+    last_thread        = Qnil;
+    last_context       = Qnil;
+    last_debug_context = NULL;
 
     return Qtrue;
 }
@@ -1415,15 +1416,12 @@ debug_debug_load(int argc, VALUE *argv, VALUE self)
       return errinfo;
     }
 
-    /* We should run all at_exit handler's in order to provide, 
-     * for instance, a chance to run all defined test cases */
-    rb_exec_end_proc();
-
-    /* We could have issued a Debugger.stop inside the debug
-       session. */
-    if (start_count > 0) {
-      debug_stop(self);
-    }
+    /* We don't want to stop the debugger yet, because the
+     * user may have set breakpoints in at_exit blocks that
+     * should be hit. But we don't want to step out into debugger
+     * code either, so we reset stepping stop points here.
+     */
+    reset_stepping_stop_points(debug_context);
 
     return Qnil;
 }
@@ -2262,7 +2260,6 @@ void
 Init_ruby_debug()
 {
     mDebugger = rb_define_module("Debugger");
-    rb_define_const(mDebugger, "VERSION", rb_str_new2(DEBUG_VERSION));
     rb_define_module_function(mDebugger, "start_", debug_start, 0);
     rb_define_module_function(mDebugger, "stop", debug_stop, 0);
     rb_define_module_function(mDebugger, "started?", debug_is_started, 0);

data/lib/ruby-debug-base.rb

@@ -1,5 +1,5 @@
-require 'ruby_debug.so'
-require 'rubygems'
+require 'ruby_debug'
+require 'ruby-debug-base/version'
 require 'linecache'
 
 module Debugger

data/lib/ruby-debug-base/version.rb

@@ -0,0 +1,3 @@
+module Debugger
+  VERSION = "0.10.5.rc1"
+end

data/test/base/base.rb

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
-require 'test/unit'
+require File.expand_path("../../helper", __FILE__)
 
 # Some tests of Debugger module in C extension ruby_debug 
 class TestRubyDebug < Test::Unit::TestCase
-  $:.unshift File.join(File.dirname(__FILE__), '..', '..', 'ext')
-  require 'ruby_debug'
-  $:.shift
+  def test_version
+    assert(defined?(Debugger::VERSION))
+  end
 
   # test current_context
   def test_current_context
@@ -26,6 +26,7 @@ class TestRubyDebug < Test::Unit::TestCase
     assert_equal(1, Debugger.current_context.stack_size)
     assert_equal(TestRubyDebug, Debugger.current_context.frame_class)
     assert_equal(false, Debugger.current_context.dead?, 'Not dead yet!')
+  ensure
     Debugger.stop
     assert_equal(false, Debugger.started?, 
                  'Debugger should no longer be started.')
@@ -47,6 +48,7 @@ class TestRubyDebug < Test::Unit::TestCase
                  'There should only be one context.')
     assert_equal(Array, a.class, 
                  'Context should be an array.')
+  ensure
     Debugger.stop
     assert_equal(false, Debugger.started?, 
                  'debugger should no longer be started.')
@@ -68,6 +70,7 @@ class TestRubyDebug < Test::Unit::TestCase
     Debugger.remove_breakpoint(1)
     assert_equal(0, Debugger.breakpoints.size,
                  'There should no longer be any breakpoints set.')
+  ensure
     Debugger.stop
   end
 end